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>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
98 enum ieee80211_max_queues {
99 IEEE80211_MAX_QUEUES = 16,
100 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
103 #define IEEE80211_INVAL_HW_QUEUE 0xff
106 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
107 * @IEEE80211_AC_VO: voice
108 * @IEEE80211_AC_VI: video
109 * @IEEE80211_AC_BE: best effort
110 * @IEEE80211_AC_BK: background
112 enum ieee80211_ac_numbers {
118 #define IEEE80211_NUM_ACS 4
121 * struct ieee80211_tx_queue_params - transmit queue configuration
123 * The information provided in this structure is required for QoS
124 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
126 * @aifs: arbitration interframe space [0..255]
127 * @cw_min: minimum contention window [a value of the form
128 * 2^n-1 in the range 1..32767]
129 * @cw_max: maximum contention window [like @cw_min]
130 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
131 * @acm: is mandatory admission control required for the access category
132 * @uapsd: is U-APSD mode enabled for the queue
134 struct ieee80211_tx_queue_params {
143 struct ieee80211_low_level_stats {
144 unsigned int dot11ACKFailureCount;
145 unsigned int dot11RTSFailureCount;
146 unsigned int dot11FCSErrorCount;
147 unsigned int dot11RTSSuccessCount;
151 * enum ieee80211_chanctx_change - change flag for channel context
152 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
153 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
154 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
155 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
156 * this is used only with channel switching with CSA
158 enum ieee80211_chanctx_change {
159 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
160 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
161 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
162 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
166 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
168 * This is the driver-visible part. The ieee80211_chanctx
169 * that contains it is visible in mac80211 only.
171 * @def: the channel definition
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;
184 u8 rx_chains_static, rx_chains_dynamic;
188 u8 drv_priv[0] __aligned(sizeof(void *));
192 * enum ieee80211_bss_change - BSS change notification flags
194 * These flags are used with the bss_info_changed() callback
195 * to indicate which BSS parameter changed.
197 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
198 * also implies a change in the AID.
199 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
200 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
201 * @BSS_CHANGED_ERP_SLOT: slot timing changed
202 * @BSS_CHANGED_HT: 802.11n parameters changed
203 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
204 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
205 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
206 * reason (IBSS and managed mode)
207 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
208 * new beacon (beaconing modes)
209 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
210 * enabled/disabled (beaconing modes)
211 * @BSS_CHANGED_CQM: Connection quality monitor config changed
212 * @BSS_CHANGED_IBSS: IBSS join status changed
213 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
214 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
215 * that it is only ever disabled for station mode.
216 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
217 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
218 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
219 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
220 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
221 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
222 * changed (currently only in P2P client mode, GO mode will be later)
223 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
224 * currently dtim_period only is under consideration.
225 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
226 * note that this is only called when it changes after the channel
227 * context had been assigned.
229 enum ieee80211_bss_change {
230 BSS_CHANGED_ASSOC = 1<<0,
231 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
232 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
233 BSS_CHANGED_ERP_SLOT = 1<<3,
234 BSS_CHANGED_HT = 1<<4,
235 BSS_CHANGED_BASIC_RATES = 1<<5,
236 BSS_CHANGED_BEACON_INT = 1<<6,
237 BSS_CHANGED_BSSID = 1<<7,
238 BSS_CHANGED_BEACON = 1<<8,
239 BSS_CHANGED_BEACON_ENABLED = 1<<9,
240 BSS_CHANGED_CQM = 1<<10,
241 BSS_CHANGED_IBSS = 1<<11,
242 BSS_CHANGED_ARP_FILTER = 1<<12,
243 BSS_CHANGED_QOS = 1<<13,
244 BSS_CHANGED_IDLE = 1<<14,
245 BSS_CHANGED_SSID = 1<<15,
246 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
247 BSS_CHANGED_PS = 1<<17,
248 BSS_CHANGED_TXPOWER = 1<<18,
249 BSS_CHANGED_P2P_PS = 1<<19,
250 BSS_CHANGED_BEACON_INFO = 1<<20,
251 BSS_CHANGED_BANDWIDTH = 1<<21,
253 /* when adding here, make sure to change ieee80211_reconfig */
257 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
258 * of addresses for an interface increase beyond this value, hardware ARP
259 * filtering will be disabled.
261 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
264 * enum ieee80211_rssi_event - RSSI threshold event
265 * An indicator for when RSSI goes below/above a certain threshold.
266 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
267 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
269 enum ieee80211_rssi_event {
275 * struct ieee80211_bss_conf - holds the BSS's changing parameters
277 * This structure keeps information about a BSS (and an association
278 * to that BSS) that can change during the lifetime of the BSS.
280 * @assoc: association status
281 * @ibss_joined: indicates whether this station is part of an IBSS
283 * @ibss_creator: indicates if a new IBSS network is being created
284 * @aid: association ID number, valid only when @assoc is true
285 * @use_cts_prot: use CTS protection
286 * @use_short_preamble: use 802.11b short preamble;
287 * if the hardware cannot handle this it must set the
288 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
289 * @use_short_slot: use short slot time (only relevant for ERP);
290 * if the hardware cannot handle this it must set the
291 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
292 * @dtim_period: num of beacons before the next DTIM, for beaconing,
293 * valid in station mode only if after the driver was notified
294 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
295 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
296 * as it may have been received during scanning long ago). If the
297 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
298 * only come from a beacon, but might not become valid until after
299 * association when a beacon is received (which is notified with the
300 * %BSS_CHANGED_DTIM flag.)
301 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
302 * the driver/device can use this to calculate synchronisation
304 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
305 * is requested, see @sync_tsf/@sync_device_ts.
306 * @beacon_int: beacon interval
307 * @assoc_capability: capabilities taken from assoc resp
308 * @basic_rates: bitmap of basic rates, each bit stands for an
309 * index into the rate table configured by the driver in
311 * @beacon_rate: associated AP's beacon TX rate
312 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
313 * @bssid: The BSSID for this BSS
314 * @enable_beacon: whether beaconing should be enabled or not
315 * @chandef: Channel definition for this BSS -- the hardware might be
316 * configured a higher bandwidth than this BSS uses, for example.
317 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
318 * This field is only valid when the channel type is one of the HT types.
319 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
321 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
322 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
323 * may filter ARP queries targeted for other addresses than listed here.
324 * The driver must allow ARP queries targeted for all address listed here
325 * to pass through. An empty list implies no ARP queries need to pass.
326 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
327 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
328 * array size), it's up to the driver what to do in that case.
329 * @qos: This is a QoS-enabled BSS.
330 * @idle: This interface is idle. There's also a global idle flag in the
331 * hardware config which may be more appropriate depending on what
332 * your driver/device needs to do.
333 * @ps: power-save mode (STA only). This flag is NOT affected by
334 * offchannel/dynamic_ps operations.
335 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
336 * @ssid_len: Length of SSID given in @ssid.
337 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
338 * @txpower: TX power in dBm
339 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
341 struct ieee80211_bss_conf {
343 /* association related data */
344 bool assoc, ibss_joined;
347 /* erp related data */
349 bool use_short_preamble;
354 u16 assoc_capability;
359 struct ieee80211_rate *beacon_rate;
360 int mcast_rate[IEEE80211_NUM_BANDS];
361 u16 ht_operation_mode;
364 struct cfg80211_chan_def chandef;
365 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
370 u8 ssid[IEEE80211_MAX_SSID_LEN];
374 struct ieee80211_p2p_noa_attr p2p_noa_attr;
378 * enum mac80211_tx_control_flags - flags to describe transmission information/status
380 * These flags are used with the @flags member of &ieee80211_tx_info.
382 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
383 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
384 * number to this frame, taking care of not overwriting the fragment
385 * number and increasing the sequence number only when the
386 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
387 * assign sequence numbers to QoS-data frames but cannot do so correctly
388 * for non-QoS-data and management frames because beacons need them from
389 * that counter as well and mac80211 cannot guarantee proper sequencing.
390 * If this flag is set, the driver should instruct the hardware to
391 * assign a sequence number to the frame or assign one itself. Cf. IEEE
392 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
393 * beacons and always be clear for frames without a sequence number field.
394 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
395 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
397 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
398 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
399 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
400 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
401 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
402 * because the destination STA was in powersave mode. Note that to
403 * avoid race conditions, the filter must be set by the hardware or
404 * firmware upon receiving a frame that indicates that the station
405 * went to sleep (must be done on device to filter frames already on
406 * the queue) and may only be unset after mac80211 gives the OK for
407 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
408 * since only then is it guaranteed that no more frames are in the
410 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
411 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
412 * is for the whole aggregation.
413 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
414 * so consider using block ack request (BAR).
415 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
416 * set by rate control algorithms to indicate probe rate, will
417 * be cleared for fragmented frames (except on the last fragment)
418 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
419 * that a frame can be transmitted while the queues are stopped for
420 * off-channel operation.
421 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
422 * used to indicate that a pending frame requires TX processing before
423 * it can be sent out.
424 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
425 * used to indicate that a frame was already retried due to PS
426 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
427 * used to indicate frame should not be encrypted
428 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
429 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
430 * be sent although the station is in powersave mode.
431 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
432 * transmit function after the current frame, this can be used
433 * by drivers to kick the DMA queue only if unset or when the
435 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
436 * after TX status because the destination was asleep, it must not
437 * be modified again (no seqno assignment, crypto, etc.)
438 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
439 * code for connection establishment, this indicates that its status
440 * should kick the MLME state machine.
441 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
442 * MLME command (internal to mac80211 to figure out whether to send TX
443 * status to user space)
444 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
445 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
446 * frame and selects the maximum number of streams that it can use.
447 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
448 * the off-channel channel when a remain-on-channel offload is done
449 * in hardware -- normal packets still flow and are expected to be
450 * handled properly by the device.
451 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
452 * testing. It will be sent out with incorrect Michael MIC key to allow
453 * TKIP countermeasures to be tested.
454 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
455 * This flag is actually used for management frame especially for P2P
456 * frames not being sent at CCK rate in 2GHz band.
457 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
458 * when its status is reported the service period ends. For frames in
459 * an SP that mac80211 transmits, it is already set; for driver frames
460 * the driver may set this flag. It is also used to do the same for
462 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
463 * This flag is used to send nullfunc frame at minimum rate when
464 * the nullfunc is used for connection monitoring purpose.
465 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
466 * would be fragmented by size (this is optional, only used for
467 * monitor injection).
468 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
469 * frame (PS-Poll or uAPSD).
471 * Note: If you have to add new flags to the enumeration, then don't
472 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
474 enum mac80211_tx_control_flags {
475 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
476 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
477 IEEE80211_TX_CTL_NO_ACK = BIT(2),
478 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
479 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
480 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
481 IEEE80211_TX_CTL_AMPDU = BIT(6),
482 IEEE80211_TX_CTL_INJECTED = BIT(7),
483 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
484 IEEE80211_TX_STAT_ACK = BIT(9),
485 IEEE80211_TX_STAT_AMPDU = BIT(10),
486 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
487 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
488 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
489 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
490 IEEE80211_TX_INTFL_RETRIED = BIT(15),
491 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
492 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
493 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
494 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
495 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
496 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
497 IEEE80211_TX_CTL_LDPC = BIT(22),
498 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
499 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
500 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
501 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
502 IEEE80211_TX_STATUS_EOSP = BIT(28),
503 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
504 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
505 IEEE80211_TX_CTL_PS_RESPONSE = BIT(31),
508 #define IEEE80211_TX_CTL_STBC_SHIFT 23
511 * This definition is used as a mask to clear all temporary flags, which are
512 * set by the tx handlers for each transmission attempt by the mac80211 stack.
514 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
515 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
516 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
517 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
518 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
519 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
520 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
521 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
524 * enum mac80211_rate_control_flags - per-rate flags set by the
525 * Rate Control algorithm.
527 * These flags are set by the Rate control algorithm for each rate during tx,
528 * in the @flags member of struct ieee80211_tx_rate.
530 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
531 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
532 * This is set if the current BSS requires ERP protection.
533 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
534 * @IEEE80211_TX_RC_MCS: HT rate.
535 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
536 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
537 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
539 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
540 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
541 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
542 * (80+80 isn't supported yet)
543 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
544 * adjacent 20 MHz channels, if the current channel type is
545 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
546 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
548 enum mac80211_rate_control_flags {
549 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
550 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
551 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
553 /* rate index is an HT/VHT MCS instead of an index */
554 IEEE80211_TX_RC_MCS = BIT(3),
555 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
556 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
557 IEEE80211_TX_RC_DUP_DATA = BIT(6),
558 IEEE80211_TX_RC_SHORT_GI = BIT(7),
559 IEEE80211_TX_RC_VHT_MCS = BIT(8),
560 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
561 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
565 /* there are 40 bytes if you don't need the rateset to be kept */
566 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
568 /* if you do need the rateset, then you have less space */
569 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
571 /* maximum number of rate stages */
572 #define IEEE80211_TX_MAX_RATES 4
574 /* maximum number of rate table entries */
575 #define IEEE80211_TX_RATE_TABLE_SIZE 4
578 * struct ieee80211_tx_rate - rate selection/status
580 * @idx: rate index to attempt to send with
581 * @flags: rate control flags (&enum mac80211_rate_control_flags)
582 * @count: number of tries in this rate before going to the next rate
584 * A value of -1 for @idx indicates an invalid rate and, if used
585 * in an array of retry rates, that no more rates should be tried.
587 * When used for transmit status reporting, the driver should
588 * always report the rate along with the flags it used.
590 * &struct ieee80211_tx_info contains an array of these structs
591 * in the control information, and it will be filled by the rate
592 * control algorithm according to what should be sent. For example,
593 * if this array contains, in the format { <idx>, <count> } the
595 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
596 * then this means that the frame should be transmitted
597 * up to twice at rate 3, up to twice at rate 2, and up to four
598 * times at rate 1 if it doesn't get acknowledged. Say it gets
599 * acknowledged by the peer after the fifth attempt, the status
600 * information should then contain
601 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
602 * since it was transmitted twice at rate 3, twice at rate 2
603 * and once at rate 1 after which we received an acknowledgement.
605 struct ieee80211_tx_rate {
611 #define IEEE80211_MAX_TX_RETRY 31
613 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
617 WARN_ON((nss - 1) & ~0x7);
618 rate->idx = ((nss - 1) << 4) | mcs;
622 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
624 return rate->idx & 0xF;
628 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
630 return (rate->idx >> 4) + 1;
634 * struct ieee80211_tx_info - skb transmit information
636 * This structure is placed in skb->cb for three uses:
637 * (1) mac80211 TX control - mac80211 tells the driver what to do
638 * (2) driver internal use (if applicable)
639 * (3) TX status information - driver tells mac80211 what happened
641 * @flags: transmit info flags, defined above
642 * @band: the band to transmit on (use for checking for races)
643 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
644 * @ack_frame_id: internal frame ID for TX status, used internally
645 * @control: union for control data
646 * @status: union for status data
647 * @driver_data: array of driver_data pointers
648 * @ampdu_ack_len: number of acked aggregated frames.
649 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
650 * @ampdu_len: number of aggregated frames.
651 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
652 * @ack_signal: signal strength of the ACK frame
654 struct ieee80211_tx_info {
655 /* common information */
668 struct ieee80211_tx_rate rates[
669 IEEE80211_TX_MAX_RATES];
677 /* only needed before rate control */
678 unsigned long jiffies;
680 /* NB: vif can be NULL for injected frames */
681 struct ieee80211_vif *vif;
682 struct ieee80211_key_conf *hw_key;
686 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
694 struct ieee80211_tx_rate driver_rates[
695 IEEE80211_TX_MAX_RATES];
698 void *rate_driver_data[
699 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
702 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
707 * struct ieee80211_sched_scan_ies - scheduled scan IEs
709 * This structure is used to pass the appropriate IEs to be used in scheduled
710 * scans for all bands. It contains both the IEs passed from the userspace
711 * and the ones generated by mac80211.
713 * @ie: array with the IEs for each supported band
714 * @len: array with the total length of the IEs for each band
716 struct ieee80211_sched_scan_ies {
717 u8 *ie[IEEE80211_NUM_BANDS];
718 size_t len[IEEE80211_NUM_BANDS];
721 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
723 return (struct ieee80211_tx_info *)skb->cb;
726 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
728 return (struct ieee80211_rx_status *)skb->cb;
732 * ieee80211_tx_info_clear_status - clear TX status
734 * @info: The &struct ieee80211_tx_info to be cleared.
736 * When the driver passes an skb back to mac80211, it must report
737 * a number of things in TX status. This function clears everything
738 * in the TX status but the rate control information (it does clear
739 * the count since you need to fill that in anyway).
741 * NOTE: You can only use this function if you do NOT use
742 * info->driver_data! Use info->rate_driver_data
743 * instead if you need only the less space that allows.
746 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
750 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
751 offsetof(struct ieee80211_tx_info, control.rates));
752 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
753 offsetof(struct ieee80211_tx_info, driver_rates));
754 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
755 /* clear the rate counts */
756 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
757 info->status.rates[i].count = 0;
760 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
761 memset(&info->status.ampdu_ack_len, 0,
762 sizeof(struct ieee80211_tx_info) -
763 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
768 * enum mac80211_rx_flags - receive flags
770 * These flags are used with the @flag member of &struct ieee80211_rx_status.
771 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
772 * Use together with %RX_FLAG_MMIC_STRIPPED.
773 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
774 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
775 * verification has been done by the hardware.
776 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
777 * If this flag is set, the stack cannot do any replay detection
778 * hence the driver or hardware will have to do that.
779 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
781 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
783 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
784 * field) is valid and contains the time the first symbol of the MPDU
785 * was received. This is useful in monitor mode and for proper IBSS
787 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
788 * field) is valid and contains the time the last symbol of the MPDU
789 * (including FCS) was received.
790 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
791 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
792 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
793 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
794 * @RX_FLAG_80MHZ: 80 MHz was used
795 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
796 * @RX_FLAG_160MHZ: 160 MHz was used
797 * @RX_FLAG_SHORT_GI: Short guard interval was used
798 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
799 * Valid only for data frames (mainly A-MPDU)
800 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
801 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
802 * to hw.radiotap_mcs_details to advertise that fact
803 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
804 * number (@ampdu_reference) must be populated and be a distinct number for
806 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
807 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
808 * monitoring purposes only
809 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
810 * subframes of a single A-MPDU
811 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
812 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
814 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
815 * is stored in the @ampdu_delimiter_crc field)
816 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
817 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
818 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
820 enum mac80211_rx_flags {
821 RX_FLAG_MMIC_ERROR = BIT(0),
822 RX_FLAG_DECRYPTED = BIT(1),
823 RX_FLAG_MMIC_STRIPPED = BIT(3),
824 RX_FLAG_IV_STRIPPED = BIT(4),
825 RX_FLAG_FAILED_FCS_CRC = BIT(5),
826 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
827 RX_FLAG_MACTIME_START = BIT(7),
828 RX_FLAG_SHORTPRE = BIT(8),
830 RX_FLAG_40MHZ = BIT(10),
831 RX_FLAG_SHORT_GI = BIT(11),
832 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
833 RX_FLAG_HT_GF = BIT(13),
834 RX_FLAG_AMPDU_DETAILS = BIT(14),
835 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
836 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
837 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
838 RX_FLAG_AMPDU_IS_LAST = BIT(18),
839 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
840 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
841 RX_FLAG_MACTIME_END = BIT(21),
842 RX_FLAG_VHT = BIT(22),
843 RX_FLAG_80MHZ = BIT(23),
844 RX_FLAG_80P80MHZ = BIT(24),
845 RX_FLAG_160MHZ = BIT(25),
846 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
847 RX_FLAG_10MHZ = BIT(28),
848 RX_FLAG_5MHZ = BIT(29),
851 #define RX_FLAG_STBC_SHIFT 26
854 * struct ieee80211_rx_status - receive status
856 * The low-level driver should provide this information (the subset
857 * supported by hardware) to the 802.11 code with each received
858 * frame, in the skb's control buffer (cb).
860 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
861 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
862 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
863 * it but can store it and pass it back to the driver for synchronisation
864 * @band: the active band when this frame was received
865 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
866 * @signal: signal strength when receiving this frame, either in dBm, in dB or
867 * unspecified depending on the hardware capabilities flags
868 * @IEEE80211_HW_SIGNAL_*
869 * @chains: bitmask of receive chains for which separate signal strength
870 * values were filled.
871 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
872 * support dB or unspecified units)
873 * @antenna: antenna used
874 * @rate_idx: index of data rate into band's supported rates or MCS index if
875 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
876 * @vht_nss: number of streams (VHT only)
878 * @rx_flags: internal RX flags for mac80211
879 * @ampdu_reference: A-MPDU reference number, must be a different value for
880 * each A-MPDU but the same for each subframe within one A-MPDU
881 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
882 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
883 * @vendor_radiotap_len: radiotap vendor namespace length
884 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
885 * that the actual data must be at the start of the SKB data
887 * @vendor_radiotap_oui: radiotap vendor namespace OUI
888 * @vendor_radiotap_subns: radiotap vendor sub namespace
890 struct ieee80211_rx_status {
892 u32 device_timestamp;
895 u32 vendor_radiotap_bitmap;
896 u16 vendor_radiotap_len;
905 s8 chain_signal[IEEE80211_MAX_CHAINS];
906 u8 ampdu_delimiter_crc;
907 u8 vendor_radiotap_align;
908 u8 vendor_radiotap_oui[3];
909 u8 vendor_radiotap_subns;
913 * enum ieee80211_conf_flags - configuration flags
915 * Flags to define PHY configuration options
917 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
918 * to determine for example whether to calculate timestamps for packets
919 * or not, do not use instead of filter flags!
920 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
921 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
922 * meaning that the hardware still wakes up for beacons, is able to
923 * transmit frames and receive the possible acknowledgment frames.
924 * Not to be confused with hardware specific wakeup/sleep states,
925 * driver is responsible for that. See the section "Powersave support"
927 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
928 * the driver should be prepared to handle configuration requests but
929 * may turn the device off as much as possible. Typically, this flag will
930 * be set when an interface is set UP but not associated or scanning, but
931 * it can also be unset in that case when monitor interfaces are active.
932 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
935 enum ieee80211_conf_flags {
936 IEEE80211_CONF_MONITOR = (1<<0),
937 IEEE80211_CONF_PS = (1<<1),
938 IEEE80211_CONF_IDLE = (1<<2),
939 IEEE80211_CONF_OFFCHANNEL = (1<<3),
944 * enum ieee80211_conf_changed - denotes which configuration changed
946 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
947 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
948 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
949 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
950 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
951 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
952 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
953 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
954 * Note that this is only valid if channel contexts are not used,
955 * otherwise each channel context has the number of chains listed.
957 enum ieee80211_conf_changed {
958 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
959 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
960 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
961 IEEE80211_CONF_CHANGE_PS = BIT(4),
962 IEEE80211_CONF_CHANGE_POWER = BIT(5),
963 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
964 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
965 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
969 * enum ieee80211_smps_mode - spatial multiplexing power save mode
971 * @IEEE80211_SMPS_AUTOMATIC: automatic
972 * @IEEE80211_SMPS_OFF: off
973 * @IEEE80211_SMPS_STATIC: static
974 * @IEEE80211_SMPS_DYNAMIC: dynamic
975 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
977 enum ieee80211_smps_mode {
978 IEEE80211_SMPS_AUTOMATIC,
980 IEEE80211_SMPS_STATIC,
981 IEEE80211_SMPS_DYNAMIC,
984 IEEE80211_SMPS_NUM_MODES,
988 * struct ieee80211_conf - configuration of the device
990 * This struct indicates how the driver shall configure the hardware.
992 * @flags: configuration flags defined above
994 * @listen_interval: listen interval in units of beacon interval
995 * @max_sleep_period: the maximum number of beacon intervals to sleep for
996 * before checking the beacon for a TIM bit (managed mode only); this
997 * value will be only achievable between DTIM frames, the hardware
998 * needs to check for the multicast traffic bit in DTIM beacons.
999 * This variable is valid only when the CONF_PS flag is set.
1000 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1001 * in power saving. Power saving will not be enabled until a beacon
1002 * has been received and the DTIM period is known.
1003 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1004 * powersave documentation below. This variable is valid only when
1005 * the CONF_PS flag is set.
1007 * @power_level: requested transmit power (in dBm), backward compatibility
1008 * value only that is set to the minimum of all interfaces
1010 * @chandef: the channel definition to tune to
1011 * @radar_enabled: whether radar detection is enabled
1013 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1014 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1015 * but actually means the number of transmissions not the number of retries
1016 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1017 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1018 * number of transmissions not the number of retries
1020 * @smps_mode: spatial multiplexing powersave mode; note that
1021 * %IEEE80211_SMPS_STATIC is used when the device is not
1022 * configured for an HT channel.
1023 * Note that this is only valid if channel contexts are not used,
1024 * otherwise each channel context has the number of chains listed.
1026 struct ieee80211_conf {
1028 int power_level, dynamic_ps_timeout;
1029 int max_sleep_period;
1031 u16 listen_interval;
1034 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1036 struct cfg80211_chan_def chandef;
1038 enum ieee80211_smps_mode smps_mode;
1042 * struct ieee80211_channel_switch - holds the channel switch data
1044 * The information provided in this structure is required for channel switch
1047 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1048 * Function (TSF) timer when the frame containing the channel switch
1049 * announcement was received. This is simply the rx.mactime parameter
1050 * the driver passed into mac80211.
1051 * @block_tx: Indicates whether transmission must be blocked before the
1052 * scheduled channel switch, as indicated by the AP.
1053 * @chandef: the new channel to switch to
1054 * @count: the number of TBTT's until the channel switch event
1056 struct ieee80211_channel_switch {
1059 struct cfg80211_chan_def chandef;
1064 * enum ieee80211_vif_flags - virtual interface flags
1066 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1067 * on this virtual interface to avoid unnecessary CPU wakeups
1068 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1069 * monitoring on this virtual interface -- i.e. it can monitor
1070 * connection quality related parameters, such as the RSSI level and
1071 * provide notifications if configured trigger levels are reached.
1073 enum ieee80211_vif_flags {
1074 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1075 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1079 * struct ieee80211_vif - per-interface data
1081 * Data in this structure is continually present for driver
1082 * use during the life of a virtual interface.
1084 * @type: type of this virtual interface
1085 * @bss_conf: BSS configuration for this interface, either our own
1086 * or the BSS we're associated to
1087 * @addr: address of this interface
1088 * @p2p: indicates whether this AP or STA interface is a p2p
1089 * interface, i.e. a GO or p2p-sta respectively
1090 * @csa_active: marks whether a channel switch is going on
1091 * @driver_flags: flags/capabilities the driver has for this interface,
1092 * these need to be set (or cleared) when the interface is added
1093 * or, if supported by the driver, the interface type is changed
1094 * at runtime, mac80211 will never touch this field
1095 * @hw_queue: hardware queue for each AC
1096 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1097 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1098 * when it is not assigned. This pointer is RCU-protected due to the TX
1099 * path needing to access it; even though the netdev carrier will always
1100 * be off when it is %NULL there can still be races and packets could be
1101 * processed after it switches back to %NULL.
1102 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1103 * interface debug files. Note that it will be NULL for the virtual
1104 * monitor interface (if that is requested.)
1105 * @drv_priv: data area for driver use, will always be aligned to
1108 struct ieee80211_vif {
1109 enum nl80211_iftype type;
1110 struct ieee80211_bss_conf bss_conf;
1116 u8 hw_queue[IEEE80211_NUM_ACS];
1118 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1122 #ifdef CONFIG_MAC80211_DEBUGFS
1123 struct dentry *debugfs_dir;
1127 u8 drv_priv[0] __aligned(sizeof(void *));
1130 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1132 #ifdef CONFIG_MAC80211_MESH
1133 return vif->type == NL80211_IFTYPE_MESH_POINT;
1139 * enum ieee80211_key_flags - key flags
1141 * These flags are used for communication about keys between the driver
1142 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1144 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1145 * driver to indicate that it requires IV generation for this
1147 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1148 * the driver for a TKIP key if it requires Michael MIC
1149 * generation in software.
1150 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1151 * that the key is pairwise rather then a shared key.
1152 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1153 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1154 * be done in software.
1155 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1156 * if space should be prepared for the IV, but the IV
1157 * itself should not be generated. Do not set together with
1158 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1159 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1160 * management frames. The flag can help drivers that have a hardware
1161 * crypto implementation that doesn't deal with management frames
1162 * properly by allowing them to not upload the keys to hardware and
1163 * fall back to software crypto. Note that this flag deals only with
1164 * RX, if your crypto engine can't deal with TX you can also set the
1165 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1167 enum ieee80211_key_flags {
1168 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1169 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1170 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
1171 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
1172 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1173 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
1177 * struct ieee80211_key_conf - key information
1179 * This key information is given by mac80211 to the driver by
1180 * the set_key() callback in &struct ieee80211_ops.
1182 * @hw_key_idx: To be set by the driver, this is the key index the driver
1183 * wants to be given when a frame is transmitted and needs to be
1184 * encrypted in hardware.
1185 * @cipher: The key's cipher suite selector.
1186 * @flags: key flags, see &enum ieee80211_key_flags.
1187 * @keyidx: the key index (0-3)
1188 * @keylen: key material length
1189 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1191 * - Temporal Encryption Key (128 bits)
1192 * - Temporal Authenticator Tx MIC Key (64 bits)
1193 * - Temporal Authenticator Rx MIC Key (64 bits)
1194 * @icv_len: The ICV length for this key type
1195 * @iv_len: The IV length for this key type
1197 struct ieee80211_key_conf {
1209 * enum set_key_cmd - key command
1211 * Used with the set_key() callback in &struct ieee80211_ops, this
1212 * indicates whether a key is being removed or added.
1214 * @SET_KEY: a key is set
1215 * @DISABLE_KEY: a key must be disabled
1218 SET_KEY, DISABLE_KEY,
1222 * enum ieee80211_sta_state - station state
1224 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1225 * this is a special state for add/remove transitions
1226 * @IEEE80211_STA_NONE: station exists without special state
1227 * @IEEE80211_STA_AUTH: station is authenticated
1228 * @IEEE80211_STA_ASSOC: station is associated
1229 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1231 enum ieee80211_sta_state {
1232 /* NOTE: These need to be ordered correctly! */
1233 IEEE80211_STA_NOTEXIST,
1236 IEEE80211_STA_ASSOC,
1237 IEEE80211_STA_AUTHORIZED,
1241 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1242 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1243 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1244 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1245 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1246 * (including 80+80 MHz)
1248 * Implementation note: 20 must be zero to be initialized
1249 * correctly, the values must be sorted.
1251 enum ieee80211_sta_rx_bandwidth {
1252 IEEE80211_STA_RX_BW_20 = 0,
1253 IEEE80211_STA_RX_BW_40,
1254 IEEE80211_STA_RX_BW_80,
1255 IEEE80211_STA_RX_BW_160,
1259 * struct ieee80211_sta_rates - station rate selection table
1261 * @rcu_head: RCU head used for freeing the table on update
1262 * @rate: transmit rates/flags to be used by default.
1263 * Overriding entries per-packet is possible by using cb tx control.
1265 struct ieee80211_sta_rates {
1266 struct rcu_head rcu_head;
1273 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1277 * struct ieee80211_sta - station table entry
1279 * A station table entry represents a station we are possibly
1280 * communicating with. Since stations are RCU-managed in
1281 * mac80211, any ieee80211_sta pointer you get access to must
1282 * either be protected by rcu_read_lock() explicitly or implicitly,
1283 * or you must take good care to not use such a pointer after a
1284 * call to your sta_remove callback that removed it.
1286 * @addr: MAC address
1287 * @aid: AID we assigned to the station if we're an AP
1288 * @supp_rates: Bitmap of supported rates (per band)
1289 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1290 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1291 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1292 * @drv_priv: data area for driver use, will always be aligned to
1293 * sizeof(void *), size is determined in hw information.
1294 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1295 * if wme is supported.
1296 * @max_sp: max Service Period. Only valid if wme is supported.
1297 * @bandwidth: current bandwidth the station can receive with
1298 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1299 * station can receive at the moment, changed by operating mode
1300 * notifications and capabilities. The value is only valid after
1301 * the station moves to associated state.
1302 * @smps_mode: current SMPS mode (off, static or dynamic)
1303 * @rates: rate control selection table
1305 struct ieee80211_sta {
1306 u32 supp_rates[IEEE80211_NUM_BANDS];
1309 struct ieee80211_sta_ht_cap ht_cap;
1310 struct ieee80211_sta_vht_cap vht_cap;
1315 enum ieee80211_sta_rx_bandwidth bandwidth;
1316 enum ieee80211_smps_mode smps_mode;
1317 struct ieee80211_sta_rates __rcu *rates;
1320 u8 drv_priv[0] __aligned(sizeof(void *));
1324 * enum sta_notify_cmd - sta notify command
1326 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1327 * indicates if an associated station made a power state transition.
1329 * @STA_NOTIFY_SLEEP: a station is now sleeping
1330 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1332 enum sta_notify_cmd {
1333 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1337 * struct ieee80211_tx_control - TX control data
1339 * @sta: station table entry, this sta pointer may be NULL and
1340 * it is not allowed to copy the pointer, due to RCU.
1342 struct ieee80211_tx_control {
1343 struct ieee80211_sta *sta;
1347 * enum ieee80211_hw_flags - hardware flags
1349 * These flags are used to indicate hardware capabilities to
1350 * the stack. Generally, flags here should have their meaning
1351 * done in a way that the simplest hardware doesn't need setting
1352 * any particular flags. There are some exceptions to this rule,
1353 * however, so you are advised to review these flags carefully.
1355 * @IEEE80211_HW_HAS_RATE_CONTROL:
1356 * The hardware or firmware includes rate control, and cannot be
1357 * controlled by the stack. As such, no rate control algorithm
1358 * should be instantiated, and the TX rate reported to userspace
1359 * will be taken from the TX status instead of the rate control
1361 * Note that this requires that the driver implement a number of
1362 * callbacks so it has the correct information, it needs to have
1363 * the @set_rts_threshold callback and must look at the BSS config
1364 * @use_cts_prot for G/N protection, @use_short_slot for slot
1365 * timing in 2.4 GHz and @use_short_preamble for preambles for
1368 * @IEEE80211_HW_RX_INCLUDES_FCS:
1369 * Indicates that received frames passed to the stack include
1370 * the FCS at the end.
1372 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1373 * Some wireless LAN chipsets buffer broadcast/multicast frames
1374 * for power saving stations in the hardware/firmware and others
1375 * rely on the host system for such buffering. This option is used
1376 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1377 * multicast frames when there are power saving stations so that
1378 * the driver can fetch them with ieee80211_get_buffered_bc().
1380 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1381 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1383 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1384 * Hardware is not capable of receiving frames with short preamble on
1387 * @IEEE80211_HW_SIGNAL_UNSPEC:
1388 * Hardware can provide signal values but we don't know its units. We
1389 * expect values between 0 and @max_signal.
1390 * If possible please provide dB or dBm instead.
1392 * @IEEE80211_HW_SIGNAL_DBM:
1393 * Hardware gives signal values in dBm, decibel difference from
1394 * one milliwatt. This is the preferred method since it is standardized
1395 * between different devices. @max_signal does not need to be set.
1397 * @IEEE80211_HW_SPECTRUM_MGMT:
1398 * Hardware supports spectrum management defined in 802.11h
1399 * Measurement, Channel Switch, Quieting, TPC
1401 * @IEEE80211_HW_AMPDU_AGGREGATION:
1402 * Hardware supports 11n A-MPDU aggregation.
1404 * @IEEE80211_HW_SUPPORTS_PS:
1405 * Hardware has power save support (i.e. can go to sleep).
1407 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1408 * Hardware requires nullfunc frame handling in stack, implies
1409 * stack support for dynamic PS.
1411 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1412 * Hardware has support for dynamic PS.
1414 * @IEEE80211_HW_MFP_CAPABLE:
1415 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1417 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1418 * Hardware supports static spatial multiplexing powersave,
1419 * ie. can turn off all but one chain even on HT connections
1420 * that should be using more chains.
1422 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1423 * Hardware supports dynamic spatial multiplexing powersave,
1424 * ie. can turn off all but one chain and then wake the rest
1425 * up as required after, for example, rts/cts handshake.
1427 * @IEEE80211_HW_SUPPORTS_UAPSD:
1428 * Hardware supports Unscheduled Automatic Power Save Delivery
1429 * (U-APSD) in managed mode. The mode is configured with
1430 * conf_tx() operation.
1432 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1433 * Hardware can provide ack status reports of Tx frames to
1436 * @IEEE80211_HW_CONNECTION_MONITOR:
1437 * The hardware performs its own connection monitoring, including
1438 * periodic keep-alives to the AP and probing the AP on beacon loss.
1439 * When this flag is set, signaling beacon-loss will cause an immediate
1440 * change to disassociated state.
1442 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1443 * This device needs to get data from beacon before association (i.e.
1446 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1447 * per-station GTKs as used by IBSS RSN or during fast transition. If
1448 * the device doesn't support per-station GTKs, but can be asked not
1449 * to decrypt group addressed frames, then IBSS RSN support is still
1450 * possible but software crypto will be used. Advertise the wiphy flag
1451 * only in that case.
1453 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1454 * autonomously manages the PS status of connected stations. When
1455 * this flag is set mac80211 will not trigger PS mode for connected
1456 * stations based on the PM bit of incoming frames.
1457 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1458 * the PS mode of connected stations.
1460 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1461 * setup strictly in HW. mac80211 should not attempt to do this in
1464 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1465 * a virtual monitor interface when monitor interfaces are the only
1466 * active interfaces.
1468 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1469 * queue mapping in order to use different queues (not just one per AC)
1470 * for different virtual interfaces. See the doc section on HW queue
1471 * control for more details.
1473 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1474 * selection table provided by the rate control algorithm.
1476 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1477 * P2P Interface. This will be honoured even if more than one interface
1480 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1481 * only, to allow getting TBTT of a DTIM beacon.
1483 enum ieee80211_hw_flags {
1484 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1485 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1486 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1487 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1488 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1489 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1490 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1491 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1492 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1493 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1494 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1495 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1496 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1497 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1498 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1499 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1500 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1501 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1502 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1503 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1504 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1505 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1506 IEEE80211_HW_AP_LINK_PS = 1<<22,
1507 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1508 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1509 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1510 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1514 * struct ieee80211_hw - hardware information and state
1516 * This structure contains the configuration and hardware
1517 * information for an 802.11 PHY.
1519 * @wiphy: This points to the &struct wiphy allocated for this
1520 * 802.11 PHY. You must fill in the @perm_addr and @dev
1521 * members of this structure using SET_IEEE80211_DEV()
1522 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1523 * bands (with channels, bitrates) are registered here.
1525 * @conf: &struct ieee80211_conf, device configuration, don't use.
1527 * @priv: pointer to private area that was allocated for driver use
1528 * along with this structure.
1530 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1532 * @extra_tx_headroom: headroom to reserve in each transmit skb
1533 * for use by the driver (e.g. for transmit headers.)
1535 * @channel_change_time: time (in microseconds) it takes to change channels.
1537 * @max_signal: Maximum value for signal (rssi) in RX information, used
1538 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1540 * @max_listen_interval: max listen interval in units of beacon interval
1543 * @queues: number of available hardware transmit queues for
1544 * data packets. WMM/QoS requires at least four, these
1545 * queues need to have configurable access parameters.
1547 * @rate_control_algorithm: rate control algorithm for this hardware.
1548 * If unset (NULL), the default algorithm will be used. Must be
1549 * set before calling ieee80211_register_hw().
1551 * @vif_data_size: size (in bytes) of the drv_priv data area
1552 * within &struct ieee80211_vif.
1553 * @sta_data_size: size (in bytes) of the drv_priv data area
1554 * within &struct ieee80211_sta.
1555 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1556 * within &struct ieee80211_chanctx_conf.
1558 * @max_rates: maximum number of alternate rate retry stages the hw
1560 * @max_report_rates: maximum number of alternate rate retry stages
1561 * the hw can report back.
1562 * @max_rate_tries: maximum number of tries for each stage
1564 * @napi_weight: weight used for NAPI polling. You must specify an
1565 * appropriate value here if a napi_poll operation is provided
1568 * @max_rx_aggregation_subframes: maximum buffer size (number of
1569 * sub-frames) to be used for A-MPDU block ack receiver
1571 * This is only relevant if the device has restrictions on the
1572 * number of subframes, if it relies on mac80211 to do reordering
1573 * it shouldn't be set.
1575 * @max_tx_aggregation_subframes: maximum number of subframes in an
1576 * aggregate an HT driver will transmit, used by the peer as a
1577 * hint to size its reorder buffer.
1579 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1580 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1582 * @radiotap_mcs_details: lists which MCS information can the HW
1583 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1584 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1585 * adding _BW is supported today.
1587 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1588 * the default is _GI | _BANDWIDTH.
1589 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1591 * @netdev_features: netdev features to be set in each netdev created
1592 * from this HW. Note only HW checksum features are currently
1593 * compatible with mac80211. Other feature bits will be rejected.
1595 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1596 * for each access category if it is uAPSD trigger-enabled and delivery-
1597 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1598 * Each bit corresponds to different AC. Value '1' in specific bit means
1599 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1602 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1603 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1604 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1606 struct ieee80211_hw {
1607 struct ieee80211_conf conf;
1608 struct wiphy *wiphy;
1609 const char *rate_control_algorithm;
1612 unsigned int extra_tx_headroom;
1613 int channel_change_time;
1616 int chanctx_data_size;
1619 u16 max_listen_interval;
1622 u8 max_report_rates;
1624 u8 max_rx_aggregation_subframes;
1625 u8 max_tx_aggregation_subframes;
1626 u8 offchannel_tx_hw_queue;
1627 u8 radiotap_mcs_details;
1628 u16 radiotap_vht_details;
1629 netdev_features_t netdev_features;
1631 u8 uapsd_max_sp_len;
1635 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1637 * @wiphy: the &struct wiphy which we want to query
1639 * mac80211 drivers can use this to get to their respective
1640 * &struct ieee80211_hw. Drivers wishing to get to their own private
1641 * structure can then access it via hw->priv. Note that mac802111 drivers should
1642 * not use wiphy_priv() to try to get their private driver structure as this
1643 * is already used internally by mac80211.
1645 * Return: The mac80211 driver hw struct of @wiphy.
1647 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1650 * SET_IEEE80211_DEV - set device for 802.11 hardware
1652 * @hw: the &struct ieee80211_hw to set the device for
1653 * @dev: the &struct device of this 802.11 device
1655 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1657 set_wiphy_dev(hw->wiphy, dev);
1661 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1663 * @hw: the &struct ieee80211_hw to set the MAC address for
1664 * @addr: the address to set
1666 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1668 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1671 static inline struct ieee80211_rate *
1672 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1673 const struct ieee80211_tx_info *c)
1675 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1677 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1680 static inline struct ieee80211_rate *
1681 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1682 const struct ieee80211_tx_info *c)
1684 if (c->control.rts_cts_rate_idx < 0)
1686 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1689 static inline struct ieee80211_rate *
1690 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1691 const struct ieee80211_tx_info *c, int idx)
1693 if (c->control.rates[idx + 1].idx < 0)
1695 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1699 * ieee80211_free_txskb - free TX skb
1703 * Free a transmit skb. Use this funtion when some failure
1704 * to transmit happened and thus status cannot be reported.
1706 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1709 * DOC: Hardware crypto acceleration
1711 * mac80211 is capable of taking advantage of many hardware
1712 * acceleration designs for encryption and decryption operations.
1714 * The set_key() callback in the &struct ieee80211_ops for a given
1715 * device is called to enable hardware acceleration of encryption and
1716 * decryption. The callback takes a @sta parameter that will be NULL
1717 * for default keys or keys used for transmission only, or point to
1718 * the station information for the peer for individual keys.
1719 * Multiple transmission keys with the same key index may be used when
1720 * VLANs are configured for an access point.
1722 * When transmitting, the TX control data will use the @hw_key_idx
1723 * selected by the driver by modifying the &struct ieee80211_key_conf
1724 * pointed to by the @key parameter to the set_key() function.
1726 * The set_key() call for the %SET_KEY command should return 0 if
1727 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1728 * added; if you return 0 then hw_key_idx must be assigned to the
1729 * hardware key index, you are free to use the full u8 range.
1731 * When the cmd is %DISABLE_KEY then it must succeed.
1733 * Note that it is permissible to not decrypt a frame even if a key
1734 * for it has been uploaded to hardware, the stack will not make any
1735 * decision based on whether a key has been uploaded or not but rather
1736 * based on the receive flags.
1738 * The &struct ieee80211_key_conf structure pointed to by the @key
1739 * parameter is guaranteed to be valid until another call to set_key()
1740 * removes it, but it can only be used as a cookie to differentiate
1743 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1744 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1746 * The update_tkip_key() call updates the driver with the new phase 1 key.
1747 * This happens every time the iv16 wraps around (every 65536 packets). The
1748 * set_key() call will happen only once for each key (unless the AP did
1749 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1750 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1751 * handler is software decryption with wrap around of iv16.
1753 * The set_default_unicast_key() call updates the default WEP key index
1754 * configured to the hardware for WEP encryption type. This is required
1755 * for devices that support offload of data packets (e.g. ARP responses).
1759 * DOC: Powersave support
1761 * mac80211 has support for various powersave implementations.
1763 * First, it can support hardware that handles all powersaving by itself,
1764 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1765 * flag. In that case, it will be told about the desired powersave mode
1766 * with the %IEEE80211_CONF_PS flag depending on the association status.
1767 * The hardware must take care of sending nullfunc frames when necessary,
1768 * i.e. when entering and leaving powersave mode. The hardware is required
1769 * to look at the AID in beacons and signal to the AP that it woke up when
1770 * it finds traffic directed to it.
1772 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1773 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1774 * with hardware wakeup and sleep states. Driver is responsible for waking
1775 * up the hardware before issuing commands to the hardware and putting it
1776 * back to sleep at appropriate times.
1778 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1779 * buffered multicast/broadcast frames after the beacon. Also it must be
1780 * possible to send frames and receive the acknowledment frame.
1782 * Other hardware designs cannot send nullfunc frames by themselves and also
1783 * need software support for parsing the TIM bitmap. This is also supported
1784 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1785 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1786 * required to pass up beacons. The hardware is still required to handle
1787 * waking up for multicast traffic; if it cannot the driver must handle that
1788 * as best as it can, mac80211 is too slow to do that.
1790 * Dynamic powersave is an extension to normal powersave in which the
1791 * hardware stays awake for a user-specified period of time after sending a
1792 * frame so that reply frames need not be buffered and therefore delayed to
1793 * the next wakeup. It's compromise of getting good enough latency when
1794 * there's data traffic and still saving significantly power in idle
1797 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1798 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1799 * flag and mac80211 will handle everything automatically. Additionally,
1800 * hardware having support for the dynamic PS feature may set the
1801 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1802 * dynamic PS mode itself. The driver needs to look at the
1803 * @dynamic_ps_timeout hardware configuration value and use it that value
1804 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1805 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1806 * enabled whenever user has enabled powersave.
1808 * Driver informs U-APSD client support by enabling
1809 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1810 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1811 * Nullfunc frames and stay awake until the service period has ended. To
1812 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1813 * from that AC are transmitted with powersave enabled.
1815 * Note: U-APSD client mode is not yet supported with
1816 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1820 * DOC: Beacon filter support
1822 * Some hardware have beacon filter support to reduce host cpu wakeups
1823 * which will reduce system power consumption. It usually works so that
1824 * the firmware creates a checksum of the beacon but omits all constantly
1825 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1826 * beacon is forwarded to the host, otherwise it will be just dropped. That
1827 * way the host will only receive beacons where some relevant information
1828 * (for example ERP protection or WMM settings) have changed.
1830 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1831 * interface capability. The driver needs to enable beacon filter support
1832 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1833 * power save is enabled, the stack will not check for beacon loss and the
1834 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1836 * The time (or number of beacons missed) until the firmware notifies the
1837 * driver of a beacon loss event (which in turn causes the driver to call
1838 * ieee80211_beacon_loss()) should be configurable and will be controlled
1839 * by mac80211 and the roaming algorithm in the future.
1841 * Since there may be constantly changing information elements that nothing
1842 * in the software stack cares about, we will, in the future, have mac80211
1843 * tell the driver which information elements are interesting in the sense
1844 * that we want to see changes in them. This will include
1845 * - a list of information element IDs
1846 * - a list of OUIs for the vendor information element
1848 * Ideally, the hardware would filter out any beacons without changes in the
1849 * requested elements, but if it cannot support that it may, at the expense
1850 * of some efficiency, filter out only a subset. For example, if the device
1851 * doesn't support checking for OUIs it should pass up all changes in all
1852 * vendor information elements.
1854 * Note that change, for the sake of simplification, also includes information
1855 * elements appearing or disappearing from the beacon.
1857 * Some hardware supports an "ignore list" instead, just make sure nothing
1858 * that was requested is on the ignore list, and include commonly changing
1859 * information element IDs in the ignore list, for example 11 (BSS load) and
1860 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1861 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1862 * it could also include some currently unused IDs.
1865 * In addition to these capabilities, hardware should support notifying the
1866 * host of changes in the beacon RSSI. This is relevant to implement roaming
1867 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1868 * the received data packets). This can consist in notifying the host when
1869 * the RSSI changes significantly or when it drops below or rises above
1870 * configurable thresholds. In the future these thresholds will also be
1871 * configured by mac80211 (which gets them from userspace) to implement
1872 * them as the roaming algorithm requires.
1874 * If the hardware cannot implement this, the driver should ask it to
1875 * periodically pass beacon frames to the host so that software can do the
1876 * signal strength threshold checking.
1880 * DOC: Spatial multiplexing power save
1882 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1883 * power in an 802.11n implementation. For details on the mechanism
1884 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1885 * "11.2.3 SM power save".
1887 * The mac80211 implementation is capable of sending action frames
1888 * to update the AP about the station's SMPS mode, and will instruct
1889 * the driver to enter the specific mode. It will also announce the
1890 * requested SMPS mode during the association handshake. Hardware
1891 * support for this feature is required, and can be indicated by
1894 * The default mode will be "automatic", which nl80211/cfg80211
1895 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1896 * turned off otherwise.
1898 * To support this feature, the driver must set the appropriate
1899 * hardware support flags, and handle the SMPS flag to the config()
1900 * operation. It will then with this mechanism be instructed to
1901 * enter the requested SMPS mode while associated to an HT AP.
1905 * DOC: Frame filtering
1907 * mac80211 requires to see many management frames for proper
1908 * operation, and users may want to see many more frames when
1909 * in monitor mode. However, for best CPU usage and power consumption,
1910 * having as few frames as possible percolate through the stack is
1911 * desirable. Hence, the hardware should filter as much as possible.
1913 * To achieve this, mac80211 uses filter flags (see below) to tell
1914 * the driver's configure_filter() function which frames should be
1915 * passed to mac80211 and which should be filtered out.
1917 * Before configure_filter() is invoked, the prepare_multicast()
1918 * callback is invoked with the parameters @mc_count and @mc_list
1919 * for the combined multicast address list of all virtual interfaces.
1920 * It's use is optional, and it returns a u64 that is passed to
1921 * configure_filter(). Additionally, configure_filter() has the
1922 * arguments @changed_flags telling which flags were changed and
1923 * @total_flags with the new flag states.
1925 * If your device has no multicast address filters your driver will
1926 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1927 * parameter to see whether multicast frames should be accepted
1930 * All unsupported flags in @total_flags must be cleared.
1931 * Hardware does not support a flag if it is incapable of _passing_
1932 * the frame to the stack. Otherwise the driver must ignore
1933 * the flag, but not clear it.
1934 * You must _only_ clear the flag (announce no support for the
1935 * flag to mac80211) if you are not able to pass the packet type
1936 * to the stack (so the hardware always filters it).
1937 * So for example, you should clear @FIF_CONTROL, if your hardware
1938 * always filters control frames. If your hardware always passes
1939 * control frames to the kernel and is incapable of filtering them,
1940 * you do _not_ clear the @FIF_CONTROL flag.
1941 * This rule applies to all other FIF flags as well.
1945 * DOC: AP support for powersaving clients
1947 * In order to implement AP and P2P GO modes, mac80211 has support for
1948 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1949 * There currently is no support for sAPSD.
1951 * There is one assumption that mac80211 makes, namely that a client
1952 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1953 * Both are supported, and both can be used by the same client, but
1954 * they can't be used concurrently by the same client. This simplifies
1957 * The first thing to keep in mind is that there is a flag for complete
1958 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1959 * mac80211 expects the driver to handle most of the state machine for
1960 * powersaving clients and will ignore the PM bit in incoming frames.
1961 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1962 * stations' powersave transitions. In this mode, mac80211 also doesn't
1963 * handle PS-Poll/uAPSD.
1965 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1966 * PM bit in incoming frames for client powersave transitions. When a
1967 * station goes to sleep, we will stop transmitting to it. There is,
1968 * however, a race condition: a station might go to sleep while there is
1969 * data buffered on hardware queues. If the device has support for this
1970 * it will reject frames, and the driver should give the frames back to
1971 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1972 * cause mac80211 to retry the frame when the station wakes up. The
1973 * driver is also notified of powersave transitions by calling its
1974 * @sta_notify callback.
1976 * When the station is asleep, it has three choices: it can wake up,
1977 * it can PS-Poll, or it can possibly start a uAPSD service period.
1978 * Waking up is implemented by simply transmitting all buffered (and
1979 * filtered) frames to the station. This is the easiest case. When
1980 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1981 * will inform the driver of this with the @allow_buffered_frames
1982 * callback; this callback is optional. mac80211 will then transmit
1983 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1984 * on each frame. The last frame in the service period (or the only
1985 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1986 * indicate that it ends the service period; as this frame must have
1987 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1988 * When TX status is reported for this frame, the service period is
1989 * marked has having ended and a new one can be started by the peer.
1991 * Additionally, non-bufferable MMPDUs can also be transmitted by
1992 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1994 * Another race condition can happen on some devices like iwlwifi
1995 * when there are frames queued for the station and it wakes up
1996 * or polls; the frames that are already queued could end up being
1997 * transmitted first instead, causing reordering and/or wrong
1998 * processing of the EOSP. The cause is that allowing frames to be
1999 * transmitted to a certain station is out-of-band communication to
2000 * the device. To allow this problem to be solved, the driver can
2001 * call ieee80211_sta_block_awake() if frames are buffered when it
2002 * is notified that the station went to sleep. When all these frames
2003 * have been filtered (see above), it must call the function again
2004 * to indicate that the station is no longer blocked.
2006 * If the driver buffers frames in the driver for aggregation in any
2007 * way, it must use the ieee80211_sta_set_buffered() call when it is
2008 * notified of the station going to sleep to inform mac80211 of any
2009 * TIDs that have frames buffered. Note that when a station wakes up
2010 * this information is reset (hence the requirement to call it when
2011 * informed of the station going to sleep). Then, when a service
2012 * period starts for any reason, @release_buffered_frames is called
2013 * with the number of frames to be released and which TIDs they are
2014 * to come from. In this case, the driver is responsible for setting
2015 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2016 * to help the @more_data paramter is passed to tell the driver if
2017 * there is more data on other TIDs -- the TIDs to release frames
2018 * from are ignored since mac80211 doesn't know how many frames the
2019 * buffers for those TIDs contain.
2021 * If the driver also implement GO mode, where absence periods may
2022 * shorten service periods (or abort PS-Poll responses), it must
2023 * filter those response frames except in the case of frames that
2024 * are buffered in the driver -- those must remain buffered to avoid
2025 * reordering. Because it is possible that no frames are released
2026 * in this case, the driver must call ieee80211_sta_eosp()
2027 * to indicate to mac80211 that the service period ended anyway.
2029 * Finally, if frames from multiple TIDs are released from mac80211
2030 * but the driver might reorder them, it must clear & set the flags
2031 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2032 * and also take care of the EOSP and MORE_DATA bits in the frame.
2033 * The driver may also use ieee80211_sta_eosp() in this case.
2037 * DOC: HW queue control
2039 * Before HW queue control was introduced, mac80211 only had a single static
2040 * assignment of per-interface AC software queues to hardware queues. This
2041 * was problematic for a few reasons:
2042 * 1) off-channel transmissions might get stuck behind other frames
2043 * 2) multiple virtual interfaces couldn't be handled correctly
2044 * 3) after-DTIM frames could get stuck behind other frames
2046 * To solve this, hardware typically uses multiple different queues for all
2047 * the different usages, and this needs to be propagated into mac80211 so it
2048 * won't have the same problem with the software queues.
2050 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2051 * flag that tells it that the driver implements its own queue control. To do
2052 * so, the driver will set up the various queues in each &struct ieee80211_vif
2053 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2054 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2055 * if necessary will queue the frame on the right software queue that mirrors
2056 * the hardware queue.
2057 * Additionally, the driver has to then use these HW queue IDs for the queue
2058 * management functions (ieee80211_stop_queue() et al.)
2060 * The driver is free to set up the queue mappings as needed, multiple virtual
2061 * interfaces may map to the same hardware queues if needed. The setup has to
2062 * happen during add_interface or change_interface callbacks. For example, a
2063 * driver supporting station+station and station+AP modes might decide to have
2064 * 10 hardware queues to handle different scenarios:
2066 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2067 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2068 * after-DTIM queue for AP: 8
2069 * off-channel queue: 9
2071 * It would then set up the hardware like this:
2072 * hw.offchannel_tx_hw_queue = 9
2074 * and the first virtual interface that is added as follows:
2075 * vif.hw_queue[IEEE80211_AC_VO] = 0
2076 * vif.hw_queue[IEEE80211_AC_VI] = 1
2077 * vif.hw_queue[IEEE80211_AC_BE] = 2
2078 * vif.hw_queue[IEEE80211_AC_BK] = 3
2079 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2080 * and the second virtual interface with 4-7.
2082 * If queue 6 gets full, for example, mac80211 would only stop the second
2083 * virtual interface's BE queue since virtual interface queues are per AC.
2085 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2086 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2087 * queue could potentially be shared since mac80211 will look at cab_queue when
2088 * a queue is stopped/woken even if the interface is not in AP mode.
2092 * enum ieee80211_filter_flags - hardware filter flags
2094 * These flags determine what the filter in hardware should be
2095 * programmed to let through and what should not be passed to the
2096 * stack. It is always safe to pass more frames than requested,
2097 * but this has negative impact on power consumption.
2099 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2100 * think of the BSS as your network segment and then this corresponds
2101 * to the regular ethernet device promiscuous mode.
2103 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2104 * by the user or if the hardware is not capable of filtering by
2105 * multicast address.
2107 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2108 * %RX_FLAG_FAILED_FCS_CRC for them)
2110 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2111 * the %RX_FLAG_FAILED_PLCP_CRC for them
2113 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2114 * to the hardware that it should not filter beacons or probe responses
2115 * by BSSID. Filtering them can greatly reduce the amount of processing
2116 * mac80211 needs to do and the amount of CPU wakeups, so you should
2117 * honour this flag if possible.
2119 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2120 * is not set then only those addressed to this station.
2122 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2124 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2125 * those addressed to this station.
2127 * @FIF_PROBE_REQ: pass probe request frames
2129 enum ieee80211_filter_flags {
2130 FIF_PROMISC_IN_BSS = 1<<0,
2131 FIF_ALLMULTI = 1<<1,
2133 FIF_PLCPFAIL = 1<<3,
2134 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2136 FIF_OTHER_BSS = 1<<6,
2138 FIF_PROBE_REQ = 1<<8,
2142 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2144 * These flags are used with the ampdu_action() callback in
2145 * &struct ieee80211_ops to indicate which action is needed.
2147 * Note that drivers MUST be able to deal with a TX aggregation
2148 * session being stopped even before they OK'ed starting it by
2149 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2150 * might receive the addBA frame and send a delBA right away!
2152 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2153 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2154 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2155 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2156 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2157 * queued packets, now unaggregated. After all packets are transmitted the
2158 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2159 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2160 * called when the station is removed. There's no need or reason to call
2161 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2162 * session is gone and removes the station.
2163 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2164 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2165 * now the connection is dropped and the station will be removed. Drivers
2166 * should clean up and drop remaining packets when this is called.
2168 enum ieee80211_ampdu_mlme_action {
2169 IEEE80211_AMPDU_RX_START,
2170 IEEE80211_AMPDU_RX_STOP,
2171 IEEE80211_AMPDU_TX_START,
2172 IEEE80211_AMPDU_TX_STOP_CONT,
2173 IEEE80211_AMPDU_TX_STOP_FLUSH,
2174 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2175 IEEE80211_AMPDU_TX_OPERATIONAL,
2179 * enum ieee80211_frame_release_type - frame release reason
2180 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2181 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2182 * frame received on trigger-enabled AC
2184 enum ieee80211_frame_release_type {
2185 IEEE80211_FRAME_RELEASE_PSPOLL,
2186 IEEE80211_FRAME_RELEASE_UAPSD,
2190 * enum ieee80211_rate_control_changed - flags to indicate what changed
2192 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2193 * to this station changed. The actual bandwidth is in the station
2194 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2195 * flag changes, for HT and VHT the bandwidth field changes.
2196 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2197 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2198 * changed (in IBSS mode) due to discovering more information about
2200 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2203 enum ieee80211_rate_control_changed {
2204 IEEE80211_RC_BW_CHANGED = BIT(0),
2205 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2206 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2207 IEEE80211_RC_NSS_CHANGED = BIT(3),
2211 * enum ieee80211_roc_type - remain on channel type
2213 * With the support for multi channel contexts and multi channel operations,
2214 * remain on channel operations might be limited/deferred/aborted by other
2215 * flows/operations which have higher priority (and vise versa).
2216 * Specifying the ROC type can be used by devices to prioritize the ROC
2217 * operations compared to other operations/flows.
2219 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2220 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2221 * for sending managment frames offchannel.
2223 enum ieee80211_roc_type {
2224 IEEE80211_ROC_TYPE_NORMAL = 0,
2225 IEEE80211_ROC_TYPE_MGMT_TX,
2229 * struct ieee80211_ops - callbacks from mac80211 to the driver
2231 * This structure contains various callbacks that the driver may
2232 * handle or, in some cases, must handle, for example to configure
2233 * the hardware to a new channel or to transmit a frame.
2235 * @tx: Handler that 802.11 module calls for each transmitted frame.
2236 * skb contains the buffer starting from the IEEE 802.11 header.
2237 * The low-level driver should send the frame out based on
2238 * configuration in the TX control data. This handler should,
2239 * preferably, never fail and stop queues appropriately.
2242 * @start: Called before the first netdevice attached to the hardware
2243 * is enabled. This should turn on the hardware and must turn on
2244 * frame reception (for possibly enabled monitor interfaces.)
2245 * Returns negative error codes, these may be seen in userspace,
2247 * When the device is started it should not have a MAC address
2248 * to avoid acknowledging frames before a non-monitor device
2250 * Must be implemented and can sleep.
2252 * @stop: Called after last netdevice attached to the hardware
2253 * is disabled. This should turn off the hardware (at least
2254 * it must turn off frame reception.)
2255 * May be called right after add_interface if that rejects
2256 * an interface. If you added any work onto the mac80211 workqueue
2257 * you should ensure to cancel it on this callback.
2258 * Must be implemented and can sleep.
2260 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2261 * stop transmitting and doing any other configuration, and then
2262 * ask the device to suspend. This is only invoked when WoWLAN is
2263 * configured, otherwise the device is deconfigured completely and
2264 * reconfigured at resume time.
2265 * The driver may also impose special conditions under which it
2266 * wants to use the "normal" suspend (deconfigure), say if it only
2267 * supports WoWLAN when the device is associated. In this case, it
2268 * must return 1 from this function.
2270 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2271 * now resuming its operation, after this the device must be fully
2272 * functional again. If this returns an error, the only way out is
2273 * to also unregister the device. If it returns 1, then mac80211
2274 * will also go through the regular complete restart on resume.
2276 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2277 * modified. The reason is that device_set_wakeup_enable() is
2278 * supposed to be called when the configuration changes, not only
2281 * @add_interface: Called when a netdevice attached to the hardware is
2282 * enabled. Because it is not called for monitor mode devices, @start
2283 * and @stop must be implemented.
2284 * The driver should perform any initialization it needs before
2285 * the device can be enabled. The initial configuration for the
2286 * interface is given in the conf parameter.
2287 * The callback may refuse to add an interface by returning a
2288 * negative error code (which will be seen in userspace.)
2289 * Must be implemented and can sleep.
2291 * @change_interface: Called when a netdevice changes type. This callback
2292 * is optional, but only if it is supported can interface types be
2293 * switched while the interface is UP. The callback may sleep.
2294 * Note that while an interface is being switched, it will not be
2295 * found by the interface iteration callbacks.
2297 * @remove_interface: Notifies a driver that an interface is going down.
2298 * The @stop callback is called after this if it is the last interface
2299 * and no monitor interfaces are present.
2300 * When all interfaces are removed, the MAC address in the hardware
2301 * must be cleared so the device no longer acknowledges packets,
2302 * the mac_addr member of the conf structure is, however, set to the
2303 * MAC address of the device going away.
2304 * Hence, this callback must be implemented. It can sleep.
2306 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2307 * function to change hardware configuration, e.g., channel.
2308 * This function should never fail but returns a negative error code
2309 * if it does. The callback can sleep.
2311 * @bss_info_changed: Handler for configuration requests related to BSS
2312 * parameters that may vary during BSS's lifespan, and may affect low
2313 * level driver (e.g. assoc/disassoc status, erp parameters).
2314 * This function should not be used if no BSS has been set, unless
2315 * for association indication. The @changed parameter indicates which
2316 * of the bss parameters has changed when a call is made. The callback
2319 * @prepare_multicast: Prepare for multicast filter configuration.
2320 * This callback is optional, and its return value is passed
2321 * to configure_filter(). This callback must be atomic.
2323 * @configure_filter: Configure the device's RX filter.
2324 * See the section "Frame filtering" for more information.
2325 * This callback must be implemented and can sleep.
2327 * @set_multicast_list: Configure the device's interface specific RX multicast
2328 * filter. This callback is optional. This callback must be atomic.
2330 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2331 * must be set or cleared for a given STA. Must be atomic.
2333 * @set_key: See the section "Hardware crypto acceleration"
2334 * This callback is only called between add_interface and
2335 * remove_interface calls, i.e. while the given virtual interface
2337 * Returns a negative error code if the key can't be added.
2338 * The callback can sleep.
2340 * @update_tkip_key: See the section "Hardware crypto acceleration"
2341 * This callback will be called in the context of Rx. Called for drivers
2342 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2343 * The callback must be atomic.
2345 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2346 * host is suspended, it can assign this callback to retrieve the data
2347 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2348 * After rekeying was done it should (for example during resume) notify
2349 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2351 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2352 * WEP when the device sends data packets autonomously, e.g. for ARP
2353 * offloading. The index can be 0-3, or -1 for unsetting it.
2355 * @hw_scan: Ask the hardware to service the scan request, no need to start
2356 * the scan state machine in stack. The scan must honour the channel
2357 * configuration done by the regulatory agent in the wiphy's
2358 * registered bands. The hardware (or the driver) needs to make sure
2359 * that power save is disabled.
2360 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2361 * entire IEs after the SSID, so that drivers need not look at these
2362 * at all but just send them after the SSID -- mac80211 includes the
2363 * (extended) supported rates and HT information (where applicable).
2364 * When the scan finishes, ieee80211_scan_completed() must be called;
2365 * note that it also must be called when the scan cannot finish due to
2366 * any error unless this callback returned a negative error code.
2367 * The callback can sleep.
2369 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2370 * The driver should ask the hardware to cancel the scan (if possible),
2371 * but the scan will be completed only after the driver will call
2372 * ieee80211_scan_completed().
2373 * This callback is needed for wowlan, to prevent enqueueing a new
2374 * scan_work after the low-level driver was already suspended.
2375 * The callback can sleep.
2377 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2378 * specific intervals. The driver must call the
2379 * ieee80211_sched_scan_results() function whenever it finds results.
2380 * This process will continue until sched_scan_stop is called.
2382 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2384 * @sw_scan_start: Notifier function that is called just before a software scan
2385 * is started. Can be NULL, if the driver doesn't need this notification.
2386 * The callback can sleep.
2388 * @sw_scan_complete: Notifier function that is called just after a
2389 * software scan finished. Can be NULL, if the driver doesn't need
2390 * this notification.
2391 * The callback can sleep.
2393 * @get_stats: Return low-level statistics.
2394 * Returns zero if statistics are available.
2395 * The callback can sleep.
2397 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2398 * callback should be provided to read the TKIP transmit IVs (both IV32
2399 * and IV16) for the given key from hardware.
2400 * The callback must be atomic.
2402 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2403 * if the device does fragmentation by itself; if this callback is
2404 * implemented then the stack will not do fragmentation.
2405 * The callback can sleep.
2407 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2408 * The callback can sleep.
2410 * @sta_add: Notifies low level driver about addition of an associated station,
2411 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2413 * @sta_remove: Notifies low level driver about removal of an associated
2414 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2416 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2417 * when a station is added to mac80211's station list. This callback
2418 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2419 * conditional. This callback can sleep.
2421 * @sta_remove_debugfs: Remove the debugfs files which were added using
2422 * @sta_add_debugfs. This callback can sleep.
2424 * @sta_notify: Notifies low level driver about power state transition of an
2425 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2426 * in AP mode, this callback will not be called when the flag
2427 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2429 * @sta_state: Notifies low level driver about state transition of a
2430 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2431 * This callback is mutually exclusive with @sta_add/@sta_remove.
2432 * It must not fail for down transitions but may fail for transitions
2433 * up the list of states.
2434 * The callback can sleep.
2436 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2437 * used to transmit to the station. The changes are advertised with bits
2438 * from &enum ieee80211_rate_control_changed and the values are reflected
2439 * in the station data. This callback should only be used when the driver
2440 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2441 * otherwise the rate control algorithm is notified directly.
2444 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2445 * bursting) for a hardware TX queue.
2446 * Returns a negative error code on failure.
2447 * The callback can sleep.
2449 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2450 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2451 * required function.
2452 * The callback can sleep.
2454 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2455 * Currently, this is only used for IBSS mode debugging. Is not a
2456 * required function.
2457 * The callback can sleep.
2459 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2460 * with other STAs in the IBSS. This is only used in IBSS mode. This
2461 * function is optional if the firmware/hardware takes full care of
2462 * TSF synchronization.
2463 * The callback can sleep.
2465 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2466 * This is needed only for IBSS mode and the result of this function is
2467 * used to determine whether to reply to Probe Requests.
2468 * Returns non-zero if this device sent the last beacon.
2469 * The callback can sleep.
2471 * @ampdu_action: Perform a certain A-MPDU action
2472 * The RA/TID combination determines the destination and TID we want
2473 * the ampdu action to be performed for. The action is defined through
2474 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2475 * is the first frame we expect to perform the action on. Notice
2476 * that TX/RX_STOP can pass NULL for this parameter.
2477 * The @buf_size parameter is only valid when the action is set to
2478 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2479 * buffer size (number of subframes) for this session -- the driver
2480 * may neither send aggregates containing more subframes than this
2481 * nor send aggregates in a way that lost frames would exceed the
2482 * buffer size. If just limiting the aggregate size, this would be
2483 * possible with a buf_size of 8:
2485 * - RX: 2....7 (lost frame #1)
2487 * which is invalid since #1 was now re-transmitted well past the
2488 * buffer size of 8. Correct ways to retransmit #1 would be:
2489 * - TX: 1 or 18 or 81
2490 * Even "189" would be wrong since 1 could be lost again.
2492 * Returns a negative error code on failure.
2493 * The callback can sleep.
2495 * @get_survey: Return per-channel survey information
2497 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2498 * need to set wiphy->rfkill_poll to %true before registration,
2499 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2500 * The callback can sleep.
2502 * @set_coverage_class: Set slot time for given coverage class as specified
2503 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2504 * accordingly. This callback is not required and may sleep.
2506 * @testmode_cmd: Implement a cfg80211 test mode command.
2507 * The callback can sleep.
2508 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2510 * @flush: Flush all pending frames from the hardware queue, making sure
2511 * that the hardware queues are empty. The @queues parameter is a bitmap
2512 * of queues to flush, which is useful if different virtual interfaces
2513 * use different hardware queues; it may also indicate all queues.
2514 * If the parameter @drop is set to %true, pending frames may be dropped.
2515 * The callback can sleep.
2517 * @channel_switch: Drivers that need (or want) to offload the channel
2518 * switch operation for CSAs received from the AP may implement this
2519 * callback. They must then call ieee80211_chswitch_done() to indicate
2520 * completion of the channel switch.
2522 * @napi_poll: Poll Rx queue for incoming data frames.
2524 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2525 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2526 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2527 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2529 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2531 * @remain_on_channel: Starts an off-channel period on the given channel, must
2532 * call back to ieee80211_ready_on_channel() when on that channel. Note
2533 * that normal channel traffic is not stopped as this is intended for hw
2534 * offload. Frames to transmit on the off-channel channel are transmitted
2535 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2536 * duration (which will always be non-zero) expires, the driver must call
2537 * ieee80211_remain_on_channel_expired().
2538 * Note that this callback may be called while the device is in IDLE and
2539 * must be accepted in this case.
2540 * This callback may sleep.
2541 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2542 * aborted before it expires. This callback may sleep.
2544 * @set_ringparam: Set tx and rx ring sizes.
2546 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2548 * @tx_frames_pending: Check if there is any pending frame in the hardware
2549 * queues before entering power save.
2551 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2552 * when transmitting a frame. Currently only legacy rates are handled.
2553 * The callback can sleep.
2554 * @rssi_callback: Notify driver when the average RSSI goes above/below
2555 * thresholds that were registered previously. The callback can sleep.
2557 * @release_buffered_frames: Release buffered frames according to the given
2558 * parameters. In the case where the driver buffers some frames for
2559 * sleeping stations mac80211 will use this callback to tell the driver
2560 * to release some frames, either for PS-poll or uAPSD.
2561 * Note that if the @more_data paramter is %false the driver must check
2562 * if there are more frames on the given TIDs, and if there are more than
2563 * the frames being released then it must still set the more-data bit in
2564 * the frame. If the @more_data parameter is %true, then of course the
2565 * more-data bit must always be set.
2566 * The @tids parameter tells the driver which TIDs to release frames
2567 * from, for PS-poll it will always have only a single bit set.
2568 * In the case this is used for a PS-poll initiated release, the
2569 * @num_frames parameter will always be 1 so code can be shared. In
2570 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2571 * on the TX status (and must report TX status) so that the PS-poll
2572 * period is properly ended. This is used to avoid sending multiple
2573 * responses for a retried PS-poll frame.
2574 * In the case this is used for uAPSD, the @num_frames parameter may be
2575 * bigger than one, but the driver may send fewer frames (it must send
2576 * at least one, however). In this case it is also responsible for
2577 * setting the EOSP flag in the QoS header of the frames. Also, when the
2578 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2579 * on the last frame in the SP. Alternatively, it may call the function
2580 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2581 * This callback must be atomic.
2582 * @allow_buffered_frames: Prepare device to allow the given number of frames
2583 * to go out to the given station. The frames will be sent by mac80211
2584 * via the usual TX path after this call. The TX information for frames
2585 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2586 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2587 * frames from multiple TIDs are released and the driver might reorder
2588 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2589 * on the last frame and clear it on all others and also handle the EOSP
2590 * bit in the QoS header correctly. Alternatively, it can also call the
2591 * ieee80211_sta_eosp() function.
2592 * The @tids parameter is a bitmap and tells the driver which TIDs the
2593 * frames will be on; it will at most have two bits set.
2594 * This callback must be atomic.
2596 * @get_et_sset_count: Ethtool API to get string-set count.
2598 * @get_et_stats: Ethtool API to get a set of u64 stats.
2600 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2601 * and perhaps other supported types of ethtool data-sets.
2603 * @get_rssi: Get current signal strength in dBm, the function is optional
2606 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2607 * before associated. In multi-channel scenarios, a virtual interface is
2608 * bound to a channel before it is associated, but as it isn't associated
2609 * yet it need not necessarily be given airtime, in particular since any
2610 * transmission to a P2P GO needs to be synchronized against the GO's
2611 * powersave state. mac80211 will call this function before transmitting a
2612 * management frame prior to having successfully associated to allow the
2613 * driver to give it channel time for the transmission, to get a response
2614 * and to be able to synchronize with the GO.
2615 * The callback will be called before each transmission and upon return
2616 * mac80211 will transmit the frame right away.
2617 * The callback is optional and can (should!) sleep.
2619 * @add_chanctx: Notifies device driver about new channel context creation.
2620 * @remove_chanctx: Notifies device driver about channel context destruction.
2621 * @change_chanctx: Notifies device driver about channel context changes that
2622 * may happen when combining different virtual interfaces on the same
2623 * channel context with different settings
2624 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2625 * to vif. Possible use is for hw queue remapping.
2626 * @unassign_vif_chanctx: Notifies device driver about channel context being
2628 * @start_ap: Start operation on the AP interface, this is called after all the
2629 * information in bss_conf is set and beacon can be retrieved. A channel
2630 * context is bound before this is called. Note that if the driver uses
2631 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2632 * just "paused" for scanning/ROC, which is indicated by the beacon being
2633 * disabled/enabled via @bss_info_changed.
2634 * @stop_ap: Stop operation on the AP interface.
2636 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2637 * reconfiguration has completed. This can help the driver implement the
2638 * reconfiguration step. Also called when reconfiguring because the
2639 * driver's resume function returned 1, as this is just like an "inline"
2640 * hardware restart. This callback may sleep.
2642 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2643 * Currently, this is only called for managed or P2P client interfaces.
2644 * This callback is optional; it must not sleep.
2646 * @channel_switch_beacon: Starts a channel switch to a new channel.
2647 * Beacons are modified to include CSA or ECSA IEs before calling this
2648 * function. The corresponding count fields in these IEs must be
2649 * decremented, and when they reach zero the driver must call
2650 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2651 * get the csa counter decremented by mac80211, but must check if it is
2652 * zero using ieee80211_csa_is_complete() after the beacon has been
2653 * transmitted and then call ieee80211_csa_finish().
2656 struct ieee80211_ops {
2657 void (*tx)(struct ieee80211_hw *hw,
2658 struct ieee80211_tx_control *control,
2659 struct sk_buff *skb);
2660 int (*start)(struct ieee80211_hw *hw);
2661 void (*stop)(struct ieee80211_hw *hw);
2663 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2664 int (*resume)(struct ieee80211_hw *hw);
2665 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2667 int (*add_interface)(struct ieee80211_hw *hw,
2668 struct ieee80211_vif *vif);
2669 int (*change_interface)(struct ieee80211_hw *hw,
2670 struct ieee80211_vif *vif,
2671 enum nl80211_iftype new_type, bool p2p);
2672 void (*remove_interface)(struct ieee80211_hw *hw,
2673 struct ieee80211_vif *vif);
2674 int (*config)(struct ieee80211_hw *hw, u32 changed);
2675 void (*bss_info_changed)(struct ieee80211_hw *hw,
2676 struct ieee80211_vif *vif,
2677 struct ieee80211_bss_conf *info,
2680 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2681 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2683 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2684 struct netdev_hw_addr_list *mc_list);
2685 void (*configure_filter)(struct ieee80211_hw *hw,
2686 unsigned int changed_flags,
2687 unsigned int *total_flags,
2689 void (*set_multicast_list)(struct ieee80211_hw *hw,
2690 struct ieee80211_vif *vif, bool allmulti,
2691 struct netdev_hw_addr_list *mc_list);
2693 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2695 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2696 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2697 struct ieee80211_key_conf *key);
2698 void (*update_tkip_key)(struct ieee80211_hw *hw,
2699 struct ieee80211_vif *vif,
2700 struct ieee80211_key_conf *conf,
2701 struct ieee80211_sta *sta,
2702 u32 iv32, u16 *phase1key);
2703 void (*set_rekey_data)(struct ieee80211_hw *hw,
2704 struct ieee80211_vif *vif,
2705 struct cfg80211_gtk_rekey_data *data);
2706 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2707 struct ieee80211_vif *vif, int idx);
2708 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2709 struct cfg80211_scan_request *req);
2710 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2711 struct ieee80211_vif *vif);
2712 int (*sched_scan_start)(struct ieee80211_hw *hw,
2713 struct ieee80211_vif *vif,
2714 struct cfg80211_sched_scan_request *req,
2715 struct ieee80211_sched_scan_ies *ies);
2716 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2717 struct ieee80211_vif *vif);
2718 void (*sw_scan_start)(struct ieee80211_hw *hw);
2719 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2720 int (*get_stats)(struct ieee80211_hw *hw,
2721 struct ieee80211_low_level_stats *stats);
2722 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2723 u32 *iv32, u16 *iv16);
2724 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2725 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2726 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2727 struct ieee80211_sta *sta);
2728 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2729 struct ieee80211_sta *sta);
2730 #ifdef CONFIG_MAC80211_DEBUGFS
2731 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2732 struct ieee80211_vif *vif,
2733 struct ieee80211_sta *sta,
2734 struct dentry *dir);
2735 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2736 struct ieee80211_vif *vif,
2737 struct ieee80211_sta *sta,
2738 struct dentry *dir);
2740 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2741 enum sta_notify_cmd, struct ieee80211_sta *sta);
2742 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2743 struct ieee80211_sta *sta,
2744 enum ieee80211_sta_state old_state,
2745 enum ieee80211_sta_state new_state);
2746 void (*sta_rc_update)(struct ieee80211_hw *hw,
2747 struct ieee80211_vif *vif,
2748 struct ieee80211_sta *sta,
2750 int (*conf_tx)(struct ieee80211_hw *hw,
2751 struct ieee80211_vif *vif, u16 ac,
2752 const struct ieee80211_tx_queue_params *params);
2753 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2754 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2756 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2757 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2758 int (*ampdu_action)(struct ieee80211_hw *hw,
2759 struct ieee80211_vif *vif,
2760 enum ieee80211_ampdu_mlme_action action,
2761 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2763 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2764 struct survey_info *survey);
2765 void (*rfkill_poll)(struct ieee80211_hw *hw);
2766 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2767 #ifdef CONFIG_NL80211_TESTMODE
2768 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2769 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2770 struct netlink_callback *cb,
2771 void *data, int len);
2773 void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
2774 void (*channel_switch)(struct ieee80211_hw *hw,
2775 struct ieee80211_channel_switch *ch_switch);
2776 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2777 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2778 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2780 int (*remain_on_channel)(struct ieee80211_hw *hw,
2781 struct ieee80211_vif *vif,
2782 struct ieee80211_channel *chan,
2784 enum ieee80211_roc_type type);
2785 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2786 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2787 void (*get_ringparam)(struct ieee80211_hw *hw,
2788 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2789 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2790 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2791 const struct cfg80211_bitrate_mask *mask);
2792 void (*rssi_callback)(struct ieee80211_hw *hw,
2793 struct ieee80211_vif *vif,
2794 enum ieee80211_rssi_event rssi_event);
2796 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2797 struct ieee80211_sta *sta,
2798 u16 tids, int num_frames,
2799 enum ieee80211_frame_release_type reason,
2801 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2802 struct ieee80211_sta *sta,
2803 u16 tids, int num_frames,
2804 enum ieee80211_frame_release_type reason,
2807 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2808 struct ieee80211_vif *vif, int sset);
2809 void (*get_et_stats)(struct ieee80211_hw *hw,
2810 struct ieee80211_vif *vif,
2811 struct ethtool_stats *stats, u64 *data);
2812 void (*get_et_strings)(struct ieee80211_hw *hw,
2813 struct ieee80211_vif *vif,
2814 u32 sset, u8 *data);
2815 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2816 struct ieee80211_sta *sta, s8 *rssi_dbm);
2818 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2819 struct ieee80211_vif *vif);
2821 int (*add_chanctx)(struct ieee80211_hw *hw,
2822 struct ieee80211_chanctx_conf *ctx);
2823 void (*remove_chanctx)(struct ieee80211_hw *hw,
2824 struct ieee80211_chanctx_conf *ctx);
2825 void (*change_chanctx)(struct ieee80211_hw *hw,
2826 struct ieee80211_chanctx_conf *ctx,
2828 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2829 struct ieee80211_vif *vif,
2830 struct ieee80211_chanctx_conf *ctx);
2831 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2832 struct ieee80211_vif *vif,
2833 struct ieee80211_chanctx_conf *ctx);
2835 void (*restart_complete)(struct ieee80211_hw *hw);
2837 #if IS_ENABLED(CONFIG_IPV6)
2838 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2839 struct ieee80211_vif *vif,
2840 struct inet6_dev *idev);
2842 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
2843 struct ieee80211_vif *vif,
2844 struct cfg80211_chan_def *chandef);
2848 * ieee80211_alloc_hw - Allocate a new hardware device
2850 * This must be called once for each hardware device. The returned pointer
2851 * must be used to refer to this device when calling other functions.
2852 * mac80211 allocates a private data area for the driver pointed to by
2853 * @priv in &struct ieee80211_hw, the size of this area is given as
2856 * @priv_data_len: length of private data
2857 * @ops: callbacks for this device
2859 * Return: A pointer to the new hardware device, or %NULL on error.
2861 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2862 const struct ieee80211_ops *ops);
2865 * ieee80211_register_hw - Register hardware device
2867 * You must call this function before any other functions in
2868 * mac80211. Note that before a hardware can be registered, you
2869 * need to fill the contained wiphy's information.
2871 * @hw: the device to register as returned by ieee80211_alloc_hw()
2873 * Return: 0 on success. An error code otherwise.
2875 int ieee80211_register_hw(struct ieee80211_hw *hw);
2878 * struct ieee80211_tpt_blink - throughput blink description
2879 * @throughput: throughput in Kbit/sec
2880 * @blink_time: blink time in milliseconds
2881 * (full cycle, ie. one off + one on period)
2883 struct ieee80211_tpt_blink {
2889 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2890 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2891 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2892 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2893 * interface is connected in some way, including being an AP
2895 enum ieee80211_tpt_led_trigger_flags {
2896 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2897 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2898 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2901 #ifdef CONFIG_MAC80211_LEDS
2902 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2903 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2904 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2905 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2906 extern char *__ieee80211_create_tpt_led_trigger(
2907 struct ieee80211_hw *hw, unsigned int flags,
2908 const struct ieee80211_tpt_blink *blink_table,
2909 unsigned int blink_table_len);
2912 * ieee80211_get_tx_led_name - get name of TX LED
2914 * mac80211 creates a transmit LED trigger for each wireless hardware
2915 * that can be used to drive LEDs if your driver registers a LED device.
2916 * This function returns the name (or %NULL if not configured for LEDs)
2917 * of the trigger so you can automatically link the LED device.
2919 * @hw: the hardware to get the LED trigger name for
2921 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2923 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2925 #ifdef CONFIG_MAC80211_LEDS
2926 return __ieee80211_get_tx_led_name(hw);
2933 * ieee80211_get_rx_led_name - get name of RX LED
2935 * mac80211 creates a receive LED trigger for each wireless hardware
2936 * that can be used to drive LEDs if your driver registers a LED device.
2937 * This function returns the name (or %NULL if not configured for LEDs)
2938 * of the trigger so you can automatically link the LED device.
2940 * @hw: the hardware to get the LED trigger name for
2942 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2944 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2946 #ifdef CONFIG_MAC80211_LEDS
2947 return __ieee80211_get_rx_led_name(hw);
2954 * ieee80211_get_assoc_led_name - get name of association LED
2956 * mac80211 creates a association LED trigger for each wireless hardware
2957 * that can be used to drive LEDs if your driver registers a LED device.
2958 * This function returns the name (or %NULL if not configured for LEDs)
2959 * of the trigger so you can automatically link the LED device.
2961 * @hw: the hardware to get the LED trigger name for
2963 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2965 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2967 #ifdef CONFIG_MAC80211_LEDS
2968 return __ieee80211_get_assoc_led_name(hw);
2975 * ieee80211_get_radio_led_name - get name of radio LED
2977 * mac80211 creates a radio change LED trigger for each wireless hardware
2978 * that can be used to drive LEDs if your driver registers a LED device.
2979 * This function returns the name (or %NULL if not configured for LEDs)
2980 * of the trigger so you can automatically link the LED device.
2982 * @hw: the hardware to get the LED trigger name for
2984 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2986 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2988 #ifdef CONFIG_MAC80211_LEDS
2989 return __ieee80211_get_radio_led_name(hw);
2996 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2997 * @hw: the hardware to create the trigger for
2998 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2999 * @blink_table: the blink table -- needs to be ordered by throughput
3000 * @blink_table_len: size of the blink table
3002 * Return: %NULL (in case of error, or if no LED triggers are
3003 * configured) or the name of the new trigger.
3005 * Note: This function must be called before ieee80211_register_hw().
3007 static inline char *
3008 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3009 const struct ieee80211_tpt_blink *blink_table,
3010 unsigned int blink_table_len)
3012 #ifdef CONFIG_MAC80211_LEDS
3013 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3021 * ieee80211_unregister_hw - Unregister a hardware device
3023 * This function instructs mac80211 to free allocated resources
3024 * and unregister netdevices from the networking subsystem.
3026 * @hw: the hardware to unregister
3028 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3031 * ieee80211_free_hw - free hardware descriptor
3033 * This function frees everything that was allocated, including the
3034 * private data for the driver. You must call ieee80211_unregister_hw()
3035 * before calling this function.
3037 * @hw: the hardware to free
3039 void ieee80211_free_hw(struct ieee80211_hw *hw);
3042 * ieee80211_restart_hw - restart hardware completely
3044 * Call this function when the hardware was restarted for some reason
3045 * (hardware error, ...) and the driver is unable to restore its state
3046 * by itself. mac80211 assumes that at this point the driver/hardware
3047 * is completely uninitialised and stopped, it starts the process by
3048 * calling the ->start() operation. The driver will need to reset all
3049 * internal state that it has prior to calling this function.
3051 * @hw: the hardware to restart
3053 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3055 /** ieee80211_napi_schedule - schedule NAPI poll
3057 * Use this function to schedule NAPI polling on a device.
3059 * @hw: the hardware to start polling
3061 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
3063 /** ieee80211_napi_complete - complete NAPI polling
3065 * Use this function to finish NAPI polling on a device.
3067 * @hw: the hardware to stop polling
3069 void ieee80211_napi_complete(struct ieee80211_hw *hw);
3072 * ieee80211_rx - receive frame
3074 * Use this function to hand received frames to mac80211. The receive
3075 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3076 * paged @skb is used, the driver is recommended to put the ieee80211
3077 * header of the frame on the linear part of the @skb to avoid memory
3078 * allocation and/or memcpy by the stack.
3080 * This function may not be called in IRQ context. Calls to this function
3081 * for a single hardware must be synchronized against each other. Calls to
3082 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3083 * mixed for a single hardware. Must not run concurrently with
3084 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3086 * In process context use instead ieee80211_rx_ni().
3088 * @hw: the hardware this frame came in on
3089 * @skb: the buffer to receive, owned by mac80211 after this call
3091 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3094 * ieee80211_rx_irqsafe - receive frame
3096 * Like ieee80211_rx() but can be called in IRQ context
3097 * (internally defers to a tasklet.)
3099 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3100 * be mixed for a single hardware.Must not run concurrently with
3101 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3103 * @hw: the hardware this frame came in on
3104 * @skb: the buffer to receive, owned by mac80211 after this call
3106 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3109 * ieee80211_rx_ni - receive frame (in process context)
3111 * Like ieee80211_rx() but can be called in process context
3112 * (internally disables bottom halves).
3114 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3115 * not be mixed for a single hardware. Must not run concurrently with
3116 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3118 * @hw: the hardware this frame came in on
3119 * @skb: the buffer to receive, owned by mac80211 after this call
3121 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3122 struct sk_buff *skb)
3125 ieee80211_rx(hw, skb);
3130 * ieee80211_sta_ps_transition - PS transition for connected sta
3132 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3133 * flag set, use this function to inform mac80211 about a connected station
3134 * entering/leaving PS mode.
3136 * This function may not be called in IRQ context or with softirqs enabled.
3138 * Calls to this function for a single hardware must be synchronized against
3141 * @sta: currently connected sta
3142 * @start: start or stop PS
3144 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3146 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3149 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3150 * (in process context)
3152 * Like ieee80211_sta_ps_transition() but can be called in process context
3153 * (internally disables bottom halves). Concurrent call restriction still
3156 * @sta: currently connected sta
3157 * @start: start or stop PS
3159 * Return: Like ieee80211_sta_ps_transition().
3161 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3167 ret = ieee80211_sta_ps_transition(sta, start);
3174 * The TX headroom reserved by mac80211 for its own tx_status functions.
3175 * This is enough for the radiotap header.
3177 #define IEEE80211_TX_STATUS_HEADROOM 14
3180 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3181 * @sta: &struct ieee80211_sta pointer for the sleeping station
3182 * @tid: the TID that has buffered frames
3183 * @buffered: indicates whether or not frames are buffered for this TID
3185 * If a driver buffers frames for a powersave station instead of passing
3186 * them back to mac80211 for retransmission, the station may still need
3187 * to be told that there are buffered frames via the TIM bit.
3189 * This function informs mac80211 whether or not there are frames that are
3190 * buffered in the driver for a given TID; mac80211 can then use this data
3191 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3192 * call! Beware of the locking!)
3194 * If all frames are released to the station (due to PS-poll or uAPSD)
3195 * then the driver needs to inform mac80211 that there no longer are
3196 * frames buffered. However, when the station wakes up mac80211 assumes
3197 * that all buffered frames will be transmitted and clears this data,
3198 * drivers need to make sure they inform mac80211 about all buffered
3199 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3201 * Note that technically mac80211 only needs to know this per AC, not per
3202 * TID, but since driver buffering will inevitably happen per TID (since
3203 * it is related to aggregation) it is easier to make mac80211 map the
3204 * TID to the AC as required instead of keeping track in all drivers that
3207 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3208 u8 tid, bool buffered);
3211 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3213 * Call this function in a driver with per-packet rate selection support
3214 * to combine the rate info in the packet tx info with the most recent
3215 * rate selection table for the station entry.
3217 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3218 * @sta: the receiver station to which this packet is sent.
3219 * @skb: the frame to be transmitted.
3220 * @dest: buffer for extracted rate/retry information
3221 * @max_rates: maximum number of rates to fetch
3223 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3224 struct ieee80211_sta *sta,
3225 struct sk_buff *skb,
3226 struct ieee80211_tx_rate *dest,
3230 * ieee80211_tx_status - transmit status callback
3232 * Call this function for all transmitted frames after they have been
3233 * transmitted. It is permissible to not call this function for
3234 * multicast frames but this can affect statistics.
3236 * This function may not be called in IRQ context. Calls to this function
3237 * for a single hardware must be synchronized against each other. Calls
3238 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3239 * may not be mixed for a single hardware. Must not run concurrently with
3240 * ieee80211_rx() or ieee80211_rx_ni().
3242 * @hw: the hardware the frame was transmitted by
3243 * @skb: the frame that was transmitted, owned by mac80211 after this call
3245 void ieee80211_tx_status(struct ieee80211_hw *hw,
3246 struct sk_buff *skb);
3249 * ieee80211_tx_status_ni - transmit status callback (in process context)
3251 * Like ieee80211_tx_status() but can be called in process context.
3253 * Calls to this function, ieee80211_tx_status() and
3254 * ieee80211_tx_status_irqsafe() may not be mixed
3255 * for a single hardware.
3257 * @hw: the hardware the frame was transmitted by
3258 * @skb: the frame that was transmitted, owned by mac80211 after this call
3260 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3261 struct sk_buff *skb)
3264 ieee80211_tx_status(hw, skb);
3269 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3271 * Like ieee80211_tx_status() but can be called in IRQ context
3272 * (internally defers to a tasklet.)
3274 * Calls to this function, ieee80211_tx_status() and
3275 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3277 * @hw: the hardware the frame was transmitted by
3278 * @skb: the frame that was transmitted, owned by mac80211 after this call
3280 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3281 struct sk_buff *skb);
3284 * ieee80211_report_low_ack - report non-responding station
3286 * When operating in AP-mode, call this function to report a non-responding
3289 * @sta: the non-responding connected sta
3290 * @num_packets: number of packets sent to @sta without a response
3292 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3295 * ieee80211_beacon_get_tim - beacon generation function
3296 * @hw: pointer obtained from ieee80211_alloc_hw().
3297 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3298 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3299 * Set to 0 if invalid (in non-AP modes).
3300 * @tim_length: pointer to variable that will receive the TIM IE length,
3301 * (including the ID and length bytes!).
3302 * Set to 0 if invalid (in non-AP modes).
3304 * If the driver implements beaconing modes, it must use this function to
3305 * obtain the beacon frame/template.
3307 * If the beacon frames are generated by the host system (i.e., not in
3308 * hardware/firmware), the driver uses this function to get each beacon
3309 * frame from mac80211 -- it is responsible for calling this function
3310 * before the beacon is needed (e.g. based on hardware interrupt).
3312 * If the beacon frames are generated by the device, then the driver
3313 * must use the returned beacon as the template and change the TIM IE
3314 * according to the current DTIM parameters/TIM bitmap.
3316 * The driver is responsible for freeing the returned skb.
3318 * Return: The beacon template. %NULL on error.
3320 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3321 struct ieee80211_vif *vif,
3322 u16 *tim_offset, u16 *tim_length);
3325 * ieee80211_beacon_get - beacon generation function
3326 * @hw: pointer obtained from ieee80211_alloc_hw().
3327 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3329 * See ieee80211_beacon_get_tim().
3331 * Return: See ieee80211_beacon_get_tim().
3333 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3334 struct ieee80211_vif *vif)
3336 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3340 * ieee80211_csa_finish - notify mac80211 about channel switch
3341 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3343 * After a channel switch announcement was scheduled and the counter in this
3344 * announcement hit zero, this function must be called by the driver to
3345 * notify mac80211 that the channel can be changed.
3347 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3350 * ieee80211_csa_is_complete - find out if counters reached zero
3351 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3353 * This function returns whether the channel switch counters reached zero.
3355 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3359 * ieee80211_proberesp_get - retrieve a Probe Response template
3360 * @hw: pointer obtained from ieee80211_alloc_hw().
3361 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3363 * Creates a Probe Response template which can, for example, be uploaded to
3364 * hardware. The destination address should be set by the caller.
3366 * Can only be called in AP mode.
3368 * Return: The Probe Response template. %NULL on error.
3370 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3371 struct ieee80211_vif *vif);
3374 * ieee80211_pspoll_get - retrieve a PS Poll template
3375 * @hw: pointer obtained from ieee80211_alloc_hw().
3376 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3378 * Creates a PS Poll a template which can, for example, uploaded to
3379 * hardware. The template must be updated after association so that correct
3380 * AID, BSSID and MAC address is used.
3382 * Note: Caller (or hardware) is responsible for setting the
3383 * &IEEE80211_FCTL_PM bit.
3385 * Return: The PS Poll template. %NULL on error.
3387 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3388 struct ieee80211_vif *vif);
3391 * ieee80211_nullfunc_get - retrieve a nullfunc template
3392 * @hw: pointer obtained from ieee80211_alloc_hw().
3393 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3395 * Creates a Nullfunc template which can, for example, uploaded to
3396 * hardware. The template must be updated after association so that correct
3397 * BSSID and address is used.
3399 * Note: Caller (or hardware) is responsible for setting the
3400 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3402 * Return: The nullfunc template. %NULL on error.
3404 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3405 struct ieee80211_vif *vif);
3408 * ieee80211_probereq_get - retrieve a Probe Request template
3409 * @hw: pointer obtained from ieee80211_alloc_hw().
3410 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3411 * @ssid: SSID buffer
3412 * @ssid_len: length of SSID
3413 * @tailroom: tailroom to reserve at end of SKB for IEs
3415 * Creates a Probe Request template which can, for example, be uploaded to
3418 * Return: The Probe Request template. %NULL on error.
3420 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3421 struct ieee80211_vif *vif,
3422 const u8 *ssid, size_t ssid_len,
3426 * ieee80211_rts_get - RTS frame generation function
3427 * @hw: pointer obtained from ieee80211_alloc_hw().
3428 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3429 * @frame: pointer to the frame that is going to be protected by the RTS.
3430 * @frame_len: the frame length (in octets).
3431 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3432 * @rts: The buffer where to store the RTS frame.
3434 * If the RTS frames are generated by the host system (i.e., not in
3435 * hardware/firmware), the low-level driver uses this function to receive
3436 * the next RTS frame from the 802.11 code. The low-level is responsible
3437 * for calling this function before and RTS frame is needed.
3439 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3440 const void *frame, size_t frame_len,
3441 const struct ieee80211_tx_info *frame_txctl,
3442 struct ieee80211_rts *rts);
3445 * ieee80211_rts_duration - Get the duration field for an RTS frame
3446 * @hw: pointer obtained from ieee80211_alloc_hw().
3447 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3448 * @frame_len: the length of the frame that is going to be protected by the RTS.
3449 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3451 * If the RTS is generated in firmware, but the host system must provide
3452 * the duration field, the low-level driver uses this function to receive
3453 * the duration field value in little-endian byteorder.
3455 * Return: The duration.
3457 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3458 struct ieee80211_vif *vif, size_t frame_len,
3459 const struct ieee80211_tx_info *frame_txctl);
3462 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3463 * @hw: pointer obtained from ieee80211_alloc_hw().
3464 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3465 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3466 * @frame_len: the frame length (in octets).
3467 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3468 * @cts: The buffer where to store the CTS-to-self frame.
3470 * If the CTS-to-self frames are generated by the host system (i.e., not in
3471 * hardware/firmware), the low-level driver uses this function to receive
3472 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3473 * for calling this function before and CTS-to-self frame is needed.
3475 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3476 struct ieee80211_vif *vif,
3477 const void *frame, size_t frame_len,
3478 const struct ieee80211_tx_info *frame_txctl,
3479 struct ieee80211_cts *cts);
3482 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3483 * @hw: pointer obtained from ieee80211_alloc_hw().
3484 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3485 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3486 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3488 * If the CTS-to-self is generated in firmware, but the host system must provide
3489 * the duration field, the low-level driver uses this function to receive
3490 * the duration field value in little-endian byteorder.
3492 * Return: The duration.
3494 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3495 struct ieee80211_vif *vif,
3497 const struct ieee80211_tx_info *frame_txctl);
3500 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3501 * @hw: pointer obtained from ieee80211_alloc_hw().
3502 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3503 * @band: the band to calculate the frame duration on
3504 * @frame_len: the length of the frame.
3505 * @rate: the rate at which the frame is going to be transmitted.
3507 * Calculate the duration field of some generic frame, given its
3508 * length and transmission rate (in 100kbps).
3510 * Return: The duration.
3512 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3513 struct ieee80211_vif *vif,
3514 enum ieee80211_band band,
3516 struct ieee80211_rate *rate);
3519 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3520 * @hw: pointer as obtained from ieee80211_alloc_hw().
3521 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3523 * Function for accessing buffered broadcast and multicast frames. If
3524 * hardware/firmware does not implement buffering of broadcast/multicast
3525 * frames when power saving is used, 802.11 code buffers them in the host
3526 * memory. The low-level driver uses this function to fetch next buffered
3527 * frame. In most cases, this is used when generating beacon frame.
3529 * Return: A pointer to the next buffered skb or NULL if no more buffered
3530 * frames are available.
3532 * Note: buffered frames are returned only after DTIM beacon frame was
3533 * generated with ieee80211_beacon_get() and the low-level driver must thus
3534 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3535 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3536 * does not need to check for DTIM beacons separately and should be able to
3537 * use common code for all beacons.
3540 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3543 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3545 * This function returns the TKIP phase 1 key for the given IV32.
3547 * @keyconf: the parameter passed with the set key
3548 * @iv32: IV32 to get the P1K for
3549 * @p1k: a buffer to which the key will be written, as 5 u16 values
3551 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3552 u32 iv32, u16 *p1k);
3555 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3557 * This function returns the TKIP phase 1 key for the IV32 taken
3558 * from the given packet.
3560 * @keyconf: the parameter passed with the set key
3561 * @skb: the packet to take the IV32 value from that will be encrypted
3563 * @p1k: a buffer to which the key will be written, as 5 u16 values
3565 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3566 struct sk_buff *skb, u16 *p1k)
3568 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3569 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3570 u32 iv32 = get_unaligned_le32(&data[4]);
3572 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3576 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3578 * This function returns the TKIP phase 1 key for the given IV32
3579 * and transmitter address.
3581 * @keyconf: the parameter passed with the set key
3582 * @ta: TA that will be used with the key
3583 * @iv32: IV32 to get the P1K for
3584 * @p1k: a buffer to which the key will be written, as 5 u16 values
3586 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3587 const u8 *ta, u32 iv32, u16 *p1k);
3590 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3592 * This function computes the TKIP RC4 key for the IV values
3595 * @keyconf: the parameter passed with the set key
3596 * @skb: the packet to take the IV32/IV16 values from that will be
3597 * encrypted with this key
3598 * @p2k: a buffer to which the key will be written, 16 bytes
3600 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3601 struct sk_buff *skb, u8 *p2k);
3604 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3606 * This function computes the two AES-CMAC sub-keys, based on the
3607 * previously installed master key.
3609 * @keyconf: the parameter passed with the set key
3610 * @k1: a buffer to be filled with the 1st sub-key
3611 * @k2: a buffer to be filled with the 2nd sub-key
3613 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3617 * struct ieee80211_key_seq - key sequence counter
3619 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3620 * @ccmp: PN data, most significant byte first (big endian,
3621 * reverse order than in packet)
3622 * @aes_cmac: PN data, most significant byte first (big endian,
3623 * reverse order than in packet)
3625 struct ieee80211_key_seq {
3641 * ieee80211_get_key_tx_seq - get key TX sequence counter
3643 * @keyconf: the parameter passed with the set key
3644 * @seq: buffer to receive the sequence data
3646 * This function allows a driver to retrieve the current TX IV/PN
3647 * for the given key. It must not be called if IV generation is
3648 * offloaded to the device.
3650 * Note that this function may only be called when no TX processing
3651 * can be done concurrently, for example when queues are stopped
3652 * and the stop has been synchronized.
3654 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3655 struct ieee80211_key_seq *seq);
3658 * ieee80211_get_key_rx_seq - get key RX sequence counter
3660 * @keyconf: the parameter passed with the set key
3661 * @tid: The TID, or -1 for the management frame value (CCMP only);
3662 * the value on TID 0 is also used for non-QoS frames. For
3663 * CMAC, only TID 0 is valid.
3664 * @seq: buffer to receive the sequence data
3666 * This function allows a driver to retrieve the current RX IV/PNs
3667 * for the given key. It must not be called if IV checking is done
3668 * by the device and not by mac80211.
3670 * Note that this function may only be called when no RX processing
3671 * can be done concurrently.
3673 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3674 int tid, struct ieee80211_key_seq *seq);
3677 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3678 * @vif: virtual interface the rekeying was done on
3679 * @bssid: The BSSID of the AP, for checking association
3680 * @replay_ctr: the new replay counter after GTK rekeying
3681 * @gfp: allocation flags
3683 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3684 const u8 *replay_ctr, gfp_t gfp);
3687 * ieee80211_wake_queue - wake specific queue
3688 * @hw: pointer as obtained from ieee80211_alloc_hw().
3689 * @queue: queue number (counted from zero).
3691 * Drivers should use this function instead of netif_wake_queue.
3693 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3696 * ieee80211_stop_queue - stop specific queue
3697 * @hw: pointer as obtained from ieee80211_alloc_hw().
3698 * @queue: queue number (counted from zero).
3700 * Drivers should use this function instead of netif_stop_queue.
3702 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3705 * ieee80211_queue_stopped - test status of the queue
3706 * @hw: pointer as obtained from ieee80211_alloc_hw().
3707 * @queue: queue number (counted from zero).
3709 * Drivers should use this function instead of netif_stop_queue.
3711 * Return: %true if the queue is stopped. %false otherwise.
3714 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3717 * ieee80211_stop_queues - stop all queues
3718 * @hw: pointer as obtained from ieee80211_alloc_hw().
3720 * Drivers should use this function instead of netif_stop_queue.
3722 void ieee80211_stop_queues(struct ieee80211_hw *hw);
3725 * ieee80211_wake_queues - wake all queues
3726 * @hw: pointer as obtained from ieee80211_alloc_hw().
3728 * Drivers should use this function instead of netif_wake_queue.
3730 void ieee80211_wake_queues(struct ieee80211_hw *hw);
3733 * ieee80211_scan_completed - completed hardware scan
3735 * When hardware scan offload is used (i.e. the hw_scan() callback is
3736 * assigned) this function needs to be called by the driver to notify
3737 * mac80211 that the scan finished. This function can be called from
3738 * any context, including hardirq context.
3740 * @hw: the hardware that finished the scan
3741 * @aborted: set to true if scan was aborted
3743 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3746 * ieee80211_sched_scan_results - got results from scheduled scan
3748 * When a scheduled scan is running, this function needs to be called by the
3749 * driver whenever there are new scan results available.
3751 * @hw: the hardware that is performing scheduled scans
3753 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3756 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3758 * When a scheduled scan is running, this function can be called by
3759 * the driver if it needs to stop the scan to perform another task.
3760 * Usual scenarios are drivers that cannot continue the scheduled scan
3761 * while associating, for instance.
3763 * @hw: the hardware that is performing scheduled scans
3765 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3768 * enum ieee80211_interface_iteration_flags - interface iteration flags
3769 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3770 * been added to the driver; However, note that during hardware
3771 * reconfiguration (after restart_hw) it will iterate over a new
3772 * interface and over all the existing interfaces even if they
3773 * haven't been re-added to the driver yet.
3774 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3775 * interfaces, even if they haven't been re-added to the driver yet.
3777 enum ieee80211_interface_iteration_flags {
3778 IEEE80211_IFACE_ITER_NORMAL = 0,
3779 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3783 * ieee80211_iterate_active_interfaces - iterate active interfaces
3785 * This function iterates over the interfaces associated with a given
3786 * hardware that are currently active and calls the callback for them.
3787 * This function allows the iterator function to sleep, when the iterator
3788 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3790 * Does not iterate over a new interface during add_interface().
3792 * @hw: the hardware struct of which the interfaces should be iterated over
3793 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3794 * @iterator: the iterator function to call
3795 * @data: first argument of the iterator function
3797 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3799 void (*iterator)(void *data, u8 *mac,
3800 struct ieee80211_vif *vif),
3804 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3806 * This function iterates over the interfaces associated with a given
3807 * hardware that are currently active and calls the callback for them.
3808 * This function requires the iterator callback function to be atomic,
3809 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3810 * Does not iterate over a new interface during add_interface().
3812 * @hw: the hardware struct of which the interfaces should be iterated over
3813 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3814 * @iterator: the iterator function to call, cannot sleep
3815 * @data: first argument of the iterator function
3817 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3819 void (*iterator)(void *data,
3821 struct ieee80211_vif *vif),
3825 * ieee80211_queue_work - add work onto the mac80211 workqueue
3827 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3828 * This helper ensures drivers are not queueing work when they should not be.
3830 * @hw: the hardware struct for the interface we are adding work for
3831 * @work: the work we want to add onto the mac80211 workqueue
3833 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3836 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3838 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3841 * @hw: the hardware struct for the interface we are adding work for
3842 * @dwork: delayable work to queue onto the mac80211 workqueue
3843 * @delay: number of jiffies to wait before queueing
3845 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3846 struct delayed_work *dwork,
3847 unsigned long delay);
3850 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3851 * @sta: the station for which to start a BA session
3852 * @tid: the TID to BA on.
3853 * @timeout: session timeout value (in TUs)
3855 * Return: success if addBA request was sent, failure otherwise
3857 * Although mac80211/low level driver/user space application can estimate
3858 * the need to start aggregation on a certain RA/TID, the session level
3859 * will be managed by the mac80211.
3861 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3865 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3866 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3867 * @ra: receiver address of the BA session recipient.
3868 * @tid: the TID to BA on.
3870 * This function must be called by low level driver once it has
3871 * finished with preparations for the BA session. It can be called
3874 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3878 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3879 * @sta: the station whose BA session to stop
3880 * @tid: the TID to stop BA.
3882 * Return: negative error if the TID is invalid, or no aggregation active
3884 * Although mac80211/low level driver/user space application can estimate
3885 * the need to stop aggregation on a certain RA/TID, the session level
3886 * will be managed by the mac80211.
3888 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3891 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3892 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3893 * @ra: receiver address of the BA session recipient.
3894 * @tid: the desired TID to BA on.
3896 * This function must be called by low level driver once it has
3897 * finished with preparations for the BA session tear down. It
3898 * can be called from any context.
3900 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3904 * ieee80211_find_sta - find a station
3906 * @vif: virtual interface to look for station on
3907 * @addr: station's address
3909 * Return: The station, if found. %NULL otherwise.
3911 * Note: This function must be called under RCU lock and the
3912 * resulting pointer is only valid under RCU lock as well.
3914 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3918 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3920 * @hw: pointer as obtained from ieee80211_alloc_hw()
3921 * @addr: remote station's address
3922 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3924 * Return: The station, if found. %NULL otherwise.
3926 * Note: This function must be called under RCU lock and the
3927 * resulting pointer is only valid under RCU lock as well.
3929 * NOTE: You may pass NULL for localaddr, but then you will just get
3930 * the first STA that matches the remote address 'addr'.
3931 * We can have multiple STA associated with multiple
3932 * logical stations (e.g. consider a station connecting to another
3933 * BSSID on the same AP hardware without disconnecting first).
3934 * In this case, the result of this method with localaddr NULL
3937 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3939 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3941 const u8 *localaddr);
3944 * ieee80211_sta_block_awake - block station from waking up
3946 * @pubsta: the station
3947 * @block: whether to block or unblock
3949 * Some devices require that all frames that are on the queues
3950 * for a specific station that went to sleep are flushed before
3951 * a poll response or frames after the station woke up can be
3952 * delivered to that it. Note that such frames must be rejected
3953 * by the driver as filtered, with the appropriate status flag.
3955 * This function allows implementing this mode in a race-free
3958 * To do this, a driver must keep track of the number of frames
3959 * still enqueued for a specific station. If this number is not
3960 * zero when the station goes to sleep, the driver must call
3961 * this function to force mac80211 to consider the station to
3962 * be asleep regardless of the station's actual state. Once the
3963 * number of outstanding frames reaches zero, the driver must
3964 * call this function again to unblock the station. That will
3965 * cause mac80211 to be able to send ps-poll responses, and if
3966 * the station queried in the meantime then frames will also
3967 * be sent out as a result of this. Additionally, the driver
3968 * will be notified that the station woke up some time after
3969 * it is unblocked, regardless of whether the station actually
3970 * woke up while blocked or not.
3972 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3973 struct ieee80211_sta *pubsta, bool block);
3976 * ieee80211_sta_eosp - notify mac80211 about end of SP
3977 * @pubsta: the station
3979 * When a device transmits frames in a way that it can't tell
3980 * mac80211 in the TX status about the EOSP, it must clear the
3981 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3982 * This applies for PS-Poll as well as uAPSD.
3984 * Note that just like with _tx_status() and _rx() drivers must
3985 * not mix calls to irqsafe/non-irqsafe versions, this function
3986 * must not be mixed with those either. Use the all irqsafe, or
3987 * all non-irqsafe, don't mix!
3989 * NB: the _irqsafe version of this function doesn't exist, no
3990 * driver needs it right now. Don't call this function if
3991 * you'd need the _irqsafe version, look at the git history
3992 * and restore the _irqsafe version!
3994 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
3997 * ieee80211_iter_keys - iterate keys programmed into the device
3998 * @hw: pointer obtained from ieee80211_alloc_hw()
3999 * @vif: virtual interface to iterate, may be %NULL for all
4000 * @iter: iterator function that will be called for each key
4001 * @iter_data: custom data to pass to the iterator function
4003 * This function can be used to iterate all the keys known to
4004 * mac80211, even those that weren't previously programmed into
4005 * the device. This is intended for use in WoWLAN if the device
4006 * needs reprogramming of the keys during suspend. Note that due
4007 * to locking reasons, it is also only safe to call this at few
4008 * spots since it must hold the RTNL and be able to sleep.
4010 * The order in which the keys are iterated matches the order
4011 * in which they were originally installed and handed to the
4014 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4015 struct ieee80211_vif *vif,
4016 void (*iter)(struct ieee80211_hw *hw,
4017 struct ieee80211_vif *vif,
4018 struct ieee80211_sta *sta,
4019 struct ieee80211_key_conf *key,
4024 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4025 * @hw: pointre obtained from ieee80211_alloc_hw().
4026 * @iter: iterator function
4027 * @iter_data: data passed to iterator function
4029 * Iterate all active channel contexts. This function is atomic and
4030 * doesn't acquire any locks internally that might be held in other
4031 * places while calling into the driver.
4033 * The iterator will not find a context that's being added (during
4034 * the driver callback to add it) but will find it while it's being
4037 * Note that during hardware restart, all contexts that existed
4038 * before the restart are considered already present so will be
4039 * found while iterating, whether they've been re-added already
4042 void ieee80211_iter_chan_contexts_atomic(
4043 struct ieee80211_hw *hw,
4044 void (*iter)(struct ieee80211_hw *hw,
4045 struct ieee80211_chanctx_conf *chanctx_conf,
4050 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4051 * @hw: pointer obtained from ieee80211_alloc_hw().
4052 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4054 * Creates a Probe Request template which can, for example, be uploaded to
4055 * hardware. The template is filled with bssid, ssid and supported rate
4056 * information. This function must only be called from within the
4057 * .bss_info_changed callback function and only in managed mode. The function
4058 * is only useful when the interface is associated, otherwise it will return
4061 * Return: The Probe Request template. %NULL on error.
4063 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4064 struct ieee80211_vif *vif);
4067 * ieee80211_beacon_loss - inform hardware does not receive beacons
4069 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4071 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4072 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4073 * hardware is not receiving beacons with this function.
4075 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4078 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4080 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4082 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4083 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4084 * needs to inform if the connection to the AP has been lost.
4085 * The function may also be called if the connection needs to be terminated
4086 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4088 * This function will cause immediate change to disassociated state,
4089 * without connection recovery attempts.
4091 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4094 * ieee80211_resume_disconnect - disconnect from AP after resume
4096 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4098 * Instructs mac80211 to disconnect from the AP after resume.
4099 * Drivers can use this after WoWLAN if they know that the
4100 * connection cannot be kept up, for example because keys were
4101 * used while the device was asleep but the replay counters or
4102 * similar cannot be retrieved from the device during resume.
4104 * Note that due to implementation issues, if the driver uses
4105 * the reconfiguration functionality during resume the interface
4106 * will still be added as associated first during resume and then
4107 * disconnect normally later.
4109 * This function can only be called from the resume callback and
4110 * the driver must not be holding any of its own locks while it
4111 * calls this function, or at least not any locks it needs in the
4112 * key configuration paths (if it supports HW crypto).
4114 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4117 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4118 * rssi threshold triggered
4120 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4121 * @rssi_event: the RSSI trigger event type
4122 * @gfp: context flags
4124 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4125 * monitoring is configured with an rssi threshold, the driver will inform
4126 * whenever the rssi level reaches the threshold.
4128 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4129 enum nl80211_cqm_rssi_threshold_event rssi_event,
4133 * ieee80211_radar_detected - inform that a radar was detected
4135 * @hw: pointer as obtained from ieee80211_alloc_hw()
4137 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4140 * ieee80211_chswitch_done - Complete channel switch process
4141 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4142 * @success: make the channel switch successful or not
4144 * Complete the channel switch post-process: set the new operational channel
4145 * and wake up the suspended queues.
4147 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4150 * ieee80211_request_smps - request SM PS transition
4151 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4152 * @smps_mode: new SM PS mode
4154 * This allows the driver to request an SM PS transition in managed
4155 * mode. This is useful when the driver has more information than
4156 * the stack about possible interference, for example by bluetooth.
4158 void ieee80211_request_smps(struct ieee80211_vif *vif,
4159 enum ieee80211_smps_mode smps_mode);
4162 * ieee80211_ready_on_channel - notification of remain-on-channel start
4163 * @hw: pointer as obtained from ieee80211_alloc_hw()
4165 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4168 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4169 * @hw: pointer as obtained from ieee80211_alloc_hw()
4171 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4174 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4176 * in order not to harm the system performance and user experience, the device
4177 * may request not to allow any rx ba session and tear down existing rx ba
4178 * sessions based on system constraints such as periodic BT activity that needs
4179 * to limit wlan activity (eg.sco or a2dp)."
4180 * in such cases, the intention is to limit the duration of the rx ppdu and
4181 * therefore prevent the peer device to use a-mpdu aggregation.
4183 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4184 * @ba_rx_bitmap: Bit map of open rx ba per tid
4185 * @addr: & to bssid mac address
4187 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4191 * ieee80211_send_bar - send a BlockAckReq frame
4193 * can be used to flush pending frames from the peer's aggregation reorder
4196 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4197 * @ra: the peer's destination address
4198 * @tid: the TID of the aggregation session
4199 * @ssn: the new starting sequence number for the receiver
4201 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4203 /* Rate control API */
4206 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4208 * @hw: The hardware the algorithm is invoked for.
4209 * @sband: The band this frame is being transmitted on.
4210 * @bss_conf: the current BSS configuration
4211 * @skb: the skb that will be transmitted, the control information in it needs
4213 * @reported_rate: The rate control algorithm can fill this in to indicate
4214 * which rate should be reported to userspace as the current rate and
4215 * used for rate calculations in the mesh network.
4216 * @rts: whether RTS will be used for this frame because it is longer than the
4218 * @short_preamble: whether mac80211 will request short-preamble transmission
4219 * if the selected rate supports it
4220 * @max_rate_idx: user-requested maximum (legacy) rate
4221 * (deprecated; this will be removed once drivers get updated to use
4223 * @rate_idx_mask: user-requested (legacy) rate mask
4224 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4225 * @bss: whether this frame is sent out in AP or IBSS mode
4227 struct ieee80211_tx_rate_control {
4228 struct ieee80211_hw *hw;
4229 struct ieee80211_supported_band *sband;
4230 struct ieee80211_bss_conf *bss_conf;
4231 struct sk_buff *skb;
4232 struct ieee80211_tx_rate reported_rate;
4233 bool rts, short_preamble;
4236 u8 *rate_idx_mcs_mask;
4240 struct rate_control_ops {
4241 struct module *module;
4243 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4244 void (*free)(void *priv);
4246 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4247 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4248 struct cfg80211_chan_def *chandef,
4249 struct ieee80211_sta *sta, void *priv_sta);
4250 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4251 struct cfg80211_chan_def *chandef,
4252 struct ieee80211_sta *sta, void *priv_sta,
4254 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4257 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4258 struct ieee80211_sta *sta, void *priv_sta,
4259 struct sk_buff *skb);
4260 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4261 struct ieee80211_tx_rate_control *txrc);
4263 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4264 struct dentry *dir);
4265 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4268 static inline int rate_supported(struct ieee80211_sta *sta,
4269 enum ieee80211_band band,
4272 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4276 * rate_control_send_low - helper for drivers for management/no-ack frames
4278 * Rate control algorithms that agree to use the lowest rate to
4279 * send management frames and NO_ACK data with the respective hw
4280 * retries should use this in the beginning of their mac80211 get_rate
4281 * callback. If true is returned the rate control can simply return.
4282 * If false is returned we guarantee that sta and sta and priv_sta is
4285 * Rate control algorithms wishing to do more intelligent selection of
4286 * rate for multicast/broadcast frames may choose to not use this.
4288 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4289 * that this may be null.
4290 * @priv_sta: private rate control structure. This may be null.
4291 * @txrc: rate control information we sholud populate for mac80211.
4293 bool rate_control_send_low(struct ieee80211_sta *sta,
4295 struct ieee80211_tx_rate_control *txrc);
4299 rate_lowest_index(struct ieee80211_supported_band *sband,
4300 struct ieee80211_sta *sta)
4304 for (i = 0; i < sband->n_bitrates; i++)
4305 if (rate_supported(sta, sband->band, i))
4308 /* warn when we cannot find a rate. */
4311 /* and return 0 (the lowest index) */
4316 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4317 struct ieee80211_sta *sta)
4321 for (i = 0; i < sband->n_bitrates; i++)
4322 if (rate_supported(sta, sband->band, i))
4328 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4330 * When not doing a rate control probe to test rates, rate control should pass
4331 * its rate selection to mac80211. If the driver supports receiving a station
4332 * rate table, it will use it to ensure that frames are always sent based on
4333 * the most recent rate control module decision.
4335 * @hw: pointer as obtained from ieee80211_alloc_hw()
4336 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4337 * @rates: new tx rate set to be used for this station.
4339 int rate_control_set_rates(struct ieee80211_hw *hw,
4340 struct ieee80211_sta *pubsta,
4341 struct ieee80211_sta_rates *rates);
4343 int ieee80211_rate_control_register(struct rate_control_ops *ops);
4344 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
4347 conf_is_ht20(struct ieee80211_conf *conf)
4349 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4353 conf_is_ht40_minus(struct ieee80211_conf *conf)
4355 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4356 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4360 conf_is_ht40_plus(struct ieee80211_conf *conf)
4362 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4363 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4367 conf_is_ht40(struct ieee80211_conf *conf)
4369 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4373 conf_is_ht(struct ieee80211_conf *conf)
4375 return conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT;
4378 static inline enum nl80211_iftype
4379 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4383 case NL80211_IFTYPE_STATION:
4384 return NL80211_IFTYPE_P2P_CLIENT;
4385 case NL80211_IFTYPE_AP:
4386 return NL80211_IFTYPE_P2P_GO;
4394 static inline enum nl80211_iftype
4395 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4397 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4400 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4402 int rssi_max_thold);
4404 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4407 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4409 * @vif: the specified virtual interface
4411 * Note: This function assumes that the given vif is valid.
4413 * Return: The average RSSI value for the requested interface, or 0 if not
4416 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4419 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4420 * @vif: virtual interface
4421 * @wakeup: wakeup reason(s)
4422 * @gfp: allocation flags
4424 * See cfg80211_report_wowlan_wakeup().
4426 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4427 struct cfg80211_wowlan_wakeup *wakeup,
4430 #endif /* MAC80211_H */