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.
90 * enum ieee80211_max_queues - maximum number of queues
92 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
93 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
95 enum ieee80211_max_queues {
96 IEEE80211_MAX_QUEUES = 16,
97 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
100 #define IEEE80211_INVAL_HW_QUEUE 0xff
103 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
104 * @IEEE80211_AC_VO: voice
105 * @IEEE80211_AC_VI: video
106 * @IEEE80211_AC_BE: best effort
107 * @IEEE80211_AC_BK: background
109 enum ieee80211_ac_numbers {
115 #define IEEE80211_NUM_ACS 4
118 * struct ieee80211_tx_queue_params - transmit queue configuration
120 * The information provided in this structure is required for QoS
121 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
123 * @aifs: arbitration interframe space [0..255]
124 * @cw_min: minimum contention window [a value of the form
125 * 2^n-1 in the range 1..32767]
126 * @cw_max: maximum contention window [like @cw_min]
127 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
128 * @acm: is mandatory admission control required for the access category
129 * @uapsd: is U-APSD mode enabled for the queue
131 struct ieee80211_tx_queue_params {
140 struct ieee80211_low_level_stats {
141 unsigned int dot11ACKFailureCount;
142 unsigned int dot11RTSFailureCount;
143 unsigned int dot11FCSErrorCount;
144 unsigned int dot11RTSSuccessCount;
148 * enum ieee80211_chanctx_change - change flag for channel context
149 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
150 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
152 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
153 * this is used only with channel switching with CSA
154 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
156 enum ieee80211_chanctx_change {
157 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
158 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
159 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
160 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
161 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
165 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
167 * This is the driver-visible part. The ieee80211_chanctx
168 * that contains it is visible in mac80211 only.
170 * @def: the channel definition
171 * @min_def: the minimum channel definition currently required.
172 * @rx_chains_static: The number of RX chains that must always be
173 * active on the channel to receive MIMO transmissions
174 * @rx_chains_dynamic: The number of RX chains that must be enabled
175 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
176 * this will always be >= @rx_chains_static.
177 * @radar_enabled: whether radar detection is enabled on this channel.
178 * @drv_priv: data area for driver use, will always be aligned to
179 * sizeof(void *), size is determined in hw information.
181 struct ieee80211_chanctx_conf {
182 struct cfg80211_chan_def def;
183 struct cfg80211_chan_def min_def;
185 u8 rx_chains_static, rx_chains_dynamic;
189 u8 drv_priv[0] __aligned(sizeof(void *));
193 * enum ieee80211_chanctx_switch_mode - channel context switch mode
194 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
195 * exist (and will continue to exist), but the virtual interface
196 * needs to be switched from one to the other.
197 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
198 * to exist with this call, the new context doesn't exist but
199 * will be active after this call, the virtual interface switches
200 * from the old to the new (note that the driver may of course
201 * implement this as an on-the-fly chandef switch of the existing
202 * hardware context, but the mac80211 pointer for the old context
203 * will cease to exist and only the new one will later be used
204 * for changes/removal.)
206 enum ieee80211_chanctx_switch_mode {
207 CHANCTX_SWMODE_REASSIGN_VIF,
208 CHANCTX_SWMODE_SWAP_CONTEXTS,
212 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
214 * This is structure is used to pass information about a vif that
215 * needs to switch from one chanctx to another. The
216 * &ieee80211_chanctx_switch_mode defines how the switch should be
219 * @vif: the vif that should be switched from old_ctx to new_ctx
220 * @old_ctx: the old context to which the vif was assigned
221 * @new_ctx: the new context to which the vif must be assigned
223 struct ieee80211_vif_chanctx_switch {
224 struct ieee80211_vif *vif;
225 struct ieee80211_chanctx_conf *old_ctx;
226 struct ieee80211_chanctx_conf *new_ctx;
230 * enum ieee80211_bss_change - BSS change notification flags
232 * These flags are used with the bss_info_changed() callback
233 * to indicate which BSS parameter changed.
235 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
236 * also implies a change in the AID.
237 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
238 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
239 * @BSS_CHANGED_ERP_SLOT: slot timing changed
240 * @BSS_CHANGED_HT: 802.11n parameters changed
241 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
242 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
243 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
244 * reason (IBSS and managed mode)
245 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
246 * new beacon (beaconing modes)
247 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
248 * enabled/disabled (beaconing modes)
249 * @BSS_CHANGED_CQM: Connection quality monitor config changed
250 * @BSS_CHANGED_IBSS: IBSS join status changed
251 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
252 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
253 * that it is only ever disabled for station mode.
254 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
255 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
256 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
257 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
258 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
259 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
260 * changed (currently only in P2P client mode, GO mode will be later)
261 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
262 * currently dtim_period only is under consideration.
263 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
264 * note that this is only called when it changes after the channel
265 * context had been assigned.
266 * @BSS_CHANGED_OCB: OCB join status changed
268 enum ieee80211_bss_change {
269 BSS_CHANGED_ASSOC = 1<<0,
270 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
271 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
272 BSS_CHANGED_ERP_SLOT = 1<<3,
273 BSS_CHANGED_HT = 1<<4,
274 BSS_CHANGED_BASIC_RATES = 1<<5,
275 BSS_CHANGED_BEACON_INT = 1<<6,
276 BSS_CHANGED_BSSID = 1<<7,
277 BSS_CHANGED_BEACON = 1<<8,
278 BSS_CHANGED_BEACON_ENABLED = 1<<9,
279 BSS_CHANGED_CQM = 1<<10,
280 BSS_CHANGED_IBSS = 1<<11,
281 BSS_CHANGED_ARP_FILTER = 1<<12,
282 BSS_CHANGED_QOS = 1<<13,
283 BSS_CHANGED_IDLE = 1<<14,
284 BSS_CHANGED_SSID = 1<<15,
285 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
286 BSS_CHANGED_PS = 1<<17,
287 BSS_CHANGED_TXPOWER = 1<<18,
288 BSS_CHANGED_P2P_PS = 1<<19,
289 BSS_CHANGED_BEACON_INFO = 1<<20,
290 BSS_CHANGED_BANDWIDTH = 1<<21,
291 BSS_CHANGED_OCB = 1<<22,
293 /* when adding here, make sure to change ieee80211_reconfig */
297 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
298 * of addresses for an interface increase beyond this value, hardware ARP
299 * filtering will be disabled.
301 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
304 * enum ieee80211_rssi_event - RSSI threshold event
305 * An indicator for when RSSI goes below/above a certain threshold.
306 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
307 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
309 enum ieee80211_rssi_event {
315 * struct ieee80211_bss_conf - holds the BSS's changing parameters
317 * This structure keeps information about a BSS (and an association
318 * to that BSS) that can change during the lifetime of the BSS.
320 * @assoc: association status
321 * @ibss_joined: indicates whether this station is part of an IBSS
323 * @ibss_creator: indicates if a new IBSS network is being created
324 * @aid: association ID number, valid only when @assoc is true
325 * @use_cts_prot: use CTS protection
326 * @use_short_preamble: use 802.11b short preamble;
327 * if the hardware cannot handle this it must set the
328 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
329 * @use_short_slot: use short slot time (only relevant for ERP);
330 * if the hardware cannot handle this it must set the
331 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
332 * @dtim_period: num of beacons before the next DTIM, for beaconing,
333 * valid in station mode only if after the driver was notified
334 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
335 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
336 * as it may have been received during scanning long ago). If the
337 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
338 * only come from a beacon, but might not become valid until after
339 * association when a beacon is received (which is notified with the
340 * %BSS_CHANGED_DTIM flag.)
341 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
342 * the driver/device can use this to calculate synchronisation
344 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
345 * is requested, see @sync_tsf/@sync_device_ts.
346 * @beacon_int: beacon interval
347 * @assoc_capability: capabilities taken from assoc resp
348 * @basic_rates: bitmap of basic rates, each bit stands for an
349 * index into the rate table configured by the driver in
351 * @beacon_rate: associated AP's beacon TX rate
352 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
353 * @bssid: The BSSID for this BSS
354 * @enable_beacon: whether beaconing should be enabled or not
355 * @chandef: Channel definition for this BSS -- the hardware might be
356 * configured a higher bandwidth than this BSS uses, for example.
357 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
358 * This field is only valid when the channel type is one of the HT types.
359 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
361 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
362 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
363 * may filter ARP queries targeted for other addresses than listed here.
364 * The driver must allow ARP queries targeted for all address listed here
365 * to pass through. An empty list implies no ARP queries need to pass.
366 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
367 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
368 * array size), it's up to the driver what to do in that case.
369 * @qos: This is a QoS-enabled BSS.
370 * @idle: This interface is idle. There's also a global idle flag in the
371 * hardware config which may be more appropriate depending on what
372 * your driver/device needs to do.
373 * @ps: power-save mode (STA only). This flag is NOT affected by
374 * offchannel/dynamic_ps operations.
375 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
376 * @ssid_len: Length of SSID given in @ssid.
377 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
378 * @txpower: TX power in dBm
379 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
381 struct ieee80211_bss_conf {
383 /* association related data */
384 bool assoc, ibss_joined;
387 /* erp related data */
389 bool use_short_preamble;
394 u16 assoc_capability;
399 struct ieee80211_rate *beacon_rate;
400 int mcast_rate[IEEE80211_NUM_BANDS];
401 u16 ht_operation_mode;
404 struct cfg80211_chan_def chandef;
405 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
410 u8 ssid[IEEE80211_MAX_SSID_LEN];
414 struct ieee80211_p2p_noa_attr p2p_noa_attr;
418 * enum mac80211_tx_info_flags - flags to describe transmission information/status
420 * These flags are used with the @flags member of &ieee80211_tx_info.
422 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
423 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
424 * number to this frame, taking care of not overwriting the fragment
425 * number and increasing the sequence number only when the
426 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
427 * assign sequence numbers to QoS-data frames but cannot do so correctly
428 * for non-QoS-data and management frames because beacons need them from
429 * that counter as well and mac80211 cannot guarantee proper sequencing.
430 * If this flag is set, the driver should instruct the hardware to
431 * assign a sequence number to the frame or assign one itself. Cf. IEEE
432 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
433 * beacons and always be clear for frames without a sequence number field.
434 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
435 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
437 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
438 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
439 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
440 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
441 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
442 * because the destination STA was in powersave mode. Note that to
443 * avoid race conditions, the filter must be set by the hardware or
444 * firmware upon receiving a frame that indicates that the station
445 * went to sleep (must be done on device to filter frames already on
446 * the queue) and may only be unset after mac80211 gives the OK for
447 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
448 * since only then is it guaranteed that no more frames are in the
450 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
451 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
452 * is for the whole aggregation.
453 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
454 * so consider using block ack request (BAR).
455 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
456 * set by rate control algorithms to indicate probe rate, will
457 * be cleared for fragmented frames (except on the last fragment)
458 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
459 * that a frame can be transmitted while the queues are stopped for
460 * off-channel operation.
461 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
462 * used to indicate that a pending frame requires TX processing before
463 * it can be sent out.
464 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
465 * used to indicate that a frame was already retried due to PS
466 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
467 * used to indicate frame should not be encrypted
468 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
469 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
470 * be sent although the station is in powersave mode.
471 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
472 * transmit function after the current frame, this can be used
473 * by drivers to kick the DMA queue only if unset or when the
475 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
476 * after TX status because the destination was asleep, it must not
477 * be modified again (no seqno assignment, crypto, etc.)
478 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
479 * code for connection establishment, this indicates that its status
480 * should kick the MLME state machine.
481 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
482 * MLME command (internal to mac80211 to figure out whether to send TX
483 * status to user space)
484 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
485 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
486 * frame and selects the maximum number of streams that it can use.
487 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
488 * the off-channel channel when a remain-on-channel offload is done
489 * in hardware -- normal packets still flow and are expected to be
490 * handled properly by the device.
491 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
492 * testing. It will be sent out with incorrect Michael MIC key to allow
493 * TKIP countermeasures to be tested.
494 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
495 * This flag is actually used for management frame especially for P2P
496 * frames not being sent at CCK rate in 2GHz band.
497 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
498 * when its status is reported the service period ends. For frames in
499 * an SP that mac80211 transmits, it is already set; for driver frames
500 * the driver may set this flag. It is also used to do the same for
502 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
503 * This flag is used to send nullfunc frame at minimum rate when
504 * the nullfunc is used for connection monitoring purpose.
505 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
506 * would be fragmented by size (this is optional, only used for
507 * monitor injection).
508 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
509 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
510 * any errors (like issues specific to the driver/HW).
511 * This flag must not be set for frames that don't request no-ack
512 * behaviour with IEEE80211_TX_CTL_NO_ACK.
514 * Note: If you have to add new flags to the enumeration, then don't
515 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
517 enum mac80211_tx_info_flags {
518 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
519 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
520 IEEE80211_TX_CTL_NO_ACK = BIT(2),
521 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
522 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
523 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
524 IEEE80211_TX_CTL_AMPDU = BIT(6),
525 IEEE80211_TX_CTL_INJECTED = BIT(7),
526 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
527 IEEE80211_TX_STAT_ACK = BIT(9),
528 IEEE80211_TX_STAT_AMPDU = BIT(10),
529 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
530 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
531 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
532 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
533 IEEE80211_TX_INTFL_RETRIED = BIT(15),
534 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
535 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
536 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
537 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
538 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
539 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
540 IEEE80211_TX_CTL_LDPC = BIT(22),
541 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
542 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
543 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
544 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
545 IEEE80211_TX_STATUS_EOSP = BIT(28),
546 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
547 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
548 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
551 #define IEEE80211_TX_CTL_STBC_SHIFT 23
554 * enum mac80211_tx_control_flags - flags to describe transmit control
556 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
557 * protocol frame (e.g. EAP)
558 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
559 * frame (PS-Poll or uAPSD).
561 * These flags are used in tx_info->control.flags.
563 enum mac80211_tx_control_flags {
564 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
565 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
569 * This definition is used as a mask to clear all temporary flags, which are
570 * set by the tx handlers for each transmission attempt by the mac80211 stack.
572 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
573 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
574 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
575 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
576 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
577 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
578 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
579 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
582 * enum mac80211_rate_control_flags - per-rate flags set by the
583 * Rate Control algorithm.
585 * These flags are set by the Rate control algorithm for each rate during tx,
586 * in the @flags member of struct ieee80211_tx_rate.
588 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
589 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
590 * This is set if the current BSS requires ERP protection.
591 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
592 * @IEEE80211_TX_RC_MCS: HT rate.
593 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
594 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
595 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
597 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
598 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
599 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
600 * (80+80 isn't supported yet)
601 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
602 * adjacent 20 MHz channels, if the current channel type is
603 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
604 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
606 enum mac80211_rate_control_flags {
607 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
608 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
609 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
611 /* rate index is an HT/VHT MCS instead of an index */
612 IEEE80211_TX_RC_MCS = BIT(3),
613 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
614 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
615 IEEE80211_TX_RC_DUP_DATA = BIT(6),
616 IEEE80211_TX_RC_SHORT_GI = BIT(7),
617 IEEE80211_TX_RC_VHT_MCS = BIT(8),
618 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
619 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
623 /* there are 40 bytes if you don't need the rateset to be kept */
624 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
626 /* if you do need the rateset, then you have less space */
627 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
629 /* maximum number of rate stages */
630 #define IEEE80211_TX_MAX_RATES 4
632 /* maximum number of rate table entries */
633 #define IEEE80211_TX_RATE_TABLE_SIZE 4
636 * struct ieee80211_tx_rate - rate selection/status
638 * @idx: rate index to attempt to send with
639 * @flags: rate control flags (&enum mac80211_rate_control_flags)
640 * @count: number of tries in this rate before going to the next rate
642 * A value of -1 for @idx indicates an invalid rate and, if used
643 * in an array of retry rates, that no more rates should be tried.
645 * When used for transmit status reporting, the driver should
646 * always report the rate along with the flags it used.
648 * &struct ieee80211_tx_info contains an array of these structs
649 * in the control information, and it will be filled by the rate
650 * control algorithm according to what should be sent. For example,
651 * if this array contains, in the format { <idx>, <count> } the
653 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
654 * then this means that the frame should be transmitted
655 * up to twice at rate 3, up to twice at rate 2, and up to four
656 * times at rate 1 if it doesn't get acknowledged. Say it gets
657 * acknowledged by the peer after the fifth attempt, the status
658 * information should then contain
659 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
660 * since it was transmitted twice at rate 3, twice at rate 2
661 * and once at rate 1 after which we received an acknowledgement.
663 struct ieee80211_tx_rate {
669 #define IEEE80211_MAX_TX_RETRY 31
671 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
675 WARN_ON((nss - 1) & ~0x7);
676 rate->idx = ((nss - 1) << 4) | mcs;
680 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
682 return rate->idx & 0xF;
686 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
688 return (rate->idx >> 4) + 1;
692 * struct ieee80211_tx_info - skb transmit information
694 * This structure is placed in skb->cb for three uses:
695 * (1) mac80211 TX control - mac80211 tells the driver what to do
696 * (2) driver internal use (if applicable)
697 * (3) TX status information - driver tells mac80211 what happened
699 * @flags: transmit info flags, defined above
700 * @band: the band to transmit on (use for checking for races)
701 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
702 * @ack_frame_id: internal frame ID for TX status, used internally
703 * @control: union for control data
704 * @status: union for status data
705 * @driver_data: array of driver_data pointers
706 * @ampdu_ack_len: number of acked aggregated frames.
707 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
708 * @ampdu_len: number of aggregated frames.
709 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
710 * @ack_signal: signal strength of the ACK frame
712 struct ieee80211_tx_info {
713 /* common information */
726 struct ieee80211_tx_rate rates[
727 IEEE80211_TX_MAX_RATES];
735 /* only needed before rate control */
736 unsigned long jiffies;
738 /* NB: vif can be NULL for injected frames */
739 struct ieee80211_vif *vif;
740 struct ieee80211_key_conf *hw_key;
745 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
751 void *status_driver_data[19 / sizeof(void *)];
754 struct ieee80211_tx_rate driver_rates[
755 IEEE80211_TX_MAX_RATES];
758 void *rate_driver_data[
759 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
762 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
767 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
769 * This structure is used to point to different blocks of IEs in HW scan
770 * and scheduled scan. These blocks contain the IEs passed by userspace
771 * and the ones generated by mac80211.
773 * @ies: pointers to band specific IEs.
774 * @len: lengths of band_specific IEs.
775 * @common_ies: IEs for all bands (especially vendor specific ones)
776 * @common_ie_len: length of the common_ies
778 struct ieee80211_scan_ies {
779 const u8 *ies[IEEE80211_NUM_BANDS];
780 size_t len[IEEE80211_NUM_BANDS];
781 const u8 *common_ies;
782 size_t common_ie_len;
786 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
788 return (struct ieee80211_tx_info *)skb->cb;
791 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
793 return (struct ieee80211_rx_status *)skb->cb;
797 * ieee80211_tx_info_clear_status - clear TX status
799 * @info: The &struct ieee80211_tx_info to be cleared.
801 * When the driver passes an skb back to mac80211, it must report
802 * a number of things in TX status. This function clears everything
803 * in the TX status but the rate control information (it does clear
804 * the count since you need to fill that in anyway).
806 * NOTE: You can only use this function if you do NOT use
807 * info->driver_data! Use info->rate_driver_data
808 * instead if you need only the less space that allows.
811 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
815 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
816 offsetof(struct ieee80211_tx_info, control.rates));
817 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
818 offsetof(struct ieee80211_tx_info, driver_rates));
819 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
820 /* clear the rate counts */
821 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
822 info->status.rates[i].count = 0;
825 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
826 memset(&info->status.ampdu_ack_len, 0,
827 sizeof(struct ieee80211_tx_info) -
828 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
833 * enum mac80211_rx_flags - receive flags
835 * These flags are used with the @flag member of &struct ieee80211_rx_status.
836 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
837 * Use together with %RX_FLAG_MMIC_STRIPPED.
838 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
839 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
840 * verification has been done by the hardware.
841 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
842 * If this flag is set, the stack cannot do any replay detection
843 * hence the driver or hardware will have to do that.
844 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
846 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
848 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
849 * field) is valid and contains the time the first symbol of the MPDU
850 * was received. This is useful in monitor mode and for proper IBSS
852 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
853 * field) is valid and contains the time the last symbol of the MPDU
854 * (including FCS) was received.
855 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
856 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
857 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
858 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
859 * @RX_FLAG_SHORT_GI: Short guard interval was used
860 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
861 * Valid only for data frames (mainly A-MPDU)
862 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
863 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
864 * to hw.radiotap_mcs_details to advertise that fact
865 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
866 * number (@ampdu_reference) must be populated and be a distinct number for
868 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
869 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
870 * monitoring purposes only
871 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
872 * subframes of a single A-MPDU
873 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
874 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
876 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
877 * is stored in the @ampdu_delimiter_crc field)
878 * @RX_FLAG_LDPC: LDPC was used
879 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
880 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
881 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
882 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
883 * subframes instead of a one huge frame for performance reasons.
884 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
885 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
886 * the 3rd (last) one must not have this flag set. The flag is used to
887 * deal with retransmission/duplication recovery properly since A-MSDU
888 * subframes share the same sequence number. Reported subframes can be
889 * either regular MSDU or singly A-MSDUs. Subframes must not be
890 * interleaved with other frames.
891 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
892 * radiotap data in the skb->data (before the frame) as described by
893 * the &struct ieee80211_vendor_radiotap.
895 enum mac80211_rx_flags {
896 RX_FLAG_MMIC_ERROR = BIT(0),
897 RX_FLAG_DECRYPTED = BIT(1),
898 RX_FLAG_MMIC_STRIPPED = BIT(3),
899 RX_FLAG_IV_STRIPPED = BIT(4),
900 RX_FLAG_FAILED_FCS_CRC = BIT(5),
901 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
902 RX_FLAG_MACTIME_START = BIT(7),
903 RX_FLAG_SHORTPRE = BIT(8),
905 RX_FLAG_40MHZ = BIT(10),
906 RX_FLAG_SHORT_GI = BIT(11),
907 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
908 RX_FLAG_HT_GF = BIT(13),
909 RX_FLAG_AMPDU_DETAILS = BIT(14),
910 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
911 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
912 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
913 RX_FLAG_AMPDU_IS_LAST = BIT(18),
914 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
915 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
916 RX_FLAG_MACTIME_END = BIT(21),
917 RX_FLAG_VHT = BIT(22),
918 RX_FLAG_LDPC = BIT(23),
919 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
920 RX_FLAG_10MHZ = BIT(28),
921 RX_FLAG_5MHZ = BIT(29),
922 RX_FLAG_AMSDU_MORE = BIT(30),
923 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
926 #define RX_FLAG_STBC_SHIFT 26
929 * enum mac80211_rx_vht_flags - receive VHT flags
931 * These flags are used with the @vht_flag member of
932 * &struct ieee80211_rx_status.
933 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
934 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
935 * @RX_VHT_FLAG_BF: packet was beamformed
937 enum mac80211_rx_vht_flags {
938 RX_VHT_FLAG_80MHZ = BIT(0),
939 RX_VHT_FLAG_160MHZ = BIT(1),
940 RX_VHT_FLAG_BF = BIT(2),
944 * struct ieee80211_rx_status - receive status
946 * The low-level driver should provide this information (the subset
947 * supported by hardware) to the 802.11 code with each received
948 * frame, in the skb's control buffer (cb).
950 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
951 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
952 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
953 * it but can store it and pass it back to the driver for synchronisation
954 * @band: the active band when this frame was received
955 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
956 * @signal: signal strength when receiving this frame, either in dBm, in dB or
957 * unspecified depending on the hardware capabilities flags
958 * @IEEE80211_HW_SIGNAL_*
959 * @chains: bitmask of receive chains for which separate signal strength
960 * values were filled.
961 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
962 * support dB or unspecified units)
963 * @antenna: antenna used
964 * @rate_idx: index of data rate into band's supported rates or MCS index if
965 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
966 * @vht_nss: number of streams (VHT only)
968 * @vht_flag: %RX_VHT_FLAG_*
969 * @rx_flags: internal RX flags for mac80211
970 * @ampdu_reference: A-MPDU reference number, must be a different value for
971 * each A-MPDU but the same for each subframe within one A-MPDU
972 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
974 struct ieee80211_rx_status {
976 u32 device_timestamp;
988 s8 chain_signal[IEEE80211_MAX_CHAINS];
989 u8 ampdu_delimiter_crc;
993 * struct ieee80211_vendor_radiotap - vendor radiotap data information
994 * @present: presence bitmap for this vendor namespace
995 * (this could be extended in the future if any vendor needs more
996 * bits, the radiotap spec does allow for that)
997 * @align: radiotap vendor namespace alignment. This defines the needed
998 * alignment for the @data field below, not for the vendor namespace
999 * description itself (which has a fixed 2-byte alignment)
1000 * Must be a power of two, and be set to at least 1!
1001 * @oui: radiotap vendor namespace OUI
1002 * @subns: radiotap vendor sub namespace
1003 * @len: radiotap vendor sub namespace skip length, if alignment is done
1004 * then that's added to this, i.e. this is only the length of the
1006 * @pad: number of bytes of padding after the @data, this exists so that
1007 * the skb data alignment can be preserved even if the data has odd
1009 * @data: the actual vendor namespace data
1011 * This struct, including the vendor data, goes into the skb->data before
1012 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1015 struct ieee80211_vendor_radiotap {
1026 * enum ieee80211_conf_flags - configuration flags
1028 * Flags to define PHY configuration options
1030 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1031 * to determine for example whether to calculate timestamps for packets
1032 * or not, do not use instead of filter flags!
1033 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1034 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1035 * meaning that the hardware still wakes up for beacons, is able to
1036 * transmit frames and receive the possible acknowledgment frames.
1037 * Not to be confused with hardware specific wakeup/sleep states,
1038 * driver is responsible for that. See the section "Powersave support"
1040 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1041 * the driver should be prepared to handle configuration requests but
1042 * may turn the device off as much as possible. Typically, this flag will
1043 * be set when an interface is set UP but not associated or scanning, but
1044 * it can also be unset in that case when monitor interfaces are active.
1045 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1046 * operating channel.
1048 enum ieee80211_conf_flags {
1049 IEEE80211_CONF_MONITOR = (1<<0),
1050 IEEE80211_CONF_PS = (1<<1),
1051 IEEE80211_CONF_IDLE = (1<<2),
1052 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1057 * enum ieee80211_conf_changed - denotes which configuration changed
1059 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1060 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1061 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1062 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1063 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1064 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1065 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1066 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1067 * Note that this is only valid if channel contexts are not used,
1068 * otherwise each channel context has the number of chains listed.
1070 enum ieee80211_conf_changed {
1071 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1072 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1073 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1074 IEEE80211_CONF_CHANGE_PS = BIT(4),
1075 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1076 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1077 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1078 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1082 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1084 * @IEEE80211_SMPS_AUTOMATIC: automatic
1085 * @IEEE80211_SMPS_OFF: off
1086 * @IEEE80211_SMPS_STATIC: static
1087 * @IEEE80211_SMPS_DYNAMIC: dynamic
1088 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1090 enum ieee80211_smps_mode {
1091 IEEE80211_SMPS_AUTOMATIC,
1093 IEEE80211_SMPS_STATIC,
1094 IEEE80211_SMPS_DYNAMIC,
1097 IEEE80211_SMPS_NUM_MODES,
1101 * struct ieee80211_conf - configuration of the device
1103 * This struct indicates how the driver shall configure the hardware.
1105 * @flags: configuration flags defined above
1107 * @listen_interval: listen interval in units of beacon interval
1108 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1109 * before checking the beacon for a TIM bit (managed mode only); this
1110 * value will be only achievable between DTIM frames, the hardware
1111 * needs to check for the multicast traffic bit in DTIM beacons.
1112 * This variable is valid only when the CONF_PS flag is set.
1113 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1114 * in power saving. Power saving will not be enabled until a beacon
1115 * has been received and the DTIM period is known.
1116 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1117 * powersave documentation below. This variable is valid only when
1118 * the CONF_PS flag is set.
1120 * @power_level: requested transmit power (in dBm), backward compatibility
1121 * value only that is set to the minimum of all interfaces
1123 * @chandef: the channel definition to tune to
1124 * @radar_enabled: whether radar detection is enabled
1126 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1127 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1128 * but actually means the number of transmissions not the number of retries
1129 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1130 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1131 * number of transmissions not the number of retries
1133 * @smps_mode: spatial multiplexing powersave mode; note that
1134 * %IEEE80211_SMPS_STATIC is used when the device is not
1135 * configured for an HT channel.
1136 * Note that this is only valid if channel contexts are not used,
1137 * otherwise each channel context has the number of chains listed.
1139 struct ieee80211_conf {
1141 int power_level, dynamic_ps_timeout;
1142 int max_sleep_period;
1144 u16 listen_interval;
1147 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1149 struct cfg80211_chan_def chandef;
1151 enum ieee80211_smps_mode smps_mode;
1155 * struct ieee80211_channel_switch - holds the channel switch data
1157 * The information provided in this structure is required for channel switch
1160 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1161 * Function (TSF) timer when the frame containing the channel switch
1162 * announcement was received. This is simply the rx.mactime parameter
1163 * the driver passed into mac80211.
1164 * @device_timestamp: arbitrary timestamp for the device, this is the
1165 * rx.device_timestamp parameter the driver passed to mac80211.
1166 * @block_tx: Indicates whether transmission must be blocked before the
1167 * scheduled channel switch, as indicated by the AP.
1168 * @chandef: the new channel to switch to
1169 * @count: the number of TBTT's until the channel switch event
1171 struct ieee80211_channel_switch {
1173 u32 device_timestamp;
1175 struct cfg80211_chan_def chandef;
1180 * enum ieee80211_vif_flags - virtual interface flags
1182 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1183 * on this virtual interface to avoid unnecessary CPU wakeups
1184 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1185 * monitoring on this virtual interface -- i.e. it can monitor
1186 * connection quality related parameters, such as the RSSI level and
1187 * provide notifications if configured trigger levels are reached.
1188 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1189 * interface. This flag should be set during interface addition,
1190 * but may be set/cleared as late as authentication to an AP. It is
1191 * only valid for managed/station mode interfaces.
1193 enum ieee80211_vif_flags {
1194 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1195 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1196 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1200 * struct ieee80211_vif - per-interface data
1202 * Data in this structure is continually present for driver
1203 * use during the life of a virtual interface.
1205 * @type: type of this virtual interface
1206 * @bss_conf: BSS configuration for this interface, either our own
1207 * or the BSS we're associated to
1208 * @addr: address of this interface
1209 * @p2p: indicates whether this AP or STA interface is a p2p
1210 * interface, i.e. a GO or p2p-sta respectively
1211 * @csa_active: marks whether a channel switch is going on. Internally it is
1212 * write-protected by sdata_lock and local->mtx so holding either is fine
1214 * @driver_flags: flags/capabilities the driver has for this interface,
1215 * these need to be set (or cleared) when the interface is added
1216 * or, if supported by the driver, the interface type is changed
1217 * at runtime, mac80211 will never touch this field
1218 * @hw_queue: hardware queue for each AC
1219 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1220 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1221 * when it is not assigned. This pointer is RCU-protected due to the TX
1222 * path needing to access it; even though the netdev carrier will always
1223 * be off when it is %NULL there can still be races and packets could be
1224 * processed after it switches back to %NULL.
1225 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1226 * interface debug files. Note that it will be NULL for the virtual
1227 * monitor interface (if that is requested.)
1228 * @drv_priv: data area for driver use, will always be aligned to
1231 struct ieee80211_vif {
1232 enum nl80211_iftype type;
1233 struct ieee80211_bss_conf bss_conf;
1239 u8 hw_queue[IEEE80211_NUM_ACS];
1241 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1245 #ifdef CONFIG_MAC80211_DEBUGFS
1246 struct dentry *debugfs_dir;
1250 u8 drv_priv[0] __aligned(sizeof(void *));
1253 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1255 #ifdef CONFIG_MAC80211_MESH
1256 return vif->type == NL80211_IFTYPE_MESH_POINT;
1262 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1263 * @wdev: the wdev to get the vif for
1265 * This can be used by mac80211 drivers with direct cfg80211 APIs
1266 * (like the vendor commands) that get a wdev.
1268 * Note that this function may return %NULL if the given wdev isn't
1269 * associated with a vif that the driver knows about (e.g. monitor
1270 * or AP_VLAN interfaces.)
1272 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1275 * enum ieee80211_key_flags - key flags
1277 * These flags are used for communication about keys between the driver
1278 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1280 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1281 * driver to indicate that it requires IV generation for this
1282 * particular key. Setting this flag does not necessarily mean that SKBs
1283 * will have sufficient tailroom for ICV or MIC.
1284 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1285 * the driver for a TKIP key if it requires Michael MIC
1286 * generation in software.
1287 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1288 * that the key is pairwise rather then a shared key.
1289 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1290 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1291 * be done in software.
1292 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1293 * if space should be prepared for the IV, but the IV
1294 * itself should not be generated. Do not set together with
1295 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1296 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1298 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1299 * management frames. The flag can help drivers that have a hardware
1300 * crypto implementation that doesn't deal with management frames
1301 * properly by allowing them to not upload the keys to hardware and
1302 * fall back to software crypto. Note that this flag deals only with
1303 * RX, if your crypto engine can't deal with TX you can also set the
1304 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1305 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1306 * driver for a CCMP key to indicate that is requires IV generation
1307 * only for managment frames (MFP).
1308 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1309 * driver for a key to indicate that sufficient tailroom must always
1310 * be reserved for ICV or MIC, even when HW encryption is enabled.
1312 enum ieee80211_key_flags {
1313 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1314 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1315 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1316 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1317 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1318 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1319 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1320 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1324 * struct ieee80211_key_conf - key information
1326 * This key information is given by mac80211 to the driver by
1327 * the set_key() callback in &struct ieee80211_ops.
1329 * @hw_key_idx: To be set by the driver, this is the key index the driver
1330 * wants to be given when a frame is transmitted and needs to be
1331 * encrypted in hardware.
1332 * @cipher: The key's cipher suite selector.
1333 * @flags: key flags, see &enum ieee80211_key_flags.
1334 * @keyidx: the key index (0-3)
1335 * @keylen: key material length
1336 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1338 * - Temporal Encryption Key (128 bits)
1339 * - Temporal Authenticator Tx MIC Key (64 bits)
1340 * - Temporal Authenticator Rx MIC Key (64 bits)
1341 * @icv_len: The ICV length for this key type
1342 * @iv_len: The IV length for this key type
1344 struct ieee80211_key_conf {
1356 * struct ieee80211_cipher_scheme - cipher scheme
1358 * This structure contains a cipher scheme information defining
1359 * the secure packet crypto handling.
1361 * @cipher: a cipher suite selector
1362 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1363 * @hdr_len: a length of a security header used the cipher
1364 * @pn_len: a length of a packet number in the security header
1365 * @pn_off: an offset of pn from the beginning of the security header
1366 * @key_idx_off: an offset of key index byte in the security header
1367 * @key_idx_mask: a bit mask of key_idx bits
1368 * @key_idx_shift: a bit shift needed to get key_idx
1369 * key_idx value calculation:
1370 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1371 * @mic_len: a mic length in bytes
1373 struct ieee80211_cipher_scheme {
1386 * enum set_key_cmd - key command
1388 * Used with the set_key() callback in &struct ieee80211_ops, this
1389 * indicates whether a key is being removed or added.
1391 * @SET_KEY: a key is set
1392 * @DISABLE_KEY: a key must be disabled
1395 SET_KEY, DISABLE_KEY,
1399 * enum ieee80211_sta_state - station state
1401 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1402 * this is a special state for add/remove transitions
1403 * @IEEE80211_STA_NONE: station exists without special state
1404 * @IEEE80211_STA_AUTH: station is authenticated
1405 * @IEEE80211_STA_ASSOC: station is associated
1406 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1408 enum ieee80211_sta_state {
1409 /* NOTE: These need to be ordered correctly! */
1410 IEEE80211_STA_NOTEXIST,
1413 IEEE80211_STA_ASSOC,
1414 IEEE80211_STA_AUTHORIZED,
1418 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1419 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1420 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1421 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1422 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1423 * (including 80+80 MHz)
1425 * Implementation note: 20 must be zero to be initialized
1426 * correctly, the values must be sorted.
1428 enum ieee80211_sta_rx_bandwidth {
1429 IEEE80211_STA_RX_BW_20 = 0,
1430 IEEE80211_STA_RX_BW_40,
1431 IEEE80211_STA_RX_BW_80,
1432 IEEE80211_STA_RX_BW_160,
1436 * struct ieee80211_sta_rates - station rate selection table
1438 * @rcu_head: RCU head used for freeing the table on update
1439 * @rate: transmit rates/flags to be used by default.
1440 * Overriding entries per-packet is possible by using cb tx control.
1442 struct ieee80211_sta_rates {
1443 struct rcu_head rcu_head;
1450 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1454 * struct ieee80211_sta - station table entry
1456 * A station table entry represents a station we are possibly
1457 * communicating with. Since stations are RCU-managed in
1458 * mac80211, any ieee80211_sta pointer you get access to must
1459 * either be protected by rcu_read_lock() explicitly or implicitly,
1460 * or you must take good care to not use such a pointer after a
1461 * call to your sta_remove callback that removed it.
1463 * @addr: MAC address
1464 * @aid: AID we assigned to the station if we're an AP
1465 * @supp_rates: Bitmap of supported rates (per band)
1466 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1467 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1468 * @wme: indicates whether the STA supports QoS/WME.
1469 * @drv_priv: data area for driver use, will always be aligned to
1470 * sizeof(void *), size is determined in hw information.
1471 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1472 * if wme is supported.
1473 * @max_sp: max Service Period. Only valid if wme is supported.
1474 * @bandwidth: current bandwidth the station can receive with
1475 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1476 * station can receive at the moment, changed by operating mode
1477 * notifications and capabilities. The value is only valid after
1478 * the station moves to associated state.
1479 * @smps_mode: current SMPS mode (off, static or dynamic)
1480 * @rates: rate control selection table
1481 * @tdls: indicates whether the STA is a TDLS peer
1482 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1483 * valid if the STA is a TDLS peer in the first place.
1485 struct ieee80211_sta {
1486 u32 supp_rates[IEEE80211_NUM_BANDS];
1489 struct ieee80211_sta_ht_cap ht_cap;
1490 struct ieee80211_sta_vht_cap vht_cap;
1495 enum ieee80211_sta_rx_bandwidth bandwidth;
1496 enum ieee80211_smps_mode smps_mode;
1497 struct ieee80211_sta_rates __rcu *rates;
1499 bool tdls_initiator;
1502 u8 drv_priv[0] __aligned(sizeof(void *));
1506 * enum sta_notify_cmd - sta notify command
1508 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1509 * indicates if an associated station made a power state transition.
1511 * @STA_NOTIFY_SLEEP: a station is now sleeping
1512 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1514 enum sta_notify_cmd {
1515 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1519 * struct ieee80211_tx_control - TX control data
1521 * @sta: station table entry, this sta pointer may be NULL and
1522 * it is not allowed to copy the pointer, due to RCU.
1524 struct ieee80211_tx_control {
1525 struct ieee80211_sta *sta;
1529 * enum ieee80211_hw_flags - hardware flags
1531 * These flags are used to indicate hardware capabilities to
1532 * the stack. Generally, flags here should have their meaning
1533 * done in a way that the simplest hardware doesn't need setting
1534 * any particular flags. There are some exceptions to this rule,
1535 * however, so you are advised to review these flags carefully.
1537 * @IEEE80211_HW_HAS_RATE_CONTROL:
1538 * The hardware or firmware includes rate control, and cannot be
1539 * controlled by the stack. As such, no rate control algorithm
1540 * should be instantiated, and the TX rate reported to userspace
1541 * will be taken from the TX status instead of the rate control
1543 * Note that this requires that the driver implement a number of
1544 * callbacks so it has the correct information, it needs to have
1545 * the @set_rts_threshold callback and must look at the BSS config
1546 * @use_cts_prot for G/N protection, @use_short_slot for slot
1547 * timing in 2.4 GHz and @use_short_preamble for preambles for
1550 * @IEEE80211_HW_RX_INCLUDES_FCS:
1551 * Indicates that received frames passed to the stack include
1552 * the FCS at the end.
1554 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1555 * Some wireless LAN chipsets buffer broadcast/multicast frames
1556 * for power saving stations in the hardware/firmware and others
1557 * rely on the host system for such buffering. This option is used
1558 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1559 * multicast frames when there are power saving stations so that
1560 * the driver can fetch them with ieee80211_get_buffered_bc().
1562 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1563 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1565 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1566 * Hardware is not capable of receiving frames with short preamble on
1569 * @IEEE80211_HW_SIGNAL_UNSPEC:
1570 * Hardware can provide signal values but we don't know its units. We
1571 * expect values between 0 and @max_signal.
1572 * If possible please provide dB or dBm instead.
1574 * @IEEE80211_HW_SIGNAL_DBM:
1575 * Hardware gives signal values in dBm, decibel difference from
1576 * one milliwatt. This is the preferred method since it is standardized
1577 * between different devices. @max_signal does not need to be set.
1579 * @IEEE80211_HW_SPECTRUM_MGMT:
1580 * Hardware supports spectrum management defined in 802.11h
1581 * Measurement, Channel Switch, Quieting, TPC
1583 * @IEEE80211_HW_AMPDU_AGGREGATION:
1584 * Hardware supports 11n A-MPDU aggregation.
1586 * @IEEE80211_HW_SUPPORTS_PS:
1587 * Hardware has power save support (i.e. can go to sleep).
1589 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1590 * Hardware requires nullfunc frame handling in stack, implies
1591 * stack support for dynamic PS.
1593 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1594 * Hardware has support for dynamic PS.
1596 * @IEEE80211_HW_MFP_CAPABLE:
1597 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1599 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1600 * Hardware can provide ack status reports of Tx frames to
1603 * @IEEE80211_HW_CONNECTION_MONITOR:
1604 * The hardware performs its own connection monitoring, including
1605 * periodic keep-alives to the AP and probing the AP on beacon loss.
1607 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1608 * This device needs to get data from beacon before association (i.e.
1611 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1612 * per-station GTKs as used by IBSS RSN or during fast transition. If
1613 * the device doesn't support per-station GTKs, but can be asked not
1614 * to decrypt group addressed frames, then IBSS RSN support is still
1615 * possible but software crypto will be used. Advertise the wiphy flag
1616 * only in that case.
1618 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1619 * autonomously manages the PS status of connected stations. When
1620 * this flag is set mac80211 will not trigger PS mode for connected
1621 * stations based on the PM bit of incoming frames.
1622 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1623 * the PS mode of connected stations.
1625 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1626 * setup strictly in HW. mac80211 should not attempt to do this in
1629 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1630 * a virtual monitor interface when monitor interfaces are the only
1631 * active interfaces.
1633 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1634 * be created. It is expected user-space will create vifs as
1635 * desired (and thus have them named as desired).
1637 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1638 * queue mapping in order to use different queues (not just one per AC)
1639 * for different virtual interfaces. See the doc section on HW queue
1640 * control for more details.
1642 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1643 * selection table provided by the rate control algorithm.
1645 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1646 * P2P Interface. This will be honoured even if more than one interface
1649 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1650 * only, to allow getting TBTT of a DTIM beacon.
1652 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1653 * and can cope with CCK rates in an aggregation session (e.g. by not
1654 * using aggregation for such frames.)
1656 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1657 * for a single active channel while using channel contexts. When support
1658 * is not enabled the default action is to disconnect when getting the
1661 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1662 * or tailroom of TX skbs without copying them first.
1664 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1665 * in one command, mac80211 doesn't have to run separate scans per band.
1667 enum ieee80211_hw_flags {
1668 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1669 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1670 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1671 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1672 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1673 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1674 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1675 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1676 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1677 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1678 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1679 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1680 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1681 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1682 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1683 IEEE80211_HW_NO_AUTO_VIF = 1<<15,
1685 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1686 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1687 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1688 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1689 IEEE80211_HW_AP_LINK_PS = 1<<22,
1690 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1691 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1692 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1693 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1694 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1695 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1696 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29,
1697 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
1701 * struct ieee80211_hw - hardware information and state
1703 * This structure contains the configuration and hardware
1704 * information for an 802.11 PHY.
1706 * @wiphy: This points to the &struct wiphy allocated for this
1707 * 802.11 PHY. You must fill in the @perm_addr and @dev
1708 * members of this structure using SET_IEEE80211_DEV()
1709 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1710 * bands (with channels, bitrates) are registered here.
1712 * @conf: &struct ieee80211_conf, device configuration, don't use.
1714 * @priv: pointer to private area that was allocated for driver use
1715 * along with this structure.
1717 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1719 * @extra_tx_headroom: headroom to reserve in each transmit skb
1720 * for use by the driver (e.g. for transmit headers.)
1722 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1723 * Can be used by drivers to add extra IEs.
1725 * @max_signal: Maximum value for signal (rssi) in RX information, used
1726 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1728 * @max_listen_interval: max listen interval in units of beacon interval
1731 * @queues: number of available hardware transmit queues for
1732 * data packets. WMM/QoS requires at least four, these
1733 * queues need to have configurable access parameters.
1735 * @rate_control_algorithm: rate control algorithm for this hardware.
1736 * If unset (NULL), the default algorithm will be used. Must be
1737 * set before calling ieee80211_register_hw().
1739 * @vif_data_size: size (in bytes) of the drv_priv data area
1740 * within &struct ieee80211_vif.
1741 * @sta_data_size: size (in bytes) of the drv_priv data area
1742 * within &struct ieee80211_sta.
1743 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1744 * within &struct ieee80211_chanctx_conf.
1746 * @max_rates: maximum number of alternate rate retry stages the hw
1748 * @max_report_rates: maximum number of alternate rate retry stages
1749 * the hw can report back.
1750 * @max_rate_tries: maximum number of tries for each stage
1752 * @max_rx_aggregation_subframes: maximum buffer size (number of
1753 * sub-frames) to be used for A-MPDU block ack receiver
1755 * This is only relevant if the device has restrictions on the
1756 * number of subframes, if it relies on mac80211 to do reordering
1757 * it shouldn't be set.
1759 * @max_tx_aggregation_subframes: maximum number of subframes in an
1760 * aggregate an HT driver will transmit, used by the peer as a
1761 * hint to size its reorder buffer.
1763 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1764 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1766 * @radiotap_mcs_details: lists which MCS information can the HW
1767 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1768 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1769 * adding _BW is supported today.
1771 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1772 * the default is _GI | _BANDWIDTH.
1773 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1775 * @netdev_features: netdev features to be set in each netdev created
1776 * from this HW. Note only HW checksum features are currently
1777 * compatible with mac80211. Other feature bits will be rejected.
1779 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1780 * for each access category if it is uAPSD trigger-enabled and delivery-
1781 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1782 * Each bit corresponds to different AC. Value '1' in specific bit means
1783 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1786 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1787 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1788 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1790 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1791 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1794 struct ieee80211_hw {
1795 struct ieee80211_conf conf;
1796 struct wiphy *wiphy;
1797 const char *rate_control_algorithm;
1800 unsigned int extra_tx_headroom;
1801 unsigned int extra_beacon_tailroom;
1804 int chanctx_data_size;
1806 u16 max_listen_interval;
1809 u8 max_report_rates;
1811 u8 max_rx_aggregation_subframes;
1812 u8 max_tx_aggregation_subframes;
1813 u8 offchannel_tx_hw_queue;
1814 u8 radiotap_mcs_details;
1815 u16 radiotap_vht_details;
1816 netdev_features_t netdev_features;
1818 u8 uapsd_max_sp_len;
1819 u8 n_cipher_schemes;
1820 const struct ieee80211_cipher_scheme *cipher_schemes;
1824 * struct ieee80211_scan_request - hw scan request
1826 * @ies: pointers different parts of IEs (in req.ie)
1827 * @req: cfg80211 request.
1829 struct ieee80211_scan_request {
1830 struct ieee80211_scan_ies ies;
1833 struct cfg80211_scan_request req;
1837 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
1839 * @sta: peer this TDLS channel-switch request/response came from
1840 * @chandef: channel referenced in a TDLS channel-switch request
1841 * @action_code: see &enum ieee80211_tdls_actioncode
1842 * @status: channel-switch response status
1843 * @timestamp: time at which the frame was received
1844 * @switch_time: switch-timing parameter received in the frame
1845 * @switch_timeout: switch-timing parameter received in the frame
1846 * @tmpl_skb: TDLS switch-channel response template
1847 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
1849 struct ieee80211_tdls_ch_sw_params {
1850 struct ieee80211_sta *sta;
1851 struct cfg80211_chan_def *chandef;
1857 struct sk_buff *tmpl_skb;
1862 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1864 * @wiphy: the &struct wiphy which we want to query
1866 * mac80211 drivers can use this to get to their respective
1867 * &struct ieee80211_hw. Drivers wishing to get to their own private
1868 * structure can then access it via hw->priv. Note that mac802111 drivers should
1869 * not use wiphy_priv() to try to get their private driver structure as this
1870 * is already used internally by mac80211.
1872 * Return: The mac80211 driver hw struct of @wiphy.
1874 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1877 * SET_IEEE80211_DEV - set device for 802.11 hardware
1879 * @hw: the &struct ieee80211_hw to set the device for
1880 * @dev: the &struct device of this 802.11 device
1882 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1884 set_wiphy_dev(hw->wiphy, dev);
1888 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1890 * @hw: the &struct ieee80211_hw to set the MAC address for
1891 * @addr: the address to set
1893 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1895 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1898 static inline struct ieee80211_rate *
1899 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1900 const struct ieee80211_tx_info *c)
1902 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1904 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1907 static inline struct ieee80211_rate *
1908 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1909 const struct ieee80211_tx_info *c)
1911 if (c->control.rts_cts_rate_idx < 0)
1913 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1916 static inline struct ieee80211_rate *
1917 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1918 const struct ieee80211_tx_info *c, int idx)
1920 if (c->control.rates[idx + 1].idx < 0)
1922 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1926 * ieee80211_free_txskb - free TX skb
1930 * Free a transmit skb. Use this funtion when some failure
1931 * to transmit happened and thus status cannot be reported.
1933 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1936 * DOC: Hardware crypto acceleration
1938 * mac80211 is capable of taking advantage of many hardware
1939 * acceleration designs for encryption and decryption operations.
1941 * The set_key() callback in the &struct ieee80211_ops for a given
1942 * device is called to enable hardware acceleration of encryption and
1943 * decryption. The callback takes a @sta parameter that will be NULL
1944 * for default keys or keys used for transmission only, or point to
1945 * the station information for the peer for individual keys.
1946 * Multiple transmission keys with the same key index may be used when
1947 * VLANs are configured for an access point.
1949 * When transmitting, the TX control data will use the @hw_key_idx
1950 * selected by the driver by modifying the &struct ieee80211_key_conf
1951 * pointed to by the @key parameter to the set_key() function.
1953 * The set_key() call for the %SET_KEY command should return 0 if
1954 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1955 * added; if you return 0 then hw_key_idx must be assigned to the
1956 * hardware key index, you are free to use the full u8 range.
1958 * When the cmd is %DISABLE_KEY then it must succeed.
1960 * Note that it is permissible to not decrypt a frame even if a key
1961 * for it has been uploaded to hardware, the stack will not make any
1962 * decision based on whether a key has been uploaded or not but rather
1963 * based on the receive flags.
1965 * The &struct ieee80211_key_conf structure pointed to by the @key
1966 * parameter is guaranteed to be valid until another call to set_key()
1967 * removes it, but it can only be used as a cookie to differentiate
1970 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1971 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1973 * The update_tkip_key() call updates the driver with the new phase 1 key.
1974 * This happens every time the iv16 wraps around (every 65536 packets). The
1975 * set_key() call will happen only once for each key (unless the AP did
1976 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1977 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1978 * handler is software decryption with wrap around of iv16.
1980 * The set_default_unicast_key() call updates the default WEP key index
1981 * configured to the hardware for WEP encryption type. This is required
1982 * for devices that support offload of data packets (e.g. ARP responses).
1986 * DOC: Powersave support
1988 * mac80211 has support for various powersave implementations.
1990 * First, it can support hardware that handles all powersaving by itself,
1991 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1992 * flag. In that case, it will be told about the desired powersave mode
1993 * with the %IEEE80211_CONF_PS flag depending on the association status.
1994 * The hardware must take care of sending nullfunc frames when necessary,
1995 * i.e. when entering and leaving powersave mode. The hardware is required
1996 * to look at the AID in beacons and signal to the AP that it woke up when
1997 * it finds traffic directed to it.
1999 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2000 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2001 * with hardware wakeup and sleep states. Driver is responsible for waking
2002 * up the hardware before issuing commands to the hardware and putting it
2003 * back to sleep at appropriate times.
2005 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2006 * buffered multicast/broadcast frames after the beacon. Also it must be
2007 * possible to send frames and receive the acknowledment frame.
2009 * Other hardware designs cannot send nullfunc frames by themselves and also
2010 * need software support for parsing the TIM bitmap. This is also supported
2011 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2012 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2013 * required to pass up beacons. The hardware is still required to handle
2014 * waking up for multicast traffic; if it cannot the driver must handle that
2015 * as best as it can, mac80211 is too slow to do that.
2017 * Dynamic powersave is an extension to normal powersave in which the
2018 * hardware stays awake for a user-specified period of time after sending a
2019 * frame so that reply frames need not be buffered and therefore delayed to
2020 * the next wakeup. It's compromise of getting good enough latency when
2021 * there's data traffic and still saving significantly power in idle
2024 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2025 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2026 * flag and mac80211 will handle everything automatically. Additionally,
2027 * hardware having support for the dynamic PS feature may set the
2028 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2029 * dynamic PS mode itself. The driver needs to look at the
2030 * @dynamic_ps_timeout hardware configuration value and use it that value
2031 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2032 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2033 * enabled whenever user has enabled powersave.
2035 * Driver informs U-APSD client support by enabling
2036 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2037 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2038 * Nullfunc frames and stay awake until the service period has ended. To
2039 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2040 * from that AC are transmitted with powersave enabled.
2042 * Note: U-APSD client mode is not yet supported with
2043 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2047 * DOC: Beacon filter support
2049 * Some hardware have beacon filter support to reduce host cpu wakeups
2050 * which will reduce system power consumption. It usually works so that
2051 * the firmware creates a checksum of the beacon but omits all constantly
2052 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2053 * beacon is forwarded to the host, otherwise it will be just dropped. That
2054 * way the host will only receive beacons where some relevant information
2055 * (for example ERP protection or WMM settings) have changed.
2057 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2058 * interface capability. The driver needs to enable beacon filter support
2059 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2060 * power save is enabled, the stack will not check for beacon loss and the
2061 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2063 * The time (or number of beacons missed) until the firmware notifies the
2064 * driver of a beacon loss event (which in turn causes the driver to call
2065 * ieee80211_beacon_loss()) should be configurable and will be controlled
2066 * by mac80211 and the roaming algorithm in the future.
2068 * Since there may be constantly changing information elements that nothing
2069 * in the software stack cares about, we will, in the future, have mac80211
2070 * tell the driver which information elements are interesting in the sense
2071 * that we want to see changes in them. This will include
2072 * - a list of information element IDs
2073 * - a list of OUIs for the vendor information element
2075 * Ideally, the hardware would filter out any beacons without changes in the
2076 * requested elements, but if it cannot support that it may, at the expense
2077 * of some efficiency, filter out only a subset. For example, if the device
2078 * doesn't support checking for OUIs it should pass up all changes in all
2079 * vendor information elements.
2081 * Note that change, for the sake of simplification, also includes information
2082 * elements appearing or disappearing from the beacon.
2084 * Some hardware supports an "ignore list" instead, just make sure nothing
2085 * that was requested is on the ignore list, and include commonly changing
2086 * information element IDs in the ignore list, for example 11 (BSS load) and
2087 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2088 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2089 * it could also include some currently unused IDs.
2092 * In addition to these capabilities, hardware should support notifying the
2093 * host of changes in the beacon RSSI. This is relevant to implement roaming
2094 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2095 * the received data packets). This can consist in notifying the host when
2096 * the RSSI changes significantly or when it drops below or rises above
2097 * configurable thresholds. In the future these thresholds will also be
2098 * configured by mac80211 (which gets them from userspace) to implement
2099 * them as the roaming algorithm requires.
2101 * If the hardware cannot implement this, the driver should ask it to
2102 * periodically pass beacon frames to the host so that software can do the
2103 * signal strength threshold checking.
2107 * DOC: Spatial multiplexing power save
2109 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2110 * power in an 802.11n implementation. For details on the mechanism
2111 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2112 * "11.2.3 SM power save".
2114 * The mac80211 implementation is capable of sending action frames
2115 * to update the AP about the station's SMPS mode, and will instruct
2116 * the driver to enter the specific mode. It will also announce the
2117 * requested SMPS mode during the association handshake. Hardware
2118 * support for this feature is required, and can be indicated by
2121 * The default mode will be "automatic", which nl80211/cfg80211
2122 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2123 * turned off otherwise.
2125 * To support this feature, the driver must set the appropriate
2126 * hardware support flags, and handle the SMPS flag to the config()
2127 * operation. It will then with this mechanism be instructed to
2128 * enter the requested SMPS mode while associated to an HT AP.
2132 * DOC: Frame filtering
2134 * mac80211 requires to see many management frames for proper
2135 * operation, and users may want to see many more frames when
2136 * in monitor mode. However, for best CPU usage and power consumption,
2137 * having as few frames as possible percolate through the stack is
2138 * desirable. Hence, the hardware should filter as much as possible.
2140 * To achieve this, mac80211 uses filter flags (see below) to tell
2141 * the driver's configure_filter() function which frames should be
2142 * passed to mac80211 and which should be filtered out.
2144 * Before configure_filter() is invoked, the prepare_multicast()
2145 * callback is invoked with the parameters @mc_count and @mc_list
2146 * for the combined multicast address list of all virtual interfaces.
2147 * It's use is optional, and it returns a u64 that is passed to
2148 * configure_filter(). Additionally, configure_filter() has the
2149 * arguments @changed_flags telling which flags were changed and
2150 * @total_flags with the new flag states.
2152 * If your device has no multicast address filters your driver will
2153 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2154 * parameter to see whether multicast frames should be accepted
2157 * All unsupported flags in @total_flags must be cleared.
2158 * Hardware does not support a flag if it is incapable of _passing_
2159 * the frame to the stack. Otherwise the driver must ignore
2160 * the flag, but not clear it.
2161 * You must _only_ clear the flag (announce no support for the
2162 * flag to mac80211) if you are not able to pass the packet type
2163 * to the stack (so the hardware always filters it).
2164 * So for example, you should clear @FIF_CONTROL, if your hardware
2165 * always filters control frames. If your hardware always passes
2166 * control frames to the kernel and is incapable of filtering them,
2167 * you do _not_ clear the @FIF_CONTROL flag.
2168 * This rule applies to all other FIF flags as well.
2172 * DOC: AP support for powersaving clients
2174 * In order to implement AP and P2P GO modes, mac80211 has support for
2175 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2176 * There currently is no support for sAPSD.
2178 * There is one assumption that mac80211 makes, namely that a client
2179 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2180 * Both are supported, and both can be used by the same client, but
2181 * they can't be used concurrently by the same client. This simplifies
2184 * The first thing to keep in mind is that there is a flag for complete
2185 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2186 * mac80211 expects the driver to handle most of the state machine for
2187 * powersaving clients and will ignore the PM bit in incoming frames.
2188 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2189 * stations' powersave transitions. In this mode, mac80211 also doesn't
2190 * handle PS-Poll/uAPSD.
2192 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2193 * PM bit in incoming frames for client powersave transitions. When a
2194 * station goes to sleep, we will stop transmitting to it. There is,
2195 * however, a race condition: a station might go to sleep while there is
2196 * data buffered on hardware queues. If the device has support for this
2197 * it will reject frames, and the driver should give the frames back to
2198 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2199 * cause mac80211 to retry the frame when the station wakes up. The
2200 * driver is also notified of powersave transitions by calling its
2201 * @sta_notify callback.
2203 * When the station is asleep, it has three choices: it can wake up,
2204 * it can PS-Poll, or it can possibly start a uAPSD service period.
2205 * Waking up is implemented by simply transmitting all buffered (and
2206 * filtered) frames to the station. This is the easiest case. When
2207 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2208 * will inform the driver of this with the @allow_buffered_frames
2209 * callback; this callback is optional. mac80211 will then transmit
2210 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2211 * on each frame. The last frame in the service period (or the only
2212 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2213 * indicate that it ends the service period; as this frame must have
2214 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2215 * When TX status is reported for this frame, the service period is
2216 * marked has having ended and a new one can be started by the peer.
2218 * Additionally, non-bufferable MMPDUs can also be transmitted by
2219 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2221 * Another race condition can happen on some devices like iwlwifi
2222 * when there are frames queued for the station and it wakes up
2223 * or polls; the frames that are already queued could end up being
2224 * transmitted first instead, causing reordering and/or wrong
2225 * processing of the EOSP. The cause is that allowing frames to be
2226 * transmitted to a certain station is out-of-band communication to
2227 * the device. To allow this problem to be solved, the driver can
2228 * call ieee80211_sta_block_awake() if frames are buffered when it
2229 * is notified that the station went to sleep. When all these frames
2230 * have been filtered (see above), it must call the function again
2231 * to indicate that the station is no longer blocked.
2233 * If the driver buffers frames in the driver for aggregation in any
2234 * way, it must use the ieee80211_sta_set_buffered() call when it is
2235 * notified of the station going to sleep to inform mac80211 of any
2236 * TIDs that have frames buffered. Note that when a station wakes up
2237 * this information is reset (hence the requirement to call it when
2238 * informed of the station going to sleep). Then, when a service
2239 * period starts for any reason, @release_buffered_frames is called
2240 * with the number of frames to be released and which TIDs they are
2241 * to come from. In this case, the driver is responsible for setting
2242 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2243 * to help the @more_data parameter is passed to tell the driver if
2244 * there is more data on other TIDs -- the TIDs to release frames
2245 * from are ignored since mac80211 doesn't know how many frames the
2246 * buffers for those TIDs contain.
2248 * If the driver also implement GO mode, where absence periods may
2249 * shorten service periods (or abort PS-Poll responses), it must
2250 * filter those response frames except in the case of frames that
2251 * are buffered in the driver -- those must remain buffered to avoid
2252 * reordering. Because it is possible that no frames are released
2253 * in this case, the driver must call ieee80211_sta_eosp()
2254 * to indicate to mac80211 that the service period ended anyway.
2256 * Finally, if frames from multiple TIDs are released from mac80211
2257 * but the driver might reorder them, it must clear & set the flags
2258 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2259 * and also take care of the EOSP and MORE_DATA bits in the frame.
2260 * The driver may also use ieee80211_sta_eosp() in this case.
2262 * Note that if the driver ever buffers frames other than QoS-data
2263 * frames, it must take care to never send a non-QoS-data frame as
2264 * the last frame in a service period, adding a QoS-nulldata frame
2265 * after a non-QoS-data frame if needed.
2269 * DOC: HW queue control
2271 * Before HW queue control was introduced, mac80211 only had a single static
2272 * assignment of per-interface AC software queues to hardware queues. This
2273 * was problematic for a few reasons:
2274 * 1) off-channel transmissions might get stuck behind other frames
2275 * 2) multiple virtual interfaces couldn't be handled correctly
2276 * 3) after-DTIM frames could get stuck behind other frames
2278 * To solve this, hardware typically uses multiple different queues for all
2279 * the different usages, and this needs to be propagated into mac80211 so it
2280 * won't have the same problem with the software queues.
2282 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2283 * flag that tells it that the driver implements its own queue control. To do
2284 * so, the driver will set up the various queues in each &struct ieee80211_vif
2285 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2286 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2287 * if necessary will queue the frame on the right software queue that mirrors
2288 * the hardware queue.
2289 * Additionally, the driver has to then use these HW queue IDs for the queue
2290 * management functions (ieee80211_stop_queue() et al.)
2292 * The driver is free to set up the queue mappings as needed, multiple virtual
2293 * interfaces may map to the same hardware queues if needed. The setup has to
2294 * happen during add_interface or change_interface callbacks. For example, a
2295 * driver supporting station+station and station+AP modes might decide to have
2296 * 10 hardware queues to handle different scenarios:
2298 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2299 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2300 * after-DTIM queue for AP: 8
2301 * off-channel queue: 9
2303 * It would then set up the hardware like this:
2304 * hw.offchannel_tx_hw_queue = 9
2306 * and the first virtual interface that is added as follows:
2307 * vif.hw_queue[IEEE80211_AC_VO] = 0
2308 * vif.hw_queue[IEEE80211_AC_VI] = 1
2309 * vif.hw_queue[IEEE80211_AC_BE] = 2
2310 * vif.hw_queue[IEEE80211_AC_BK] = 3
2311 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2312 * and the second virtual interface with 4-7.
2314 * If queue 6 gets full, for example, mac80211 would only stop the second
2315 * virtual interface's BE queue since virtual interface queues are per AC.
2317 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2318 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2319 * queue could potentially be shared since mac80211 will look at cab_queue when
2320 * a queue is stopped/woken even if the interface is not in AP mode.
2324 * enum ieee80211_filter_flags - hardware filter flags
2326 * These flags determine what the filter in hardware should be
2327 * programmed to let through and what should not be passed to the
2328 * stack. It is always safe to pass more frames than requested,
2329 * but this has negative impact on power consumption.
2331 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2332 * think of the BSS as your network segment and then this corresponds
2333 * to the regular ethernet device promiscuous mode.
2335 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2336 * by the user or if the hardware is not capable of filtering by
2337 * multicast address.
2339 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2340 * %RX_FLAG_FAILED_FCS_CRC for them)
2342 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2343 * the %RX_FLAG_FAILED_PLCP_CRC for them
2345 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2346 * to the hardware that it should not filter beacons or probe responses
2347 * by BSSID. Filtering them can greatly reduce the amount of processing
2348 * mac80211 needs to do and the amount of CPU wakeups, so you should
2349 * honour this flag if possible.
2351 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2352 * is not set then only those addressed to this station.
2354 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2356 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2357 * those addressed to this station.
2359 * @FIF_PROBE_REQ: pass probe request frames
2361 enum ieee80211_filter_flags {
2362 FIF_PROMISC_IN_BSS = 1<<0,
2363 FIF_ALLMULTI = 1<<1,
2365 FIF_PLCPFAIL = 1<<3,
2366 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2368 FIF_OTHER_BSS = 1<<6,
2370 FIF_PROBE_REQ = 1<<8,
2374 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2376 * These flags are used with the ampdu_action() callback in
2377 * &struct ieee80211_ops to indicate which action is needed.
2379 * Note that drivers MUST be able to deal with a TX aggregation
2380 * session being stopped even before they OK'ed starting it by
2381 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2382 * might receive the addBA frame and send a delBA right away!
2384 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2385 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2386 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2387 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2388 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2389 * queued packets, now unaggregated. After all packets are transmitted the
2390 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2391 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2392 * called when the station is removed. There's no need or reason to call
2393 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2394 * session is gone and removes the station.
2395 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2396 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2397 * now the connection is dropped and the station will be removed. Drivers
2398 * should clean up and drop remaining packets when this is called.
2400 enum ieee80211_ampdu_mlme_action {
2401 IEEE80211_AMPDU_RX_START,
2402 IEEE80211_AMPDU_RX_STOP,
2403 IEEE80211_AMPDU_TX_START,
2404 IEEE80211_AMPDU_TX_STOP_CONT,
2405 IEEE80211_AMPDU_TX_STOP_FLUSH,
2406 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2407 IEEE80211_AMPDU_TX_OPERATIONAL,
2411 * enum ieee80211_frame_release_type - frame release reason
2412 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2413 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2414 * frame received on trigger-enabled AC
2416 enum ieee80211_frame_release_type {
2417 IEEE80211_FRAME_RELEASE_PSPOLL,
2418 IEEE80211_FRAME_RELEASE_UAPSD,
2422 * enum ieee80211_rate_control_changed - flags to indicate what changed
2424 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2425 * to this station changed. The actual bandwidth is in the station
2426 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2427 * flag changes, for HT and VHT the bandwidth field changes.
2428 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2429 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2430 * changed (in IBSS mode) due to discovering more information about
2432 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2435 enum ieee80211_rate_control_changed {
2436 IEEE80211_RC_BW_CHANGED = BIT(0),
2437 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2438 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2439 IEEE80211_RC_NSS_CHANGED = BIT(3),
2443 * enum ieee80211_roc_type - remain on channel type
2445 * With the support for multi channel contexts and multi channel operations,
2446 * remain on channel operations might be limited/deferred/aborted by other
2447 * flows/operations which have higher priority (and vise versa).
2448 * Specifying the ROC type can be used by devices to prioritize the ROC
2449 * operations compared to other operations/flows.
2451 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2452 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2453 * for sending managment frames offchannel.
2455 enum ieee80211_roc_type {
2456 IEEE80211_ROC_TYPE_NORMAL = 0,
2457 IEEE80211_ROC_TYPE_MGMT_TX,
2461 * enum ieee80211_reconfig_complete_type - reconfig type
2463 * This enum is used by the reconfig_complete() callback to indicate what
2464 * reconfiguration type was completed.
2466 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2467 * (also due to resume() callback returning 1)
2468 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2469 * of wowlan configuration)
2471 enum ieee80211_reconfig_type {
2472 IEEE80211_RECONFIG_TYPE_RESTART,
2473 IEEE80211_RECONFIG_TYPE_SUSPEND,
2477 * struct ieee80211_ops - callbacks from mac80211 to the driver
2479 * This structure contains various callbacks that the driver may
2480 * handle or, in some cases, must handle, for example to configure
2481 * the hardware to a new channel or to transmit a frame.
2483 * @tx: Handler that 802.11 module calls for each transmitted frame.
2484 * skb contains the buffer starting from the IEEE 802.11 header.
2485 * The low-level driver should send the frame out based on
2486 * configuration in the TX control data. This handler should,
2487 * preferably, never fail and stop queues appropriately.
2490 * @start: Called before the first netdevice attached to the hardware
2491 * is enabled. This should turn on the hardware and must turn on
2492 * frame reception (for possibly enabled monitor interfaces.)
2493 * Returns negative error codes, these may be seen in userspace,
2495 * When the device is started it should not have a MAC address
2496 * to avoid acknowledging frames before a non-monitor device
2498 * Must be implemented and can sleep.
2500 * @stop: Called after last netdevice attached to the hardware
2501 * is disabled. This should turn off the hardware (at least
2502 * it must turn off frame reception.)
2503 * May be called right after add_interface if that rejects
2504 * an interface. If you added any work onto the mac80211 workqueue
2505 * you should ensure to cancel it on this callback.
2506 * Must be implemented and can sleep.
2508 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2509 * stop transmitting and doing any other configuration, and then
2510 * ask the device to suspend. This is only invoked when WoWLAN is
2511 * configured, otherwise the device is deconfigured completely and
2512 * reconfigured at resume time.
2513 * The driver may also impose special conditions under which it
2514 * wants to use the "normal" suspend (deconfigure), say if it only
2515 * supports WoWLAN when the device is associated. In this case, it
2516 * must return 1 from this function.
2518 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2519 * now resuming its operation, after this the device must be fully
2520 * functional again. If this returns an error, the only way out is
2521 * to also unregister the device. If it returns 1, then mac80211
2522 * will also go through the regular complete restart on resume.
2524 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2525 * modified. The reason is that device_set_wakeup_enable() is
2526 * supposed to be called when the configuration changes, not only
2529 * @add_interface: Called when a netdevice attached to the hardware is
2530 * enabled. Because it is not called for monitor mode devices, @start
2531 * and @stop must be implemented.
2532 * The driver should perform any initialization it needs before
2533 * the device can be enabled. The initial configuration for the
2534 * interface is given in the conf parameter.
2535 * The callback may refuse to add an interface by returning a
2536 * negative error code (which will be seen in userspace.)
2537 * Must be implemented and can sleep.
2539 * @change_interface: Called when a netdevice changes type. This callback
2540 * is optional, but only if it is supported can interface types be
2541 * switched while the interface is UP. The callback may sleep.
2542 * Note that while an interface is being switched, it will not be
2543 * found by the interface iteration callbacks.
2545 * @remove_interface: Notifies a driver that an interface is going down.
2546 * The @stop callback is called after this if it is the last interface
2547 * and no monitor interfaces are present.
2548 * When all interfaces are removed, the MAC address in the hardware
2549 * must be cleared so the device no longer acknowledges packets,
2550 * the mac_addr member of the conf structure is, however, set to the
2551 * MAC address of the device going away.
2552 * Hence, this callback must be implemented. It can sleep.
2554 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2555 * function to change hardware configuration, e.g., channel.
2556 * This function should never fail but returns a negative error code
2557 * if it does. The callback can sleep.
2559 * @bss_info_changed: Handler for configuration requests related to BSS
2560 * parameters that may vary during BSS's lifespan, and may affect low
2561 * level driver (e.g. assoc/disassoc status, erp parameters).
2562 * This function should not be used if no BSS has been set, unless
2563 * for association indication. The @changed parameter indicates which
2564 * of the bss parameters has changed when a call is made. The callback
2567 * @prepare_multicast: Prepare for multicast filter configuration.
2568 * This callback is optional, and its return value is passed
2569 * to configure_filter(). This callback must be atomic.
2571 * @configure_filter: Configure the device's RX filter.
2572 * See the section "Frame filtering" for more information.
2573 * This callback must be implemented and can sleep.
2575 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2576 * must be set or cleared for a given STA. Must be atomic.
2578 * @set_key: See the section "Hardware crypto acceleration"
2579 * This callback is only called between add_interface and
2580 * remove_interface calls, i.e. while the given virtual interface
2582 * Returns a negative error code if the key can't be added.
2583 * The callback can sleep.
2585 * @update_tkip_key: See the section "Hardware crypto acceleration"
2586 * This callback will be called in the context of Rx. Called for drivers
2587 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2588 * The callback must be atomic.
2590 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2591 * host is suspended, it can assign this callback to retrieve the data
2592 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2593 * After rekeying was done it should (for example during resume) notify
2594 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2596 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2597 * WEP when the device sends data packets autonomously, e.g. for ARP
2598 * offloading. The index can be 0-3, or -1 for unsetting it.
2600 * @hw_scan: Ask the hardware to service the scan request, no need to start
2601 * the scan state machine in stack. The scan must honour the channel
2602 * configuration done by the regulatory agent in the wiphy's
2603 * registered bands. The hardware (or the driver) needs to make sure
2604 * that power save is disabled.
2605 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2606 * entire IEs after the SSID, so that drivers need not look at these
2607 * at all but just send them after the SSID -- mac80211 includes the
2608 * (extended) supported rates and HT information (where applicable).
2609 * When the scan finishes, ieee80211_scan_completed() must be called;
2610 * note that it also must be called when the scan cannot finish due to
2611 * any error unless this callback returned a negative error code.
2612 * The callback can sleep.
2614 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2615 * The driver should ask the hardware to cancel the scan (if possible),
2616 * but the scan will be completed only after the driver will call
2617 * ieee80211_scan_completed().
2618 * This callback is needed for wowlan, to prevent enqueueing a new
2619 * scan_work after the low-level driver was already suspended.
2620 * The callback can sleep.
2622 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2623 * specific intervals. The driver must call the
2624 * ieee80211_sched_scan_results() function whenever it finds results.
2625 * This process will continue until sched_scan_stop is called.
2627 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2628 * In this case, ieee80211_sched_scan_stopped() must not be called.
2630 * @sw_scan_start: Notifier function that is called just before a software scan
2631 * is started. Can be NULL, if the driver doesn't need this notification.
2632 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2633 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2634 * can use this parameter. The callback can sleep.
2636 * @sw_scan_complete: Notifier function that is called just after a
2637 * software scan finished. Can be NULL, if the driver doesn't need
2638 * this notification.
2639 * The callback can sleep.
2641 * @get_stats: Return low-level statistics.
2642 * Returns zero if statistics are available.
2643 * The callback can sleep.
2645 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2646 * callback should be provided to read the TKIP transmit IVs (both IV32
2647 * and IV16) for the given key from hardware.
2648 * The callback must be atomic.
2650 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2651 * if the device does fragmentation by itself; if this callback is
2652 * implemented then the stack will not do fragmentation.
2653 * The callback can sleep.
2655 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2656 * The callback can sleep.
2658 * @sta_add: Notifies low level driver about addition of an associated station,
2659 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2661 * @sta_remove: Notifies low level driver about removal of an associated
2662 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2663 * returns it isn't safe to use the pointer, not even RCU protected;
2664 * no RCU grace period is guaranteed between returning here and freeing
2665 * the station. See @sta_pre_rcu_remove if needed.
2666 * This callback can sleep.
2668 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2669 * when a station is added to mac80211's station list. This callback
2670 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2671 * conditional. This callback can sleep.
2673 * @sta_remove_debugfs: Remove the debugfs files which were added using
2674 * @sta_add_debugfs. This callback can sleep.
2676 * @sta_notify: Notifies low level driver about power state transition of an
2677 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2678 * in AP mode, this callback will not be called when the flag
2679 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2681 * @sta_state: Notifies low level driver about state transition of a
2682 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2683 * This callback is mutually exclusive with @sta_add/@sta_remove.
2684 * It must not fail for down transitions but may fail for transitions
2685 * up the list of states. Also note that after the callback returns it
2686 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2687 * period is guaranteed between returning here and freeing the station.
2688 * See @sta_pre_rcu_remove if needed.
2689 * The callback can sleep.
2691 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2692 * synchronisation. This is useful if a driver needs to have station
2693 * pointers protected using RCU, it can then use this call to clear
2694 * the pointers instead of waiting for an RCU grace period to elapse
2696 * The callback can sleep.
2698 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2699 * used to transmit to the station. The changes are advertised with bits
2700 * from &enum ieee80211_rate_control_changed and the values are reflected
2701 * in the station data. This callback should only be used when the driver
2702 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2703 * otherwise the rate control algorithm is notified directly.
2705 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2706 * is only used if the configured rate control algorithm actually uses
2707 * the new rate table API, and is therefore optional. Must be atomic.
2709 * @sta_statistics: Get statistics for this station. For example with beacon
2710 * filtering, the statistics kept by mac80211 might not be accurate, so
2711 * let the driver pre-fill the statistics. The driver can fill most of
2712 * the values (indicating which by setting the filled bitmap), but not
2713 * all of them make sense - see the source for which ones are possible.
2714 * Statistics that the driver doesn't fill will be filled by mac80211.
2715 * The callback can sleep.
2717 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2718 * bursting) for a hardware TX queue.
2719 * Returns a negative error code on failure.
2720 * The callback can sleep.
2722 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2723 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2724 * required function.
2725 * The callback can sleep.
2727 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2728 * Currently, this is only used for IBSS mode debugging. Is not a
2729 * required function.
2730 * The callback can sleep.
2732 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2733 * with other STAs in the IBSS. This is only used in IBSS mode. This
2734 * function is optional if the firmware/hardware takes full care of
2735 * TSF synchronization.
2736 * The callback can sleep.
2738 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2739 * This is needed only for IBSS mode and the result of this function is
2740 * used to determine whether to reply to Probe Requests.
2741 * Returns non-zero if this device sent the last beacon.
2742 * The callback can sleep.
2744 * @ampdu_action: Perform a certain A-MPDU action
2745 * The RA/TID combination determines the destination and TID we want
2746 * the ampdu action to be performed for. The action is defined through
2747 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2748 * is the first frame we expect to perform the action on. Notice
2749 * that TX/RX_STOP can pass NULL for this parameter.
2750 * The @buf_size parameter is only valid when the action is set to
2751 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2752 * buffer size (number of subframes) for this session -- the driver
2753 * may neither send aggregates containing more subframes than this
2754 * nor send aggregates in a way that lost frames would exceed the
2755 * buffer size. If just limiting the aggregate size, this would be
2756 * possible with a buf_size of 8:
2758 * - RX: 2....7 (lost frame #1)
2760 * which is invalid since #1 was now re-transmitted well past the
2761 * buffer size of 8. Correct ways to retransmit #1 would be:
2762 * - TX: 1 or 18 or 81
2763 * Even "189" would be wrong since 1 could be lost again.
2765 * Returns a negative error code on failure.
2766 * The callback can sleep.
2768 * @get_survey: Return per-channel survey information
2770 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2771 * need to set wiphy->rfkill_poll to %true before registration,
2772 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2773 * The callback can sleep.
2775 * @set_coverage_class: Set slot time for given coverage class as specified
2776 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2777 * accordingly; coverage class equals to -1 to enable ACK timeout
2778 * estimation algorithm (dynack). To disable dynack set valid value for
2779 * coverage class. This callback is not required and may sleep.
2781 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2782 * be %NULL. The callback can sleep.
2783 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2785 * @flush: Flush all pending frames from the hardware queue, making sure
2786 * that the hardware queues are empty. The @queues parameter is a bitmap
2787 * of queues to flush, which is useful if different virtual interfaces
2788 * use different hardware queues; it may also indicate all queues.
2789 * If the parameter @drop is set to %true, pending frames may be dropped.
2790 * Note that vif can be NULL.
2791 * The callback can sleep.
2793 * @channel_switch: Drivers that need (or want) to offload the channel
2794 * switch operation for CSAs received from the AP may implement this
2795 * callback. They must then call ieee80211_chswitch_done() to indicate
2796 * completion of the channel switch.
2798 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2799 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2800 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2801 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2803 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2805 * @remain_on_channel: Starts an off-channel period on the given channel, must
2806 * call back to ieee80211_ready_on_channel() when on that channel. Note
2807 * that normal channel traffic is not stopped as this is intended for hw
2808 * offload. Frames to transmit on the off-channel channel are transmitted
2809 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2810 * duration (which will always be non-zero) expires, the driver must call
2811 * ieee80211_remain_on_channel_expired().
2812 * Note that this callback may be called while the device is in IDLE and
2813 * must be accepted in this case.
2814 * This callback may sleep.
2815 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2816 * aborted before it expires. This callback may sleep.
2818 * @set_ringparam: Set tx and rx ring sizes.
2820 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2822 * @tx_frames_pending: Check if there is any pending frame in the hardware
2823 * queues before entering power save.
2825 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2826 * when transmitting a frame. Currently only legacy rates are handled.
2827 * The callback can sleep.
2828 * @rssi_callback: Notify driver when the average RSSI goes above/below
2829 * thresholds that were registered previously. The callback can sleep.
2831 * @release_buffered_frames: Release buffered frames according to the given
2832 * parameters. In the case where the driver buffers some frames for
2833 * sleeping stations mac80211 will use this callback to tell the driver
2834 * to release some frames, either for PS-poll or uAPSD.
2835 * Note that if the @more_data parameter is %false the driver must check
2836 * if there are more frames on the given TIDs, and if there are more than
2837 * the frames being released then it must still set the more-data bit in
2838 * the frame. If the @more_data parameter is %true, then of course the
2839 * more-data bit must always be set.
2840 * The @tids parameter tells the driver which TIDs to release frames
2841 * from, for PS-poll it will always have only a single bit set.
2842 * In the case this is used for a PS-poll initiated release, the
2843 * @num_frames parameter will always be 1 so code can be shared. In
2844 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2845 * on the TX status (and must report TX status) so that the PS-poll
2846 * period is properly ended. This is used to avoid sending multiple
2847 * responses for a retried PS-poll frame.
2848 * In the case this is used for uAPSD, the @num_frames parameter may be
2849 * bigger than one, but the driver may send fewer frames (it must send
2850 * at least one, however). In this case it is also responsible for
2851 * setting the EOSP flag in the QoS header of the frames. Also, when the
2852 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2853 * on the last frame in the SP. Alternatively, it may call the function
2854 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2855 * This callback must be atomic.
2856 * @allow_buffered_frames: Prepare device to allow the given number of frames
2857 * to go out to the given station. The frames will be sent by mac80211
2858 * via the usual TX path after this call. The TX information for frames
2859 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2860 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2861 * frames from multiple TIDs are released and the driver might reorder
2862 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2863 * on the last frame and clear it on all others and also handle the EOSP
2864 * bit in the QoS header correctly. Alternatively, it can also call the
2865 * ieee80211_sta_eosp() function.
2866 * The @tids parameter is a bitmap and tells the driver which TIDs the
2867 * frames will be on; it will at most have two bits set.
2868 * This callback must be atomic.
2870 * @get_et_sset_count: Ethtool API to get string-set count.
2872 * @get_et_stats: Ethtool API to get a set of u64 stats.
2874 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2875 * and perhaps other supported types of ethtool data-sets.
2877 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2878 * before associated. In multi-channel scenarios, a virtual interface is
2879 * bound to a channel before it is associated, but as it isn't associated
2880 * yet it need not necessarily be given airtime, in particular since any
2881 * transmission to a P2P GO needs to be synchronized against the GO's
2882 * powersave state. mac80211 will call this function before transmitting a
2883 * management frame prior to having successfully associated to allow the
2884 * driver to give it channel time for the transmission, to get a response
2885 * and to be able to synchronize with the GO.
2886 * The callback will be called before each transmission and upon return
2887 * mac80211 will transmit the frame right away.
2888 * The callback is optional and can (should!) sleep.
2890 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2891 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2892 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2893 * setup-response is a direct packet not buffered by the AP.
2894 * mac80211 will call this function just before the transmission of a TDLS
2895 * discovery-request. The recommended period of protection is at least
2896 * 2 * (DTIM period).
2897 * The callback is optional and can sleep.
2899 * @add_chanctx: Notifies device driver about new channel context creation.
2900 * @remove_chanctx: Notifies device driver about channel context destruction.
2901 * @change_chanctx: Notifies device driver about channel context changes that
2902 * may happen when combining different virtual interfaces on the same
2903 * channel context with different settings
2904 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2905 * to vif. Possible use is for hw queue remapping.
2906 * @unassign_vif_chanctx: Notifies device driver about channel context being
2908 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2909 * another, as specified in the list of
2910 * @ieee80211_vif_chanctx_switch passed to the driver, according
2911 * to the mode defined in &ieee80211_chanctx_switch_mode.
2913 * @start_ap: Start operation on the AP interface, this is called after all the
2914 * information in bss_conf is set and beacon can be retrieved. A channel
2915 * context is bound before this is called. Note that if the driver uses
2916 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2917 * just "paused" for scanning/ROC, which is indicated by the beacon being
2918 * disabled/enabled via @bss_info_changed.
2919 * @stop_ap: Stop operation on the AP interface.
2921 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
2922 * during resume, when the reconfiguration has completed.
2923 * This can help the driver implement the reconfiguration step (and
2924 * indicate mac80211 is ready to receive frames).
2925 * This callback may sleep.
2927 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2928 * Currently, this is only called for managed or P2P client interfaces.
2929 * This callback is optional; it must not sleep.
2931 * @channel_switch_beacon: Starts a channel switch to a new channel.
2932 * Beacons are modified to include CSA or ECSA IEs before calling this
2933 * function. The corresponding count fields in these IEs must be
2934 * decremented, and when they reach 1 the driver must call
2935 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2936 * get the csa counter decremented by mac80211, but must check if it is
2937 * 1 using ieee80211_csa_is_complete() after the beacon has been
2938 * transmitted and then call ieee80211_csa_finish().
2939 * If the CSA count starts as zero or 1, this function will not be called,
2940 * since there won't be any time to beacon before the switch anyway.
2941 * @pre_channel_switch: This is an optional callback that is called
2942 * before a channel switch procedure is started (ie. when a STA
2943 * gets a CSA or an userspace initiated channel-switch), allowing
2944 * the driver to prepare for the channel switch.
2945 * @post_channel_switch: This is an optional callback that is called
2946 * after a channel switch procedure is completed, allowing the
2947 * driver to go back to a normal configuration.
2949 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2950 * information in bss_conf is set up and the beacon can be retrieved. A
2951 * channel context is bound before this is called.
2952 * @leave_ibss: Leave the IBSS again.
2954 * @get_expected_throughput: extract the expected throughput towards the
2955 * specified station. The returned value is expressed in Kbps. It returns 0
2956 * if the RC algorithm does not have proper data to provide.
2958 * @get_txpower: get current maximum tx power (in dBm) based on configuration
2959 * and hardware limits.
2961 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2962 * is responsible for continually initiating channel-switching operations
2963 * and returning to the base channel for communication with the AP. The
2964 * driver receives a channel-switch request template and the location of
2965 * the switch-timing IE within the template as part of the invocation.
2966 * The template is valid only within the call, and the driver can
2967 * optionally copy the skb for further re-use.
2968 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2969 * peers must be on the base channel when the call completes.
2970 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
2971 * response) has been received from a remote peer. The driver gets
2972 * parameters parsed from the incoming frame and may use them to continue
2973 * an ongoing channel-switch operation. In addition, a channel-switch
2974 * response template is provided, together with the location of the
2975 * switch-timing IE within the template. The skb can only be used within
2976 * the function call.
2978 struct ieee80211_ops {
2979 void (*tx)(struct ieee80211_hw *hw,
2980 struct ieee80211_tx_control *control,
2981 struct sk_buff *skb);
2982 int (*start)(struct ieee80211_hw *hw);
2983 void (*stop)(struct ieee80211_hw *hw);
2985 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2986 int (*resume)(struct ieee80211_hw *hw);
2987 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2989 int (*add_interface)(struct ieee80211_hw *hw,
2990 struct ieee80211_vif *vif);
2991 int (*change_interface)(struct ieee80211_hw *hw,
2992 struct ieee80211_vif *vif,
2993 enum nl80211_iftype new_type, bool p2p);
2994 void (*remove_interface)(struct ieee80211_hw *hw,
2995 struct ieee80211_vif *vif);
2996 int (*config)(struct ieee80211_hw *hw, u32 changed);
2997 void (*bss_info_changed)(struct ieee80211_hw *hw,
2998 struct ieee80211_vif *vif,
2999 struct ieee80211_bss_conf *info,
3002 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3003 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3005 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3006 struct netdev_hw_addr_list *mc_list);
3007 void (*configure_filter)(struct ieee80211_hw *hw,
3008 unsigned int changed_flags,
3009 unsigned int *total_flags,
3011 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3013 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3014 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3015 struct ieee80211_key_conf *key);
3016 void (*update_tkip_key)(struct ieee80211_hw *hw,
3017 struct ieee80211_vif *vif,
3018 struct ieee80211_key_conf *conf,
3019 struct ieee80211_sta *sta,
3020 u32 iv32, u16 *phase1key);
3021 void (*set_rekey_data)(struct ieee80211_hw *hw,
3022 struct ieee80211_vif *vif,
3023 struct cfg80211_gtk_rekey_data *data);
3024 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3025 struct ieee80211_vif *vif, int idx);
3026 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3027 struct ieee80211_scan_request *req);
3028 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3029 struct ieee80211_vif *vif);
3030 int (*sched_scan_start)(struct ieee80211_hw *hw,
3031 struct ieee80211_vif *vif,
3032 struct cfg80211_sched_scan_request *req,
3033 struct ieee80211_scan_ies *ies);
3034 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3035 struct ieee80211_vif *vif);
3036 void (*sw_scan_start)(struct ieee80211_hw *hw,
3037 struct ieee80211_vif *vif,
3038 const u8 *mac_addr);
3039 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3040 struct ieee80211_vif *vif);
3041 int (*get_stats)(struct ieee80211_hw *hw,
3042 struct ieee80211_low_level_stats *stats);
3043 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
3044 u32 *iv32, u16 *iv16);
3045 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3046 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3047 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3048 struct ieee80211_sta *sta);
3049 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3050 struct ieee80211_sta *sta);
3051 #ifdef CONFIG_MAC80211_DEBUGFS
3052 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3053 struct ieee80211_vif *vif,
3054 struct ieee80211_sta *sta,
3055 struct dentry *dir);
3056 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3057 struct ieee80211_vif *vif,
3058 struct ieee80211_sta *sta,
3059 struct dentry *dir);
3061 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3062 enum sta_notify_cmd, struct ieee80211_sta *sta);
3063 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3064 struct ieee80211_sta *sta,
3065 enum ieee80211_sta_state old_state,
3066 enum ieee80211_sta_state new_state);
3067 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3068 struct ieee80211_vif *vif,
3069 struct ieee80211_sta *sta);
3070 void (*sta_rc_update)(struct ieee80211_hw *hw,
3071 struct ieee80211_vif *vif,
3072 struct ieee80211_sta *sta,
3074 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3075 struct ieee80211_vif *vif,
3076 struct ieee80211_sta *sta);
3077 void (*sta_statistics)(struct ieee80211_hw *hw,
3078 struct ieee80211_vif *vif,
3079 struct ieee80211_sta *sta,
3080 struct station_info *sinfo);
3081 int (*conf_tx)(struct ieee80211_hw *hw,
3082 struct ieee80211_vif *vif, u16 ac,
3083 const struct ieee80211_tx_queue_params *params);
3084 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3085 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3087 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3088 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3089 int (*ampdu_action)(struct ieee80211_hw *hw,
3090 struct ieee80211_vif *vif,
3091 enum ieee80211_ampdu_mlme_action action,
3092 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3094 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3095 struct survey_info *survey);
3096 void (*rfkill_poll)(struct ieee80211_hw *hw);
3097 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3098 #ifdef CONFIG_NL80211_TESTMODE
3099 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3100 void *data, int len);
3101 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3102 struct netlink_callback *cb,
3103 void *data, int len);
3105 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3106 u32 queues, bool drop);
3107 void (*channel_switch)(struct ieee80211_hw *hw,
3108 struct ieee80211_vif *vif,
3109 struct ieee80211_channel_switch *ch_switch);
3110 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3111 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3113 int (*remain_on_channel)(struct ieee80211_hw *hw,
3114 struct ieee80211_vif *vif,
3115 struct ieee80211_channel *chan,
3117 enum ieee80211_roc_type type);
3118 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3119 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3120 void (*get_ringparam)(struct ieee80211_hw *hw,
3121 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3122 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3123 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3124 const struct cfg80211_bitrate_mask *mask);
3125 void (*rssi_callback)(struct ieee80211_hw *hw,
3126 struct ieee80211_vif *vif,
3127 enum ieee80211_rssi_event rssi_event);
3129 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3130 struct ieee80211_sta *sta,
3131 u16 tids, int num_frames,
3132 enum ieee80211_frame_release_type reason,
3134 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3135 struct ieee80211_sta *sta,
3136 u16 tids, int num_frames,
3137 enum ieee80211_frame_release_type reason,
3140 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3141 struct ieee80211_vif *vif, int sset);
3142 void (*get_et_stats)(struct ieee80211_hw *hw,
3143 struct ieee80211_vif *vif,
3144 struct ethtool_stats *stats, u64 *data);
3145 void (*get_et_strings)(struct ieee80211_hw *hw,
3146 struct ieee80211_vif *vif,
3147 u32 sset, u8 *data);
3149 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3150 struct ieee80211_vif *vif);
3152 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3153 struct ieee80211_vif *vif);
3155 int (*add_chanctx)(struct ieee80211_hw *hw,
3156 struct ieee80211_chanctx_conf *ctx);
3157 void (*remove_chanctx)(struct ieee80211_hw *hw,
3158 struct ieee80211_chanctx_conf *ctx);
3159 void (*change_chanctx)(struct ieee80211_hw *hw,
3160 struct ieee80211_chanctx_conf *ctx,
3162 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3163 struct ieee80211_vif *vif,
3164 struct ieee80211_chanctx_conf *ctx);
3165 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3166 struct ieee80211_vif *vif,
3167 struct ieee80211_chanctx_conf *ctx);
3168 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3169 struct ieee80211_vif_chanctx_switch *vifs,
3171 enum ieee80211_chanctx_switch_mode mode);
3173 void (*reconfig_complete)(struct ieee80211_hw *hw,
3174 enum ieee80211_reconfig_type reconfig_type);
3176 #if IS_ENABLED(CONFIG_IPV6)
3177 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3178 struct ieee80211_vif *vif,
3179 struct inet6_dev *idev);
3181 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3182 struct ieee80211_vif *vif,
3183 struct cfg80211_chan_def *chandef);
3184 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3185 struct ieee80211_vif *vif,
3186 struct ieee80211_channel_switch *ch_switch);
3188 int (*post_channel_switch)(struct ieee80211_hw *hw,
3189 struct ieee80211_vif *vif);
3191 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3192 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3193 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3194 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3197 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3198 struct ieee80211_vif *vif,
3199 struct ieee80211_sta *sta, u8 oper_class,
3200 struct cfg80211_chan_def *chandef,
3201 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3202 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3203 struct ieee80211_vif *vif,
3204 struct ieee80211_sta *sta);
3205 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3206 struct ieee80211_vif *vif,
3207 struct ieee80211_tdls_ch_sw_params *params);
3211 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3213 * This must be called once for each hardware device. The returned pointer
3214 * must be used to refer to this device when calling other functions.
3215 * mac80211 allocates a private data area for the driver pointed to by
3216 * @priv in &struct ieee80211_hw, the size of this area is given as
3219 * @priv_data_len: length of private data
3220 * @ops: callbacks for this device
3221 * @requested_name: Requested name for this device.
3222 * NULL is valid value, and means use the default naming (phy%d)
3224 * Return: A pointer to the new hardware device, or %NULL on error.
3226 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3227 const struct ieee80211_ops *ops,
3228 const char *requested_name);
3231 * ieee80211_alloc_hw - Allocate a new hardware device
3233 * This must be called once for each hardware device. The returned pointer
3234 * must be used to refer to this device when calling other functions.
3235 * mac80211 allocates a private data area for the driver pointed to by
3236 * @priv in &struct ieee80211_hw, the size of this area is given as
3239 * @priv_data_len: length of private data
3240 * @ops: callbacks for this device
3242 * Return: A pointer to the new hardware device, or %NULL on error.
3245 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3246 const struct ieee80211_ops *ops)
3248 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3252 * ieee80211_register_hw - Register hardware device
3254 * You must call this function before any other functions in
3255 * mac80211. Note that before a hardware can be registered, you
3256 * need to fill the contained wiphy's information.
3258 * @hw: the device to register as returned by ieee80211_alloc_hw()
3260 * Return: 0 on success. An error code otherwise.
3262 int ieee80211_register_hw(struct ieee80211_hw *hw);
3265 * struct ieee80211_tpt_blink - throughput blink description
3266 * @throughput: throughput in Kbit/sec
3267 * @blink_time: blink time in milliseconds
3268 * (full cycle, ie. one off + one on period)
3270 struct ieee80211_tpt_blink {
3276 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3277 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3278 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3279 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3280 * interface is connected in some way, including being an AP
3282 enum ieee80211_tpt_led_trigger_flags {
3283 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3284 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3285 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3288 #ifdef CONFIG_MAC80211_LEDS
3289 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3290 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3291 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3292 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3293 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3295 const struct ieee80211_tpt_blink *blink_table,
3296 unsigned int blink_table_len);
3299 * ieee80211_get_tx_led_name - get name of TX LED
3301 * mac80211 creates a transmit LED trigger for each wireless hardware
3302 * that can be used to drive LEDs if your driver registers a LED device.
3303 * This function returns the name (or %NULL if not configured for LEDs)
3304 * of the trigger so you can automatically link the LED device.
3306 * @hw: the hardware to get the LED trigger name for
3308 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3310 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3312 #ifdef CONFIG_MAC80211_LEDS
3313 return __ieee80211_get_tx_led_name(hw);
3320 * ieee80211_get_rx_led_name - get name of RX LED
3322 * mac80211 creates a receive LED trigger for each wireless hardware
3323 * that can be used to drive LEDs if your driver registers a LED device.
3324 * This function returns the name (or %NULL if not configured for LEDs)
3325 * of the trigger so you can automatically link the LED device.
3327 * @hw: the hardware to get the LED trigger name for
3329 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3331 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3333 #ifdef CONFIG_MAC80211_LEDS
3334 return __ieee80211_get_rx_led_name(hw);
3341 * ieee80211_get_assoc_led_name - get name of association LED
3343 * mac80211 creates a association LED trigger for each wireless hardware
3344 * that can be used to drive LEDs if your driver registers a LED device.
3345 * This function returns the name (or %NULL if not configured for LEDs)
3346 * of the trigger so you can automatically link the LED device.
3348 * @hw: the hardware to get the LED trigger name for
3350 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3352 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3354 #ifdef CONFIG_MAC80211_LEDS
3355 return __ieee80211_get_assoc_led_name(hw);
3362 * ieee80211_get_radio_led_name - get name of radio LED
3364 * mac80211 creates a radio change LED trigger for each wireless hardware
3365 * that can be used to drive LEDs if your driver registers a LED device.
3366 * This function returns the name (or %NULL if not configured for LEDs)
3367 * of the trigger so you can automatically link the LED device.
3369 * @hw: the hardware to get the LED trigger name for
3371 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3373 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3375 #ifdef CONFIG_MAC80211_LEDS
3376 return __ieee80211_get_radio_led_name(hw);
3383 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3384 * @hw: the hardware to create the trigger for
3385 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3386 * @blink_table: the blink table -- needs to be ordered by throughput
3387 * @blink_table_len: size of the blink table
3389 * Return: %NULL (in case of error, or if no LED triggers are
3390 * configured) or the name of the new trigger.
3392 * Note: This function must be called before ieee80211_register_hw().
3394 static inline char *
3395 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3396 const struct ieee80211_tpt_blink *blink_table,
3397 unsigned int blink_table_len)
3399 #ifdef CONFIG_MAC80211_LEDS
3400 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3408 * ieee80211_unregister_hw - Unregister a hardware device
3410 * This function instructs mac80211 to free allocated resources
3411 * and unregister netdevices from the networking subsystem.
3413 * @hw: the hardware to unregister
3415 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3418 * ieee80211_free_hw - free hardware descriptor
3420 * This function frees everything that was allocated, including the
3421 * private data for the driver. You must call ieee80211_unregister_hw()
3422 * before calling this function.
3424 * @hw: the hardware to free
3426 void ieee80211_free_hw(struct ieee80211_hw *hw);
3429 * ieee80211_restart_hw - restart hardware completely
3431 * Call this function when the hardware was restarted for some reason
3432 * (hardware error, ...) and the driver is unable to restore its state
3433 * by itself. mac80211 assumes that at this point the driver/hardware
3434 * is completely uninitialised and stopped, it starts the process by
3435 * calling the ->start() operation. The driver will need to reset all
3436 * internal state that it has prior to calling this function.
3438 * @hw: the hardware to restart
3440 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3443 * ieee80211_napi_add - initialize mac80211 NAPI context
3444 * @hw: the hardware to initialize the NAPI context on
3445 * @napi: the NAPI context to initialize
3446 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3447 * driver doesn't use NAPI
3448 * @poll: poll function
3449 * @weight: default weight
3451 * See also netif_napi_add().
3453 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3454 struct net_device *napi_dev,
3455 int (*poll)(struct napi_struct *, int),
3459 * ieee80211_rx - receive frame
3461 * Use this function to hand received frames to mac80211. The receive
3462 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3463 * paged @skb is used, the driver is recommended to put the ieee80211
3464 * header of the frame on the linear part of the @skb to avoid memory
3465 * allocation and/or memcpy by the stack.
3467 * This function may not be called in IRQ context. Calls to this function
3468 * for a single hardware must be synchronized against each other. Calls to
3469 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3470 * mixed for a single hardware. Must not run concurrently with
3471 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3473 * In process context use instead ieee80211_rx_ni().
3475 * @hw: the hardware this frame came in on
3476 * @skb: the buffer to receive, owned by mac80211 after this call
3478 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3481 * ieee80211_rx_irqsafe - receive frame
3483 * Like ieee80211_rx() but can be called in IRQ context
3484 * (internally defers to a tasklet.)
3486 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3487 * be mixed for a single hardware.Must not run concurrently with
3488 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3490 * @hw: the hardware this frame came in on
3491 * @skb: the buffer to receive, owned by mac80211 after this call
3493 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3496 * ieee80211_rx_ni - receive frame (in process context)
3498 * Like ieee80211_rx() but can be called in process context
3499 * (internally disables bottom halves).
3501 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3502 * not be mixed for a single hardware. Must not run concurrently with
3503 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3505 * @hw: the hardware this frame came in on
3506 * @skb: the buffer to receive, owned by mac80211 after this call
3508 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3509 struct sk_buff *skb)
3512 ieee80211_rx(hw, skb);
3517 * ieee80211_sta_ps_transition - PS transition for connected sta
3519 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3520 * flag set, use this function to inform mac80211 about a connected station
3521 * entering/leaving PS mode.
3523 * This function may not be called in IRQ context or with softirqs enabled.
3525 * Calls to this function for a single hardware must be synchronized against
3528 * @sta: currently connected sta
3529 * @start: start or stop PS
3531 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3533 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3536 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3537 * (in process context)
3539 * Like ieee80211_sta_ps_transition() but can be called in process context
3540 * (internally disables bottom halves). Concurrent call restriction still
3543 * @sta: currently connected sta
3544 * @start: start or stop PS
3546 * Return: Like ieee80211_sta_ps_transition().
3548 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3554 ret = ieee80211_sta_ps_transition(sta, start);
3561 * The TX headroom reserved by mac80211 for its own tx_status functions.
3562 * This is enough for the radiotap header.
3564 #define IEEE80211_TX_STATUS_HEADROOM 14
3567 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3568 * @sta: &struct ieee80211_sta pointer for the sleeping station
3569 * @tid: the TID that has buffered frames
3570 * @buffered: indicates whether or not frames are buffered for this TID
3572 * If a driver buffers frames for a powersave station instead of passing
3573 * them back to mac80211 for retransmission, the station may still need
3574 * to be told that there are buffered frames via the TIM bit.
3576 * This function informs mac80211 whether or not there are frames that are
3577 * buffered in the driver for a given TID; mac80211 can then use this data
3578 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3579 * call! Beware of the locking!)
3581 * If all frames are released to the station (due to PS-poll or uAPSD)
3582 * then the driver needs to inform mac80211 that there no longer are
3583 * frames buffered. However, when the station wakes up mac80211 assumes
3584 * that all buffered frames will be transmitted and clears this data,
3585 * drivers need to make sure they inform mac80211 about all buffered
3586 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3588 * Note that technically mac80211 only needs to know this per AC, not per
3589 * TID, but since driver buffering will inevitably happen per TID (since
3590 * it is related to aggregation) it is easier to make mac80211 map the
3591 * TID to the AC as required instead of keeping track in all drivers that
3594 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3595 u8 tid, bool buffered);
3598 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3600 * Call this function in a driver with per-packet rate selection support
3601 * to combine the rate info in the packet tx info with the most recent
3602 * rate selection table for the station entry.
3604 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3605 * @sta: the receiver station to which this packet is sent.
3606 * @skb: the frame to be transmitted.
3607 * @dest: buffer for extracted rate/retry information
3608 * @max_rates: maximum number of rates to fetch
3610 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3611 struct ieee80211_sta *sta,
3612 struct sk_buff *skb,
3613 struct ieee80211_tx_rate *dest,
3617 * ieee80211_tx_status - transmit status callback
3619 * Call this function for all transmitted frames after they have been
3620 * transmitted. It is permissible to not call this function for
3621 * multicast frames but this can affect statistics.
3623 * This function may not be called in IRQ context. Calls to this function
3624 * for a single hardware must be synchronized against each other. Calls
3625 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3626 * may not be mixed for a single hardware. Must not run concurrently with
3627 * ieee80211_rx() or ieee80211_rx_ni().
3629 * @hw: the hardware the frame was transmitted by
3630 * @skb: the frame that was transmitted, owned by mac80211 after this call
3632 void ieee80211_tx_status(struct ieee80211_hw *hw,
3633 struct sk_buff *skb);
3636 * ieee80211_tx_status_noskb - transmit status callback without skb
3638 * This function can be used as a replacement for ieee80211_tx_status
3639 * in drivers that cannot reliably map tx status information back to
3642 * Calls to this function for a single hardware must be synchronized
3643 * against each other. Calls to this function, ieee80211_tx_status_ni()
3644 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3646 * @hw: the hardware the frame was transmitted by
3647 * @sta: the receiver station to which this packet is sent
3648 * (NULL for multicast packets)
3649 * @info: tx status information
3651 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3652 struct ieee80211_sta *sta,
3653 struct ieee80211_tx_info *info);
3656 * ieee80211_tx_status_ni - transmit status callback (in process context)
3658 * Like ieee80211_tx_status() but can be called in process context.
3660 * Calls to this function, ieee80211_tx_status() and
3661 * ieee80211_tx_status_irqsafe() may not be mixed
3662 * for a single hardware.
3664 * @hw: the hardware the frame was transmitted by
3665 * @skb: the frame that was transmitted, owned by mac80211 after this call
3667 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3668 struct sk_buff *skb)
3671 ieee80211_tx_status(hw, skb);
3676 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3678 * Like ieee80211_tx_status() but can be called in IRQ context
3679 * (internally defers to a tasklet.)
3681 * Calls to this function, ieee80211_tx_status() and
3682 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3684 * @hw: the hardware the frame was transmitted by
3685 * @skb: the frame that was transmitted, owned by mac80211 after this call
3687 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3688 struct sk_buff *skb);
3691 * ieee80211_report_low_ack - report non-responding station
3693 * When operating in AP-mode, call this function to report a non-responding
3696 * @sta: the non-responding connected sta
3697 * @num_packets: number of packets sent to @sta without a response
3699 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3701 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3704 * struct ieee80211_mutable_offsets - mutable beacon offsets
3705 * @tim_offset: position of TIM element
3706 * @tim_length: size of TIM element
3707 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3708 * to CSA counters. This array can contain zero values which
3709 * should be ignored.
3711 struct ieee80211_mutable_offsets {
3715 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3719 * ieee80211_beacon_get_template - beacon template generation function
3720 * @hw: pointer obtained from ieee80211_alloc_hw().
3721 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3722 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3723 * receive the offsets that may be updated by the driver.
3725 * If the driver implements beaconing modes, it must use this function to
3726 * obtain the beacon template.
3728 * This function should be used if the beacon frames are generated by the
3729 * device, and then the driver must use the returned beacon as the template
3730 * The driver or the device are responsible to update the DTIM and, when
3731 * applicable, the CSA count.
3733 * The driver is responsible for freeing the returned skb.
3735 * Return: The beacon template. %NULL on error.
3738 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3739 struct ieee80211_vif *vif,
3740 struct ieee80211_mutable_offsets *offs);
3743 * ieee80211_beacon_get_tim - beacon generation function
3744 * @hw: pointer obtained from ieee80211_alloc_hw().
3745 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3746 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3747 * Set to 0 if invalid (in non-AP modes).
3748 * @tim_length: pointer to variable that will receive the TIM IE length,
3749 * (including the ID and length bytes!).
3750 * Set to 0 if invalid (in non-AP modes).
3752 * If the driver implements beaconing modes, it must use this function to
3753 * obtain the beacon frame.
3755 * If the beacon frames are generated by the host system (i.e., not in
3756 * hardware/firmware), the driver uses this function to get each beacon
3757 * frame from mac80211 -- it is responsible for calling this function exactly
3758 * once before the beacon is needed (e.g. based on hardware interrupt).
3760 * The driver is responsible for freeing the returned skb.
3762 * Return: The beacon template. %NULL on error.
3764 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3765 struct ieee80211_vif *vif,
3766 u16 *tim_offset, u16 *tim_length);
3769 * ieee80211_beacon_get - beacon generation function
3770 * @hw: pointer obtained from ieee80211_alloc_hw().
3771 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3773 * See ieee80211_beacon_get_tim().
3775 * Return: See ieee80211_beacon_get_tim().
3777 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3778 struct ieee80211_vif *vif)
3780 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3784 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3785 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3787 * The csa counter should be updated after each beacon transmission.
3788 * This function is called implicitly when
3789 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3790 * beacon frames are generated by the device, the driver should call this
3791 * function after each beacon transmission to sync mac80211's csa counters.
3793 * Return: new csa counter value
3795 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3798 * ieee80211_csa_finish - notify mac80211 about channel switch
3799 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3801 * After a channel switch announcement was scheduled and the counter in this
3802 * announcement hits 1, this function must be called by the driver to
3803 * notify mac80211 that the channel can be changed.
3805 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3808 * ieee80211_csa_is_complete - find out if counters reached 1
3809 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3811 * This function returns whether the channel switch counters reached zero.
3813 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3817 * ieee80211_proberesp_get - retrieve a Probe Response template
3818 * @hw: pointer obtained from ieee80211_alloc_hw().
3819 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3821 * Creates a Probe Response template which can, for example, be uploaded to
3822 * hardware. The destination address should be set by the caller.
3824 * Can only be called in AP mode.
3826 * Return: The Probe Response template. %NULL on error.
3828 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3829 struct ieee80211_vif *vif);
3832 * ieee80211_pspoll_get - retrieve a PS Poll template
3833 * @hw: pointer obtained from ieee80211_alloc_hw().
3834 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3836 * Creates a PS Poll a template which can, for example, uploaded to
3837 * hardware. The template must be updated after association so that correct
3838 * AID, BSSID and MAC address is used.
3840 * Note: Caller (or hardware) is responsible for setting the
3841 * &IEEE80211_FCTL_PM bit.
3843 * Return: The PS Poll template. %NULL on error.
3845 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3846 struct ieee80211_vif *vif);
3849 * ieee80211_nullfunc_get - retrieve a nullfunc template
3850 * @hw: pointer obtained from ieee80211_alloc_hw().
3851 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3853 * Creates a Nullfunc template which can, for example, uploaded to
3854 * hardware. The template must be updated after association so that correct
3855 * BSSID and address is used.
3857 * Note: Caller (or hardware) is responsible for setting the
3858 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3860 * Return: The nullfunc template. %NULL on error.
3862 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3863 struct ieee80211_vif *vif);
3866 * ieee80211_probereq_get - retrieve a Probe Request template
3867 * @hw: pointer obtained from ieee80211_alloc_hw().
3868 * @src_addr: source MAC address
3869 * @ssid: SSID buffer
3870 * @ssid_len: length of SSID
3871 * @tailroom: tailroom to reserve at end of SKB for IEs
3873 * Creates a Probe Request template which can, for example, be uploaded to
3876 * Return: The Probe Request template. %NULL on error.
3878 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3880 const u8 *ssid, size_t ssid_len,
3884 * ieee80211_rts_get - RTS frame generation function
3885 * @hw: pointer obtained from ieee80211_alloc_hw().
3886 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3887 * @frame: pointer to the frame that is going to be protected by the RTS.
3888 * @frame_len: the frame length (in octets).
3889 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3890 * @rts: The buffer where to store the RTS frame.
3892 * If the RTS frames are generated by the host system (i.e., not in
3893 * hardware/firmware), the low-level driver uses this function to receive
3894 * the next RTS frame from the 802.11 code. The low-level is responsible
3895 * for calling this function before and RTS frame is needed.
3897 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3898 const void *frame, size_t frame_len,
3899 const struct ieee80211_tx_info *frame_txctl,
3900 struct ieee80211_rts *rts);
3903 * ieee80211_rts_duration - Get the duration field for an RTS frame
3904 * @hw: pointer obtained from ieee80211_alloc_hw().
3905 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3906 * @frame_len: the length of the frame that is going to be protected by the RTS.
3907 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3909 * If the RTS is generated in firmware, but the host system must provide
3910 * the duration field, the low-level driver uses this function to receive
3911 * the duration field value in little-endian byteorder.
3913 * Return: The duration.
3915 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3916 struct ieee80211_vif *vif, size_t frame_len,
3917 const struct ieee80211_tx_info *frame_txctl);
3920 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3921 * @hw: pointer obtained from ieee80211_alloc_hw().
3922 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3923 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3924 * @frame_len: the frame length (in octets).
3925 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3926 * @cts: The buffer where to store the CTS-to-self frame.
3928 * If the CTS-to-self frames are generated by the host system (i.e., not in
3929 * hardware/firmware), the low-level driver uses this function to receive
3930 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3931 * for calling this function before and CTS-to-self frame is needed.
3933 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3934 struct ieee80211_vif *vif,
3935 const void *frame, size_t frame_len,
3936 const struct ieee80211_tx_info *frame_txctl,
3937 struct ieee80211_cts *cts);
3940 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3941 * @hw: pointer obtained from ieee80211_alloc_hw().
3942 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3943 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3944 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3946 * If the CTS-to-self is generated in firmware, but the host system must provide
3947 * the duration field, the low-level driver uses this function to receive
3948 * the duration field value in little-endian byteorder.
3950 * Return: The duration.
3952 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3953 struct ieee80211_vif *vif,
3955 const struct ieee80211_tx_info *frame_txctl);
3958 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3959 * @hw: pointer obtained from ieee80211_alloc_hw().
3960 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3961 * @band: the band to calculate the frame duration on
3962 * @frame_len: the length of the frame.
3963 * @rate: the rate at which the frame is going to be transmitted.
3965 * Calculate the duration field of some generic frame, given its
3966 * length and transmission rate (in 100kbps).
3968 * Return: The duration.
3970 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3971 struct ieee80211_vif *vif,
3972 enum ieee80211_band band,
3974 struct ieee80211_rate *rate);
3977 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3978 * @hw: pointer as obtained from ieee80211_alloc_hw().
3979 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3981 * Function for accessing buffered broadcast and multicast frames. If
3982 * hardware/firmware does not implement buffering of broadcast/multicast
3983 * frames when power saving is used, 802.11 code buffers them in the host
3984 * memory. The low-level driver uses this function to fetch next buffered
3985 * frame. In most cases, this is used when generating beacon frame.
3987 * Return: A pointer to the next buffered skb or NULL if no more buffered
3988 * frames are available.
3990 * Note: buffered frames are returned only after DTIM beacon frame was
3991 * generated with ieee80211_beacon_get() and the low-level driver must thus
3992 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3993 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3994 * does not need to check for DTIM beacons separately and should be able to
3995 * use common code for all beacons.
3998 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4001 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4003 * This function returns the TKIP phase 1 key for the given IV32.
4005 * @keyconf: the parameter passed with the set key
4006 * @iv32: IV32 to get the P1K for
4007 * @p1k: a buffer to which the key will be written, as 5 u16 values
4009 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4010 u32 iv32, u16 *p1k);
4013 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4015 * This function returns the TKIP phase 1 key for the IV32 taken
4016 * from the given packet.
4018 * @keyconf: the parameter passed with the set key
4019 * @skb: the packet to take the IV32 value from that will be encrypted
4021 * @p1k: a buffer to which the key will be written, as 5 u16 values
4023 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4024 struct sk_buff *skb, u16 *p1k)
4026 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4027 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4028 u32 iv32 = get_unaligned_le32(&data[4]);
4030 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4034 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4036 * This function returns the TKIP phase 1 key for the given IV32
4037 * and transmitter address.
4039 * @keyconf: the parameter passed with the set key
4040 * @ta: TA that will be used with the key
4041 * @iv32: IV32 to get the P1K for
4042 * @p1k: a buffer to which the key will be written, as 5 u16 values
4044 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4045 const u8 *ta, u32 iv32, u16 *p1k);
4048 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4050 * This function computes the TKIP RC4 key for the IV values
4053 * @keyconf: the parameter passed with the set key
4054 * @skb: the packet to take the IV32/IV16 values from that will be
4055 * encrypted with this key
4056 * @p2k: a buffer to which the key will be written, 16 bytes
4058 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4059 struct sk_buff *skb, u8 *p2k);
4062 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
4064 * This function computes the two AES-CMAC sub-keys, based on the
4065 * previously installed master key.
4067 * @keyconf: the parameter passed with the set key
4068 * @k1: a buffer to be filled with the 1st sub-key
4069 * @k2: a buffer to be filled with the 2nd sub-key
4071 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
4075 * struct ieee80211_key_seq - key sequence counter
4077 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
4078 * @ccmp: PN data, most significant byte first (big endian,
4079 * reverse order than in packet)
4080 * @aes_cmac: PN data, most significant byte first (big endian,
4081 * reverse order than in packet)
4083 struct ieee80211_key_seq {
4099 * ieee80211_get_key_tx_seq - get key TX sequence counter
4101 * @keyconf: the parameter passed with the set key
4102 * @seq: buffer to receive the sequence data
4104 * This function allows a driver to retrieve the current TX IV/PN
4105 * for the given key. It must not be called if IV generation is
4106 * offloaded to the device.
4108 * Note that this function may only be called when no TX processing
4109 * can be done concurrently, for example when queues are stopped
4110 * and the stop has been synchronized.
4112 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4113 struct ieee80211_key_seq *seq);
4116 * ieee80211_get_key_rx_seq - get key RX sequence counter
4118 * @keyconf: the parameter passed with the set key
4119 * @tid: The TID, or -1 for the management frame value (CCMP only);
4120 * the value on TID 0 is also used for non-QoS frames. For
4121 * CMAC, only TID 0 is valid.
4122 * @seq: buffer to receive the sequence data
4124 * This function allows a driver to retrieve the current RX IV/PNs
4125 * for the given key. It must not be called if IV checking is done
4126 * by the device and not by mac80211.
4128 * Note that this function may only be called when no RX processing
4129 * can be done concurrently.
4131 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4132 int tid, struct ieee80211_key_seq *seq);
4135 * ieee80211_set_key_tx_seq - set key TX sequence counter
4137 * @keyconf: the parameter passed with the set key
4138 * @seq: new sequence data
4140 * This function allows a driver to set the current TX IV/PNs for the
4141 * given key. This is useful when resuming from WoWLAN sleep and the
4142 * device may have transmitted frames using the PTK, e.g. replies to
4145 * Note that this function may only be called when no TX processing
4146 * can be done concurrently.
4148 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4149 struct ieee80211_key_seq *seq);
4152 * ieee80211_set_key_rx_seq - set key RX sequence counter
4154 * @keyconf: the parameter passed with the set key
4155 * @tid: The TID, or -1 for the management frame value (CCMP only);
4156 * the value on TID 0 is also used for non-QoS frames. For
4157 * CMAC, only TID 0 is valid.
4158 * @seq: new sequence data
4160 * This function allows a driver to set the current RX IV/PNs for the
4161 * given key. This is useful when resuming from WoWLAN sleep and GTK
4162 * rekey may have been done while suspended. It should not be called
4163 * if IV checking is done by the device and not by mac80211.
4165 * Note that this function may only be called when no RX processing
4166 * can be done concurrently.
4168 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4169 int tid, struct ieee80211_key_seq *seq);
4172 * ieee80211_remove_key - remove the given key
4173 * @keyconf: the parameter passed with the set key
4175 * Remove the given key. If the key was uploaded to the hardware at the
4176 * time this function is called, it is not deleted in the hardware but
4177 * instead assumed to have been removed already.
4179 * Note that due to locking considerations this function can (currently)
4180 * only be called during key iteration (ieee80211_iter_keys().)
4182 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4185 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4186 * @vif: the virtual interface to add the key on
4187 * @keyconf: new key data
4189 * When GTK rekeying was done while the system was suspended, (a) new
4190 * key(s) will be available. These will be needed by mac80211 for proper
4191 * RX processing, so this function allows setting them.
4193 * The function returns the newly allocated key structure, which will
4194 * have similar contents to the passed key configuration but point to
4195 * mac80211-owned memory. In case of errors, the function returns an
4196 * ERR_PTR(), use IS_ERR() etc.
4198 * Note that this function assumes the key isn't added to hardware
4199 * acceleration, so no TX will be done with the key. Since it's a GTK
4200 * on managed (station) networks, this is true anyway. If the driver
4201 * calls this function from the resume callback and subsequently uses
4202 * the return code 1 to reconfigure the device, this key will be part
4203 * of the reconfiguration.
4205 * Note that the driver should also call ieee80211_set_key_rx_seq()
4206 * for the new key for each TID to set up sequence counters properly.
4208 * IMPORTANT: If this replaces a key that is present in the hardware,
4209 * then it will attempt to remove it during this call. In many cases
4210 * this isn't what you want, so call ieee80211_remove_key() first for
4211 * the key that's being replaced.
4213 struct ieee80211_key_conf *
4214 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4215 struct ieee80211_key_conf *keyconf);
4218 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4219 * @vif: virtual interface the rekeying was done on
4220 * @bssid: The BSSID of the AP, for checking association
4221 * @replay_ctr: the new replay counter after GTK rekeying
4222 * @gfp: allocation flags
4224 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4225 const u8 *replay_ctr, gfp_t gfp);
4228 * ieee80211_wake_queue - wake specific queue
4229 * @hw: pointer as obtained from ieee80211_alloc_hw().
4230 * @queue: queue number (counted from zero).
4232 * Drivers should use this function instead of netif_wake_queue.
4234 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4237 * ieee80211_stop_queue - stop specific queue
4238 * @hw: pointer as obtained from ieee80211_alloc_hw().
4239 * @queue: queue number (counted from zero).
4241 * Drivers should use this function instead of netif_stop_queue.
4243 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4246 * ieee80211_queue_stopped - test status of the queue
4247 * @hw: pointer as obtained from ieee80211_alloc_hw().
4248 * @queue: queue number (counted from zero).
4250 * Drivers should use this function instead of netif_stop_queue.
4252 * Return: %true if the queue is stopped. %false otherwise.
4255 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4258 * ieee80211_stop_queues - stop all queues
4259 * @hw: pointer as obtained from ieee80211_alloc_hw().
4261 * Drivers should use this function instead of netif_stop_queue.
4263 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4266 * ieee80211_wake_queues - wake all queues
4267 * @hw: pointer as obtained from ieee80211_alloc_hw().
4269 * Drivers should use this function instead of netif_wake_queue.
4271 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4274 * ieee80211_scan_completed - completed hardware scan
4276 * When hardware scan offload is used (i.e. the hw_scan() callback is
4277 * assigned) this function needs to be called by the driver to notify
4278 * mac80211 that the scan finished. This function can be called from
4279 * any context, including hardirq context.
4281 * @hw: the hardware that finished the scan
4282 * @aborted: set to true if scan was aborted
4284 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4287 * ieee80211_sched_scan_results - got results from scheduled scan
4289 * When a scheduled scan is running, this function needs to be called by the
4290 * driver whenever there are new scan results available.
4292 * @hw: the hardware that is performing scheduled scans
4294 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4297 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4299 * When a scheduled scan is running, this function can be called by
4300 * the driver if it needs to stop the scan to perform another task.
4301 * Usual scenarios are drivers that cannot continue the scheduled scan
4302 * while associating, for instance.
4304 * @hw: the hardware that is performing scheduled scans
4306 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4309 * enum ieee80211_interface_iteration_flags - interface iteration flags
4310 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4311 * been added to the driver; However, note that during hardware
4312 * reconfiguration (after restart_hw) it will iterate over a new
4313 * interface and over all the existing interfaces even if they
4314 * haven't been re-added to the driver yet.
4315 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4316 * interfaces, even if they haven't been re-added to the driver yet.
4318 enum ieee80211_interface_iteration_flags {
4319 IEEE80211_IFACE_ITER_NORMAL = 0,
4320 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4324 * ieee80211_iterate_active_interfaces - iterate active interfaces
4326 * This function iterates over the interfaces associated with a given
4327 * hardware that are currently active and calls the callback for them.
4328 * This function allows the iterator function to sleep, when the iterator
4329 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4331 * Does not iterate over a new interface during add_interface().
4333 * @hw: the hardware struct of which the interfaces should be iterated over
4334 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4335 * @iterator: the iterator function to call
4336 * @data: first argument of the iterator function
4338 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
4340 void (*iterator)(void *data, u8 *mac,
4341 struct ieee80211_vif *vif),
4345 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4347 * This function iterates over the interfaces associated with a given
4348 * hardware that are currently active and calls the callback for them.
4349 * This function requires the iterator callback function to be atomic,
4350 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4351 * Does not iterate over a new interface during add_interface().
4353 * @hw: the hardware struct of which the interfaces should be iterated over
4354 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4355 * @iterator: the iterator function to call, cannot sleep
4356 * @data: first argument of the iterator function
4358 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4360 void (*iterator)(void *data,
4362 struct ieee80211_vif *vif),
4366 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4368 * This function iterates over the interfaces associated with a given
4369 * hardware that are currently active and calls the callback for them.
4370 * This version can only be used while holding the RTNL.
4372 * @hw: the hardware struct of which the interfaces should be iterated over
4373 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4374 * @iterator: the iterator function to call, cannot sleep
4375 * @data: first argument of the iterator function
4377 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4379 void (*iterator)(void *data,
4381 struct ieee80211_vif *vif),
4385 * ieee80211_iterate_stations_atomic - iterate stations
4387 * This function iterates over all stations associated with a given
4388 * hardware that are currently uploaded to the driver and calls the callback
4389 * function for them.
4390 * This function requires the iterator callback function to be atomic,
4392 * @hw: the hardware struct of which the interfaces should be iterated over
4393 * @iterator: the iterator function to call, cannot sleep
4394 * @data: first argument of the iterator function
4396 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4397 void (*iterator)(void *data,
4398 struct ieee80211_sta *sta),
4401 * ieee80211_queue_work - add work onto the mac80211 workqueue
4403 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4404 * This helper ensures drivers are not queueing work when they should not be.
4406 * @hw: the hardware struct for the interface we are adding work for
4407 * @work: the work we want to add onto the mac80211 workqueue
4409 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4412 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4414 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4417 * @hw: the hardware struct for the interface we are adding work for
4418 * @dwork: delayable work to queue onto the mac80211 workqueue
4419 * @delay: number of jiffies to wait before queueing
4421 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4422 struct delayed_work *dwork,
4423 unsigned long delay);
4426 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4427 * @sta: the station for which to start a BA session
4428 * @tid: the TID to BA on.
4429 * @timeout: session timeout value (in TUs)
4431 * Return: success if addBA request was sent, failure otherwise
4433 * Although mac80211/low level driver/user space application can estimate
4434 * the need to start aggregation on a certain RA/TID, the session level
4435 * will be managed by the mac80211.
4437 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4441 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4442 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4443 * @ra: receiver address of the BA session recipient.
4444 * @tid: the TID to BA on.
4446 * This function must be called by low level driver once it has
4447 * finished with preparations for the BA session. It can be called
4450 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4454 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4455 * @sta: the station whose BA session to stop
4456 * @tid: the TID to stop BA.
4458 * Return: negative error if the TID is invalid, or no aggregation active
4460 * Although mac80211/low level driver/user space application can estimate
4461 * the need to stop aggregation on a certain RA/TID, the session level
4462 * will be managed by the mac80211.
4464 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4467 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4468 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4469 * @ra: receiver address of the BA session recipient.
4470 * @tid: the desired TID to BA on.
4472 * This function must be called by low level driver once it has
4473 * finished with preparations for the BA session tear down. It
4474 * can be called from any context.
4476 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4480 * ieee80211_find_sta - find a station
4482 * @vif: virtual interface to look for station on
4483 * @addr: station's address
4485 * Return: The station, if found. %NULL otherwise.
4487 * Note: This function must be called under RCU lock and the
4488 * resulting pointer is only valid under RCU lock as well.
4490 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4494 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4496 * @hw: pointer as obtained from ieee80211_alloc_hw()
4497 * @addr: remote station's address
4498 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4500 * Return: The station, if found. %NULL otherwise.
4502 * Note: This function must be called under RCU lock and the
4503 * resulting pointer is only valid under RCU lock as well.
4505 * NOTE: You may pass NULL for localaddr, but then you will just get
4506 * the first STA that matches the remote address 'addr'.
4507 * We can have multiple STA associated with multiple
4508 * logical stations (e.g. consider a station connecting to another
4509 * BSSID on the same AP hardware without disconnecting first).
4510 * In this case, the result of this method with localaddr NULL
4513 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4515 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4517 const u8 *localaddr);
4520 * ieee80211_sta_block_awake - block station from waking up
4522 * @pubsta: the station
4523 * @block: whether to block or unblock
4525 * Some devices require that all frames that are on the queues
4526 * for a specific station that went to sleep are flushed before
4527 * a poll response or frames after the station woke up can be
4528 * delivered to that it. Note that such frames must be rejected
4529 * by the driver as filtered, with the appropriate status flag.
4531 * This function allows implementing this mode in a race-free
4534 * To do this, a driver must keep track of the number of frames
4535 * still enqueued for a specific station. If this number is not
4536 * zero when the station goes to sleep, the driver must call
4537 * this function to force mac80211 to consider the station to
4538 * be asleep regardless of the station's actual state. Once the
4539 * number of outstanding frames reaches zero, the driver must
4540 * call this function again to unblock the station. That will
4541 * cause mac80211 to be able to send ps-poll responses, and if
4542 * the station queried in the meantime then frames will also
4543 * be sent out as a result of this. Additionally, the driver
4544 * will be notified that the station woke up some time after
4545 * it is unblocked, regardless of whether the station actually
4546 * woke up while blocked or not.
4548 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4549 struct ieee80211_sta *pubsta, bool block);
4552 * ieee80211_sta_eosp - notify mac80211 about end of SP
4553 * @pubsta: the station
4555 * When a device transmits frames in a way that it can't tell
4556 * mac80211 in the TX status about the EOSP, it must clear the
4557 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4558 * This applies for PS-Poll as well as uAPSD.
4560 * Note that just like with _tx_status() and _rx() drivers must
4561 * not mix calls to irqsafe/non-irqsafe versions, this function
4562 * must not be mixed with those either. Use the all irqsafe, or
4563 * all non-irqsafe, don't mix!
4565 * NB: the _irqsafe version of this function doesn't exist, no
4566 * driver needs it right now. Don't call this function if
4567 * you'd need the _irqsafe version, look at the git history
4568 * and restore the _irqsafe version!
4570 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4573 * ieee80211_iter_keys - iterate keys programmed into the device
4574 * @hw: pointer obtained from ieee80211_alloc_hw()
4575 * @vif: virtual interface to iterate, may be %NULL for all
4576 * @iter: iterator function that will be called for each key
4577 * @iter_data: custom data to pass to the iterator function
4579 * This function can be used to iterate all the keys known to
4580 * mac80211, even those that weren't previously programmed into
4581 * the device. This is intended for use in WoWLAN if the device
4582 * needs reprogramming of the keys during suspend. Note that due
4583 * to locking reasons, it is also only safe to call this at few
4584 * spots since it must hold the RTNL and be able to sleep.
4586 * The order in which the keys are iterated matches the order
4587 * in which they were originally installed and handed to the
4590 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4591 struct ieee80211_vif *vif,
4592 void (*iter)(struct ieee80211_hw *hw,
4593 struct ieee80211_vif *vif,
4594 struct ieee80211_sta *sta,
4595 struct ieee80211_key_conf *key,
4600 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4601 * @hw: pointre obtained from ieee80211_alloc_hw().
4602 * @iter: iterator function
4603 * @iter_data: data passed to iterator function
4605 * Iterate all active channel contexts. This function is atomic and
4606 * doesn't acquire any locks internally that might be held in other
4607 * places while calling into the driver.
4609 * The iterator will not find a context that's being added (during
4610 * the driver callback to add it) but will find it while it's being
4613 * Note that during hardware restart, all contexts that existed
4614 * before the restart are considered already present so will be
4615 * found while iterating, whether they've been re-added already
4618 void ieee80211_iter_chan_contexts_atomic(
4619 struct ieee80211_hw *hw,
4620 void (*iter)(struct ieee80211_hw *hw,
4621 struct ieee80211_chanctx_conf *chanctx_conf,
4626 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4627 * @hw: pointer obtained from ieee80211_alloc_hw().
4628 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4630 * Creates a Probe Request template which can, for example, be uploaded to
4631 * hardware. The template is filled with bssid, ssid and supported rate
4632 * information. This function must only be called from within the
4633 * .bss_info_changed callback function and only in managed mode. The function
4634 * is only useful when the interface is associated, otherwise it will return
4637 * Return: The Probe Request template. %NULL on error.
4639 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4640 struct ieee80211_vif *vif);
4643 * ieee80211_beacon_loss - inform hardware does not receive beacons
4645 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4647 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4648 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4649 * hardware is not receiving beacons with this function.
4651 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4654 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4656 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4658 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4659 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4660 * needs to inform if the connection to the AP has been lost.
4661 * The function may also be called if the connection needs to be terminated
4662 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4664 * This function will cause immediate change to disassociated state,
4665 * without connection recovery attempts.
4667 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4670 * ieee80211_resume_disconnect - disconnect from AP after resume
4672 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4674 * Instructs mac80211 to disconnect from the AP after resume.
4675 * Drivers can use this after WoWLAN if they know that the
4676 * connection cannot be kept up, for example because keys were
4677 * used while the device was asleep but the replay counters or
4678 * similar cannot be retrieved from the device during resume.
4680 * Note that due to implementation issues, if the driver uses
4681 * the reconfiguration functionality during resume the interface
4682 * will still be added as associated first during resume and then
4683 * disconnect normally later.
4685 * This function can only be called from the resume callback and
4686 * the driver must not be holding any of its own locks while it
4687 * calls this function, or at least not any locks it needs in the
4688 * key configuration paths (if it supports HW crypto).
4690 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4693 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4694 * rssi threshold triggered
4696 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4697 * @rssi_event: the RSSI trigger event type
4698 * @gfp: context flags
4700 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4701 * monitoring is configured with an rssi threshold, the driver will inform
4702 * whenever the rssi level reaches the threshold.
4704 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4705 enum nl80211_cqm_rssi_threshold_event rssi_event,
4709 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4711 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4712 * @gfp: context flags
4714 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
4717 * ieee80211_radar_detected - inform that a radar was detected
4719 * @hw: pointer as obtained from ieee80211_alloc_hw()
4721 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4724 * ieee80211_chswitch_done - Complete channel switch process
4725 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4726 * @success: make the channel switch successful or not
4728 * Complete the channel switch post-process: set the new operational channel
4729 * and wake up the suspended queues.
4731 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4734 * ieee80211_request_smps - request SM PS transition
4735 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4736 * @smps_mode: new SM PS mode
4738 * This allows the driver to request an SM PS transition in managed
4739 * mode. This is useful when the driver has more information than
4740 * the stack about possible interference, for example by bluetooth.
4742 void ieee80211_request_smps(struct ieee80211_vif *vif,
4743 enum ieee80211_smps_mode smps_mode);
4746 * ieee80211_ready_on_channel - notification of remain-on-channel start
4747 * @hw: pointer as obtained from ieee80211_alloc_hw()
4749 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4752 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4753 * @hw: pointer as obtained from ieee80211_alloc_hw()
4755 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4758 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4760 * in order not to harm the system performance and user experience, the device
4761 * may request not to allow any rx ba session and tear down existing rx ba
4762 * sessions based on system constraints such as periodic BT activity that needs
4763 * to limit wlan activity (eg.sco or a2dp)."
4764 * in such cases, the intention is to limit the duration of the rx ppdu and
4765 * therefore prevent the peer device to use a-mpdu aggregation.
4767 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4768 * @ba_rx_bitmap: Bit map of open rx ba per tid
4769 * @addr: & to bssid mac address
4771 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4775 * ieee80211_send_bar - send a BlockAckReq frame
4777 * can be used to flush pending frames from the peer's aggregation reorder
4780 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4781 * @ra: the peer's destination address
4782 * @tid: the TID of the aggregation session
4783 * @ssn: the new starting sequence number for the receiver
4785 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4788 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
4790 * Some device drivers may offload part of the Rx aggregation flow including
4791 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4794 * Create structures responsible for reordering so device drivers may call here
4795 * when they complete AddBa negotiation.
4797 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4798 * @addr: station mac address
4801 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
4802 const u8 *addr, u16 tid);
4805 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
4807 * Some device drivers may offload part of the Rx aggregation flow including
4808 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4811 * Destroy structures responsible for reordering so device drivers may call here
4812 * when they complete DelBa negotiation.
4814 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4815 * @addr: station mac address
4818 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
4819 const u8 *addr, u16 tid);
4821 /* Rate control API */
4824 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4826 * @hw: The hardware the algorithm is invoked for.
4827 * @sband: The band this frame is being transmitted on.
4828 * @bss_conf: the current BSS configuration
4829 * @skb: the skb that will be transmitted, the control information in it needs
4831 * @reported_rate: The rate control algorithm can fill this in to indicate
4832 * which rate should be reported to userspace as the current rate and
4833 * used for rate calculations in the mesh network.
4834 * @rts: whether RTS will be used for this frame because it is longer than the
4836 * @short_preamble: whether mac80211 will request short-preamble transmission
4837 * if the selected rate supports it
4838 * @max_rate_idx: user-requested maximum (legacy) rate
4839 * (deprecated; this will be removed once drivers get updated to use
4841 * @rate_idx_mask: user-requested (legacy) rate mask
4842 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4843 * @bss: whether this frame is sent out in AP or IBSS mode
4845 struct ieee80211_tx_rate_control {
4846 struct ieee80211_hw *hw;
4847 struct ieee80211_supported_band *sband;
4848 struct ieee80211_bss_conf *bss_conf;
4849 struct sk_buff *skb;
4850 struct ieee80211_tx_rate reported_rate;
4851 bool rts, short_preamble;
4854 u8 *rate_idx_mcs_mask;
4858 struct rate_control_ops {
4860 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4861 void (*free)(void *priv);
4863 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4864 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4865 struct cfg80211_chan_def *chandef,
4866 struct ieee80211_sta *sta, void *priv_sta);
4867 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4868 struct cfg80211_chan_def *chandef,
4869 struct ieee80211_sta *sta, void *priv_sta,
4871 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4874 void (*tx_status_noskb)(void *priv,
4875 struct ieee80211_supported_band *sband,
4876 struct ieee80211_sta *sta, void *priv_sta,
4877 struct ieee80211_tx_info *info);
4878 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4879 struct ieee80211_sta *sta, void *priv_sta,
4880 struct sk_buff *skb);
4881 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4882 struct ieee80211_tx_rate_control *txrc);
4884 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4885 struct dentry *dir);
4886 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4888 u32 (*get_expected_throughput)(void *priv_sta);
4891 static inline int rate_supported(struct ieee80211_sta *sta,
4892 enum ieee80211_band band,
4895 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4899 * rate_control_send_low - helper for drivers for management/no-ack frames
4901 * Rate control algorithms that agree to use the lowest rate to
4902 * send management frames and NO_ACK data with the respective hw
4903 * retries should use this in the beginning of their mac80211 get_rate
4904 * callback. If true is returned the rate control can simply return.
4905 * If false is returned we guarantee that sta and sta and priv_sta is
4908 * Rate control algorithms wishing to do more intelligent selection of
4909 * rate for multicast/broadcast frames may choose to not use this.
4911 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4912 * that this may be null.
4913 * @priv_sta: private rate control structure. This may be null.
4914 * @txrc: rate control information we sholud populate for mac80211.
4916 bool rate_control_send_low(struct ieee80211_sta *sta,
4918 struct ieee80211_tx_rate_control *txrc);
4922 rate_lowest_index(struct ieee80211_supported_band *sband,
4923 struct ieee80211_sta *sta)
4927 for (i = 0; i < sband->n_bitrates; i++)
4928 if (rate_supported(sta, sband->band, i))
4931 /* warn when we cannot find a rate. */
4934 /* and return 0 (the lowest index) */
4939 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4940 struct ieee80211_sta *sta)
4944 for (i = 0; i < sband->n_bitrates; i++)
4945 if (rate_supported(sta, sband->band, i))
4951 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4953 * When not doing a rate control probe to test rates, rate control should pass
4954 * its rate selection to mac80211. If the driver supports receiving a station
4955 * rate table, it will use it to ensure that frames are always sent based on
4956 * the most recent rate control module decision.
4958 * @hw: pointer as obtained from ieee80211_alloc_hw()
4959 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4960 * @rates: new tx rate set to be used for this station.
4962 int rate_control_set_rates(struct ieee80211_hw *hw,
4963 struct ieee80211_sta *pubsta,
4964 struct ieee80211_sta_rates *rates);
4966 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4967 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4970 conf_is_ht20(struct ieee80211_conf *conf)
4972 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4976 conf_is_ht40_minus(struct ieee80211_conf *conf)
4978 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4979 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4983 conf_is_ht40_plus(struct ieee80211_conf *conf)
4985 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4986 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4990 conf_is_ht40(struct ieee80211_conf *conf)
4992 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4996 conf_is_ht(struct ieee80211_conf *conf)
4998 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
4999 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5000 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5003 static inline enum nl80211_iftype
5004 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5008 case NL80211_IFTYPE_STATION:
5009 return NL80211_IFTYPE_P2P_CLIENT;
5010 case NL80211_IFTYPE_AP:
5011 return NL80211_IFTYPE_P2P_GO;
5019 static inline enum nl80211_iftype
5020 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5022 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5025 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5027 int rssi_max_thold);
5029 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5032 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5034 * @vif: the specified virtual interface
5036 * Note: This function assumes that the given vif is valid.
5038 * Return: The average RSSI value for the requested interface, or 0 if not
5041 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5044 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5045 * @vif: virtual interface
5046 * @wakeup: wakeup reason(s)
5047 * @gfp: allocation flags
5049 * See cfg80211_report_wowlan_wakeup().
5051 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5052 struct cfg80211_wowlan_wakeup *wakeup,
5056 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5057 * @hw: pointer as obtained from ieee80211_alloc_hw()
5058 * @vif: virtual interface
5059 * @skb: frame to be sent from within the driver
5060 * @band: the band to transmit on
5061 * @sta: optional pointer to get the station to send the frame to
5063 * Note: must be called under RCU lock
5065 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5066 struct ieee80211_vif *vif, struct sk_buff *skb,
5067 int band, struct ieee80211_sta **sta);
5070 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5072 * @next_tsf: TSF timestamp of the next absent state change
5073 * @has_next_tsf: next absent state change event pending
5075 * @absent: descriptor bitmask, set if GO is currently absent
5079 * @count: count fields from the NoA descriptors
5080 * @desc: adjusted data from the NoA
5082 struct ieee80211_noa_data {
5088 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5093 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5097 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5100 * @data: NoA tracking data
5101 * @tsf: current TSF timestamp
5103 * Return: number of successfully parsed descriptors
5105 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5106 struct ieee80211_noa_data *data, u32 tsf);
5109 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5111 * @data: NoA tracking data
5112 * @tsf: current TSF timestamp
5114 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5117 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5118 * @vif: virtual interface
5119 * @peer: the peer's destination address
5120 * @oper: the requested TDLS operation
5121 * @reason_code: reason code for the operation, valid for TDLS teardown
5122 * @gfp: allocation flags
5124 * See cfg80211_tdls_oper_request().
5126 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5127 enum nl80211_tdls_operation oper,
5128 u16 reason_code, gfp_t gfp);
5131 * ieee80211_reserve_tid - request to reserve a specific TID
5133 * There is sometimes a need (such as in TDLS) for blocking the driver from
5134 * using a specific TID so that the FW can use it for certain operations such
5135 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5136 * this function must be called as it flushes out packets on this TID and marks
5137 * it as blocked, so that any transmit for the station on this TID will be
5138 * redirected to the alternative TID in the same AC.
5140 * Note that this function blocks and may call back into the driver, so it
5141 * should be called without driver locks held. Also note this function should
5142 * only be called from the driver's @sta_state callback.
5144 * @sta: the station to reserve the TID for
5145 * @tid: the TID to reserve
5147 * Returns: 0 on success, else on failure
5149 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5152 * ieee80211_unreserve_tid - request to unreserve a specific TID
5154 * Once there is no longer any need for reserving a certain TID, this function
5155 * should be called, and no longer will packets have their TID modified for
5156 * preventing use of this TID in the driver.
5158 * Note that this function blocks and acquires a lock, so it should be called
5159 * without driver locks held. Also note this function should only be called
5160 * from the driver's @sta_state callback.
5163 * @tid: the TID to unreserve
5165 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5168 * ieee80211_ie_split - split an IE buffer according to ordering
5170 * @ies: the IE buffer
5171 * @ielen: the length of the IE buffer
5172 * @ids: an array with element IDs that are allowed before
5174 * @n_ids: the size of the element ID array
5175 * @offset: offset where to start splitting in the buffer
5177 * This function splits an IE buffer by updating the @offset
5178 * variable to point to the location where the buffer should be
5181 * It assumes that the given IE buffer is well-formed, this
5182 * has to be guaranteed by the caller!
5184 * It also assumes that the IEs in the buffer are ordered
5185 * correctly, if not the result of using this function will not
5186 * be ordered correctly either, i.e. it does no reordering.
5188 * The function returns the offset where the next part of the
5189 * buffer starts, which may be @ielen if the entire (remainder)
5190 * of the buffer should be used.
5192 size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5193 const u8 *ids, int n_ids, size_t offset);
5194 #endif /* MAC80211_H */