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
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
17 #include <linux/bug.h>
18 #include <linux/kernel.h>
19 #include <linux/if_ether.h>
20 #include <linux/skbuff.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
23 #include <asm/unaligned.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
73 * DOC: mac80211 workqueue
75 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
76 * The workqueue is a single threaded workqueue and can only be accessed by
77 * helpers for sanity checking. Drivers must ensure all work added onto the
78 * mac80211 workqueue should be cancelled on the driver stop() callback.
80 * mac80211 will flushed the workqueue upon interface removal and during
83 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
88 * DOC: mac80211 software tx queueing
90 * mac80211 provides an optional intermediate queueing implementation designed
91 * to allow the driver to keep hardware queues short and provide some fairness
92 * between different stations/interfaces.
93 * In this model, the driver pulls data frames from the mac80211 queue instead
94 * of letting mac80211 push them via drv_tx().
95 * Other frames (e.g. control or management) are still pushed using drv_tx().
97 * Drivers indicate that they use this model by implementing the .wake_tx_queue
100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
101 * single per-vif queue for multicast data frames.
103 * The driver is expected to initialize its private per-queue data for stations
104 * and interfaces in the .add_interface and .sta_add ops.
106 * The driver can't access the queue directly. To dequeue a frame, it calls
107 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
108 * calls the .wake_tx_queue driver op.
110 * For AP powersave TIM handling, the driver only needs to indicate if it has
111 * buffered packets in the driver specific data structures by calling
112 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
113 * struct, mac80211 sets the appropriate TIM PVB bits and calls
114 * .release_buffered_frames().
115 * In that callback the driver is therefore expected to release its own
116 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
117 * via the usual ieee80211_tx_dequeue).
123 * enum ieee80211_max_queues - maximum number of queues
125 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
126 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
128 enum ieee80211_max_queues {
129 IEEE80211_MAX_QUEUES = 16,
130 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
133 #define IEEE80211_INVAL_HW_QUEUE 0xff
136 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
137 * @IEEE80211_AC_VO: voice
138 * @IEEE80211_AC_VI: video
139 * @IEEE80211_AC_BE: best effort
140 * @IEEE80211_AC_BK: background
142 enum ieee80211_ac_numbers {
148 #define IEEE80211_NUM_ACS 4
151 * struct ieee80211_tx_queue_params - transmit queue configuration
153 * The information provided in this structure is required for QoS
154 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
156 * @aifs: arbitration interframe space [0..255]
157 * @cw_min: minimum contention window [a value of the form
158 * 2^n-1 in the range 1..32767]
159 * @cw_max: maximum contention window [like @cw_min]
160 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
161 * @acm: is mandatory admission control required for the access category
162 * @uapsd: is U-APSD mode enabled for the queue
164 struct ieee80211_tx_queue_params {
173 struct ieee80211_low_level_stats {
174 unsigned int dot11ACKFailureCount;
175 unsigned int dot11RTSFailureCount;
176 unsigned int dot11FCSErrorCount;
177 unsigned int dot11RTSSuccessCount;
181 * enum ieee80211_chanctx_change - change flag for channel context
182 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
183 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
184 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
185 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
186 * this is used only with channel switching with CSA
187 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
189 enum ieee80211_chanctx_change {
190 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
191 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
192 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
193 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
194 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
198 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
200 * This is the driver-visible part. The ieee80211_chanctx
201 * that contains it is visible in mac80211 only.
203 * @def: the channel definition
204 * @min_def: the minimum channel definition currently required.
205 * @rx_chains_static: The number of RX chains that must always be
206 * active on the channel to receive MIMO transmissions
207 * @rx_chains_dynamic: The number of RX chains that must be enabled
208 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
209 * this will always be >= @rx_chains_static.
210 * @radar_enabled: whether radar detection is enabled on this channel.
211 * @drv_priv: data area for driver use, will always be aligned to
212 * sizeof(void *), size is determined in hw information.
214 struct ieee80211_chanctx_conf {
215 struct cfg80211_chan_def def;
216 struct cfg80211_chan_def min_def;
218 u8 rx_chains_static, rx_chains_dynamic;
222 u8 drv_priv[0] __aligned(sizeof(void *));
226 * enum ieee80211_chanctx_switch_mode - channel context switch mode
227 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
228 * exist (and will continue to exist), but the virtual interface
229 * needs to be switched from one to the other.
230 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
231 * to exist with this call, the new context doesn't exist but
232 * will be active after this call, the virtual interface switches
233 * from the old to the new (note that the driver may of course
234 * implement this as an on-the-fly chandef switch of the existing
235 * hardware context, but the mac80211 pointer for the old context
236 * will cease to exist and only the new one will later be used
237 * for changes/removal.)
239 enum ieee80211_chanctx_switch_mode {
240 CHANCTX_SWMODE_REASSIGN_VIF,
241 CHANCTX_SWMODE_SWAP_CONTEXTS,
245 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
247 * This is structure is used to pass information about a vif that
248 * needs to switch from one chanctx to another. The
249 * &ieee80211_chanctx_switch_mode defines how the switch should be
252 * @vif: the vif that should be switched from old_ctx to new_ctx
253 * @old_ctx: the old context to which the vif was assigned
254 * @new_ctx: the new context to which the vif must be assigned
256 struct ieee80211_vif_chanctx_switch {
257 struct ieee80211_vif *vif;
258 struct ieee80211_chanctx_conf *old_ctx;
259 struct ieee80211_chanctx_conf *new_ctx;
263 * enum ieee80211_bss_change - BSS change notification flags
265 * These flags are used with the bss_info_changed() callback
266 * to indicate which BSS parameter changed.
268 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
269 * also implies a change in the AID.
270 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
271 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
272 * @BSS_CHANGED_ERP_SLOT: slot timing changed
273 * @BSS_CHANGED_HT: 802.11n parameters changed
274 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
275 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
276 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
277 * reason (IBSS and managed mode)
278 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
279 * new beacon (beaconing modes)
280 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
281 * enabled/disabled (beaconing modes)
282 * @BSS_CHANGED_CQM: Connection quality monitor config changed
283 * @BSS_CHANGED_IBSS: IBSS join status changed
284 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
285 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
286 * that it is only ever disabled for station mode.
287 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
288 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
289 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
290 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
291 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
292 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
293 * changed (currently only in P2P client mode, GO mode will be later)
294 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
295 * currently dtim_period only is under consideration.
296 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
297 * note that this is only called when it changes after the channel
298 * context had been assigned.
299 * @BSS_CHANGED_OCB: OCB join status changed
301 enum ieee80211_bss_change {
302 BSS_CHANGED_ASSOC = 1<<0,
303 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
304 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
305 BSS_CHANGED_ERP_SLOT = 1<<3,
306 BSS_CHANGED_HT = 1<<4,
307 BSS_CHANGED_BASIC_RATES = 1<<5,
308 BSS_CHANGED_BEACON_INT = 1<<6,
309 BSS_CHANGED_BSSID = 1<<7,
310 BSS_CHANGED_BEACON = 1<<8,
311 BSS_CHANGED_BEACON_ENABLED = 1<<9,
312 BSS_CHANGED_CQM = 1<<10,
313 BSS_CHANGED_IBSS = 1<<11,
314 BSS_CHANGED_ARP_FILTER = 1<<12,
315 BSS_CHANGED_QOS = 1<<13,
316 BSS_CHANGED_IDLE = 1<<14,
317 BSS_CHANGED_SSID = 1<<15,
318 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
319 BSS_CHANGED_PS = 1<<17,
320 BSS_CHANGED_TXPOWER = 1<<18,
321 BSS_CHANGED_P2P_PS = 1<<19,
322 BSS_CHANGED_BEACON_INFO = 1<<20,
323 BSS_CHANGED_BANDWIDTH = 1<<21,
324 BSS_CHANGED_OCB = 1<<22,
326 /* when adding here, make sure to change ieee80211_reconfig */
330 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
331 * of addresses for an interface increase beyond this value, hardware ARP
332 * filtering will be disabled.
334 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
337 * enum ieee80211_event_type - event to be notified to the low level driver
338 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
339 * @MLME_EVENT: event related to MLME
341 enum ieee80211_event_type {
347 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
348 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
349 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
351 enum ieee80211_rssi_event_data {
357 * enum ieee80211_rssi_event - data attached to an %RSSI_EVENT
358 * @data: See &enum ieee80211_rssi_event_data
360 struct ieee80211_rssi_event {
361 enum ieee80211_rssi_event_data data;
365 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
366 * @AUTH_EVENT: the MLME operation is authentication
367 * @ASSOC_EVENT: the MLME operation is association
368 * @DEAUTH_RX_EVENT: deauth received..
369 * @DEAUTH_TX_EVENT: deauth sent.
371 enum ieee80211_mlme_event_data {
379 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
380 * @MLME_SUCCESS: the MLME operation completed successfully.
381 * @MLME_DENIED: the MLME operation was denied by the peer.
382 * @MLME_TIMEOUT: the MLME operation timed out.
384 enum ieee80211_mlme_event_status {
391 * enum ieee80211_mlme_event - data attached to an %MLME_EVENT
392 * @data: See &enum ieee80211_mlme_event_data
393 * @status: See &enum ieee80211_mlme_event_status
394 * @reason: the reason code if applicable
396 struct ieee80211_mlme_event {
397 enum ieee80211_mlme_event_data data;
398 enum ieee80211_mlme_event_status status;
403 * struct ieee80211_event - event to be sent to the driver
404 * @type The event itself. See &enum ieee80211_event_type.
405 * @rssi: relevant if &type is %RSSI_EVENT
406 * @mlme: relevant if &type is %AUTH_EVENT
408 struct ieee80211_event {
409 enum ieee80211_event_type type;
411 struct ieee80211_rssi_event rssi;
412 struct ieee80211_mlme_event mlme;
417 * struct ieee80211_bss_conf - holds the BSS's changing parameters
419 * This structure keeps information about a BSS (and an association
420 * to that BSS) that can change during the lifetime of the BSS.
422 * @assoc: association status
423 * @ibss_joined: indicates whether this station is part of an IBSS
425 * @ibss_creator: indicates if a new IBSS network is being created
426 * @aid: association ID number, valid only when @assoc is true
427 * @use_cts_prot: use CTS protection
428 * @use_short_preamble: use 802.11b short preamble;
429 * if the hardware cannot handle this it must set the
430 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
431 * @use_short_slot: use short slot time (only relevant for ERP);
432 * if the hardware cannot handle this it must set the
433 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
434 * @dtim_period: num of beacons before the next DTIM, for beaconing,
435 * valid in station mode only if after the driver was notified
436 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
437 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
438 * as it may have been received during scanning long ago). If the
439 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
440 * only come from a beacon, but might not become valid until after
441 * association when a beacon is received (which is notified with the
442 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
443 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
444 * the driver/device can use this to calculate synchronisation
445 * (see @sync_tsf). See also sync_dtim_count important notice.
446 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
447 * is requested, see @sync_tsf/@sync_device_ts.
448 * IMPORTANT: These three sync_* parameters would possibly be out of sync
449 * by the time the driver will use them. The synchronized view is currently
450 * guaranteed only in certain callbacks.
451 * @beacon_int: beacon interval
452 * @assoc_capability: capabilities taken from assoc resp
453 * @basic_rates: bitmap of basic rates, each bit stands for an
454 * index into the rate table configured by the driver in
456 * @beacon_rate: associated AP's beacon TX rate
457 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
458 * @bssid: The BSSID for this BSS
459 * @enable_beacon: whether beaconing should be enabled or not
460 * @chandef: Channel definition for this BSS -- the hardware might be
461 * configured a higher bandwidth than this BSS uses, for example.
462 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
463 * This field is only valid when the channel type is one of the HT types.
464 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
466 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
467 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
468 * may filter ARP queries targeted for other addresses than listed here.
469 * The driver must allow ARP queries targeted for all address listed here
470 * to pass through. An empty list implies no ARP queries need to pass.
471 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
472 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
473 * array size), it's up to the driver what to do in that case.
474 * @qos: This is a QoS-enabled BSS.
475 * @idle: This interface is idle. There's also a global idle flag in the
476 * hardware config which may be more appropriate depending on what
477 * your driver/device needs to do.
478 * @ps: power-save mode (STA only). This flag is NOT affected by
479 * offchannel/dynamic_ps operations.
480 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
481 * @ssid_len: Length of SSID given in @ssid.
482 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
483 * @txpower: TX power in dBm
484 * @txpower_type: TX power adjustment used to control per packet Transmit
485 * Power Control (TPC) in lower driver for the current vif. In particular
486 * TPC is enabled if value passed in %txpower_type is
487 * NL80211_TX_POWER_LIMITED (allow using less than specified from
488 * userspace), whereas TPC is disabled if %txpower_type is set to
489 * NL80211_TX_POWER_FIXED (use value configured from userspace)
490 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
492 struct ieee80211_bss_conf {
494 /* association related data */
495 bool assoc, ibss_joined;
498 /* erp related data */
500 bool use_short_preamble;
505 u16 assoc_capability;
510 struct ieee80211_rate *beacon_rate;
511 int mcast_rate[IEEE80211_NUM_BANDS];
512 u16 ht_operation_mode;
515 struct cfg80211_chan_def chandef;
516 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
521 u8 ssid[IEEE80211_MAX_SSID_LEN];
525 enum nl80211_tx_power_setting txpower_type;
526 struct ieee80211_p2p_noa_attr p2p_noa_attr;
530 * enum mac80211_tx_info_flags - flags to describe transmission information/status
532 * These flags are used with the @flags member of &ieee80211_tx_info.
534 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
535 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
536 * number to this frame, taking care of not overwriting the fragment
537 * number and increasing the sequence number only when the
538 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
539 * assign sequence numbers to QoS-data frames but cannot do so correctly
540 * for non-QoS-data and management frames because beacons need them from
541 * that counter as well and mac80211 cannot guarantee proper sequencing.
542 * If this flag is set, the driver should instruct the hardware to
543 * assign a sequence number to the frame or assign one itself. Cf. IEEE
544 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
545 * beacons and always be clear for frames without a sequence number field.
546 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
547 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
549 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
550 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
551 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
552 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
553 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
554 * because the destination STA was in powersave mode. Note that to
555 * avoid race conditions, the filter must be set by the hardware or
556 * firmware upon receiving a frame that indicates that the station
557 * went to sleep (must be done on device to filter frames already on
558 * the queue) and may only be unset after mac80211 gives the OK for
559 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
560 * since only then is it guaranteed that no more frames are in the
562 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
563 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
564 * is for the whole aggregation.
565 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
566 * so consider using block ack request (BAR).
567 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
568 * set by rate control algorithms to indicate probe rate, will
569 * be cleared for fragmented frames (except on the last fragment)
570 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
571 * that a frame can be transmitted while the queues are stopped for
572 * off-channel operation.
573 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
574 * used to indicate that a pending frame requires TX processing before
575 * it can be sent out.
576 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
577 * used to indicate that a frame was already retried due to PS
578 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
579 * used to indicate frame should not be encrypted
580 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
581 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
582 * be sent although the station is in powersave mode.
583 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
584 * transmit function after the current frame, this can be used
585 * by drivers to kick the DMA queue only if unset or when the
587 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
588 * after TX status because the destination was asleep, it must not
589 * be modified again (no seqno assignment, crypto, etc.)
590 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
591 * code for connection establishment, this indicates that its status
592 * should kick the MLME state machine.
593 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
594 * MLME command (internal to mac80211 to figure out whether to send TX
595 * status to user space)
596 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
597 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
598 * frame and selects the maximum number of streams that it can use.
599 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
600 * the off-channel channel when a remain-on-channel offload is done
601 * in hardware -- normal packets still flow and are expected to be
602 * handled properly by the device.
603 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
604 * testing. It will be sent out with incorrect Michael MIC key to allow
605 * TKIP countermeasures to be tested.
606 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
607 * This flag is actually used for management frame especially for P2P
608 * frames not being sent at CCK rate in 2GHz band.
609 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
610 * when its status is reported the service period ends. For frames in
611 * an SP that mac80211 transmits, it is already set; for driver frames
612 * the driver may set this flag. It is also used to do the same for
614 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
615 * This flag is used to send nullfunc frame at minimum rate when
616 * the nullfunc is used for connection monitoring purpose.
617 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
618 * would be fragmented by size (this is optional, only used for
619 * monitor injection).
620 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
621 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
622 * any errors (like issues specific to the driver/HW).
623 * This flag must not be set for frames that don't request no-ack
624 * behaviour with IEEE80211_TX_CTL_NO_ACK.
626 * Note: If you have to add new flags to the enumeration, then don't
627 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
629 enum mac80211_tx_info_flags {
630 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
631 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
632 IEEE80211_TX_CTL_NO_ACK = BIT(2),
633 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
634 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
635 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
636 IEEE80211_TX_CTL_AMPDU = BIT(6),
637 IEEE80211_TX_CTL_INJECTED = BIT(7),
638 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
639 IEEE80211_TX_STAT_ACK = BIT(9),
640 IEEE80211_TX_STAT_AMPDU = BIT(10),
641 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
642 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
643 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
644 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
645 IEEE80211_TX_INTFL_RETRIED = BIT(15),
646 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
647 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
648 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
649 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
650 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
651 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
652 IEEE80211_TX_CTL_LDPC = BIT(22),
653 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
654 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
655 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
656 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
657 IEEE80211_TX_STATUS_EOSP = BIT(28),
658 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
659 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
660 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
663 #define IEEE80211_TX_CTL_STBC_SHIFT 23
666 * enum mac80211_tx_control_flags - flags to describe transmit control
668 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
669 * protocol frame (e.g. EAP)
670 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
671 * frame (PS-Poll or uAPSD).
673 * These flags are used in tx_info->control.flags.
675 enum mac80211_tx_control_flags {
676 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
677 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
681 * This definition is used as a mask to clear all temporary flags, which are
682 * set by the tx handlers for each transmission attempt by the mac80211 stack.
684 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
685 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
686 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
687 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
688 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
689 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
690 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
691 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
694 * enum mac80211_rate_control_flags - per-rate flags set by the
695 * Rate Control algorithm.
697 * These flags are set by the Rate control algorithm for each rate during tx,
698 * in the @flags member of struct ieee80211_tx_rate.
700 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
701 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
702 * This is set if the current BSS requires ERP protection.
703 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
704 * @IEEE80211_TX_RC_MCS: HT rate.
705 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
706 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
707 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
709 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
710 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
711 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
712 * (80+80 isn't supported yet)
713 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
714 * adjacent 20 MHz channels, if the current channel type is
715 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
716 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
718 enum mac80211_rate_control_flags {
719 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
720 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
721 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
723 /* rate index is an HT/VHT MCS instead of an index */
724 IEEE80211_TX_RC_MCS = BIT(3),
725 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
726 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
727 IEEE80211_TX_RC_DUP_DATA = BIT(6),
728 IEEE80211_TX_RC_SHORT_GI = BIT(7),
729 IEEE80211_TX_RC_VHT_MCS = BIT(8),
730 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
731 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
735 /* there are 40 bytes if you don't need the rateset to be kept */
736 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
738 /* if you do need the rateset, then you have less space */
739 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
741 /* maximum number of rate stages */
742 #define IEEE80211_TX_MAX_RATES 4
744 /* maximum number of rate table entries */
745 #define IEEE80211_TX_RATE_TABLE_SIZE 4
748 * struct ieee80211_tx_rate - rate selection/status
750 * @idx: rate index to attempt to send with
751 * @flags: rate control flags (&enum mac80211_rate_control_flags)
752 * @count: number of tries in this rate before going to the next rate
754 * A value of -1 for @idx indicates an invalid rate and, if used
755 * in an array of retry rates, that no more rates should be tried.
757 * When used for transmit status reporting, the driver should
758 * always report the rate along with the flags it used.
760 * &struct ieee80211_tx_info contains an array of these structs
761 * in the control information, and it will be filled by the rate
762 * control algorithm according to what should be sent. For example,
763 * if this array contains, in the format { <idx>, <count> } the
765 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
766 * then this means that the frame should be transmitted
767 * up to twice at rate 3, up to twice at rate 2, and up to four
768 * times at rate 1 if it doesn't get acknowledged. Say it gets
769 * acknowledged by the peer after the fifth attempt, the status
770 * information should then contain
771 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
772 * since it was transmitted twice at rate 3, twice at rate 2
773 * and once at rate 1 after which we received an acknowledgement.
775 struct ieee80211_tx_rate {
781 #define IEEE80211_MAX_TX_RETRY 31
783 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
787 WARN_ON((nss - 1) & ~0x7);
788 rate->idx = ((nss - 1) << 4) | mcs;
792 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
794 return rate->idx & 0xF;
798 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
800 return (rate->idx >> 4) + 1;
804 * struct ieee80211_tx_info - skb transmit information
806 * This structure is placed in skb->cb for three uses:
807 * (1) mac80211 TX control - mac80211 tells the driver what to do
808 * (2) driver internal use (if applicable)
809 * (3) TX status information - driver tells mac80211 what happened
811 * @flags: transmit info flags, defined above
812 * @band: the band to transmit on (use for checking for races)
813 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
814 * @ack_frame_id: internal frame ID for TX status, used internally
815 * @control: union for control data
816 * @status: union for status data
817 * @driver_data: array of driver_data pointers
818 * @ampdu_ack_len: number of acked aggregated frames.
819 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
820 * @ampdu_len: number of aggregated frames.
821 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
822 * @ack_signal: signal strength of the ACK frame
824 struct ieee80211_tx_info {
825 /* common information */
838 struct ieee80211_tx_rate rates[
839 IEEE80211_TX_MAX_RATES];
847 /* only needed before rate control */
848 unsigned long jiffies;
850 /* NB: vif can be NULL for injected frames */
851 struct ieee80211_vif *vif;
852 struct ieee80211_key_conf *hw_key;
857 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
863 void *status_driver_data[19 / sizeof(void *)];
866 struct ieee80211_tx_rate driver_rates[
867 IEEE80211_TX_MAX_RATES];
870 void *rate_driver_data[
871 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
874 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
879 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
881 * This structure is used to point to different blocks of IEs in HW scan
882 * and scheduled scan. These blocks contain the IEs passed by userspace
883 * and the ones generated by mac80211.
885 * @ies: pointers to band specific IEs.
886 * @len: lengths of band_specific IEs.
887 * @common_ies: IEs for all bands (especially vendor specific ones)
888 * @common_ie_len: length of the common_ies
890 struct ieee80211_scan_ies {
891 const u8 *ies[IEEE80211_NUM_BANDS];
892 size_t len[IEEE80211_NUM_BANDS];
893 const u8 *common_ies;
894 size_t common_ie_len;
898 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
900 return (struct ieee80211_tx_info *)skb->cb;
903 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
905 return (struct ieee80211_rx_status *)skb->cb;
909 * ieee80211_tx_info_clear_status - clear TX status
911 * @info: The &struct ieee80211_tx_info to be cleared.
913 * When the driver passes an skb back to mac80211, it must report
914 * a number of things in TX status. This function clears everything
915 * in the TX status but the rate control information (it does clear
916 * the count since you need to fill that in anyway).
918 * NOTE: You can only use this function if you do NOT use
919 * info->driver_data! Use info->rate_driver_data
920 * instead if you need only the less space that allows.
923 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
927 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
928 offsetof(struct ieee80211_tx_info, control.rates));
929 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
930 offsetof(struct ieee80211_tx_info, driver_rates));
931 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
932 /* clear the rate counts */
933 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
934 info->status.rates[i].count = 0;
937 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
938 memset(&info->status.ampdu_ack_len, 0,
939 sizeof(struct ieee80211_tx_info) -
940 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
945 * enum mac80211_rx_flags - receive flags
947 * These flags are used with the @flag member of &struct ieee80211_rx_status.
948 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
949 * Use together with %RX_FLAG_MMIC_STRIPPED.
950 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
951 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
952 * verification has been done by the hardware.
953 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
954 * If this flag is set, the stack cannot do any replay detection
955 * hence the driver or hardware will have to do that.
956 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
958 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
960 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
961 * field) is valid and contains the time the first symbol of the MPDU
962 * was received. This is useful in monitor mode and for proper IBSS
964 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
965 * field) is valid and contains the time the last symbol of the MPDU
966 * (including FCS) was received.
967 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
968 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
969 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
970 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
971 * @RX_FLAG_SHORT_GI: Short guard interval was used
972 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
973 * Valid only for data frames (mainly A-MPDU)
974 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
975 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
976 * to hw.radiotap_mcs_details to advertise that fact
977 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
978 * number (@ampdu_reference) must be populated and be a distinct number for
980 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
981 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
982 * monitoring purposes only
983 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
984 * subframes of a single A-MPDU
985 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
986 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
988 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
989 * is stored in the @ampdu_delimiter_crc field)
990 * @RX_FLAG_LDPC: LDPC was used
991 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
992 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
993 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
994 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
995 * subframes instead of a one huge frame for performance reasons.
996 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
997 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
998 * the 3rd (last) one must not have this flag set. The flag is used to
999 * deal with retransmission/duplication recovery properly since A-MSDU
1000 * subframes share the same sequence number. Reported subframes can be
1001 * either regular MSDU or singly A-MSDUs. Subframes must not be
1002 * interleaved with other frames.
1003 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1004 * radiotap data in the skb->data (before the frame) as described by
1005 * the &struct ieee80211_vendor_radiotap.
1007 enum mac80211_rx_flags {
1008 RX_FLAG_MMIC_ERROR = BIT(0),
1009 RX_FLAG_DECRYPTED = BIT(1),
1010 RX_FLAG_MMIC_STRIPPED = BIT(3),
1011 RX_FLAG_IV_STRIPPED = BIT(4),
1012 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1013 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1014 RX_FLAG_MACTIME_START = BIT(7),
1015 RX_FLAG_SHORTPRE = BIT(8),
1016 RX_FLAG_HT = BIT(9),
1017 RX_FLAG_40MHZ = BIT(10),
1018 RX_FLAG_SHORT_GI = BIT(11),
1019 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1020 RX_FLAG_HT_GF = BIT(13),
1021 RX_FLAG_AMPDU_DETAILS = BIT(14),
1022 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
1023 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
1024 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1025 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1026 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1027 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1028 RX_FLAG_MACTIME_END = BIT(21),
1029 RX_FLAG_VHT = BIT(22),
1030 RX_FLAG_LDPC = BIT(23),
1031 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1032 RX_FLAG_10MHZ = BIT(28),
1033 RX_FLAG_5MHZ = BIT(29),
1034 RX_FLAG_AMSDU_MORE = BIT(30),
1035 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1038 #define RX_FLAG_STBC_SHIFT 26
1041 * enum mac80211_rx_vht_flags - receive VHT flags
1043 * These flags are used with the @vht_flag member of
1044 * &struct ieee80211_rx_status.
1045 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1046 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1047 * @RX_VHT_FLAG_BF: packet was beamformed
1049 enum mac80211_rx_vht_flags {
1050 RX_VHT_FLAG_80MHZ = BIT(0),
1051 RX_VHT_FLAG_160MHZ = BIT(1),
1052 RX_VHT_FLAG_BF = BIT(2),
1056 * struct ieee80211_rx_status - receive status
1058 * The low-level driver should provide this information (the subset
1059 * supported by hardware) to the 802.11 code with each received
1060 * frame, in the skb's control buffer (cb).
1062 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1063 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1064 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1065 * it but can store it and pass it back to the driver for synchronisation
1066 * @band: the active band when this frame was received
1067 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1068 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1069 * unspecified depending on the hardware capabilities flags
1070 * @IEEE80211_HW_SIGNAL_*
1071 * @chains: bitmask of receive chains for which separate signal strength
1072 * values were filled.
1073 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1074 * support dB or unspecified units)
1075 * @antenna: antenna used
1076 * @rate_idx: index of data rate into band's supported rates or MCS index if
1077 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1078 * @vht_nss: number of streams (VHT only)
1080 * @vht_flag: %RX_VHT_FLAG_*
1081 * @rx_flags: internal RX flags for mac80211
1082 * @ampdu_reference: A-MPDU reference number, must be a different value for
1083 * each A-MPDU but the same for each subframe within one A-MPDU
1084 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1086 struct ieee80211_rx_status {
1088 u32 device_timestamp;
1089 u32 ampdu_reference;
1100 s8 chain_signal[IEEE80211_MAX_CHAINS];
1101 u8 ampdu_delimiter_crc;
1105 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1106 * @present: presence bitmap for this vendor namespace
1107 * (this could be extended in the future if any vendor needs more
1108 * bits, the radiotap spec does allow for that)
1109 * @align: radiotap vendor namespace alignment. This defines the needed
1110 * alignment for the @data field below, not for the vendor namespace
1111 * description itself (which has a fixed 2-byte alignment)
1112 * Must be a power of two, and be set to at least 1!
1113 * @oui: radiotap vendor namespace OUI
1114 * @subns: radiotap vendor sub namespace
1115 * @len: radiotap vendor sub namespace skip length, if alignment is done
1116 * then that's added to this, i.e. this is only the length of the
1118 * @pad: number of bytes of padding after the @data, this exists so that
1119 * the skb data alignment can be preserved even if the data has odd
1121 * @data: the actual vendor namespace data
1123 * This struct, including the vendor data, goes into the skb->data before
1124 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1127 struct ieee80211_vendor_radiotap {
1138 * enum ieee80211_conf_flags - configuration flags
1140 * Flags to define PHY configuration options
1142 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1143 * to determine for example whether to calculate timestamps for packets
1144 * or not, do not use instead of filter flags!
1145 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1146 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1147 * meaning that the hardware still wakes up for beacons, is able to
1148 * transmit frames and receive the possible acknowledgment frames.
1149 * Not to be confused with hardware specific wakeup/sleep states,
1150 * driver is responsible for that. See the section "Powersave support"
1152 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1153 * the driver should be prepared to handle configuration requests but
1154 * may turn the device off as much as possible. Typically, this flag will
1155 * be set when an interface is set UP but not associated or scanning, but
1156 * it can also be unset in that case when monitor interfaces are active.
1157 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1158 * operating channel.
1160 enum ieee80211_conf_flags {
1161 IEEE80211_CONF_MONITOR = (1<<0),
1162 IEEE80211_CONF_PS = (1<<1),
1163 IEEE80211_CONF_IDLE = (1<<2),
1164 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1169 * enum ieee80211_conf_changed - denotes which configuration changed
1171 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1172 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1173 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1174 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1175 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1176 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1177 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1178 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1179 * Note that this is only valid if channel contexts are not used,
1180 * otherwise each channel context has the number of chains listed.
1182 enum ieee80211_conf_changed {
1183 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1184 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1185 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1186 IEEE80211_CONF_CHANGE_PS = BIT(4),
1187 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1188 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1189 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1190 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1194 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1196 * @IEEE80211_SMPS_AUTOMATIC: automatic
1197 * @IEEE80211_SMPS_OFF: off
1198 * @IEEE80211_SMPS_STATIC: static
1199 * @IEEE80211_SMPS_DYNAMIC: dynamic
1200 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1202 enum ieee80211_smps_mode {
1203 IEEE80211_SMPS_AUTOMATIC,
1205 IEEE80211_SMPS_STATIC,
1206 IEEE80211_SMPS_DYNAMIC,
1209 IEEE80211_SMPS_NUM_MODES,
1213 * struct ieee80211_conf - configuration of the device
1215 * This struct indicates how the driver shall configure the hardware.
1217 * @flags: configuration flags defined above
1219 * @listen_interval: listen interval in units of beacon interval
1220 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1221 * before checking the beacon for a TIM bit (managed mode only); this
1222 * value will be only achievable between DTIM frames, the hardware
1223 * needs to check for the multicast traffic bit in DTIM beacons.
1224 * This variable is valid only when the CONF_PS flag is set.
1225 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1226 * in power saving. Power saving will not be enabled until a beacon
1227 * has been received and the DTIM period is known.
1228 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1229 * powersave documentation below. This variable is valid only when
1230 * the CONF_PS flag is set.
1232 * @power_level: requested transmit power (in dBm), backward compatibility
1233 * value only that is set to the minimum of all interfaces
1235 * @chandef: the channel definition to tune to
1236 * @radar_enabled: whether radar detection is enabled
1238 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1239 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1240 * but actually means the number of transmissions not the number of retries
1241 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1242 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1243 * number of transmissions not the number of retries
1245 * @smps_mode: spatial multiplexing powersave mode; note that
1246 * %IEEE80211_SMPS_STATIC is used when the device is not
1247 * configured for an HT channel.
1248 * Note that this is only valid if channel contexts are not used,
1249 * otherwise each channel context has the number of chains listed.
1251 struct ieee80211_conf {
1253 int power_level, dynamic_ps_timeout;
1254 int max_sleep_period;
1256 u16 listen_interval;
1259 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1261 struct cfg80211_chan_def chandef;
1263 enum ieee80211_smps_mode smps_mode;
1267 * struct ieee80211_channel_switch - holds the channel switch data
1269 * The information provided in this structure is required for channel switch
1272 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1273 * Function (TSF) timer when the frame containing the channel switch
1274 * announcement was received. This is simply the rx.mactime parameter
1275 * the driver passed into mac80211.
1276 * @device_timestamp: arbitrary timestamp for the device, this is the
1277 * rx.device_timestamp parameter the driver passed to mac80211.
1278 * @block_tx: Indicates whether transmission must be blocked before the
1279 * scheduled channel switch, as indicated by the AP.
1280 * @chandef: the new channel to switch to
1281 * @count: the number of TBTT's until the channel switch event
1283 struct ieee80211_channel_switch {
1285 u32 device_timestamp;
1287 struct cfg80211_chan_def chandef;
1292 * enum ieee80211_vif_flags - virtual interface flags
1294 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1295 * on this virtual interface to avoid unnecessary CPU wakeups
1296 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1297 * monitoring on this virtual interface -- i.e. it can monitor
1298 * connection quality related parameters, such as the RSSI level and
1299 * provide notifications if configured trigger levels are reached.
1300 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1301 * interface. This flag should be set during interface addition,
1302 * but may be set/cleared as late as authentication to an AP. It is
1303 * only valid for managed/station mode interfaces.
1305 enum ieee80211_vif_flags {
1306 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1307 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1308 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1312 * struct ieee80211_vif - per-interface data
1314 * Data in this structure is continually present for driver
1315 * use during the life of a virtual interface.
1317 * @type: type of this virtual interface
1318 * @bss_conf: BSS configuration for this interface, either our own
1319 * or the BSS we're associated to
1320 * @addr: address of this interface
1321 * @p2p: indicates whether this AP or STA interface is a p2p
1322 * interface, i.e. a GO or p2p-sta respectively
1323 * @csa_active: marks whether a channel switch is going on. Internally it is
1324 * write-protected by sdata_lock and local->mtx so holding either is fine
1326 * @driver_flags: flags/capabilities the driver has for this interface,
1327 * these need to be set (or cleared) when the interface is added
1328 * or, if supported by the driver, the interface type is changed
1329 * at runtime, mac80211 will never touch this field
1330 * @hw_queue: hardware queue for each AC
1331 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1332 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1333 * when it is not assigned. This pointer is RCU-protected due to the TX
1334 * path needing to access it; even though the netdev carrier will always
1335 * be off when it is %NULL there can still be races and packets could be
1336 * processed after it switches back to %NULL.
1337 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1338 * interface debug files. Note that it will be NULL for the virtual
1339 * monitor interface (if that is requested.)
1340 * @drv_priv: data area for driver use, will always be aligned to
1342 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1344 struct ieee80211_vif {
1345 enum nl80211_iftype type;
1346 struct ieee80211_bss_conf bss_conf;
1352 u8 hw_queue[IEEE80211_NUM_ACS];
1354 struct ieee80211_txq *txq;
1356 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1360 #ifdef CONFIG_MAC80211_DEBUGFS
1361 struct dentry *debugfs_dir;
1365 u8 drv_priv[0] __aligned(sizeof(void *));
1368 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1370 #ifdef CONFIG_MAC80211_MESH
1371 return vif->type == NL80211_IFTYPE_MESH_POINT;
1377 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1378 * @wdev: the wdev to get the vif for
1380 * This can be used by mac80211 drivers with direct cfg80211 APIs
1381 * (like the vendor commands) that get a wdev.
1383 * Note that this function may return %NULL if the given wdev isn't
1384 * associated with a vif that the driver knows about (e.g. monitor
1385 * or AP_VLAN interfaces.)
1387 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1390 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1391 * @vif: the vif to get the wdev for
1393 * This can be used by mac80211 drivers with direct cfg80211 APIs
1394 * (like the vendor commands) that needs to get the wdev for a vif.
1396 * Note that this function may return %NULL if the given wdev isn't
1397 * associated with a vif that the driver knows about (e.g. monitor
1398 * or AP_VLAN interfaces.)
1400 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1403 * enum ieee80211_key_flags - key flags
1405 * These flags are used for communication about keys between the driver
1406 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1408 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1409 * driver to indicate that it requires IV generation for this
1410 * particular key. Setting this flag does not necessarily mean that SKBs
1411 * will have sufficient tailroom for ICV or MIC.
1412 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1413 * the driver for a TKIP key if it requires Michael MIC
1414 * generation in software.
1415 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1416 * that the key is pairwise rather then a shared key.
1417 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1418 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1419 * (MFP) to be done in software.
1420 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1421 * if space should be prepared for the IV, but the IV
1422 * itself should not be generated. Do not set together with
1423 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1424 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1426 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1427 * management frames. The flag can help drivers that have a hardware
1428 * crypto implementation that doesn't deal with management frames
1429 * properly by allowing them to not upload the keys to hardware and
1430 * fall back to software crypto. Note that this flag deals only with
1431 * RX, if your crypto engine can't deal with TX you can also set the
1432 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1433 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1434 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1435 * only for managment frames (MFP).
1436 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1437 * driver for a key to indicate that sufficient tailroom must always
1438 * be reserved for ICV or MIC, even when HW encryption is enabled.
1440 enum ieee80211_key_flags {
1441 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1442 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1443 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1444 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1445 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1446 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1447 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1448 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1452 * struct ieee80211_key_conf - key information
1454 * This key information is given by mac80211 to the driver by
1455 * the set_key() callback in &struct ieee80211_ops.
1457 * @hw_key_idx: To be set by the driver, this is the key index the driver
1458 * wants to be given when a frame is transmitted and needs to be
1459 * encrypted in hardware.
1460 * @cipher: The key's cipher suite selector.
1461 * @flags: key flags, see &enum ieee80211_key_flags.
1462 * @keyidx: the key index (0-3)
1463 * @keylen: key material length
1464 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1466 * - Temporal Encryption Key (128 bits)
1467 * - Temporal Authenticator Tx MIC Key (64 bits)
1468 * - Temporal Authenticator Rx MIC Key (64 bits)
1469 * @icv_len: The ICV length for this key type
1470 * @iv_len: The IV length for this key type
1472 struct ieee80211_key_conf {
1484 * struct ieee80211_cipher_scheme - cipher scheme
1486 * This structure contains a cipher scheme information defining
1487 * the secure packet crypto handling.
1489 * @cipher: a cipher suite selector
1490 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1491 * @hdr_len: a length of a security header used the cipher
1492 * @pn_len: a length of a packet number in the security header
1493 * @pn_off: an offset of pn from the beginning of the security header
1494 * @key_idx_off: an offset of key index byte in the security header
1495 * @key_idx_mask: a bit mask of key_idx bits
1496 * @key_idx_shift: a bit shift needed to get key_idx
1497 * key_idx value calculation:
1498 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1499 * @mic_len: a mic length in bytes
1501 struct ieee80211_cipher_scheme {
1514 * enum set_key_cmd - key command
1516 * Used with the set_key() callback in &struct ieee80211_ops, this
1517 * indicates whether a key is being removed or added.
1519 * @SET_KEY: a key is set
1520 * @DISABLE_KEY: a key must be disabled
1523 SET_KEY, DISABLE_KEY,
1527 * enum ieee80211_sta_state - station state
1529 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1530 * this is a special state for add/remove transitions
1531 * @IEEE80211_STA_NONE: station exists without special state
1532 * @IEEE80211_STA_AUTH: station is authenticated
1533 * @IEEE80211_STA_ASSOC: station is associated
1534 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1536 enum ieee80211_sta_state {
1537 /* NOTE: These need to be ordered correctly! */
1538 IEEE80211_STA_NOTEXIST,
1541 IEEE80211_STA_ASSOC,
1542 IEEE80211_STA_AUTHORIZED,
1546 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1547 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1548 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1549 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1550 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1551 * (including 80+80 MHz)
1553 * Implementation note: 20 must be zero to be initialized
1554 * correctly, the values must be sorted.
1556 enum ieee80211_sta_rx_bandwidth {
1557 IEEE80211_STA_RX_BW_20 = 0,
1558 IEEE80211_STA_RX_BW_40,
1559 IEEE80211_STA_RX_BW_80,
1560 IEEE80211_STA_RX_BW_160,
1564 * struct ieee80211_sta_rates - station rate selection table
1566 * @rcu_head: RCU head used for freeing the table on update
1567 * @rate: transmit rates/flags to be used by default.
1568 * Overriding entries per-packet is possible by using cb tx control.
1570 struct ieee80211_sta_rates {
1571 struct rcu_head rcu_head;
1578 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1582 * struct ieee80211_sta - station table entry
1584 * A station table entry represents a station we are possibly
1585 * communicating with. Since stations are RCU-managed in
1586 * mac80211, any ieee80211_sta pointer you get access to must
1587 * either be protected by rcu_read_lock() explicitly or implicitly,
1588 * or you must take good care to not use such a pointer after a
1589 * call to your sta_remove callback that removed it.
1591 * @addr: MAC address
1592 * @aid: AID we assigned to the station if we're an AP
1593 * @supp_rates: Bitmap of supported rates (per band)
1594 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1595 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1596 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1597 * otherwise always false)
1598 * @drv_priv: data area for driver use, will always be aligned to
1599 * sizeof(void *), size is determined in hw information.
1600 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1601 * if wme is supported.
1602 * @max_sp: max Service Period. Only valid if wme is supported.
1603 * @bandwidth: current bandwidth the station can receive with
1604 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1605 * station can receive at the moment, changed by operating mode
1606 * notifications and capabilities. The value is only valid after
1607 * the station moves to associated state.
1608 * @smps_mode: current SMPS mode (off, static or dynamic)
1609 * @rates: rate control selection table
1610 * @tdls: indicates whether the STA is a TDLS peer
1611 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1612 * valid if the STA is a TDLS peer in the first place.
1613 * @mfp: indicates whether the STA uses management frame protection or not.
1614 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1616 struct ieee80211_sta {
1617 u32 supp_rates[IEEE80211_NUM_BANDS];
1620 struct ieee80211_sta_ht_cap ht_cap;
1621 struct ieee80211_sta_vht_cap vht_cap;
1626 enum ieee80211_sta_rx_bandwidth bandwidth;
1627 enum ieee80211_smps_mode smps_mode;
1628 struct ieee80211_sta_rates __rcu *rates;
1630 bool tdls_initiator;
1633 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1636 u8 drv_priv[0] __aligned(sizeof(void *));
1640 * enum sta_notify_cmd - sta notify command
1642 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1643 * indicates if an associated station made a power state transition.
1645 * @STA_NOTIFY_SLEEP: a station is now sleeping
1646 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1648 enum sta_notify_cmd {
1649 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1653 * struct ieee80211_tx_control - TX control data
1655 * @sta: station table entry, this sta pointer may be NULL and
1656 * it is not allowed to copy the pointer, due to RCU.
1658 struct ieee80211_tx_control {
1659 struct ieee80211_sta *sta;
1663 * struct ieee80211_txq - Software intermediate tx queue
1665 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1666 * @sta: station table entry, %NULL for per-vif queue
1667 * @tid: the TID for this queue (unused for per-vif queue)
1668 * @ac: the AC for this queue
1669 * @drv_priv: data area for driver use, will always be aligned to
1672 * The driver can obtain packets from this queue by calling
1673 * ieee80211_tx_dequeue().
1675 struct ieee80211_txq {
1676 struct ieee80211_vif *vif;
1677 struct ieee80211_sta *sta;
1682 u8 drv_priv[0] __aligned(sizeof(void *));
1686 * enum ieee80211_hw_flags - hardware flags
1688 * These flags are used to indicate hardware capabilities to
1689 * the stack. Generally, flags here should have their meaning
1690 * done in a way that the simplest hardware doesn't need setting
1691 * any particular flags. There are some exceptions to this rule,
1692 * however, so you are advised to review these flags carefully.
1694 * @IEEE80211_HW_HAS_RATE_CONTROL:
1695 * The hardware or firmware includes rate control, and cannot be
1696 * controlled by the stack. As such, no rate control algorithm
1697 * should be instantiated, and the TX rate reported to userspace
1698 * will be taken from the TX status instead of the rate control
1700 * Note that this requires that the driver implement a number of
1701 * callbacks so it has the correct information, it needs to have
1702 * the @set_rts_threshold callback and must look at the BSS config
1703 * @use_cts_prot for G/N protection, @use_short_slot for slot
1704 * timing in 2.4 GHz and @use_short_preamble for preambles for
1707 * @IEEE80211_HW_RX_INCLUDES_FCS:
1708 * Indicates that received frames passed to the stack include
1709 * the FCS at the end.
1711 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1712 * Some wireless LAN chipsets buffer broadcast/multicast frames
1713 * for power saving stations in the hardware/firmware and others
1714 * rely on the host system for such buffering. This option is used
1715 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1716 * multicast frames when there are power saving stations so that
1717 * the driver can fetch them with ieee80211_get_buffered_bc().
1719 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1720 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1722 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1723 * Hardware is not capable of receiving frames with short preamble on
1726 * @IEEE80211_HW_SIGNAL_UNSPEC:
1727 * Hardware can provide signal values but we don't know its units. We
1728 * expect values between 0 and @max_signal.
1729 * If possible please provide dB or dBm instead.
1731 * @IEEE80211_HW_SIGNAL_DBM:
1732 * Hardware gives signal values in dBm, decibel difference from
1733 * one milliwatt. This is the preferred method since it is standardized
1734 * between different devices. @max_signal does not need to be set.
1736 * @IEEE80211_HW_SPECTRUM_MGMT:
1737 * Hardware supports spectrum management defined in 802.11h
1738 * Measurement, Channel Switch, Quieting, TPC
1740 * @IEEE80211_HW_AMPDU_AGGREGATION:
1741 * Hardware supports 11n A-MPDU aggregation.
1743 * @IEEE80211_HW_SUPPORTS_PS:
1744 * Hardware has power save support (i.e. can go to sleep).
1746 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1747 * Hardware requires nullfunc frame handling in stack, implies
1748 * stack support for dynamic PS.
1750 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1751 * Hardware has support for dynamic PS.
1753 * @IEEE80211_HW_MFP_CAPABLE:
1754 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1756 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1757 * Hardware can provide ack status reports of Tx frames to
1760 * @IEEE80211_HW_CONNECTION_MONITOR:
1761 * The hardware performs its own connection monitoring, including
1762 * periodic keep-alives to the AP and probing the AP on beacon loss.
1764 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1765 * This device needs to get data from beacon before association (i.e.
1768 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1769 * per-station GTKs as used by IBSS RSN or during fast transition. If
1770 * the device doesn't support per-station GTKs, but can be asked not
1771 * to decrypt group addressed frames, then IBSS RSN support is still
1772 * possible but software crypto will be used. Advertise the wiphy flag
1773 * only in that case.
1775 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1776 * autonomously manages the PS status of connected stations. When
1777 * this flag is set mac80211 will not trigger PS mode for connected
1778 * stations based on the PM bit of incoming frames.
1779 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1780 * the PS mode of connected stations.
1782 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1783 * setup strictly in HW. mac80211 should not attempt to do this in
1786 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1787 * a virtual monitor interface when monitor interfaces are the only
1788 * active interfaces.
1790 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1791 * be created. It is expected user-space will create vifs as
1792 * desired (and thus have them named as desired).
1794 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1795 * crypto algorithms can be done in software - so don't automatically
1796 * try to fall back to it if hardware crypto fails, but do so only if
1797 * the driver returns 1. This also forces the driver to advertise its
1798 * supported cipher suites.
1800 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1801 * queue mapping in order to use different queues (not just one per AC)
1802 * for different virtual interfaces. See the doc section on HW queue
1803 * control for more details.
1805 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1806 * selection table provided by the rate control algorithm.
1808 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1809 * P2P Interface. This will be honoured even if more than one interface
1812 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1813 * only, to allow getting TBTT of a DTIM beacon.
1815 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1816 * and can cope with CCK rates in an aggregation session (e.g. by not
1817 * using aggregation for such frames.)
1819 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1820 * for a single active channel while using channel contexts. When support
1821 * is not enabled the default action is to disconnect when getting the
1824 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1825 * or tailroom of TX skbs without copying them first.
1827 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1828 * in one command, mac80211 doesn't have to run separate scans per band.
1830 enum ieee80211_hw_flags {
1831 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1832 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1833 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1834 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1835 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1836 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1837 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1838 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1839 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1840 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1841 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1842 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1843 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1844 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1845 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1846 IEEE80211_HW_NO_AUTO_VIF = 1<<15,
1847 IEEE80211_HW_SW_CRYPTO_CONTROL = 1<<16,
1849 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1850 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1851 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1852 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1853 IEEE80211_HW_AP_LINK_PS = 1<<22,
1854 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1855 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1856 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1857 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1858 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1859 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1860 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29,
1861 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
1865 * struct ieee80211_hw - hardware information and state
1867 * This structure contains the configuration and hardware
1868 * information for an 802.11 PHY.
1870 * @wiphy: This points to the &struct wiphy allocated for this
1871 * 802.11 PHY. You must fill in the @perm_addr and @dev
1872 * members of this structure using SET_IEEE80211_DEV()
1873 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1874 * bands (with channels, bitrates) are registered here.
1876 * @conf: &struct ieee80211_conf, device configuration, don't use.
1878 * @priv: pointer to private area that was allocated for driver use
1879 * along with this structure.
1881 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1883 * @extra_tx_headroom: headroom to reserve in each transmit skb
1884 * for use by the driver (e.g. for transmit headers.)
1886 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1887 * Can be used by drivers to add extra IEs.
1889 * @max_signal: Maximum value for signal (rssi) in RX information, used
1890 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1892 * @max_listen_interval: max listen interval in units of beacon interval
1895 * @queues: number of available hardware transmit queues for
1896 * data packets. WMM/QoS requires at least four, these
1897 * queues need to have configurable access parameters.
1899 * @rate_control_algorithm: rate control algorithm for this hardware.
1900 * If unset (NULL), the default algorithm will be used. Must be
1901 * set before calling ieee80211_register_hw().
1903 * @vif_data_size: size (in bytes) of the drv_priv data area
1904 * within &struct ieee80211_vif.
1905 * @sta_data_size: size (in bytes) of the drv_priv data area
1906 * within &struct ieee80211_sta.
1907 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1908 * within &struct ieee80211_chanctx_conf.
1909 * @txq_data_size: size (in bytes) of the drv_priv data area
1910 * within @struct ieee80211_txq.
1912 * @max_rates: maximum number of alternate rate retry stages the hw
1914 * @max_report_rates: maximum number of alternate rate retry stages
1915 * the hw can report back.
1916 * @max_rate_tries: maximum number of tries for each stage
1918 * @max_rx_aggregation_subframes: maximum buffer size (number of
1919 * sub-frames) to be used for A-MPDU block ack receiver
1921 * This is only relevant if the device has restrictions on the
1922 * number of subframes, if it relies on mac80211 to do reordering
1923 * it shouldn't be set.
1925 * @max_tx_aggregation_subframes: maximum number of subframes in an
1926 * aggregate an HT driver will transmit, used by the peer as a
1927 * hint to size its reorder buffer.
1929 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1930 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1932 * @radiotap_mcs_details: lists which MCS information can the HW
1933 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1934 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1935 * adding _BW is supported today.
1937 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1938 * the default is _GI | _BANDWIDTH.
1939 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1941 * @netdev_features: netdev features to be set in each netdev created
1942 * from this HW. Note only HW checksum features are currently
1943 * compatible with mac80211. Other feature bits will be rejected.
1945 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1946 * for each access category if it is uAPSD trigger-enabled and delivery-
1947 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1948 * Each bit corresponds to different AC. Value '1' in specific bit means
1949 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1952 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1953 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1954 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1956 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1957 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1960 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
1961 * entries for a vif.
1963 struct ieee80211_hw {
1964 struct ieee80211_conf conf;
1965 struct wiphy *wiphy;
1966 const char *rate_control_algorithm;
1969 unsigned int extra_tx_headroom;
1970 unsigned int extra_beacon_tailroom;
1973 int chanctx_data_size;
1976 u16 max_listen_interval;
1979 u8 max_report_rates;
1981 u8 max_rx_aggregation_subframes;
1982 u8 max_tx_aggregation_subframes;
1983 u8 offchannel_tx_hw_queue;
1984 u8 radiotap_mcs_details;
1985 u16 radiotap_vht_details;
1986 netdev_features_t netdev_features;
1988 u8 uapsd_max_sp_len;
1989 u8 n_cipher_schemes;
1990 const struct ieee80211_cipher_scheme *cipher_schemes;
1991 int txq_ac_max_pending;
1995 * struct ieee80211_scan_request - hw scan request
1997 * @ies: pointers different parts of IEs (in req.ie)
1998 * @req: cfg80211 request.
2000 struct ieee80211_scan_request {
2001 struct ieee80211_scan_ies ies;
2004 struct cfg80211_scan_request req;
2008 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2010 * @sta: peer this TDLS channel-switch request/response came from
2011 * @chandef: channel referenced in a TDLS channel-switch request
2012 * @action_code: see &enum ieee80211_tdls_actioncode
2013 * @status: channel-switch response status
2014 * @timestamp: time at which the frame was received
2015 * @switch_time: switch-timing parameter received in the frame
2016 * @switch_timeout: switch-timing parameter received in the frame
2017 * @tmpl_skb: TDLS switch-channel response template
2018 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2020 struct ieee80211_tdls_ch_sw_params {
2021 struct ieee80211_sta *sta;
2022 struct cfg80211_chan_def *chandef;
2028 struct sk_buff *tmpl_skb;
2033 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2035 * @wiphy: the &struct wiphy which we want to query
2037 * mac80211 drivers can use this to get to their respective
2038 * &struct ieee80211_hw. Drivers wishing to get to their own private
2039 * structure can then access it via hw->priv. Note that mac802111 drivers should
2040 * not use wiphy_priv() to try to get their private driver structure as this
2041 * is already used internally by mac80211.
2043 * Return: The mac80211 driver hw struct of @wiphy.
2045 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2048 * SET_IEEE80211_DEV - set device for 802.11 hardware
2050 * @hw: the &struct ieee80211_hw to set the device for
2051 * @dev: the &struct device of this 802.11 device
2053 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2055 set_wiphy_dev(hw->wiphy, dev);
2059 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2061 * @hw: the &struct ieee80211_hw to set the MAC address for
2062 * @addr: the address to set
2064 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
2066 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2069 static inline struct ieee80211_rate *
2070 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2071 const struct ieee80211_tx_info *c)
2073 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2075 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2078 static inline struct ieee80211_rate *
2079 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2080 const struct ieee80211_tx_info *c)
2082 if (c->control.rts_cts_rate_idx < 0)
2084 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2087 static inline struct ieee80211_rate *
2088 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2089 const struct ieee80211_tx_info *c, int idx)
2091 if (c->control.rates[idx + 1].idx < 0)
2093 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2097 * ieee80211_free_txskb - free TX skb
2101 * Free a transmit skb. Use this funtion when some failure
2102 * to transmit happened and thus status cannot be reported.
2104 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2107 * DOC: Hardware crypto acceleration
2109 * mac80211 is capable of taking advantage of many hardware
2110 * acceleration designs for encryption and decryption operations.
2112 * The set_key() callback in the &struct ieee80211_ops for a given
2113 * device is called to enable hardware acceleration of encryption and
2114 * decryption. The callback takes a @sta parameter that will be NULL
2115 * for default keys or keys used for transmission only, or point to
2116 * the station information for the peer for individual keys.
2117 * Multiple transmission keys with the same key index may be used when
2118 * VLANs are configured for an access point.
2120 * When transmitting, the TX control data will use the @hw_key_idx
2121 * selected by the driver by modifying the &struct ieee80211_key_conf
2122 * pointed to by the @key parameter to the set_key() function.
2124 * The set_key() call for the %SET_KEY command should return 0 if
2125 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2126 * added; if you return 0 then hw_key_idx must be assigned to the
2127 * hardware key index, you are free to use the full u8 range.
2129 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2130 * set, mac80211 will not automatically fall back to software crypto if
2131 * enabling hardware crypto failed. The set_key() call may also return the
2132 * value 1 to permit this specific key/algorithm to be done in software.
2134 * When the cmd is %DISABLE_KEY then it must succeed.
2136 * Note that it is permissible to not decrypt a frame even if a key
2137 * for it has been uploaded to hardware, the stack will not make any
2138 * decision based on whether a key has been uploaded or not but rather
2139 * based on the receive flags.
2141 * The &struct ieee80211_key_conf structure pointed to by the @key
2142 * parameter is guaranteed to be valid until another call to set_key()
2143 * removes it, but it can only be used as a cookie to differentiate
2146 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2147 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2149 * The update_tkip_key() call updates the driver with the new phase 1 key.
2150 * This happens every time the iv16 wraps around (every 65536 packets). The
2151 * set_key() call will happen only once for each key (unless the AP did
2152 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2153 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2154 * handler is software decryption with wrap around of iv16.
2156 * The set_default_unicast_key() call updates the default WEP key index
2157 * configured to the hardware for WEP encryption type. This is required
2158 * for devices that support offload of data packets (e.g. ARP responses).
2162 * DOC: Powersave support
2164 * mac80211 has support for various powersave implementations.
2166 * First, it can support hardware that handles all powersaving by itself,
2167 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2168 * flag. In that case, it will be told about the desired powersave mode
2169 * with the %IEEE80211_CONF_PS flag depending on the association status.
2170 * The hardware must take care of sending nullfunc frames when necessary,
2171 * i.e. when entering and leaving powersave mode. The hardware is required
2172 * to look at the AID in beacons and signal to the AP that it woke up when
2173 * it finds traffic directed to it.
2175 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2176 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2177 * with hardware wakeup and sleep states. Driver is responsible for waking
2178 * up the hardware before issuing commands to the hardware and putting it
2179 * back to sleep at appropriate times.
2181 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2182 * buffered multicast/broadcast frames after the beacon. Also it must be
2183 * possible to send frames and receive the acknowledment frame.
2185 * Other hardware designs cannot send nullfunc frames by themselves and also
2186 * need software support for parsing the TIM bitmap. This is also supported
2187 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2188 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2189 * required to pass up beacons. The hardware is still required to handle
2190 * waking up for multicast traffic; if it cannot the driver must handle that
2191 * as best as it can, mac80211 is too slow to do that.
2193 * Dynamic powersave is an extension to normal powersave in which the
2194 * hardware stays awake for a user-specified period of time after sending a
2195 * frame so that reply frames need not be buffered and therefore delayed to
2196 * the next wakeup. It's compromise of getting good enough latency when
2197 * there's data traffic and still saving significantly power in idle
2200 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2201 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2202 * flag and mac80211 will handle everything automatically. Additionally,
2203 * hardware having support for the dynamic PS feature may set the
2204 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2205 * dynamic PS mode itself. The driver needs to look at the
2206 * @dynamic_ps_timeout hardware configuration value and use it that value
2207 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2208 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2209 * enabled whenever user has enabled powersave.
2211 * Driver informs U-APSD client support by enabling
2212 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2213 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2214 * Nullfunc frames and stay awake until the service period has ended. To
2215 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2216 * from that AC are transmitted with powersave enabled.
2218 * Note: U-APSD client mode is not yet supported with
2219 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2223 * DOC: Beacon filter support
2225 * Some hardware have beacon filter support to reduce host cpu wakeups
2226 * which will reduce system power consumption. It usually works so that
2227 * the firmware creates a checksum of the beacon but omits all constantly
2228 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2229 * beacon is forwarded to the host, otherwise it will be just dropped. That
2230 * way the host will only receive beacons where some relevant information
2231 * (for example ERP protection or WMM settings) have changed.
2233 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2234 * interface capability. The driver needs to enable beacon filter support
2235 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2236 * power save is enabled, the stack will not check for beacon loss and the
2237 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2239 * The time (or number of beacons missed) until the firmware notifies the
2240 * driver of a beacon loss event (which in turn causes the driver to call
2241 * ieee80211_beacon_loss()) should be configurable and will be controlled
2242 * by mac80211 and the roaming algorithm in the future.
2244 * Since there may be constantly changing information elements that nothing
2245 * in the software stack cares about, we will, in the future, have mac80211
2246 * tell the driver which information elements are interesting in the sense
2247 * that we want to see changes in them. This will include
2248 * - a list of information element IDs
2249 * - a list of OUIs for the vendor information element
2251 * Ideally, the hardware would filter out any beacons without changes in the
2252 * requested elements, but if it cannot support that it may, at the expense
2253 * of some efficiency, filter out only a subset. For example, if the device
2254 * doesn't support checking for OUIs it should pass up all changes in all
2255 * vendor information elements.
2257 * Note that change, for the sake of simplification, also includes information
2258 * elements appearing or disappearing from the beacon.
2260 * Some hardware supports an "ignore list" instead, just make sure nothing
2261 * that was requested is on the ignore list, and include commonly changing
2262 * information element IDs in the ignore list, for example 11 (BSS load) and
2263 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2264 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2265 * it could also include some currently unused IDs.
2268 * In addition to these capabilities, hardware should support notifying the
2269 * host of changes in the beacon RSSI. This is relevant to implement roaming
2270 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2271 * the received data packets). This can consist in notifying the host when
2272 * the RSSI changes significantly or when it drops below or rises above
2273 * configurable thresholds. In the future these thresholds will also be
2274 * configured by mac80211 (which gets them from userspace) to implement
2275 * them as the roaming algorithm requires.
2277 * If the hardware cannot implement this, the driver should ask it to
2278 * periodically pass beacon frames to the host so that software can do the
2279 * signal strength threshold checking.
2283 * DOC: Spatial multiplexing power save
2285 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2286 * power in an 802.11n implementation. For details on the mechanism
2287 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2288 * "11.2.3 SM power save".
2290 * The mac80211 implementation is capable of sending action frames
2291 * to update the AP about the station's SMPS mode, and will instruct
2292 * the driver to enter the specific mode. It will also announce the
2293 * requested SMPS mode during the association handshake. Hardware
2294 * support for this feature is required, and can be indicated by
2297 * The default mode will be "automatic", which nl80211/cfg80211
2298 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2299 * turned off otherwise.
2301 * To support this feature, the driver must set the appropriate
2302 * hardware support flags, and handle the SMPS flag to the config()
2303 * operation. It will then with this mechanism be instructed to
2304 * enter the requested SMPS mode while associated to an HT AP.
2308 * DOC: Frame filtering
2310 * mac80211 requires to see many management frames for proper
2311 * operation, and users may want to see many more frames when
2312 * in monitor mode. However, for best CPU usage and power consumption,
2313 * having as few frames as possible percolate through the stack is
2314 * desirable. Hence, the hardware should filter as much as possible.
2316 * To achieve this, mac80211 uses filter flags (see below) to tell
2317 * the driver's configure_filter() function which frames should be
2318 * passed to mac80211 and which should be filtered out.
2320 * Before configure_filter() is invoked, the prepare_multicast()
2321 * callback is invoked with the parameters @mc_count and @mc_list
2322 * for the combined multicast address list of all virtual interfaces.
2323 * It's use is optional, and it returns a u64 that is passed to
2324 * configure_filter(). Additionally, configure_filter() has the
2325 * arguments @changed_flags telling which flags were changed and
2326 * @total_flags with the new flag states.
2328 * If your device has no multicast address filters your driver will
2329 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2330 * parameter to see whether multicast frames should be accepted
2333 * All unsupported flags in @total_flags must be cleared.
2334 * Hardware does not support a flag if it is incapable of _passing_
2335 * the frame to the stack. Otherwise the driver must ignore
2336 * the flag, but not clear it.
2337 * You must _only_ clear the flag (announce no support for the
2338 * flag to mac80211) if you are not able to pass the packet type
2339 * to the stack (so the hardware always filters it).
2340 * So for example, you should clear @FIF_CONTROL, if your hardware
2341 * always filters control frames. If your hardware always passes
2342 * control frames to the kernel and is incapable of filtering them,
2343 * you do _not_ clear the @FIF_CONTROL flag.
2344 * This rule applies to all other FIF flags as well.
2348 * DOC: AP support for powersaving clients
2350 * In order to implement AP and P2P GO modes, mac80211 has support for
2351 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2352 * There currently is no support for sAPSD.
2354 * There is one assumption that mac80211 makes, namely that a client
2355 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2356 * Both are supported, and both can be used by the same client, but
2357 * they can't be used concurrently by the same client. This simplifies
2360 * The first thing to keep in mind is that there is a flag for complete
2361 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2362 * mac80211 expects the driver to handle most of the state machine for
2363 * powersaving clients and will ignore the PM bit in incoming frames.
2364 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2365 * stations' powersave transitions. In this mode, mac80211 also doesn't
2366 * handle PS-Poll/uAPSD.
2368 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2369 * PM bit in incoming frames for client powersave transitions. When a
2370 * station goes to sleep, we will stop transmitting to it. There is,
2371 * however, a race condition: a station might go to sleep while there is
2372 * data buffered on hardware queues. If the device has support for this
2373 * it will reject frames, and the driver should give the frames back to
2374 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2375 * cause mac80211 to retry the frame when the station wakes up. The
2376 * driver is also notified of powersave transitions by calling its
2377 * @sta_notify callback.
2379 * When the station is asleep, it has three choices: it can wake up,
2380 * it can PS-Poll, or it can possibly start a uAPSD service period.
2381 * Waking up is implemented by simply transmitting all buffered (and
2382 * filtered) frames to the station. This is the easiest case. When
2383 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2384 * will inform the driver of this with the @allow_buffered_frames
2385 * callback; this callback is optional. mac80211 will then transmit
2386 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2387 * on each frame. The last frame in the service period (or the only
2388 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2389 * indicate that it ends the service period; as this frame must have
2390 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2391 * When TX status is reported for this frame, the service period is
2392 * marked has having ended and a new one can be started by the peer.
2394 * Additionally, non-bufferable MMPDUs can also be transmitted by
2395 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2397 * Another race condition can happen on some devices like iwlwifi
2398 * when there are frames queued for the station and it wakes up
2399 * or polls; the frames that are already queued could end up being
2400 * transmitted first instead, causing reordering and/or wrong
2401 * processing of the EOSP. The cause is that allowing frames to be
2402 * transmitted to a certain station is out-of-band communication to
2403 * the device. To allow this problem to be solved, the driver can
2404 * call ieee80211_sta_block_awake() if frames are buffered when it
2405 * is notified that the station went to sleep. When all these frames
2406 * have been filtered (see above), it must call the function again
2407 * to indicate that the station is no longer blocked.
2409 * If the driver buffers frames in the driver for aggregation in any
2410 * way, it must use the ieee80211_sta_set_buffered() call when it is
2411 * notified of the station going to sleep to inform mac80211 of any
2412 * TIDs that have frames buffered. Note that when a station wakes up
2413 * this information is reset (hence the requirement to call it when
2414 * informed of the station going to sleep). Then, when a service
2415 * period starts for any reason, @release_buffered_frames is called
2416 * with the number of frames to be released and which TIDs they are
2417 * to come from. In this case, the driver is responsible for setting
2418 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2419 * to help the @more_data parameter is passed to tell the driver if
2420 * there is more data on other TIDs -- the TIDs to release frames
2421 * from are ignored since mac80211 doesn't know how many frames the
2422 * buffers for those TIDs contain.
2424 * If the driver also implement GO mode, where absence periods may
2425 * shorten service periods (or abort PS-Poll responses), it must
2426 * filter those response frames except in the case of frames that
2427 * are buffered in the driver -- those must remain buffered to avoid
2428 * reordering. Because it is possible that no frames are released
2429 * in this case, the driver must call ieee80211_sta_eosp()
2430 * to indicate to mac80211 that the service period ended anyway.
2432 * Finally, if frames from multiple TIDs are released from mac80211
2433 * but the driver might reorder them, it must clear & set the flags
2434 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2435 * and also take care of the EOSP and MORE_DATA bits in the frame.
2436 * The driver may also use ieee80211_sta_eosp() in this case.
2438 * Note that if the driver ever buffers frames other than QoS-data
2439 * frames, it must take care to never send a non-QoS-data frame as
2440 * the last frame in a service period, adding a QoS-nulldata frame
2441 * after a non-QoS-data frame if needed.
2445 * DOC: HW queue control
2447 * Before HW queue control was introduced, mac80211 only had a single static
2448 * assignment of per-interface AC software queues to hardware queues. This
2449 * was problematic for a few reasons:
2450 * 1) off-channel transmissions might get stuck behind other frames
2451 * 2) multiple virtual interfaces couldn't be handled correctly
2452 * 3) after-DTIM frames could get stuck behind other frames
2454 * To solve this, hardware typically uses multiple different queues for all
2455 * the different usages, and this needs to be propagated into mac80211 so it
2456 * won't have the same problem with the software queues.
2458 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2459 * flag that tells it that the driver implements its own queue control. To do
2460 * so, the driver will set up the various queues in each &struct ieee80211_vif
2461 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2462 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2463 * if necessary will queue the frame on the right software queue that mirrors
2464 * the hardware queue.
2465 * Additionally, the driver has to then use these HW queue IDs for the queue
2466 * management functions (ieee80211_stop_queue() et al.)
2468 * The driver is free to set up the queue mappings as needed, multiple virtual
2469 * interfaces may map to the same hardware queues if needed. The setup has to
2470 * happen during add_interface or change_interface callbacks. For example, a
2471 * driver supporting station+station and station+AP modes might decide to have
2472 * 10 hardware queues to handle different scenarios:
2474 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2475 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2476 * after-DTIM queue for AP: 8
2477 * off-channel queue: 9
2479 * It would then set up the hardware like this:
2480 * hw.offchannel_tx_hw_queue = 9
2482 * and the first virtual interface that is added as follows:
2483 * vif.hw_queue[IEEE80211_AC_VO] = 0
2484 * vif.hw_queue[IEEE80211_AC_VI] = 1
2485 * vif.hw_queue[IEEE80211_AC_BE] = 2
2486 * vif.hw_queue[IEEE80211_AC_BK] = 3
2487 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2488 * and the second virtual interface with 4-7.
2490 * If queue 6 gets full, for example, mac80211 would only stop the second
2491 * virtual interface's BE queue since virtual interface queues are per AC.
2493 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2494 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2495 * queue could potentially be shared since mac80211 will look at cab_queue when
2496 * a queue is stopped/woken even if the interface is not in AP mode.
2500 * enum ieee80211_filter_flags - hardware filter flags
2502 * These flags determine what the filter in hardware should be
2503 * programmed to let through and what should not be passed to the
2504 * stack. It is always safe to pass more frames than requested,
2505 * but this has negative impact on power consumption.
2507 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2508 * think of the BSS as your network segment and then this corresponds
2509 * to the regular ethernet device promiscuous mode.
2511 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2512 * by the user or if the hardware is not capable of filtering by
2513 * multicast address.
2515 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2516 * %RX_FLAG_FAILED_FCS_CRC for them)
2518 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2519 * the %RX_FLAG_FAILED_PLCP_CRC for them
2521 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2522 * to the hardware that it should not filter beacons or probe responses
2523 * by BSSID. Filtering them can greatly reduce the amount of processing
2524 * mac80211 needs to do and the amount of CPU wakeups, so you should
2525 * honour this flag if possible.
2527 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2528 * is not set then only those addressed to this station.
2530 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2532 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2533 * those addressed to this station.
2535 * @FIF_PROBE_REQ: pass probe request frames
2537 enum ieee80211_filter_flags {
2538 FIF_PROMISC_IN_BSS = 1<<0,
2539 FIF_ALLMULTI = 1<<1,
2541 FIF_PLCPFAIL = 1<<3,
2542 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2544 FIF_OTHER_BSS = 1<<6,
2546 FIF_PROBE_REQ = 1<<8,
2550 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2552 * These flags are used with the ampdu_action() callback in
2553 * &struct ieee80211_ops to indicate which action is needed.
2555 * Note that drivers MUST be able to deal with a TX aggregation
2556 * session being stopped even before they OK'ed starting it by
2557 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2558 * might receive the addBA frame and send a delBA right away!
2560 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2561 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2562 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2563 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2564 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2565 * queued packets, now unaggregated. After all packets are transmitted the
2566 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2567 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2568 * called when the station is removed. There's no need or reason to call
2569 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2570 * session is gone and removes the station.
2571 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2572 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2573 * now the connection is dropped and the station will be removed. Drivers
2574 * should clean up and drop remaining packets when this is called.
2576 enum ieee80211_ampdu_mlme_action {
2577 IEEE80211_AMPDU_RX_START,
2578 IEEE80211_AMPDU_RX_STOP,
2579 IEEE80211_AMPDU_TX_START,
2580 IEEE80211_AMPDU_TX_STOP_CONT,
2581 IEEE80211_AMPDU_TX_STOP_FLUSH,
2582 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2583 IEEE80211_AMPDU_TX_OPERATIONAL,
2587 * enum ieee80211_frame_release_type - frame release reason
2588 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2589 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2590 * frame received on trigger-enabled AC
2592 enum ieee80211_frame_release_type {
2593 IEEE80211_FRAME_RELEASE_PSPOLL,
2594 IEEE80211_FRAME_RELEASE_UAPSD,
2598 * enum ieee80211_rate_control_changed - flags to indicate what changed
2600 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2601 * to this station changed. The actual bandwidth is in the station
2602 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2603 * flag changes, for HT and VHT the bandwidth field changes.
2604 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2605 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2606 * changed (in IBSS mode) due to discovering more information about
2608 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2611 enum ieee80211_rate_control_changed {
2612 IEEE80211_RC_BW_CHANGED = BIT(0),
2613 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2614 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2615 IEEE80211_RC_NSS_CHANGED = BIT(3),
2619 * enum ieee80211_roc_type - remain on channel type
2621 * With the support for multi channel contexts and multi channel operations,
2622 * remain on channel operations might be limited/deferred/aborted by other
2623 * flows/operations which have higher priority (and vise versa).
2624 * Specifying the ROC type can be used by devices to prioritize the ROC
2625 * operations compared to other operations/flows.
2627 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2628 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2629 * for sending managment frames offchannel.
2631 enum ieee80211_roc_type {
2632 IEEE80211_ROC_TYPE_NORMAL = 0,
2633 IEEE80211_ROC_TYPE_MGMT_TX,
2637 * enum ieee80211_reconfig_complete_type - reconfig type
2639 * This enum is used by the reconfig_complete() callback to indicate what
2640 * reconfiguration type was completed.
2642 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2643 * (also due to resume() callback returning 1)
2644 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2645 * of wowlan configuration)
2647 enum ieee80211_reconfig_type {
2648 IEEE80211_RECONFIG_TYPE_RESTART,
2649 IEEE80211_RECONFIG_TYPE_SUSPEND,
2653 * struct ieee80211_ops - callbacks from mac80211 to the driver
2655 * This structure contains various callbacks that the driver may
2656 * handle or, in some cases, must handle, for example to configure
2657 * the hardware to a new channel or to transmit a frame.
2659 * @tx: Handler that 802.11 module calls for each transmitted frame.
2660 * skb contains the buffer starting from the IEEE 802.11 header.
2661 * The low-level driver should send the frame out based on
2662 * configuration in the TX control data. This handler should,
2663 * preferably, never fail and stop queues appropriately.
2666 * @start: Called before the first netdevice attached to the hardware
2667 * is enabled. This should turn on the hardware and must turn on
2668 * frame reception (for possibly enabled monitor interfaces.)
2669 * Returns negative error codes, these may be seen in userspace,
2671 * When the device is started it should not have a MAC address
2672 * to avoid acknowledging frames before a non-monitor device
2674 * Must be implemented and can sleep.
2676 * @stop: Called after last netdevice attached to the hardware
2677 * is disabled. This should turn off the hardware (at least
2678 * it must turn off frame reception.)
2679 * May be called right after add_interface if that rejects
2680 * an interface. If you added any work onto the mac80211 workqueue
2681 * you should ensure to cancel it on this callback.
2682 * Must be implemented and can sleep.
2684 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2685 * stop transmitting and doing any other configuration, and then
2686 * ask the device to suspend. This is only invoked when WoWLAN is
2687 * configured, otherwise the device is deconfigured completely and
2688 * reconfigured at resume time.
2689 * The driver may also impose special conditions under which it
2690 * wants to use the "normal" suspend (deconfigure), say if it only
2691 * supports WoWLAN when the device is associated. In this case, it
2692 * must return 1 from this function.
2694 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2695 * now resuming its operation, after this the device must be fully
2696 * functional again. If this returns an error, the only way out is
2697 * to also unregister the device. If it returns 1, then mac80211
2698 * will also go through the regular complete restart on resume.
2700 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2701 * modified. The reason is that device_set_wakeup_enable() is
2702 * supposed to be called when the configuration changes, not only
2705 * @add_interface: Called when a netdevice attached to the hardware is
2706 * enabled. Because it is not called for monitor mode devices, @start
2707 * and @stop must be implemented.
2708 * The driver should perform any initialization it needs before
2709 * the device can be enabled. The initial configuration for the
2710 * interface is given in the conf parameter.
2711 * The callback may refuse to add an interface by returning a
2712 * negative error code (which will be seen in userspace.)
2713 * Must be implemented and can sleep.
2715 * @change_interface: Called when a netdevice changes type. This callback
2716 * is optional, but only if it is supported can interface types be
2717 * switched while the interface is UP. The callback may sleep.
2718 * Note that while an interface is being switched, it will not be
2719 * found by the interface iteration callbacks.
2721 * @remove_interface: Notifies a driver that an interface is going down.
2722 * The @stop callback is called after this if it is the last interface
2723 * and no monitor interfaces are present.
2724 * When all interfaces are removed, the MAC address in the hardware
2725 * must be cleared so the device no longer acknowledges packets,
2726 * the mac_addr member of the conf structure is, however, set to the
2727 * MAC address of the device going away.
2728 * Hence, this callback must be implemented. It can sleep.
2730 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2731 * function to change hardware configuration, e.g., channel.
2732 * This function should never fail but returns a negative error code
2733 * if it does. The callback can sleep.
2735 * @bss_info_changed: Handler for configuration requests related to BSS
2736 * parameters that may vary during BSS's lifespan, and may affect low
2737 * level driver (e.g. assoc/disassoc status, erp parameters).
2738 * This function should not be used if no BSS has been set, unless
2739 * for association indication. The @changed parameter indicates which
2740 * of the bss parameters has changed when a call is made. The callback
2743 * @prepare_multicast: Prepare for multicast filter configuration.
2744 * This callback is optional, and its return value is passed
2745 * to configure_filter(). This callback must be atomic.
2747 * @configure_filter: Configure the device's RX filter.
2748 * See the section "Frame filtering" for more information.
2749 * This callback must be implemented and can sleep.
2751 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2752 * must be set or cleared for a given STA. Must be atomic.
2754 * @set_key: See the section "Hardware crypto acceleration"
2755 * This callback is only called between add_interface and
2756 * remove_interface calls, i.e. while the given virtual interface
2758 * Returns a negative error code if the key can't be added.
2759 * The callback can sleep.
2761 * @update_tkip_key: See the section "Hardware crypto acceleration"
2762 * This callback will be called in the context of Rx. Called for drivers
2763 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2764 * The callback must be atomic.
2766 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2767 * host is suspended, it can assign this callback to retrieve the data
2768 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2769 * After rekeying was done it should (for example during resume) notify
2770 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2772 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2773 * WEP when the device sends data packets autonomously, e.g. for ARP
2774 * offloading. The index can be 0-3, or -1 for unsetting it.
2776 * @hw_scan: Ask the hardware to service the scan request, no need to start
2777 * the scan state machine in stack. The scan must honour the channel
2778 * configuration done by the regulatory agent in the wiphy's
2779 * registered bands. The hardware (or the driver) needs to make sure
2780 * that power save is disabled.
2781 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2782 * entire IEs after the SSID, so that drivers need not look at these
2783 * at all but just send them after the SSID -- mac80211 includes the
2784 * (extended) supported rates and HT information (where applicable).
2785 * When the scan finishes, ieee80211_scan_completed() must be called;
2786 * note that it also must be called when the scan cannot finish due to
2787 * any error unless this callback returned a negative error code.
2788 * The callback can sleep.
2790 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2791 * The driver should ask the hardware to cancel the scan (if possible),
2792 * but the scan will be completed only after the driver will call
2793 * ieee80211_scan_completed().
2794 * This callback is needed for wowlan, to prevent enqueueing a new
2795 * scan_work after the low-level driver was already suspended.
2796 * The callback can sleep.
2798 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2799 * specific intervals. The driver must call the
2800 * ieee80211_sched_scan_results() function whenever it finds results.
2801 * This process will continue until sched_scan_stop is called.
2803 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2804 * In this case, ieee80211_sched_scan_stopped() must not be called.
2806 * @sw_scan_start: Notifier function that is called just before a software scan
2807 * is started. Can be NULL, if the driver doesn't need this notification.
2808 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2809 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2810 * can use this parameter. The callback can sleep.
2812 * @sw_scan_complete: Notifier function that is called just after a
2813 * software scan finished. Can be NULL, if the driver doesn't need
2814 * this notification.
2815 * The callback can sleep.
2817 * @get_stats: Return low-level statistics.
2818 * Returns zero if statistics are available.
2819 * The callback can sleep.
2821 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2822 * callback should be provided to read the TKIP transmit IVs (both IV32
2823 * and IV16) for the given key from hardware.
2824 * The callback must be atomic.
2826 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2827 * if the device does fragmentation by itself; if this callback is
2828 * implemented then the stack will not do fragmentation.
2829 * The callback can sleep.
2831 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2832 * The callback can sleep.
2834 * @sta_add: Notifies low level driver about addition of an associated station,
2835 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2837 * @sta_remove: Notifies low level driver about removal of an associated
2838 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2839 * returns it isn't safe to use the pointer, not even RCU protected;
2840 * no RCU grace period is guaranteed between returning here and freeing
2841 * the station. See @sta_pre_rcu_remove if needed.
2842 * This callback can sleep.
2844 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2845 * when a station is added to mac80211's station list. This callback
2846 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2847 * conditional. This callback can sleep.
2849 * @sta_remove_debugfs: Remove the debugfs files which were added using
2850 * @sta_add_debugfs. This callback can sleep.
2852 * @sta_notify: Notifies low level driver about power state transition of an
2853 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2854 * in AP mode, this callback will not be called when the flag
2855 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2857 * @sta_state: Notifies low level driver about state transition of a
2858 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2859 * This callback is mutually exclusive with @sta_add/@sta_remove.
2860 * It must not fail for down transitions but may fail for transitions
2861 * up the list of states. Also note that after the callback returns it
2862 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2863 * period is guaranteed between returning here and freeing the station.
2864 * See @sta_pre_rcu_remove if needed.
2865 * The callback can sleep.
2867 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2868 * synchronisation. This is useful if a driver needs to have station
2869 * pointers protected using RCU, it can then use this call to clear
2870 * the pointers instead of waiting for an RCU grace period to elapse
2872 * The callback can sleep.
2874 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2875 * used to transmit to the station. The changes are advertised with bits
2876 * from &enum ieee80211_rate_control_changed and the values are reflected
2877 * in the station data. This callback should only be used when the driver
2878 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2879 * otherwise the rate control algorithm is notified directly.
2881 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2882 * is only used if the configured rate control algorithm actually uses
2883 * the new rate table API, and is therefore optional. Must be atomic.
2885 * @sta_statistics: Get statistics for this station. For example with beacon
2886 * filtering, the statistics kept by mac80211 might not be accurate, so
2887 * let the driver pre-fill the statistics. The driver can fill most of
2888 * the values (indicating which by setting the filled bitmap), but not
2889 * all of them make sense - see the source for which ones are possible.
2890 * Statistics that the driver doesn't fill will be filled by mac80211.
2891 * The callback can sleep.
2893 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2894 * bursting) for a hardware TX queue.
2895 * Returns a negative error code on failure.
2896 * The callback can sleep.
2898 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2899 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2900 * required function.
2901 * The callback can sleep.
2903 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2904 * Currently, this is only used for IBSS mode debugging. Is not a
2905 * required function.
2906 * The callback can sleep.
2908 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2909 * with other STAs in the IBSS. This is only used in IBSS mode. This
2910 * function is optional if the firmware/hardware takes full care of
2911 * TSF synchronization.
2912 * The callback can sleep.
2914 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2915 * This is needed only for IBSS mode and the result of this function is
2916 * used to determine whether to reply to Probe Requests.
2917 * Returns non-zero if this device sent the last beacon.
2918 * The callback can sleep.
2920 * @ampdu_action: Perform a certain A-MPDU action
2921 * The RA/TID combination determines the destination and TID we want
2922 * the ampdu action to be performed for. The action is defined through
2923 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2924 * is the first frame we expect to perform the action on. Notice
2925 * that TX/RX_STOP can pass NULL for this parameter.
2926 * The @buf_size parameter is only valid when the action is set to
2927 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2928 * buffer size (number of subframes) for this session -- the driver
2929 * may neither send aggregates containing more subframes than this
2930 * nor send aggregates in a way that lost frames would exceed the
2931 * buffer size. If just limiting the aggregate size, this would be
2932 * possible with a buf_size of 8:
2934 * - RX: 2....7 (lost frame #1)
2936 * which is invalid since #1 was now re-transmitted well past the
2937 * buffer size of 8. Correct ways to retransmit #1 would be:
2938 * - TX: 1 or 18 or 81
2939 * Even "189" would be wrong since 1 could be lost again.
2941 * Returns a negative error code on failure.
2942 * The callback can sleep.
2944 * @get_survey: Return per-channel survey information
2946 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2947 * need to set wiphy->rfkill_poll to %true before registration,
2948 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2949 * The callback can sleep.
2951 * @set_coverage_class: Set slot time for given coverage class as specified
2952 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2953 * accordingly; coverage class equals to -1 to enable ACK timeout
2954 * estimation algorithm (dynack). To disable dynack set valid value for
2955 * coverage class. This callback is not required and may sleep.
2957 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2958 * be %NULL. The callback can sleep.
2959 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2961 * @flush: Flush all pending frames from the hardware queue, making sure
2962 * that the hardware queues are empty. The @queues parameter is a bitmap
2963 * of queues to flush, which is useful if different virtual interfaces
2964 * use different hardware queues; it may also indicate all queues.
2965 * If the parameter @drop is set to %true, pending frames may be dropped.
2966 * Note that vif can be NULL.
2967 * The callback can sleep.
2969 * @channel_switch: Drivers that need (or want) to offload the channel
2970 * switch operation for CSAs received from the AP may implement this
2971 * callback. They must then call ieee80211_chswitch_done() to indicate
2972 * completion of the channel switch.
2974 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2975 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2976 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2977 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2979 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2981 * @remain_on_channel: Starts an off-channel period on the given channel, must
2982 * call back to ieee80211_ready_on_channel() when on that channel. Note
2983 * that normal channel traffic is not stopped as this is intended for hw
2984 * offload. Frames to transmit on the off-channel channel are transmitted
2985 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2986 * duration (which will always be non-zero) expires, the driver must call
2987 * ieee80211_remain_on_channel_expired().
2988 * Note that this callback may be called while the device is in IDLE and
2989 * must be accepted in this case.
2990 * This callback may sleep.
2991 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2992 * aborted before it expires. This callback may sleep.
2994 * @set_ringparam: Set tx and rx ring sizes.
2996 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2998 * @tx_frames_pending: Check if there is any pending frame in the hardware
2999 * queues before entering power save.
3001 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3002 * when transmitting a frame. Currently only legacy rates are handled.
3003 * The callback can sleep.
3004 * @event_callback: Notify driver about any event in mac80211. See
3005 * &enum ieee80211_event_type for the different types.
3006 * The callback can sleep.
3008 * @release_buffered_frames: Release buffered frames according to the given
3009 * parameters. In the case where the driver buffers some frames for
3010 * sleeping stations mac80211 will use this callback to tell the driver
3011 * to release some frames, either for PS-poll or uAPSD.
3012 * Note that if the @more_data parameter is %false the driver must check
3013 * if there are more frames on the given TIDs, and if there are more than
3014 * the frames being released then it must still set the more-data bit in
3015 * the frame. If the @more_data parameter is %true, then of course the
3016 * more-data bit must always be set.
3017 * The @tids parameter tells the driver which TIDs to release frames
3018 * from, for PS-poll it will always have only a single bit set.
3019 * In the case this is used for a PS-poll initiated release, the
3020 * @num_frames parameter will always be 1 so code can be shared. In
3021 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3022 * on the TX status (and must report TX status) so that the PS-poll
3023 * period is properly ended. This is used to avoid sending multiple
3024 * responses for a retried PS-poll frame.
3025 * In the case this is used for uAPSD, the @num_frames parameter may be
3026 * bigger than one, but the driver may send fewer frames (it must send
3027 * at least one, however). In this case it is also responsible for
3028 * setting the EOSP flag in the QoS header of the frames. Also, when the
3029 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3030 * on the last frame in the SP. Alternatively, it may call the function
3031 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3032 * This callback must be atomic.
3033 * @allow_buffered_frames: Prepare device to allow the given number of frames
3034 * to go out to the given station. The frames will be sent by mac80211
3035 * via the usual TX path after this call. The TX information for frames
3036 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3037 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3038 * frames from multiple TIDs are released and the driver might reorder
3039 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3040 * on the last frame and clear it on all others and also handle the EOSP
3041 * bit in the QoS header correctly. Alternatively, it can also call the
3042 * ieee80211_sta_eosp() function.
3043 * The @tids parameter is a bitmap and tells the driver which TIDs the
3044 * frames will be on; it will at most have two bits set.
3045 * This callback must be atomic.
3047 * @get_et_sset_count: Ethtool API to get string-set count.
3049 * @get_et_stats: Ethtool API to get a set of u64 stats.
3051 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3052 * and perhaps other supported types of ethtool data-sets.
3054 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3055 * before associated. In multi-channel scenarios, a virtual interface is
3056 * bound to a channel before it is associated, but as it isn't associated
3057 * yet it need not necessarily be given airtime, in particular since any
3058 * transmission to a P2P GO needs to be synchronized against the GO's
3059 * powersave state. mac80211 will call this function before transmitting a
3060 * management frame prior to having successfully associated to allow the
3061 * driver to give it channel time for the transmission, to get a response
3062 * and to be able to synchronize with the GO.
3063 * The callback will be called before each transmission and upon return
3064 * mac80211 will transmit the frame right away.
3065 * The callback is optional and can (should!) sleep.
3067 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3068 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3069 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3070 * setup-response is a direct packet not buffered by the AP.
3071 * mac80211 will call this function just before the transmission of a TDLS
3072 * discovery-request. The recommended period of protection is at least
3073 * 2 * (DTIM period).
3074 * The callback is optional and can sleep.
3076 * @add_chanctx: Notifies device driver about new channel context creation.
3077 * @remove_chanctx: Notifies device driver about channel context destruction.
3078 * @change_chanctx: Notifies device driver about channel context changes that
3079 * may happen when combining different virtual interfaces on the same
3080 * channel context with different settings
3081 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3082 * to vif. Possible use is for hw queue remapping.
3083 * @unassign_vif_chanctx: Notifies device driver about channel context being
3085 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3086 * another, as specified in the list of
3087 * @ieee80211_vif_chanctx_switch passed to the driver, according
3088 * to the mode defined in &ieee80211_chanctx_switch_mode.
3090 * @start_ap: Start operation on the AP interface, this is called after all the
3091 * information in bss_conf is set and beacon can be retrieved. A channel
3092 * context is bound before this is called. Note that if the driver uses
3093 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3094 * just "paused" for scanning/ROC, which is indicated by the beacon being
3095 * disabled/enabled via @bss_info_changed.
3096 * @stop_ap: Stop operation on the AP interface.
3098 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3099 * during resume, when the reconfiguration has completed.
3100 * This can help the driver implement the reconfiguration step (and
3101 * indicate mac80211 is ready to receive frames).
3102 * This callback may sleep.
3104 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3105 * Currently, this is only called for managed or P2P client interfaces.
3106 * This callback is optional; it must not sleep.
3108 * @channel_switch_beacon: Starts a channel switch to a new channel.
3109 * Beacons are modified to include CSA or ECSA IEs before calling this
3110 * function. The corresponding count fields in these IEs must be
3111 * decremented, and when they reach 1 the driver must call
3112 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3113 * get the csa counter decremented by mac80211, but must check if it is
3114 * 1 using ieee80211_csa_is_complete() after the beacon has been
3115 * transmitted and then call ieee80211_csa_finish().
3116 * If the CSA count starts as zero or 1, this function will not be called,
3117 * since there won't be any time to beacon before the switch anyway.
3118 * @pre_channel_switch: This is an optional callback that is called
3119 * before a channel switch procedure is started (ie. when a STA
3120 * gets a CSA or an userspace initiated channel-switch), allowing
3121 * the driver to prepare for the channel switch.
3122 * @post_channel_switch: This is an optional callback that is called
3123 * after a channel switch procedure is completed, allowing the
3124 * driver to go back to a normal configuration.
3126 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3127 * information in bss_conf is set up and the beacon can be retrieved. A
3128 * channel context is bound before this is called.
3129 * @leave_ibss: Leave the IBSS again.
3131 * @get_expected_throughput: extract the expected throughput towards the
3132 * specified station. The returned value is expressed in Kbps. It returns 0
3133 * if the RC algorithm does not have proper data to provide.
3135 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3136 * and hardware limits.
3138 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3139 * is responsible for continually initiating channel-switching operations
3140 * and returning to the base channel for communication with the AP. The
3141 * driver receives a channel-switch request template and the location of
3142 * the switch-timing IE within the template as part of the invocation.
3143 * The template is valid only within the call, and the driver can
3144 * optionally copy the skb for further re-use.
3145 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3146 * peers must be on the base channel when the call completes.
3147 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3148 * response) has been received from a remote peer. The driver gets
3149 * parameters parsed from the incoming frame and may use them to continue
3150 * an ongoing channel-switch operation. In addition, a channel-switch
3151 * response template is provided, together with the location of the
3152 * switch-timing IE within the template. The skb can only be used within
3153 * the function call.
3155 * @wake_tx_queue: Called when new packets have been added to the queue.
3157 struct ieee80211_ops {
3158 void (*tx)(struct ieee80211_hw *hw,
3159 struct ieee80211_tx_control *control,
3160 struct sk_buff *skb);
3161 int (*start)(struct ieee80211_hw *hw);
3162 void (*stop)(struct ieee80211_hw *hw);
3164 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3165 int (*resume)(struct ieee80211_hw *hw);
3166 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3168 int (*add_interface)(struct ieee80211_hw *hw,
3169 struct ieee80211_vif *vif);
3170 int (*change_interface)(struct ieee80211_hw *hw,
3171 struct ieee80211_vif *vif,
3172 enum nl80211_iftype new_type, bool p2p);
3173 void (*remove_interface)(struct ieee80211_hw *hw,
3174 struct ieee80211_vif *vif);
3175 int (*config)(struct ieee80211_hw *hw, u32 changed);
3176 void (*bss_info_changed)(struct ieee80211_hw *hw,
3177 struct ieee80211_vif *vif,
3178 struct ieee80211_bss_conf *info,
3181 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3182 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3184 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3185 struct netdev_hw_addr_list *mc_list);
3186 void (*configure_filter)(struct ieee80211_hw *hw,
3187 unsigned int changed_flags,
3188 unsigned int *total_flags,
3190 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3192 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3193 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3194 struct ieee80211_key_conf *key);
3195 void (*update_tkip_key)(struct ieee80211_hw *hw,
3196 struct ieee80211_vif *vif,
3197 struct ieee80211_key_conf *conf,
3198 struct ieee80211_sta *sta,
3199 u32 iv32, u16 *phase1key);
3200 void (*set_rekey_data)(struct ieee80211_hw *hw,
3201 struct ieee80211_vif *vif,
3202 struct cfg80211_gtk_rekey_data *data);
3203 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3204 struct ieee80211_vif *vif, int idx);
3205 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3206 struct ieee80211_scan_request *req);
3207 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3208 struct ieee80211_vif *vif);
3209 int (*sched_scan_start)(struct ieee80211_hw *hw,
3210 struct ieee80211_vif *vif,
3211 struct cfg80211_sched_scan_request *req,
3212 struct ieee80211_scan_ies *ies);
3213 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3214 struct ieee80211_vif *vif);
3215 void (*sw_scan_start)(struct ieee80211_hw *hw,
3216 struct ieee80211_vif *vif,
3217 const u8 *mac_addr);
3218 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3219 struct ieee80211_vif *vif);
3220 int (*get_stats)(struct ieee80211_hw *hw,
3221 struct ieee80211_low_level_stats *stats);
3222 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
3223 u32 *iv32, u16 *iv16);
3224 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3225 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3226 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3227 struct ieee80211_sta *sta);
3228 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3229 struct ieee80211_sta *sta);
3230 #ifdef CONFIG_MAC80211_DEBUGFS
3231 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3232 struct ieee80211_vif *vif,
3233 struct ieee80211_sta *sta,
3234 struct dentry *dir);
3235 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3236 struct ieee80211_vif *vif,
3237 struct ieee80211_sta *sta,
3238 struct dentry *dir);
3240 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3241 enum sta_notify_cmd, struct ieee80211_sta *sta);
3242 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3243 struct ieee80211_sta *sta,
3244 enum ieee80211_sta_state old_state,
3245 enum ieee80211_sta_state new_state);
3246 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3247 struct ieee80211_vif *vif,
3248 struct ieee80211_sta *sta);
3249 void (*sta_rc_update)(struct ieee80211_hw *hw,
3250 struct ieee80211_vif *vif,
3251 struct ieee80211_sta *sta,
3253 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3254 struct ieee80211_vif *vif,
3255 struct ieee80211_sta *sta);
3256 void (*sta_statistics)(struct ieee80211_hw *hw,
3257 struct ieee80211_vif *vif,
3258 struct ieee80211_sta *sta,
3259 struct station_info *sinfo);
3260 int (*conf_tx)(struct ieee80211_hw *hw,
3261 struct ieee80211_vif *vif, u16 ac,
3262 const struct ieee80211_tx_queue_params *params);
3263 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3264 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3266 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3267 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3268 int (*ampdu_action)(struct ieee80211_hw *hw,
3269 struct ieee80211_vif *vif,
3270 enum ieee80211_ampdu_mlme_action action,
3271 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3273 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3274 struct survey_info *survey);
3275 void (*rfkill_poll)(struct ieee80211_hw *hw);
3276 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3277 #ifdef CONFIG_NL80211_TESTMODE
3278 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3279 void *data, int len);
3280 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3281 struct netlink_callback *cb,
3282 void *data, int len);
3284 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3285 u32 queues, bool drop);
3286 void (*channel_switch)(struct ieee80211_hw *hw,
3287 struct ieee80211_vif *vif,
3288 struct ieee80211_channel_switch *ch_switch);
3289 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3290 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3292 int (*remain_on_channel)(struct ieee80211_hw *hw,
3293 struct ieee80211_vif *vif,
3294 struct ieee80211_channel *chan,
3296 enum ieee80211_roc_type type);
3297 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3298 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3299 void (*get_ringparam)(struct ieee80211_hw *hw,
3300 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3301 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3302 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3303 const struct cfg80211_bitrate_mask *mask);
3304 void (*event_callback)(struct ieee80211_hw *hw,
3305 struct ieee80211_vif *vif,
3306 const struct ieee80211_event *event);
3308 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3309 struct ieee80211_sta *sta,
3310 u16 tids, int num_frames,
3311 enum ieee80211_frame_release_type reason,
3313 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3314 struct ieee80211_sta *sta,
3315 u16 tids, int num_frames,
3316 enum ieee80211_frame_release_type reason,
3319 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3320 struct ieee80211_vif *vif, int sset);
3321 void (*get_et_stats)(struct ieee80211_hw *hw,
3322 struct ieee80211_vif *vif,
3323 struct ethtool_stats *stats, u64 *data);
3324 void (*get_et_strings)(struct ieee80211_hw *hw,
3325 struct ieee80211_vif *vif,
3326 u32 sset, u8 *data);
3328 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3329 struct ieee80211_vif *vif);
3331 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3332 struct ieee80211_vif *vif);
3334 int (*add_chanctx)(struct ieee80211_hw *hw,
3335 struct ieee80211_chanctx_conf *ctx);
3336 void (*remove_chanctx)(struct ieee80211_hw *hw,
3337 struct ieee80211_chanctx_conf *ctx);
3338 void (*change_chanctx)(struct ieee80211_hw *hw,
3339 struct ieee80211_chanctx_conf *ctx,
3341 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3342 struct ieee80211_vif *vif,
3343 struct ieee80211_chanctx_conf *ctx);
3344 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3345 struct ieee80211_vif *vif,
3346 struct ieee80211_chanctx_conf *ctx);
3347 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3348 struct ieee80211_vif_chanctx_switch *vifs,
3350 enum ieee80211_chanctx_switch_mode mode);
3352 void (*reconfig_complete)(struct ieee80211_hw *hw,
3353 enum ieee80211_reconfig_type reconfig_type);
3355 #if IS_ENABLED(CONFIG_IPV6)
3356 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3357 struct ieee80211_vif *vif,
3358 struct inet6_dev *idev);
3360 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3361 struct ieee80211_vif *vif,
3362 struct cfg80211_chan_def *chandef);
3363 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3364 struct ieee80211_vif *vif,
3365 struct ieee80211_channel_switch *ch_switch);
3367 int (*post_channel_switch)(struct ieee80211_hw *hw,
3368 struct ieee80211_vif *vif);
3370 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3371 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3372 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3373 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3376 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3377 struct ieee80211_vif *vif,
3378 struct ieee80211_sta *sta, u8 oper_class,
3379 struct cfg80211_chan_def *chandef,
3380 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3381 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3382 struct ieee80211_vif *vif,
3383 struct ieee80211_sta *sta);
3384 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3385 struct ieee80211_vif *vif,
3386 struct ieee80211_tdls_ch_sw_params *params);
3388 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3389 struct ieee80211_txq *txq);
3393 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3395 * This must be called once for each hardware device. The returned pointer
3396 * must be used to refer to this device when calling other functions.
3397 * mac80211 allocates a private data area for the driver pointed to by
3398 * @priv in &struct ieee80211_hw, the size of this area is given as
3401 * @priv_data_len: length of private data
3402 * @ops: callbacks for this device
3403 * @requested_name: Requested name for this device.
3404 * NULL is valid value, and means use the default naming (phy%d)
3406 * Return: A pointer to the new hardware device, or %NULL on error.
3408 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3409 const struct ieee80211_ops *ops,
3410 const char *requested_name);
3413 * ieee80211_alloc_hw - Allocate a new hardware device
3415 * This must be called once for each hardware device. The returned pointer
3416 * must be used to refer to this device when calling other functions.
3417 * mac80211 allocates a private data area for the driver pointed to by
3418 * @priv in &struct ieee80211_hw, the size of this area is given as
3421 * @priv_data_len: length of private data
3422 * @ops: callbacks for this device
3424 * Return: A pointer to the new hardware device, or %NULL on error.
3427 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3428 const struct ieee80211_ops *ops)
3430 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3434 * ieee80211_register_hw - Register hardware device
3436 * You must call this function before any other functions in
3437 * mac80211. Note that before a hardware can be registered, you
3438 * need to fill the contained wiphy's information.
3440 * @hw: the device to register as returned by ieee80211_alloc_hw()
3442 * Return: 0 on success. An error code otherwise.
3444 int ieee80211_register_hw(struct ieee80211_hw *hw);
3447 * struct ieee80211_tpt_blink - throughput blink description
3448 * @throughput: throughput in Kbit/sec
3449 * @blink_time: blink time in milliseconds
3450 * (full cycle, ie. one off + one on period)
3452 struct ieee80211_tpt_blink {
3458 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3459 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3460 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3461 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3462 * interface is connected in some way, including being an AP
3464 enum ieee80211_tpt_led_trigger_flags {
3465 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3466 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3467 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3470 #ifdef CONFIG_MAC80211_LEDS
3471 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3472 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3473 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3474 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3475 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3477 const struct ieee80211_tpt_blink *blink_table,
3478 unsigned int blink_table_len);
3481 * ieee80211_get_tx_led_name - get name of TX LED
3483 * mac80211 creates a transmit LED trigger for each wireless hardware
3484 * that can be used to drive LEDs if your driver registers a LED device.
3485 * This function returns the name (or %NULL if not configured for LEDs)
3486 * of the trigger so you can automatically link the LED device.
3488 * @hw: the hardware to get the LED trigger name for
3490 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3492 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3494 #ifdef CONFIG_MAC80211_LEDS
3495 return __ieee80211_get_tx_led_name(hw);
3502 * ieee80211_get_rx_led_name - get name of RX LED
3504 * mac80211 creates a receive LED trigger for each wireless hardware
3505 * that can be used to drive LEDs if your driver registers a LED device.
3506 * This function returns the name (or %NULL if not configured for LEDs)
3507 * of the trigger so you can automatically link the LED device.
3509 * @hw: the hardware to get the LED trigger name for
3511 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3513 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3515 #ifdef CONFIG_MAC80211_LEDS
3516 return __ieee80211_get_rx_led_name(hw);
3523 * ieee80211_get_assoc_led_name - get name of association LED
3525 * mac80211 creates a association LED trigger for each wireless hardware
3526 * that can be used to drive LEDs if your driver registers a LED device.
3527 * This function returns the name (or %NULL if not configured for LEDs)
3528 * of the trigger so you can automatically link the LED device.
3530 * @hw: the hardware to get the LED trigger name for
3532 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3534 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3536 #ifdef CONFIG_MAC80211_LEDS
3537 return __ieee80211_get_assoc_led_name(hw);
3544 * ieee80211_get_radio_led_name - get name of radio LED
3546 * mac80211 creates a radio change LED trigger for each wireless hardware
3547 * that can be used to drive LEDs if your driver registers a LED device.
3548 * This function returns the name (or %NULL if not configured for LEDs)
3549 * of the trigger so you can automatically link the LED device.
3551 * @hw: the hardware to get the LED trigger name for
3553 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3555 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3557 #ifdef CONFIG_MAC80211_LEDS
3558 return __ieee80211_get_radio_led_name(hw);
3565 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3566 * @hw: the hardware to create the trigger for
3567 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3568 * @blink_table: the blink table -- needs to be ordered by throughput
3569 * @blink_table_len: size of the blink table
3571 * Return: %NULL (in case of error, or if no LED triggers are
3572 * configured) or the name of the new trigger.
3574 * Note: This function must be called before ieee80211_register_hw().
3576 static inline char *
3577 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3578 const struct ieee80211_tpt_blink *blink_table,
3579 unsigned int blink_table_len)
3581 #ifdef CONFIG_MAC80211_LEDS
3582 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3590 * ieee80211_unregister_hw - Unregister a hardware device
3592 * This function instructs mac80211 to free allocated resources
3593 * and unregister netdevices from the networking subsystem.
3595 * @hw: the hardware to unregister
3597 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3600 * ieee80211_free_hw - free hardware descriptor
3602 * This function frees everything that was allocated, including the
3603 * private data for the driver. You must call ieee80211_unregister_hw()
3604 * before calling this function.
3606 * @hw: the hardware to free
3608 void ieee80211_free_hw(struct ieee80211_hw *hw);
3611 * ieee80211_restart_hw - restart hardware completely
3613 * Call this function when the hardware was restarted for some reason
3614 * (hardware error, ...) and the driver is unable to restore its state
3615 * by itself. mac80211 assumes that at this point the driver/hardware
3616 * is completely uninitialised and stopped, it starts the process by
3617 * calling the ->start() operation. The driver will need to reset all
3618 * internal state that it has prior to calling this function.
3620 * @hw: the hardware to restart
3622 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3625 * ieee80211_napi_add - initialize mac80211 NAPI context
3626 * @hw: the hardware to initialize the NAPI context on
3627 * @napi: the NAPI context to initialize
3628 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3629 * driver doesn't use NAPI
3630 * @poll: poll function
3631 * @weight: default weight
3633 * See also netif_napi_add().
3635 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3636 struct net_device *napi_dev,
3637 int (*poll)(struct napi_struct *, int),
3641 * ieee80211_rx - receive frame
3643 * Use this function to hand received frames to mac80211. The receive
3644 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3645 * paged @skb is used, the driver is recommended to put the ieee80211
3646 * header of the frame on the linear part of the @skb to avoid memory
3647 * allocation and/or memcpy by the stack.
3649 * This function may not be called in IRQ context. Calls to this function
3650 * for a single hardware must be synchronized against each other. Calls to
3651 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3652 * mixed for a single hardware. Must not run concurrently with
3653 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3655 * In process context use instead ieee80211_rx_ni().
3657 * @hw: the hardware this frame came in on
3658 * @skb: the buffer to receive, owned by mac80211 after this call
3660 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3663 * ieee80211_rx_irqsafe - receive frame
3665 * Like ieee80211_rx() but can be called in IRQ context
3666 * (internally defers to a tasklet.)
3668 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3669 * be mixed for a single hardware.Must not run concurrently with
3670 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3672 * @hw: the hardware this frame came in on
3673 * @skb: the buffer to receive, owned by mac80211 after this call
3675 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3678 * ieee80211_rx_ni - receive frame (in process context)
3680 * Like ieee80211_rx() but can be called in process context
3681 * (internally disables bottom halves).
3683 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3684 * not be mixed for a single hardware. Must not run concurrently with
3685 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3687 * @hw: the hardware this frame came in on
3688 * @skb: the buffer to receive, owned by mac80211 after this call
3690 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3691 struct sk_buff *skb)
3694 ieee80211_rx(hw, skb);
3699 * ieee80211_sta_ps_transition - PS transition for connected sta
3701 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3702 * flag set, use this function to inform mac80211 about a connected station
3703 * entering/leaving PS mode.
3705 * This function may not be called in IRQ context or with softirqs enabled.
3707 * Calls to this function for a single hardware must be synchronized against
3710 * @sta: currently connected sta
3711 * @start: start or stop PS
3713 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3715 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3718 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3719 * (in process context)
3721 * Like ieee80211_sta_ps_transition() but can be called in process context
3722 * (internally disables bottom halves). Concurrent call restriction still
3725 * @sta: currently connected sta
3726 * @start: start or stop PS
3728 * Return: Like ieee80211_sta_ps_transition().
3730 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3736 ret = ieee80211_sta_ps_transition(sta, start);
3743 * The TX headroom reserved by mac80211 for its own tx_status functions.
3744 * This is enough for the radiotap header.
3746 #define IEEE80211_TX_STATUS_HEADROOM 14
3749 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3750 * @sta: &struct ieee80211_sta pointer for the sleeping station
3751 * @tid: the TID that has buffered frames
3752 * @buffered: indicates whether or not frames are buffered for this TID
3754 * If a driver buffers frames for a powersave station instead of passing
3755 * them back to mac80211 for retransmission, the station may still need
3756 * to be told that there are buffered frames via the TIM bit.
3758 * This function informs mac80211 whether or not there are frames that are
3759 * buffered in the driver for a given TID; mac80211 can then use this data
3760 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3761 * call! Beware of the locking!)
3763 * If all frames are released to the station (due to PS-poll or uAPSD)
3764 * then the driver needs to inform mac80211 that there no longer are
3765 * frames buffered. However, when the station wakes up mac80211 assumes
3766 * that all buffered frames will be transmitted and clears this data,
3767 * drivers need to make sure they inform mac80211 about all buffered
3768 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3770 * Note that technically mac80211 only needs to know this per AC, not per
3771 * TID, but since driver buffering will inevitably happen per TID (since
3772 * it is related to aggregation) it is easier to make mac80211 map the
3773 * TID to the AC as required instead of keeping track in all drivers that
3776 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3777 u8 tid, bool buffered);
3780 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3782 * Call this function in a driver with per-packet rate selection support
3783 * to combine the rate info in the packet tx info with the most recent
3784 * rate selection table for the station entry.
3786 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3787 * @sta: the receiver station to which this packet is sent.
3788 * @skb: the frame to be transmitted.
3789 * @dest: buffer for extracted rate/retry information
3790 * @max_rates: maximum number of rates to fetch
3792 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3793 struct ieee80211_sta *sta,
3794 struct sk_buff *skb,
3795 struct ieee80211_tx_rate *dest,
3799 * ieee80211_tx_status - transmit status callback
3801 * Call this function for all transmitted frames after they have been
3802 * transmitted. It is permissible to not call this function for
3803 * multicast frames but this can affect statistics.
3805 * This function may not be called in IRQ context. Calls to this function
3806 * for a single hardware must be synchronized against each other. Calls
3807 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3808 * may not be mixed for a single hardware. Must not run concurrently with
3809 * ieee80211_rx() or ieee80211_rx_ni().
3811 * @hw: the hardware the frame was transmitted by
3812 * @skb: the frame that was transmitted, owned by mac80211 after this call
3814 void ieee80211_tx_status(struct ieee80211_hw *hw,
3815 struct sk_buff *skb);
3818 * ieee80211_tx_status_noskb - transmit status callback without skb
3820 * This function can be used as a replacement for ieee80211_tx_status
3821 * in drivers that cannot reliably map tx status information back to
3824 * Calls to this function for a single hardware must be synchronized
3825 * against each other. Calls to this function, ieee80211_tx_status_ni()
3826 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3828 * @hw: the hardware the frame was transmitted by
3829 * @sta: the receiver station to which this packet is sent
3830 * (NULL for multicast packets)
3831 * @info: tx status information
3833 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3834 struct ieee80211_sta *sta,
3835 struct ieee80211_tx_info *info);
3838 * ieee80211_tx_status_ni - transmit status callback (in process context)
3840 * Like ieee80211_tx_status() but can be called in process context.
3842 * Calls to this function, ieee80211_tx_status() and
3843 * ieee80211_tx_status_irqsafe() may not be mixed
3844 * for a single hardware.
3846 * @hw: the hardware the frame was transmitted by
3847 * @skb: the frame that was transmitted, owned by mac80211 after this call
3849 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3850 struct sk_buff *skb)
3853 ieee80211_tx_status(hw, skb);
3858 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3860 * Like ieee80211_tx_status() but can be called in IRQ context
3861 * (internally defers to a tasklet.)
3863 * Calls to this function, ieee80211_tx_status() and
3864 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3866 * @hw: the hardware the frame was transmitted by
3867 * @skb: the frame that was transmitted, owned by mac80211 after this call
3869 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3870 struct sk_buff *skb);
3873 * ieee80211_report_low_ack - report non-responding station
3875 * When operating in AP-mode, call this function to report a non-responding
3878 * @sta: the non-responding connected sta
3879 * @num_packets: number of packets sent to @sta without a response
3881 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3883 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3886 * struct ieee80211_mutable_offsets - mutable beacon offsets
3887 * @tim_offset: position of TIM element
3888 * @tim_length: size of TIM element
3889 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3890 * to CSA counters. This array can contain zero values which
3891 * should be ignored.
3893 struct ieee80211_mutable_offsets {
3897 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3901 * ieee80211_beacon_get_template - beacon template generation function
3902 * @hw: pointer obtained from ieee80211_alloc_hw().
3903 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3904 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3905 * receive the offsets that may be updated by the driver.
3907 * If the driver implements beaconing modes, it must use this function to
3908 * obtain the beacon template.
3910 * This function should be used if the beacon frames are generated by the
3911 * device, and then the driver must use the returned beacon as the template
3912 * The driver or the device are responsible to update the DTIM and, when
3913 * applicable, the CSA count.
3915 * The driver is responsible for freeing the returned skb.
3917 * Return: The beacon template. %NULL on error.
3920 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3921 struct ieee80211_vif *vif,
3922 struct ieee80211_mutable_offsets *offs);
3925 * ieee80211_beacon_get_tim - beacon generation function
3926 * @hw: pointer obtained from ieee80211_alloc_hw().
3927 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3928 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3929 * Set to 0 if invalid (in non-AP modes).
3930 * @tim_length: pointer to variable that will receive the TIM IE length,
3931 * (including the ID and length bytes!).
3932 * Set to 0 if invalid (in non-AP modes).
3934 * If the driver implements beaconing modes, it must use this function to
3935 * obtain the beacon frame.
3937 * If the beacon frames are generated by the host system (i.e., not in
3938 * hardware/firmware), the driver uses this function to get each beacon
3939 * frame from mac80211 -- it is responsible for calling this function exactly
3940 * once before the beacon is needed (e.g. based on hardware interrupt).
3942 * The driver is responsible for freeing the returned skb.
3944 * Return: The beacon template. %NULL on error.
3946 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3947 struct ieee80211_vif *vif,
3948 u16 *tim_offset, u16 *tim_length);
3951 * ieee80211_beacon_get - beacon generation function
3952 * @hw: pointer obtained from ieee80211_alloc_hw().
3953 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3955 * See ieee80211_beacon_get_tim().
3957 * Return: See ieee80211_beacon_get_tim().
3959 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3960 struct ieee80211_vif *vif)
3962 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3966 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3967 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3969 * The csa counter should be updated after each beacon transmission.
3970 * This function is called implicitly when
3971 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3972 * beacon frames are generated by the device, the driver should call this
3973 * function after each beacon transmission to sync mac80211's csa counters.
3975 * Return: new csa counter value
3977 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3980 * ieee80211_csa_finish - notify mac80211 about channel switch
3981 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3983 * After a channel switch announcement was scheduled and the counter in this
3984 * announcement hits 1, this function must be called by the driver to
3985 * notify mac80211 that the channel can be changed.
3987 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3990 * ieee80211_csa_is_complete - find out if counters reached 1
3991 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3993 * This function returns whether the channel switch counters reached zero.
3995 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3999 * ieee80211_proberesp_get - retrieve a Probe Response template
4000 * @hw: pointer obtained from ieee80211_alloc_hw().
4001 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4003 * Creates a Probe Response template which can, for example, be uploaded to
4004 * hardware. The destination address should be set by the caller.
4006 * Can only be called in AP mode.
4008 * Return: The Probe Response template. %NULL on error.
4010 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4011 struct ieee80211_vif *vif);
4014 * ieee80211_pspoll_get - retrieve a PS Poll template
4015 * @hw: pointer obtained from ieee80211_alloc_hw().
4016 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4018 * Creates a PS Poll a template which can, for example, uploaded to
4019 * hardware. The template must be updated after association so that correct
4020 * AID, BSSID and MAC address is used.
4022 * Note: Caller (or hardware) is responsible for setting the
4023 * &IEEE80211_FCTL_PM bit.
4025 * Return: The PS Poll template. %NULL on error.
4027 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4028 struct ieee80211_vif *vif);
4031 * ieee80211_nullfunc_get - retrieve a nullfunc template
4032 * @hw: pointer obtained from ieee80211_alloc_hw().
4033 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4035 * Creates a Nullfunc template which can, for example, uploaded to
4036 * hardware. The template must be updated after association so that correct
4037 * BSSID and address is used.
4039 * Note: Caller (or hardware) is responsible for setting the
4040 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4042 * Return: The nullfunc template. %NULL on error.
4044 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4045 struct ieee80211_vif *vif);
4048 * ieee80211_probereq_get - retrieve a Probe Request template
4049 * @hw: pointer obtained from ieee80211_alloc_hw().
4050 * @src_addr: source MAC address
4051 * @ssid: SSID buffer
4052 * @ssid_len: length of SSID
4053 * @tailroom: tailroom to reserve at end of SKB for IEs
4055 * Creates a Probe Request template which can, for example, be uploaded to
4058 * Return: The Probe Request template. %NULL on error.
4060 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4062 const u8 *ssid, size_t ssid_len,
4066 * ieee80211_rts_get - RTS frame generation function
4067 * @hw: pointer obtained from ieee80211_alloc_hw().
4068 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4069 * @frame: pointer to the frame that is going to be protected by the RTS.
4070 * @frame_len: the frame length (in octets).
4071 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4072 * @rts: The buffer where to store the RTS frame.
4074 * If the RTS frames are generated by the host system (i.e., not in
4075 * hardware/firmware), the low-level driver uses this function to receive
4076 * the next RTS frame from the 802.11 code. The low-level is responsible
4077 * for calling this function before and RTS frame is needed.
4079 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4080 const void *frame, size_t frame_len,
4081 const struct ieee80211_tx_info *frame_txctl,
4082 struct ieee80211_rts *rts);
4085 * ieee80211_rts_duration - Get the duration field for an RTS frame
4086 * @hw: pointer obtained from ieee80211_alloc_hw().
4087 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4088 * @frame_len: the length of the frame that is going to be protected by the RTS.
4089 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4091 * If the RTS is generated in firmware, but the host system must provide
4092 * the duration field, the low-level driver uses this function to receive
4093 * the duration field value in little-endian byteorder.
4095 * Return: The duration.
4097 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4098 struct ieee80211_vif *vif, size_t frame_len,
4099 const struct ieee80211_tx_info *frame_txctl);
4102 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4103 * @hw: pointer obtained from ieee80211_alloc_hw().
4104 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4105 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4106 * @frame_len: the frame length (in octets).
4107 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4108 * @cts: The buffer where to store the CTS-to-self frame.
4110 * If the CTS-to-self frames are generated by the host system (i.e., not in
4111 * hardware/firmware), the low-level driver uses this function to receive
4112 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4113 * for calling this function before and CTS-to-self frame is needed.
4115 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4116 struct ieee80211_vif *vif,
4117 const void *frame, size_t frame_len,
4118 const struct ieee80211_tx_info *frame_txctl,
4119 struct ieee80211_cts *cts);
4122 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4123 * @hw: pointer obtained from ieee80211_alloc_hw().
4124 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4125 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4126 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4128 * If the CTS-to-self is generated in firmware, but the host system must provide
4129 * the duration field, the low-level driver uses this function to receive
4130 * the duration field value in little-endian byteorder.
4132 * Return: The duration.
4134 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4135 struct ieee80211_vif *vif,
4137 const struct ieee80211_tx_info *frame_txctl);
4140 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4141 * @hw: pointer obtained from ieee80211_alloc_hw().
4142 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4143 * @band: the band to calculate the frame duration on
4144 * @frame_len: the length of the frame.
4145 * @rate: the rate at which the frame is going to be transmitted.
4147 * Calculate the duration field of some generic frame, given its
4148 * length and transmission rate (in 100kbps).
4150 * Return: The duration.
4152 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4153 struct ieee80211_vif *vif,
4154 enum ieee80211_band band,
4156 struct ieee80211_rate *rate);
4159 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4160 * @hw: pointer as obtained from ieee80211_alloc_hw().
4161 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4163 * Function for accessing buffered broadcast and multicast frames. If
4164 * hardware/firmware does not implement buffering of broadcast/multicast
4165 * frames when power saving is used, 802.11 code buffers them in the host
4166 * memory. The low-level driver uses this function to fetch next buffered
4167 * frame. In most cases, this is used when generating beacon frame.
4169 * Return: A pointer to the next buffered skb or NULL if no more buffered
4170 * frames are available.
4172 * Note: buffered frames are returned only after DTIM beacon frame was
4173 * generated with ieee80211_beacon_get() and the low-level driver must thus
4174 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4175 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4176 * does not need to check for DTIM beacons separately and should be able to
4177 * use common code for all beacons.
4180 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4183 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4185 * This function returns the TKIP phase 1 key for the given IV32.
4187 * @keyconf: the parameter passed with the set key
4188 * @iv32: IV32 to get the P1K for
4189 * @p1k: a buffer to which the key will be written, as 5 u16 values
4191 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4192 u32 iv32, u16 *p1k);
4195 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4197 * This function returns the TKIP phase 1 key for the IV32 taken
4198 * from the given packet.
4200 * @keyconf: the parameter passed with the set key
4201 * @skb: the packet to take the IV32 value from that will be encrypted
4203 * @p1k: a buffer to which the key will be written, as 5 u16 values
4205 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4206 struct sk_buff *skb, u16 *p1k)
4208 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4209 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4210 u32 iv32 = get_unaligned_le32(&data[4]);
4212 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4216 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4218 * This function returns the TKIP phase 1 key for the given IV32
4219 * and transmitter address.
4221 * @keyconf: the parameter passed with the set key
4222 * @ta: TA that will be used with the key
4223 * @iv32: IV32 to get the P1K for
4224 * @p1k: a buffer to which the key will be written, as 5 u16 values
4226 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4227 const u8 *ta, u32 iv32, u16 *p1k);
4230 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4232 * This function computes the TKIP RC4 key for the IV values
4235 * @keyconf: the parameter passed with the set key
4236 * @skb: the packet to take the IV32/IV16 values from that will be
4237 * encrypted with this key
4238 * @p2k: a buffer to which the key will be written, 16 bytes
4240 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4241 struct sk_buff *skb, u8 *p2k);
4244 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
4246 * This function computes the two AES-CMAC sub-keys, based on the
4247 * previously installed master key.
4249 * @keyconf: the parameter passed with the set key
4250 * @k1: a buffer to be filled with the 1st sub-key
4251 * @k2: a buffer to be filled with the 2nd sub-key
4253 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
4257 * struct ieee80211_key_seq - key sequence counter
4259 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
4260 * @ccmp: PN data, most significant byte first (big endian,
4261 * reverse order than in packet)
4262 * @aes_cmac: PN data, most significant byte first (big endian,
4263 * reverse order than in packet)
4264 * @aes_gmac: PN data, most significant byte first (big endian,
4265 * reverse order than in packet)
4266 * @gcmp: PN data, most significant byte first (big endian,
4267 * reverse order than in packet)
4269 struct ieee80211_key_seq {
4291 * ieee80211_get_key_tx_seq - get key TX sequence counter
4293 * @keyconf: the parameter passed with the set key
4294 * @seq: buffer to receive the sequence data
4296 * This function allows a driver to retrieve the current TX IV/PN
4297 * for the given key. It must not be called if IV generation is
4298 * offloaded to the device.
4300 * Note that this function may only be called when no TX processing
4301 * can be done concurrently, for example when queues are stopped
4302 * and the stop has been synchronized.
4304 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4305 struct ieee80211_key_seq *seq);
4308 * ieee80211_get_key_rx_seq - get key RX sequence counter
4310 * @keyconf: the parameter passed with the set key
4311 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4312 * the value on TID 0 is also used for non-QoS frames. For
4313 * CMAC, only TID 0 is valid.
4314 * @seq: buffer to receive the sequence data
4316 * This function allows a driver to retrieve the current RX IV/PNs
4317 * for the given key. It must not be called if IV checking is done
4318 * by the device and not by mac80211.
4320 * Note that this function may only be called when no RX processing
4321 * can be done concurrently.
4323 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4324 int tid, struct ieee80211_key_seq *seq);
4327 * ieee80211_set_key_tx_seq - set key TX sequence counter
4329 * @keyconf: the parameter passed with the set key
4330 * @seq: new sequence data
4332 * This function allows a driver to set the current TX IV/PNs for the
4333 * given key. This is useful when resuming from WoWLAN sleep and the
4334 * device may have transmitted frames using the PTK, e.g. replies to
4337 * Note that this function may only be called when no TX processing
4338 * can be done concurrently.
4340 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4341 struct ieee80211_key_seq *seq);
4344 * ieee80211_set_key_rx_seq - set key RX sequence counter
4346 * @keyconf: the parameter passed with the set key
4347 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4348 * the value on TID 0 is also used for non-QoS frames. For
4349 * CMAC, only TID 0 is valid.
4350 * @seq: new sequence data
4352 * This function allows a driver to set the current RX IV/PNs for the
4353 * given key. This is useful when resuming from WoWLAN sleep and GTK
4354 * rekey may have been done while suspended. It should not be called
4355 * if IV checking is done by the device and not by mac80211.
4357 * Note that this function may only be called when no RX processing
4358 * can be done concurrently.
4360 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4361 int tid, struct ieee80211_key_seq *seq);
4364 * ieee80211_remove_key - remove the given key
4365 * @keyconf: the parameter passed with the set key
4367 * Remove the given key. If the key was uploaded to the hardware at the
4368 * time this function is called, it is not deleted in the hardware but
4369 * instead assumed to have been removed already.
4371 * Note that due to locking considerations this function can (currently)
4372 * only be called during key iteration (ieee80211_iter_keys().)
4374 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4377 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4378 * @vif: the virtual interface to add the key on
4379 * @keyconf: new key data
4381 * When GTK rekeying was done while the system was suspended, (a) new
4382 * key(s) will be available. These will be needed by mac80211 for proper
4383 * RX processing, so this function allows setting them.
4385 * The function returns the newly allocated key structure, which will
4386 * have similar contents to the passed key configuration but point to
4387 * mac80211-owned memory. In case of errors, the function returns an
4388 * ERR_PTR(), use IS_ERR() etc.
4390 * Note that this function assumes the key isn't added to hardware
4391 * acceleration, so no TX will be done with the key. Since it's a GTK
4392 * on managed (station) networks, this is true anyway. If the driver
4393 * calls this function from the resume callback and subsequently uses
4394 * the return code 1 to reconfigure the device, this key will be part
4395 * of the reconfiguration.
4397 * Note that the driver should also call ieee80211_set_key_rx_seq()
4398 * for the new key for each TID to set up sequence counters properly.
4400 * IMPORTANT: If this replaces a key that is present in the hardware,
4401 * then it will attempt to remove it during this call. In many cases
4402 * this isn't what you want, so call ieee80211_remove_key() first for
4403 * the key that's being replaced.
4405 struct ieee80211_key_conf *
4406 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4407 struct ieee80211_key_conf *keyconf);
4410 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4411 * @vif: virtual interface the rekeying was done on
4412 * @bssid: The BSSID of the AP, for checking association
4413 * @replay_ctr: the new replay counter after GTK rekeying
4414 * @gfp: allocation flags
4416 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4417 const u8 *replay_ctr, gfp_t gfp);
4420 * ieee80211_wake_queue - wake specific queue
4421 * @hw: pointer as obtained from ieee80211_alloc_hw().
4422 * @queue: queue number (counted from zero).
4424 * Drivers should use this function instead of netif_wake_queue.
4426 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4429 * ieee80211_stop_queue - stop specific queue
4430 * @hw: pointer as obtained from ieee80211_alloc_hw().
4431 * @queue: queue number (counted from zero).
4433 * Drivers should use this function instead of netif_stop_queue.
4435 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4438 * ieee80211_queue_stopped - test status of the queue
4439 * @hw: pointer as obtained from ieee80211_alloc_hw().
4440 * @queue: queue number (counted from zero).
4442 * Drivers should use this function instead of netif_stop_queue.
4444 * Return: %true if the queue is stopped. %false otherwise.
4447 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4450 * ieee80211_stop_queues - stop all queues
4451 * @hw: pointer as obtained from ieee80211_alloc_hw().
4453 * Drivers should use this function instead of netif_stop_queue.
4455 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4458 * ieee80211_wake_queues - wake all queues
4459 * @hw: pointer as obtained from ieee80211_alloc_hw().
4461 * Drivers should use this function instead of netif_wake_queue.
4463 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4466 * ieee80211_scan_completed - completed hardware scan
4468 * When hardware scan offload is used (i.e. the hw_scan() callback is
4469 * assigned) this function needs to be called by the driver to notify
4470 * mac80211 that the scan finished. This function can be called from
4471 * any context, including hardirq context.
4473 * @hw: the hardware that finished the scan
4474 * @aborted: set to true if scan was aborted
4476 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4479 * ieee80211_sched_scan_results - got results from scheduled scan
4481 * When a scheduled scan is running, this function needs to be called by the
4482 * driver whenever there are new scan results available.
4484 * @hw: the hardware that is performing scheduled scans
4486 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4489 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4491 * When a scheduled scan is running, this function can be called by
4492 * the driver if it needs to stop the scan to perform another task.
4493 * Usual scenarios are drivers that cannot continue the scheduled scan
4494 * while associating, for instance.
4496 * @hw: the hardware that is performing scheduled scans
4498 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4501 * enum ieee80211_interface_iteration_flags - interface iteration flags
4502 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4503 * been added to the driver; However, note that during hardware
4504 * reconfiguration (after restart_hw) it will iterate over a new
4505 * interface and over all the existing interfaces even if they
4506 * haven't been re-added to the driver yet.
4507 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4508 * interfaces, even if they haven't been re-added to the driver yet.
4509 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4511 enum ieee80211_interface_iteration_flags {
4512 IEEE80211_IFACE_ITER_NORMAL = 0,
4513 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4514 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4518 * ieee80211_iterate_interfaces - iterate interfaces
4520 * This function iterates over the interfaces associated with a given
4521 * hardware and calls the callback for them. This includes active as well as
4522 * inactive interfaces. This function allows the iterator function to sleep.
4523 * Will iterate over a new interface during add_interface().
4525 * @hw: the hardware struct of which the interfaces should be iterated over
4526 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4527 * @iterator: the iterator function to call
4528 * @data: first argument of the iterator function
4530 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4531 void (*iterator)(void *data, u8 *mac,
4532 struct ieee80211_vif *vif),
4536 * ieee80211_iterate_active_interfaces - iterate active interfaces
4538 * This function iterates over the interfaces associated with a given
4539 * hardware that are currently active and calls the callback for them.
4540 * This function allows the iterator function to sleep, when the iterator
4541 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4543 * Does not iterate over a new interface during add_interface().
4545 * @hw: the hardware struct of which the interfaces should be iterated over
4546 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4547 * @iterator: the iterator function to call
4548 * @data: first argument of the iterator function
4551 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4552 void (*iterator)(void *data, u8 *mac,
4553 struct ieee80211_vif *vif),
4556 ieee80211_iterate_interfaces(hw,
4557 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4562 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4564 * This function iterates over the interfaces associated with a given
4565 * hardware that are currently active and calls the callback for them.
4566 * This function requires the iterator callback function to be atomic,
4567 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4568 * Does not iterate over a new interface during add_interface().
4570 * @hw: the hardware struct of which the interfaces should be iterated over
4571 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4572 * @iterator: the iterator function to call, cannot sleep
4573 * @data: first argument of the iterator function
4575 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4577 void (*iterator)(void *data,
4579 struct ieee80211_vif *vif),
4583 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4585 * This function iterates over the interfaces associated with a given
4586 * hardware that are currently active and calls the callback for them.
4587 * This version can only be used while holding the RTNL.
4589 * @hw: the hardware struct of which the interfaces should be iterated over
4590 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4591 * @iterator: the iterator function to call, cannot sleep
4592 * @data: first argument of the iterator function
4594 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4596 void (*iterator)(void *data,
4598 struct ieee80211_vif *vif),
4602 * ieee80211_iterate_stations_atomic - iterate stations
4604 * This function iterates over all stations associated with a given
4605 * hardware that are currently uploaded to the driver and calls the callback
4606 * function for them.
4607 * This function requires the iterator callback function to be atomic,
4609 * @hw: the hardware struct of which the interfaces should be iterated over
4610 * @iterator: the iterator function to call, cannot sleep
4611 * @data: first argument of the iterator function
4613 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4614 void (*iterator)(void *data,
4615 struct ieee80211_sta *sta),
4618 * ieee80211_queue_work - add work onto the mac80211 workqueue
4620 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4621 * This helper ensures drivers are not queueing work when they should not be.
4623 * @hw: the hardware struct for the interface we are adding work for
4624 * @work: the work we want to add onto the mac80211 workqueue
4626 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4629 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4631 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4634 * @hw: the hardware struct for the interface we are adding work for
4635 * @dwork: delayable work to queue onto the mac80211 workqueue
4636 * @delay: number of jiffies to wait before queueing
4638 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4639 struct delayed_work *dwork,
4640 unsigned long delay);
4643 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4644 * @sta: the station for which to start a BA session
4645 * @tid: the TID to BA on.
4646 * @timeout: session timeout value (in TUs)
4648 * Return: success if addBA request was sent, failure otherwise
4650 * Although mac80211/low level driver/user space application can estimate
4651 * the need to start aggregation on a certain RA/TID, the session level
4652 * will be managed by the mac80211.
4654 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4658 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4659 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4660 * @ra: receiver address of the BA session recipient.
4661 * @tid: the TID to BA on.
4663 * This function must be called by low level driver once it has
4664 * finished with preparations for the BA session. It can be called
4667 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4671 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4672 * @sta: the station whose BA session to stop
4673 * @tid: the TID to stop BA.
4675 * Return: negative error if the TID is invalid, or no aggregation active
4677 * Although mac80211/low level driver/user space application can estimate
4678 * the need to stop aggregation on a certain RA/TID, the session level
4679 * will be managed by the mac80211.
4681 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4684 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4685 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4686 * @ra: receiver address of the BA session recipient.
4687 * @tid: the desired TID to BA on.
4689 * This function must be called by low level driver once it has
4690 * finished with preparations for the BA session tear down. It
4691 * can be called from any context.
4693 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4697 * ieee80211_find_sta - find a station
4699 * @vif: virtual interface to look for station on
4700 * @addr: station's address
4702 * Return: The station, if found. %NULL otherwise.
4704 * Note: This function must be called under RCU lock and the
4705 * resulting pointer is only valid under RCU lock as well.
4707 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4711 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4713 * @hw: pointer as obtained from ieee80211_alloc_hw()
4714 * @addr: remote station's address
4715 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4717 * Return: The station, if found. %NULL otherwise.
4719 * Note: This function must be called under RCU lock and the
4720 * resulting pointer is only valid under RCU lock as well.
4722 * NOTE: You may pass NULL for localaddr, but then you will just get
4723 * the first STA that matches the remote address 'addr'.
4724 * We can have multiple STA associated with multiple
4725 * logical stations (e.g. consider a station connecting to another
4726 * BSSID on the same AP hardware without disconnecting first).
4727 * In this case, the result of this method with localaddr NULL
4730 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4732 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4734 const u8 *localaddr);
4737 * ieee80211_sta_block_awake - block station from waking up
4739 * @pubsta: the station
4740 * @block: whether to block or unblock
4742 * Some devices require that all frames that are on the queues
4743 * for a specific station that went to sleep are flushed before
4744 * a poll response or frames after the station woke up can be
4745 * delivered to that it. Note that such frames must be rejected
4746 * by the driver as filtered, with the appropriate status flag.
4748 * This function allows implementing this mode in a race-free
4751 * To do this, a driver must keep track of the number of frames
4752 * still enqueued for a specific station. If this number is not
4753 * zero when the station goes to sleep, the driver must call
4754 * this function to force mac80211 to consider the station to
4755 * be asleep regardless of the station's actual state. Once the
4756 * number of outstanding frames reaches zero, the driver must
4757 * call this function again to unblock the station. That will
4758 * cause mac80211 to be able to send ps-poll responses, and if
4759 * the station queried in the meantime then frames will also
4760 * be sent out as a result of this. Additionally, the driver
4761 * will be notified that the station woke up some time after
4762 * it is unblocked, regardless of whether the station actually
4763 * woke up while blocked or not.
4765 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4766 struct ieee80211_sta *pubsta, bool block);
4769 * ieee80211_sta_eosp - notify mac80211 about end of SP
4770 * @pubsta: the station
4772 * When a device transmits frames in a way that it can't tell
4773 * mac80211 in the TX status about the EOSP, it must clear the
4774 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4775 * This applies for PS-Poll as well as uAPSD.
4777 * Note that just like with _tx_status() and _rx() drivers must
4778 * not mix calls to irqsafe/non-irqsafe versions, this function
4779 * must not be mixed with those either. Use the all irqsafe, or
4780 * all non-irqsafe, don't mix!
4782 * NB: the _irqsafe version of this function doesn't exist, no
4783 * driver needs it right now. Don't call this function if
4784 * you'd need the _irqsafe version, look at the git history
4785 * and restore the _irqsafe version!
4787 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4790 * ieee80211_iter_keys - iterate keys programmed into the device
4791 * @hw: pointer obtained from ieee80211_alloc_hw()
4792 * @vif: virtual interface to iterate, may be %NULL for all
4793 * @iter: iterator function that will be called for each key
4794 * @iter_data: custom data to pass to the iterator function
4796 * This function can be used to iterate all the keys known to
4797 * mac80211, even those that weren't previously programmed into
4798 * the device. This is intended for use in WoWLAN if the device
4799 * needs reprogramming of the keys during suspend. Note that due
4800 * to locking reasons, it is also only safe to call this at few
4801 * spots since it must hold the RTNL and be able to sleep.
4803 * The order in which the keys are iterated matches the order
4804 * in which they were originally installed and handed to the
4807 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4808 struct ieee80211_vif *vif,
4809 void (*iter)(struct ieee80211_hw *hw,
4810 struct ieee80211_vif *vif,
4811 struct ieee80211_sta *sta,
4812 struct ieee80211_key_conf *key,
4817 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4818 * @hw: pointre obtained from ieee80211_alloc_hw().
4819 * @iter: iterator function
4820 * @iter_data: data passed to iterator function
4822 * Iterate all active channel contexts. This function is atomic and
4823 * doesn't acquire any locks internally that might be held in other
4824 * places while calling into the driver.
4826 * The iterator will not find a context that's being added (during
4827 * the driver callback to add it) but will find it while it's being
4830 * Note that during hardware restart, all contexts that existed
4831 * before the restart are considered already present so will be
4832 * found while iterating, whether they've been re-added already
4835 void ieee80211_iter_chan_contexts_atomic(
4836 struct ieee80211_hw *hw,
4837 void (*iter)(struct ieee80211_hw *hw,
4838 struct ieee80211_chanctx_conf *chanctx_conf,
4843 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4844 * @hw: pointer obtained from ieee80211_alloc_hw().
4845 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4847 * Creates a Probe Request template which can, for example, be uploaded to
4848 * hardware. The template is filled with bssid, ssid and supported rate
4849 * information. This function must only be called from within the
4850 * .bss_info_changed callback function and only in managed mode. The function
4851 * is only useful when the interface is associated, otherwise it will return
4854 * Return: The Probe Request template. %NULL on error.
4856 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4857 struct ieee80211_vif *vif);
4860 * ieee80211_beacon_loss - inform hardware does not receive beacons
4862 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4864 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4865 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4866 * hardware is not receiving beacons with this function.
4868 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4871 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4873 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4875 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4876 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4877 * needs to inform if the connection to the AP has been lost.
4878 * The function may also be called if the connection needs to be terminated
4879 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4881 * This function will cause immediate change to disassociated state,
4882 * without connection recovery attempts.
4884 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4887 * ieee80211_resume_disconnect - disconnect from AP after resume
4889 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4891 * Instructs mac80211 to disconnect from the AP after resume.
4892 * Drivers can use this after WoWLAN if they know that the
4893 * connection cannot be kept up, for example because keys were
4894 * used while the device was asleep but the replay counters or
4895 * similar cannot be retrieved from the device during resume.
4897 * Note that due to implementation issues, if the driver uses
4898 * the reconfiguration functionality during resume the interface
4899 * will still be added as associated first during resume and then
4900 * disconnect normally later.
4902 * This function can only be called from the resume callback and
4903 * the driver must not be holding any of its own locks while it
4904 * calls this function, or at least not any locks it needs in the
4905 * key configuration paths (if it supports HW crypto).
4907 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4910 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4911 * rssi threshold triggered
4913 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4914 * @rssi_event: the RSSI trigger event type
4915 * @gfp: context flags
4917 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4918 * monitoring is configured with an rssi threshold, the driver will inform
4919 * whenever the rssi level reaches the threshold.
4921 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4922 enum nl80211_cqm_rssi_threshold_event rssi_event,
4926 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4928 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4929 * @gfp: context flags
4931 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
4934 * ieee80211_radar_detected - inform that a radar was detected
4936 * @hw: pointer as obtained from ieee80211_alloc_hw()
4938 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4941 * ieee80211_chswitch_done - Complete channel switch process
4942 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4943 * @success: make the channel switch successful or not
4945 * Complete the channel switch post-process: set the new operational channel
4946 * and wake up the suspended queues.
4948 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4951 * ieee80211_request_smps - request SM PS transition
4952 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4953 * @smps_mode: new SM PS mode
4955 * This allows the driver to request an SM PS transition in managed
4956 * mode. This is useful when the driver has more information than
4957 * the stack about possible interference, for example by bluetooth.
4959 void ieee80211_request_smps(struct ieee80211_vif *vif,
4960 enum ieee80211_smps_mode smps_mode);
4963 * ieee80211_ready_on_channel - notification of remain-on-channel start
4964 * @hw: pointer as obtained from ieee80211_alloc_hw()
4966 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4969 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4970 * @hw: pointer as obtained from ieee80211_alloc_hw()
4972 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4975 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4977 * in order not to harm the system performance and user experience, the device
4978 * may request not to allow any rx ba session and tear down existing rx ba
4979 * sessions based on system constraints such as periodic BT activity that needs
4980 * to limit wlan activity (eg.sco or a2dp)."
4981 * in such cases, the intention is to limit the duration of the rx ppdu and
4982 * therefore prevent the peer device to use a-mpdu aggregation.
4984 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4985 * @ba_rx_bitmap: Bit map of open rx ba per tid
4986 * @addr: & to bssid mac address
4988 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4992 * ieee80211_send_bar - send a BlockAckReq frame
4994 * can be used to flush pending frames from the peer's aggregation reorder
4997 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4998 * @ra: the peer's destination address
4999 * @tid: the TID of the aggregation session
5000 * @ssn: the new starting sequence number for the receiver
5002 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5005 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5007 * Some device drivers may offload part of the Rx aggregation flow including
5008 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5011 * Create structures responsible for reordering so device drivers may call here
5012 * when they complete AddBa negotiation.
5014 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5015 * @addr: station mac address
5018 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5019 const u8 *addr, u16 tid);
5022 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5024 * Some device drivers may offload part of the Rx aggregation flow including
5025 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5028 * Destroy structures responsible for reordering so device drivers may call here
5029 * when they complete DelBa negotiation.
5031 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5032 * @addr: station mac address
5035 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5036 const u8 *addr, u16 tid);
5038 /* Rate control API */
5041 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5043 * @hw: The hardware the algorithm is invoked for.
5044 * @sband: The band this frame is being transmitted on.
5045 * @bss_conf: the current BSS configuration
5046 * @skb: the skb that will be transmitted, the control information in it needs
5048 * @reported_rate: The rate control algorithm can fill this in to indicate
5049 * which rate should be reported to userspace as the current rate and
5050 * used for rate calculations in the mesh network.
5051 * @rts: whether RTS will be used for this frame because it is longer than the
5053 * @short_preamble: whether mac80211 will request short-preamble transmission
5054 * if the selected rate supports it
5055 * @max_rate_idx: user-requested maximum (legacy) rate
5056 * (deprecated; this will be removed once drivers get updated to use
5058 * @rate_idx_mask: user-requested (legacy) rate mask
5059 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5060 * @bss: whether this frame is sent out in AP or IBSS mode
5062 struct ieee80211_tx_rate_control {
5063 struct ieee80211_hw *hw;
5064 struct ieee80211_supported_band *sband;
5065 struct ieee80211_bss_conf *bss_conf;
5066 struct sk_buff *skb;
5067 struct ieee80211_tx_rate reported_rate;
5068 bool rts, short_preamble;
5071 u8 *rate_idx_mcs_mask;
5075 struct rate_control_ops {
5077 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5078 void (*free)(void *priv);
5080 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5081 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5082 struct cfg80211_chan_def *chandef,
5083 struct ieee80211_sta *sta, void *priv_sta);
5084 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5085 struct cfg80211_chan_def *chandef,
5086 struct ieee80211_sta *sta, void *priv_sta,
5088 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5091 void (*tx_status_noskb)(void *priv,
5092 struct ieee80211_supported_band *sband,
5093 struct ieee80211_sta *sta, void *priv_sta,
5094 struct ieee80211_tx_info *info);
5095 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5096 struct ieee80211_sta *sta, void *priv_sta,
5097 struct sk_buff *skb);
5098 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5099 struct ieee80211_tx_rate_control *txrc);
5101 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5102 struct dentry *dir);
5103 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5105 u32 (*get_expected_throughput)(void *priv_sta);
5108 static inline int rate_supported(struct ieee80211_sta *sta,
5109 enum ieee80211_band band,
5112 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5116 * rate_control_send_low - helper for drivers for management/no-ack frames
5118 * Rate control algorithms that agree to use the lowest rate to
5119 * send management frames and NO_ACK data with the respective hw
5120 * retries should use this in the beginning of their mac80211 get_rate
5121 * callback. If true is returned the rate control can simply return.
5122 * If false is returned we guarantee that sta and sta and priv_sta is
5125 * Rate control algorithms wishing to do more intelligent selection of
5126 * rate for multicast/broadcast frames may choose to not use this.
5128 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5129 * that this may be null.
5130 * @priv_sta: private rate control structure. This may be null.
5131 * @txrc: rate control information we sholud populate for mac80211.
5133 bool rate_control_send_low(struct ieee80211_sta *sta,
5135 struct ieee80211_tx_rate_control *txrc);
5139 rate_lowest_index(struct ieee80211_supported_band *sband,
5140 struct ieee80211_sta *sta)
5144 for (i = 0; i < sband->n_bitrates; i++)
5145 if (rate_supported(sta, sband->band, i))
5148 /* warn when we cannot find a rate. */
5151 /* and return 0 (the lowest index) */
5156 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5157 struct ieee80211_sta *sta)
5161 for (i = 0; i < sband->n_bitrates; i++)
5162 if (rate_supported(sta, sband->band, i))
5168 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5170 * When not doing a rate control probe to test rates, rate control should pass
5171 * its rate selection to mac80211. If the driver supports receiving a station
5172 * rate table, it will use it to ensure that frames are always sent based on
5173 * the most recent rate control module decision.
5175 * @hw: pointer as obtained from ieee80211_alloc_hw()
5176 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5177 * @rates: new tx rate set to be used for this station.
5179 int rate_control_set_rates(struct ieee80211_hw *hw,
5180 struct ieee80211_sta *pubsta,
5181 struct ieee80211_sta_rates *rates);
5183 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5184 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5187 conf_is_ht20(struct ieee80211_conf *conf)
5189 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5193 conf_is_ht40_minus(struct ieee80211_conf *conf)
5195 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5196 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5200 conf_is_ht40_plus(struct ieee80211_conf *conf)
5202 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5203 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5207 conf_is_ht40(struct ieee80211_conf *conf)
5209 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5213 conf_is_ht(struct ieee80211_conf *conf)
5215 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5216 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5217 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5220 static inline enum nl80211_iftype
5221 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5225 case NL80211_IFTYPE_STATION:
5226 return NL80211_IFTYPE_P2P_CLIENT;
5227 case NL80211_IFTYPE_AP:
5228 return NL80211_IFTYPE_P2P_GO;
5236 static inline enum nl80211_iftype
5237 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5239 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5242 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5244 int rssi_max_thold);
5246 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5249 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5251 * @vif: the specified virtual interface
5253 * Note: This function assumes that the given vif is valid.
5255 * Return: The average RSSI value for the requested interface, or 0 if not
5258 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5261 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5262 * @vif: virtual interface
5263 * @wakeup: wakeup reason(s)
5264 * @gfp: allocation flags
5266 * See cfg80211_report_wowlan_wakeup().
5268 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5269 struct cfg80211_wowlan_wakeup *wakeup,
5273 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5274 * @hw: pointer as obtained from ieee80211_alloc_hw()
5275 * @vif: virtual interface
5276 * @skb: frame to be sent from within the driver
5277 * @band: the band to transmit on
5278 * @sta: optional pointer to get the station to send the frame to
5280 * Note: must be called under RCU lock
5282 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5283 struct ieee80211_vif *vif, struct sk_buff *skb,
5284 int band, struct ieee80211_sta **sta);
5287 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5289 * @next_tsf: TSF timestamp of the next absent state change
5290 * @has_next_tsf: next absent state change event pending
5292 * @absent: descriptor bitmask, set if GO is currently absent
5296 * @count: count fields from the NoA descriptors
5297 * @desc: adjusted data from the NoA
5299 struct ieee80211_noa_data {
5305 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5310 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5314 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5317 * @data: NoA tracking data
5318 * @tsf: current TSF timestamp
5320 * Return: number of successfully parsed descriptors
5322 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5323 struct ieee80211_noa_data *data, u32 tsf);
5326 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5328 * @data: NoA tracking data
5329 * @tsf: current TSF timestamp
5331 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5334 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5335 * @vif: virtual interface
5336 * @peer: the peer's destination address
5337 * @oper: the requested TDLS operation
5338 * @reason_code: reason code for the operation, valid for TDLS teardown
5339 * @gfp: allocation flags
5341 * See cfg80211_tdls_oper_request().
5343 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5344 enum nl80211_tdls_operation oper,
5345 u16 reason_code, gfp_t gfp);
5348 * ieee80211_reserve_tid - request to reserve a specific TID
5350 * There is sometimes a need (such as in TDLS) for blocking the driver from
5351 * using a specific TID so that the FW can use it for certain operations such
5352 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5353 * this function must be called as it flushes out packets on this TID and marks
5354 * it as blocked, so that any transmit for the station on this TID will be
5355 * redirected to the alternative TID in the same AC.
5357 * Note that this function blocks and may call back into the driver, so it
5358 * should be called without driver locks held. Also note this function should
5359 * only be called from the driver's @sta_state callback.
5361 * @sta: the station to reserve the TID for
5362 * @tid: the TID to reserve
5364 * Returns: 0 on success, else on failure
5366 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5369 * ieee80211_unreserve_tid - request to unreserve a specific TID
5371 * Once there is no longer any need for reserving a certain TID, this function
5372 * should be called, and no longer will packets have their TID modified for
5373 * preventing use of this TID in the driver.
5375 * Note that this function blocks and acquires a lock, so it should be called
5376 * without driver locks held. Also note this function should only be called
5377 * from the driver's @sta_state callback.
5380 * @tid: the TID to unreserve
5382 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5385 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5387 * @hw: pointer as obtained from ieee80211_alloc_hw()
5388 * @txq: pointer obtained from station or virtual interface
5390 * Returns the skb if successful, %NULL if no frame was available.
5392 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5393 struct ieee80211_txq *txq);
5394 #endif /* MAC80211_H */