2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
17 #include <linux/bug.h>
18 #include <linux/kernel.h>
19 #include <linux/if_ether.h>
20 #include <linux/skbuff.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
23 #include <asm/unaligned.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
73 * DOC: mac80211 workqueue
75 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
76 * The workqueue is a single threaded workqueue and can only be accessed by
77 * helpers for sanity checking. Drivers must ensure all work added onto the
78 * mac80211 workqueue should be cancelled on the driver stop() callback.
80 * mac80211 will flushed the workqueue upon interface removal and during
83 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
90 * enum ieee80211_max_queues - maximum number of queues
92 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
93 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
95 enum ieee80211_max_queues {
96 IEEE80211_MAX_QUEUES = 16,
97 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
100 #define IEEE80211_INVAL_HW_QUEUE 0xff
103 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
104 * @IEEE80211_AC_VO: voice
105 * @IEEE80211_AC_VI: video
106 * @IEEE80211_AC_BE: best effort
107 * @IEEE80211_AC_BK: background
109 enum ieee80211_ac_numbers {
115 #define IEEE80211_NUM_ACS 4
118 * struct ieee80211_tx_queue_params - transmit queue configuration
120 * The information provided in this structure is required for QoS
121 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
123 * @aifs: arbitration interframe space [0..255]
124 * @cw_min: minimum contention window [a value of the form
125 * 2^n-1 in the range 1..32767]
126 * @cw_max: maximum contention window [like @cw_min]
127 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
128 * @acm: is mandatory admission control required for the access category
129 * @uapsd: is U-APSD mode enabled for the queue
131 struct ieee80211_tx_queue_params {
140 struct ieee80211_low_level_stats {
141 unsigned int dot11ACKFailureCount;
142 unsigned int dot11RTSFailureCount;
143 unsigned int dot11FCSErrorCount;
144 unsigned int dot11RTSSuccessCount;
148 * enum ieee80211_chanctx_change - change flag for channel context
149 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
150 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
152 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
153 * this is used only with channel switching with CSA
154 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
156 enum ieee80211_chanctx_change {
157 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
158 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
159 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
160 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
161 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
165 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
167 * This is the driver-visible part. The ieee80211_chanctx
168 * that contains it is visible in mac80211 only.
170 * @def: the channel definition
171 * @min_def: the minimum channel definition currently required.
172 * @rx_chains_static: The number of RX chains that must always be
173 * active on the channel to receive MIMO transmissions
174 * @rx_chains_dynamic: The number of RX chains that must be enabled
175 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
176 * this will always be >= @rx_chains_static.
177 * @radar_enabled: whether radar detection is enabled on this channel.
178 * @drv_priv: data area for driver use, will always be aligned to
179 * sizeof(void *), size is determined in hw information.
181 struct ieee80211_chanctx_conf {
182 struct cfg80211_chan_def def;
183 struct cfg80211_chan_def min_def;
185 u8 rx_chains_static, rx_chains_dynamic;
189 u8 drv_priv[0] __aligned(sizeof(void *));
193 * enum ieee80211_chanctx_switch_mode - channel context switch mode
194 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
195 * exist (and will continue to exist), but the virtual interface
196 * needs to be switched from one to the other.
197 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
198 * to exist with this call, the new context doesn't exist but
199 * will be active after this call, the virtual interface switches
200 * from the old to the new (note that the driver may of course
201 * implement this as an on-the-fly chandef switch of the existing
202 * hardware context, but the mac80211 pointer for the old context
203 * will cease to exist and only the new one will later be used
204 * for changes/removal.)
206 enum ieee80211_chanctx_switch_mode {
207 CHANCTX_SWMODE_REASSIGN_VIF,
208 CHANCTX_SWMODE_SWAP_CONTEXTS,
212 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
214 * This is structure is used to pass information about a vif that
215 * needs to switch from one chanctx to another. The
216 * &ieee80211_chanctx_switch_mode defines how the switch should be
219 * @vif: the vif that should be switched from old_ctx to new_ctx
220 * @old_ctx: the old context to which the vif was assigned
221 * @new_ctx: the new context to which the vif must be assigned
223 struct ieee80211_vif_chanctx_switch {
224 struct ieee80211_vif *vif;
225 struct ieee80211_chanctx_conf *old_ctx;
226 struct ieee80211_chanctx_conf *new_ctx;
230 * enum ieee80211_bss_change - BSS change notification flags
232 * These flags are used with the bss_info_changed() callback
233 * to indicate which BSS parameter changed.
235 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
236 * also implies a change in the AID.
237 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
238 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
239 * @BSS_CHANGED_ERP_SLOT: slot timing changed
240 * @BSS_CHANGED_HT: 802.11n parameters changed
241 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
242 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
243 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
244 * reason (IBSS and managed mode)
245 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
246 * new beacon (beaconing modes)
247 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
248 * enabled/disabled (beaconing modes)
249 * @BSS_CHANGED_CQM: Connection quality monitor config changed
250 * @BSS_CHANGED_IBSS: IBSS join status changed
251 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
252 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
253 * that it is only ever disabled for station mode.
254 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
255 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
256 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
257 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
258 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
259 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
260 * changed (currently only in P2P client mode, GO mode will be later)
261 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
262 * currently dtim_period only is under consideration.
263 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
264 * note that this is only called when it changes after the channel
265 * context had been assigned.
266 * @BSS_CHANGED_OCB: OCB join status changed
268 enum ieee80211_bss_change {
269 BSS_CHANGED_ASSOC = 1<<0,
270 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
271 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
272 BSS_CHANGED_ERP_SLOT = 1<<3,
273 BSS_CHANGED_HT = 1<<4,
274 BSS_CHANGED_BASIC_RATES = 1<<5,
275 BSS_CHANGED_BEACON_INT = 1<<6,
276 BSS_CHANGED_BSSID = 1<<7,
277 BSS_CHANGED_BEACON = 1<<8,
278 BSS_CHANGED_BEACON_ENABLED = 1<<9,
279 BSS_CHANGED_CQM = 1<<10,
280 BSS_CHANGED_IBSS = 1<<11,
281 BSS_CHANGED_ARP_FILTER = 1<<12,
282 BSS_CHANGED_QOS = 1<<13,
283 BSS_CHANGED_IDLE = 1<<14,
284 BSS_CHANGED_SSID = 1<<15,
285 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
286 BSS_CHANGED_PS = 1<<17,
287 BSS_CHANGED_TXPOWER = 1<<18,
288 BSS_CHANGED_P2P_PS = 1<<19,
289 BSS_CHANGED_BEACON_INFO = 1<<20,
290 BSS_CHANGED_BANDWIDTH = 1<<21,
291 BSS_CHANGED_OCB = 1<<22,
293 /* when adding here, make sure to change ieee80211_reconfig */
297 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
298 * of addresses for an interface increase beyond this value, hardware ARP
299 * filtering will be disabled.
301 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
304 * enum ieee80211_rssi_event - RSSI threshold event
305 * An indicator for when RSSI goes below/above a certain threshold.
306 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
307 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
309 enum ieee80211_rssi_event {
315 * struct ieee80211_bss_conf - holds the BSS's changing parameters
317 * This structure keeps information about a BSS (and an association
318 * to that BSS) that can change during the lifetime of the BSS.
320 * @assoc: association status
321 * @ibss_joined: indicates whether this station is part of an IBSS
323 * @ibss_creator: indicates if a new IBSS network is being created
324 * @aid: association ID number, valid only when @assoc is true
325 * @use_cts_prot: use CTS protection
326 * @use_short_preamble: use 802.11b short preamble;
327 * if the hardware cannot handle this it must set the
328 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
329 * @use_short_slot: use short slot time (only relevant for ERP);
330 * if the hardware cannot handle this it must set the
331 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
332 * @dtim_period: num of beacons before the next DTIM, for beaconing,
333 * valid in station mode only if after the driver was notified
334 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
335 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
336 * as it may have been received during scanning long ago). If the
337 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
338 * only come from a beacon, but might not become valid until after
339 * association when a beacon is received (which is notified with the
340 * %BSS_CHANGED_DTIM flag.)
341 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
342 * the driver/device can use this to calculate synchronisation
344 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
345 * is requested, see @sync_tsf/@sync_device_ts.
346 * @beacon_int: beacon interval
347 * @assoc_capability: capabilities taken from assoc resp
348 * @basic_rates: bitmap of basic rates, each bit stands for an
349 * index into the rate table configured by the driver in
351 * @beacon_rate: associated AP's beacon TX rate
352 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
353 * @bssid: The BSSID for this BSS
354 * @enable_beacon: whether beaconing should be enabled or not
355 * @chandef: Channel definition for this BSS -- the hardware might be
356 * configured a higher bandwidth than this BSS uses, for example.
357 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
358 * This field is only valid when the channel type is one of the HT types.
359 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
361 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
362 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
363 * may filter ARP queries targeted for other addresses than listed here.
364 * The driver must allow ARP queries targeted for all address listed here
365 * to pass through. An empty list implies no ARP queries need to pass.
366 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
367 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
368 * array size), it's up to the driver what to do in that case.
369 * @qos: This is a QoS-enabled BSS.
370 * @idle: This interface is idle. There's also a global idle flag in the
371 * hardware config which may be more appropriate depending on what
372 * your driver/device needs to do.
373 * @ps: power-save mode (STA only). This flag is NOT affected by
374 * offchannel/dynamic_ps operations.
375 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
376 * @ssid_len: Length of SSID given in @ssid.
377 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
378 * @txpower: TX power in dBm
379 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
381 struct ieee80211_bss_conf {
383 /* association related data */
384 bool assoc, ibss_joined;
387 /* erp related data */
389 bool use_short_preamble;
394 u16 assoc_capability;
399 struct ieee80211_rate *beacon_rate;
400 int mcast_rate[IEEE80211_NUM_BANDS];
401 u16 ht_operation_mode;
404 struct cfg80211_chan_def chandef;
405 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
410 u8 ssid[IEEE80211_MAX_SSID_LEN];
414 struct ieee80211_p2p_noa_attr p2p_noa_attr;
418 * enum mac80211_tx_info_flags - flags to describe transmission information/status
420 * These flags are used with the @flags member of &ieee80211_tx_info.
422 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
423 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
424 * number to this frame, taking care of not overwriting the fragment
425 * number and increasing the sequence number only when the
426 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
427 * assign sequence numbers to QoS-data frames but cannot do so correctly
428 * for non-QoS-data and management frames because beacons need them from
429 * that counter as well and mac80211 cannot guarantee proper sequencing.
430 * If this flag is set, the driver should instruct the hardware to
431 * assign a sequence number to the frame or assign one itself. Cf. IEEE
432 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
433 * beacons and always be clear for frames without a sequence number field.
434 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
435 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
437 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
438 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
439 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
440 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
441 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
442 * because the destination STA was in powersave mode. Note that to
443 * avoid race conditions, the filter must be set by the hardware or
444 * firmware upon receiving a frame that indicates that the station
445 * went to sleep (must be done on device to filter frames already on
446 * the queue) and may only be unset after mac80211 gives the OK for
447 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
448 * since only then is it guaranteed that no more frames are in the
450 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
451 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
452 * is for the whole aggregation.
453 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
454 * so consider using block ack request (BAR).
455 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
456 * set by rate control algorithms to indicate probe rate, will
457 * be cleared for fragmented frames (except on the last fragment)
458 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
459 * that a frame can be transmitted while the queues are stopped for
460 * off-channel operation.
461 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
462 * used to indicate that a pending frame requires TX processing before
463 * it can be sent out.
464 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
465 * used to indicate that a frame was already retried due to PS
466 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
467 * used to indicate frame should not be encrypted
468 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
469 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
470 * be sent although the station is in powersave mode.
471 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
472 * transmit function after the current frame, this can be used
473 * by drivers to kick the DMA queue only if unset or when the
475 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
476 * after TX status because the destination was asleep, it must not
477 * be modified again (no seqno assignment, crypto, etc.)
478 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
479 * code for connection establishment, this indicates that its status
480 * should kick the MLME state machine.
481 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
482 * MLME command (internal to mac80211 to figure out whether to send TX
483 * status to user space)
484 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
485 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
486 * frame and selects the maximum number of streams that it can use.
487 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
488 * the off-channel channel when a remain-on-channel offload is done
489 * in hardware -- normal packets still flow and are expected to be
490 * handled properly by the device.
491 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
492 * testing. It will be sent out with incorrect Michael MIC key to allow
493 * TKIP countermeasures to be tested.
494 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
495 * This flag is actually used for management frame especially for P2P
496 * frames not being sent at CCK rate in 2GHz band.
497 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
498 * when its status is reported the service period ends. For frames in
499 * an SP that mac80211 transmits, it is already set; for driver frames
500 * the driver may set this flag. It is also used to do the same for
502 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
503 * This flag is used to send nullfunc frame at minimum rate when
504 * the nullfunc is used for connection monitoring purpose.
505 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
506 * would be fragmented by size (this is optional, only used for
507 * monitor injection).
508 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
509 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
510 * any errors (like issues specific to the driver/HW).
511 * This flag must not be set for frames that don't request no-ack
512 * behaviour with IEEE80211_TX_CTL_NO_ACK.
514 * Note: If you have to add new flags to the enumeration, then don't
515 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
517 enum mac80211_tx_info_flags {
518 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
519 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
520 IEEE80211_TX_CTL_NO_ACK = BIT(2),
521 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
522 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
523 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
524 IEEE80211_TX_CTL_AMPDU = BIT(6),
525 IEEE80211_TX_CTL_INJECTED = BIT(7),
526 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
527 IEEE80211_TX_STAT_ACK = BIT(9),
528 IEEE80211_TX_STAT_AMPDU = BIT(10),
529 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
530 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
531 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
532 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
533 IEEE80211_TX_INTFL_RETRIED = BIT(15),
534 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
535 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
536 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
537 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
538 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
539 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
540 IEEE80211_TX_CTL_LDPC = BIT(22),
541 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
542 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
543 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
544 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
545 IEEE80211_TX_STATUS_EOSP = BIT(28),
546 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
547 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
548 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
551 #define IEEE80211_TX_CTL_STBC_SHIFT 23
554 * enum mac80211_tx_control_flags - flags to describe transmit control
556 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
557 * protocol frame (e.g. EAP)
558 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
559 * frame (PS-Poll or uAPSD).
561 * These flags are used in tx_info->control.flags.
563 enum mac80211_tx_control_flags {
564 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
565 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
569 * This definition is used as a mask to clear all temporary flags, which are
570 * set by the tx handlers for each transmission attempt by the mac80211 stack.
572 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
573 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
574 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
575 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
576 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
577 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
578 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
579 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
582 * enum mac80211_rate_control_flags - per-rate flags set by the
583 * Rate Control algorithm.
585 * These flags are set by the Rate control algorithm for each rate during tx,
586 * in the @flags member of struct ieee80211_tx_rate.
588 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
589 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
590 * This is set if the current BSS requires ERP protection.
591 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
592 * @IEEE80211_TX_RC_MCS: HT rate.
593 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
594 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
595 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
597 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
598 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
599 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
600 * (80+80 isn't supported yet)
601 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
602 * adjacent 20 MHz channels, if the current channel type is
603 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
604 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
606 enum mac80211_rate_control_flags {
607 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
608 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
609 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
611 /* rate index is an HT/VHT MCS instead of an index */
612 IEEE80211_TX_RC_MCS = BIT(3),
613 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
614 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
615 IEEE80211_TX_RC_DUP_DATA = BIT(6),
616 IEEE80211_TX_RC_SHORT_GI = BIT(7),
617 IEEE80211_TX_RC_VHT_MCS = BIT(8),
618 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
619 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
623 /* there are 40 bytes if you don't need the rateset to be kept */
624 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
626 /* if you do need the rateset, then you have less space */
627 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
629 /* maximum number of rate stages */
630 #define IEEE80211_TX_MAX_RATES 4
632 /* maximum number of rate table entries */
633 #define IEEE80211_TX_RATE_TABLE_SIZE 4
636 * struct ieee80211_tx_rate - rate selection/status
638 * @idx: rate index to attempt to send with
639 * @flags: rate control flags (&enum mac80211_rate_control_flags)
640 * @count: number of tries in this rate before going to the next rate
642 * A value of -1 for @idx indicates an invalid rate and, if used
643 * in an array of retry rates, that no more rates should be tried.
645 * When used for transmit status reporting, the driver should
646 * always report the rate along with the flags it used.
648 * &struct ieee80211_tx_info contains an array of these structs
649 * in the control information, and it will be filled by the rate
650 * control algorithm according to what should be sent. For example,
651 * if this array contains, in the format { <idx>, <count> } the
653 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
654 * then this means that the frame should be transmitted
655 * up to twice at rate 3, up to twice at rate 2, and up to four
656 * times at rate 1 if it doesn't get acknowledged. Say it gets
657 * acknowledged by the peer after the fifth attempt, the status
658 * information should then contain
659 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
660 * since it was transmitted twice at rate 3, twice at rate 2
661 * and once at rate 1 after which we received an acknowledgement.
663 struct ieee80211_tx_rate {
669 #define IEEE80211_MAX_TX_RETRY 31
671 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
675 WARN_ON((nss - 1) & ~0x7);
676 rate->idx = ((nss - 1) << 4) | mcs;
680 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
682 return rate->idx & 0xF;
686 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
688 return (rate->idx >> 4) + 1;
692 * struct ieee80211_tx_info - skb transmit information
694 * This structure is placed in skb->cb for three uses:
695 * (1) mac80211 TX control - mac80211 tells the driver what to do
696 * (2) driver internal use (if applicable)
697 * (3) TX status information - driver tells mac80211 what happened
699 * @flags: transmit info flags, defined above
700 * @band: the band to transmit on (use for checking for races)
701 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
702 * @ack_frame_id: internal frame ID for TX status, used internally
703 * @control: union for control data
704 * @status: union for status data
705 * @driver_data: array of driver_data pointers
706 * @ampdu_ack_len: number of acked aggregated frames.
707 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
708 * @ampdu_len: number of aggregated frames.
709 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
710 * @ack_signal: signal strength of the ACK frame
712 struct ieee80211_tx_info {
713 /* common information */
726 struct ieee80211_tx_rate rates[
727 IEEE80211_TX_MAX_RATES];
735 /* only needed before rate control */
736 unsigned long jiffies;
738 /* NB: vif can be NULL for injected frames */
739 struct ieee80211_vif *vif;
740 struct ieee80211_key_conf *hw_key;
745 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
751 void *status_driver_data[19 / sizeof(void *)];
754 struct ieee80211_tx_rate driver_rates[
755 IEEE80211_TX_MAX_RATES];
758 void *rate_driver_data[
759 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
762 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
767 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
769 * This structure is used to point to different blocks of IEs in HW scan
770 * and scheduled scan. These blocks contain the IEs passed by userspace
771 * and the ones generated by mac80211.
773 * @ies: pointers to band specific IEs.
774 * @len: lengths of band_specific IEs.
775 * @common_ies: IEs for all bands (especially vendor specific ones)
776 * @common_ie_len: length of the common_ies
778 struct ieee80211_scan_ies {
779 const u8 *ies[IEEE80211_NUM_BANDS];
780 size_t len[IEEE80211_NUM_BANDS];
781 const u8 *common_ies;
782 size_t common_ie_len;
786 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
788 return (struct ieee80211_tx_info *)skb->cb;
791 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
793 return (struct ieee80211_rx_status *)skb->cb;
797 * ieee80211_tx_info_clear_status - clear TX status
799 * @info: The &struct ieee80211_tx_info to be cleared.
801 * When the driver passes an skb back to mac80211, it must report
802 * a number of things in TX status. This function clears everything
803 * in the TX status but the rate control information (it does clear
804 * the count since you need to fill that in anyway).
806 * NOTE: You can only use this function if you do NOT use
807 * info->driver_data! Use info->rate_driver_data
808 * instead if you need only the less space that allows.
811 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
815 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
816 offsetof(struct ieee80211_tx_info, control.rates));
817 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
818 offsetof(struct ieee80211_tx_info, driver_rates));
819 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
820 /* clear the rate counts */
821 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
822 info->status.rates[i].count = 0;
825 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
826 memset(&info->status.ampdu_ack_len, 0,
827 sizeof(struct ieee80211_tx_info) -
828 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
833 * enum mac80211_rx_flags - receive flags
835 * These flags are used with the @flag member of &struct ieee80211_rx_status.
836 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
837 * Use together with %RX_FLAG_MMIC_STRIPPED.
838 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
839 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
840 * verification has been done by the hardware.
841 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
842 * If this flag is set, the stack cannot do any replay detection
843 * hence the driver or hardware will have to do that.
844 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
846 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
848 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
849 * field) is valid and contains the time the first symbol of the MPDU
850 * was received. This is useful in monitor mode and for proper IBSS
852 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
853 * field) is valid and contains the time the last symbol of the MPDU
854 * (including FCS) was received.
855 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
856 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
857 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
858 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
859 * @RX_FLAG_SHORT_GI: Short guard interval was used
860 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
861 * Valid only for data frames (mainly A-MPDU)
862 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
863 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
864 * to hw.radiotap_mcs_details to advertise that fact
865 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
866 * number (@ampdu_reference) must be populated and be a distinct number for
868 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
869 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
870 * monitoring purposes only
871 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
872 * subframes of a single A-MPDU
873 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
874 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
876 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
877 * is stored in the @ampdu_delimiter_crc field)
878 * @RX_FLAG_LDPC: LDPC was used
879 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
880 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
881 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
882 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
883 * subframes instead of a one huge frame for performance reasons.
884 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
885 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
886 * the 3rd (last) one must not have this flag set. The flag is used to
887 * deal with retransmission/duplication recovery properly since A-MSDU
888 * subframes share the same sequence number. Reported subframes can be
889 * either regular MSDU or singly A-MSDUs. Subframes must not be
890 * interleaved with other frames.
891 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
892 * radiotap data in the skb->data (before the frame) as described by
893 * the &struct ieee80211_vendor_radiotap.
895 enum mac80211_rx_flags {
896 RX_FLAG_MMIC_ERROR = BIT(0),
897 RX_FLAG_DECRYPTED = BIT(1),
898 RX_FLAG_MMIC_STRIPPED = BIT(3),
899 RX_FLAG_IV_STRIPPED = BIT(4),
900 RX_FLAG_FAILED_FCS_CRC = BIT(5),
901 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
902 RX_FLAG_MACTIME_START = BIT(7),
903 RX_FLAG_SHORTPRE = BIT(8),
905 RX_FLAG_40MHZ = BIT(10),
906 RX_FLAG_SHORT_GI = BIT(11),
907 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
908 RX_FLAG_HT_GF = BIT(13),
909 RX_FLAG_AMPDU_DETAILS = BIT(14),
910 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
911 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
912 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
913 RX_FLAG_AMPDU_IS_LAST = BIT(18),
914 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
915 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
916 RX_FLAG_MACTIME_END = BIT(21),
917 RX_FLAG_VHT = BIT(22),
918 RX_FLAG_LDPC = BIT(23),
919 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
920 RX_FLAG_10MHZ = BIT(28),
921 RX_FLAG_5MHZ = BIT(29),
922 RX_FLAG_AMSDU_MORE = BIT(30),
923 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
926 #define RX_FLAG_STBC_SHIFT 26
929 * enum mac80211_rx_vht_flags - receive VHT flags
931 * These flags are used with the @vht_flag member of
932 * &struct ieee80211_rx_status.
933 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
934 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
935 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
936 * @RX_VHT_FLAG_BF: packet was beamformed
938 enum mac80211_rx_vht_flags {
939 RX_VHT_FLAG_80MHZ = BIT(0),
940 RX_VHT_FLAG_80P80MHZ = BIT(1),
941 RX_VHT_FLAG_160MHZ = BIT(2),
942 RX_VHT_FLAG_BF = BIT(3),
946 * struct ieee80211_rx_status - receive status
948 * The low-level driver should provide this information (the subset
949 * supported by hardware) to the 802.11 code with each received
950 * frame, in the skb's control buffer (cb).
952 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
953 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
954 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
955 * it but can store it and pass it back to the driver for synchronisation
956 * @band: the active band when this frame was received
957 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
958 * @signal: signal strength when receiving this frame, either in dBm, in dB or
959 * unspecified depending on the hardware capabilities flags
960 * @IEEE80211_HW_SIGNAL_*
961 * @chains: bitmask of receive chains for which separate signal strength
962 * values were filled.
963 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
964 * support dB or unspecified units)
965 * @antenna: antenna used
966 * @rate_idx: index of data rate into band's supported rates or MCS index if
967 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
968 * @vht_nss: number of streams (VHT only)
970 * @vht_flag: %RX_VHT_FLAG_*
971 * @rx_flags: internal RX flags for mac80211
972 * @ampdu_reference: A-MPDU reference number, must be a different value for
973 * each A-MPDU but the same for each subframe within one A-MPDU
974 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
976 struct ieee80211_rx_status {
978 u32 device_timestamp;
990 s8 chain_signal[IEEE80211_MAX_CHAINS];
991 u8 ampdu_delimiter_crc;
995 * struct ieee80211_vendor_radiotap - vendor radiotap data information
996 * @present: presence bitmap for this vendor namespace
997 * (this could be extended in the future if any vendor needs more
998 * bits, the radiotap spec does allow for that)
999 * @align: radiotap vendor namespace alignment. This defines the needed
1000 * alignment for the @data field below, not for the vendor namespace
1001 * description itself (which has a fixed 2-byte alignment)
1002 * Must be a power of two, and be set to at least 1!
1003 * @oui: radiotap vendor namespace OUI
1004 * @subns: radiotap vendor sub namespace
1005 * @len: radiotap vendor sub namespace skip length, if alignment is done
1006 * then that's added to this, i.e. this is only the length of the
1008 * @pad: number of bytes of padding after the @data, this exists so that
1009 * the skb data alignment can be preserved even if the data has odd
1011 * @data: the actual vendor namespace data
1013 * This struct, including the vendor data, goes into the skb->data before
1014 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1017 struct ieee80211_vendor_radiotap {
1028 * enum ieee80211_conf_flags - configuration flags
1030 * Flags to define PHY configuration options
1032 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1033 * to determine for example whether to calculate timestamps for packets
1034 * or not, do not use instead of filter flags!
1035 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1036 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1037 * meaning that the hardware still wakes up for beacons, is able to
1038 * transmit frames and receive the possible acknowledgment frames.
1039 * Not to be confused with hardware specific wakeup/sleep states,
1040 * driver is responsible for that. See the section "Powersave support"
1042 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1043 * the driver should be prepared to handle configuration requests but
1044 * may turn the device off as much as possible. Typically, this flag will
1045 * be set when an interface is set UP but not associated or scanning, but
1046 * it can also be unset in that case when monitor interfaces are active.
1047 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1048 * operating channel.
1050 enum ieee80211_conf_flags {
1051 IEEE80211_CONF_MONITOR = (1<<0),
1052 IEEE80211_CONF_PS = (1<<1),
1053 IEEE80211_CONF_IDLE = (1<<2),
1054 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1059 * enum ieee80211_conf_changed - denotes which configuration changed
1061 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1062 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1063 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1064 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1065 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1066 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1067 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1068 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1069 * Note that this is only valid if channel contexts are not used,
1070 * otherwise each channel context has the number of chains listed.
1072 enum ieee80211_conf_changed {
1073 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1074 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1075 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1076 IEEE80211_CONF_CHANGE_PS = BIT(4),
1077 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1078 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1079 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1080 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1084 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1086 * @IEEE80211_SMPS_AUTOMATIC: automatic
1087 * @IEEE80211_SMPS_OFF: off
1088 * @IEEE80211_SMPS_STATIC: static
1089 * @IEEE80211_SMPS_DYNAMIC: dynamic
1090 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1092 enum ieee80211_smps_mode {
1093 IEEE80211_SMPS_AUTOMATIC,
1095 IEEE80211_SMPS_STATIC,
1096 IEEE80211_SMPS_DYNAMIC,
1099 IEEE80211_SMPS_NUM_MODES,
1103 * struct ieee80211_conf - configuration of the device
1105 * This struct indicates how the driver shall configure the hardware.
1107 * @flags: configuration flags defined above
1109 * @listen_interval: listen interval in units of beacon interval
1110 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1111 * before checking the beacon for a TIM bit (managed mode only); this
1112 * value will be only achievable between DTIM frames, the hardware
1113 * needs to check for the multicast traffic bit in DTIM beacons.
1114 * This variable is valid only when the CONF_PS flag is set.
1115 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1116 * in power saving. Power saving will not be enabled until a beacon
1117 * has been received and the DTIM period is known.
1118 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1119 * powersave documentation below. This variable is valid only when
1120 * the CONF_PS flag is set.
1122 * @power_level: requested transmit power (in dBm), backward compatibility
1123 * value only that is set to the minimum of all interfaces
1125 * @chandef: the channel definition to tune to
1126 * @radar_enabled: whether radar detection is enabled
1128 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1129 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1130 * but actually means the number of transmissions not the number of retries
1131 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1132 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1133 * number of transmissions not the number of retries
1135 * @smps_mode: spatial multiplexing powersave mode; note that
1136 * %IEEE80211_SMPS_STATIC is used when the device is not
1137 * configured for an HT channel.
1138 * Note that this is only valid if channel contexts are not used,
1139 * otherwise each channel context has the number of chains listed.
1141 struct ieee80211_conf {
1143 int power_level, dynamic_ps_timeout;
1144 int max_sleep_period;
1146 u16 listen_interval;
1149 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1151 struct cfg80211_chan_def chandef;
1153 enum ieee80211_smps_mode smps_mode;
1157 * struct ieee80211_channel_switch - holds the channel switch data
1159 * The information provided in this structure is required for channel switch
1162 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1163 * Function (TSF) timer when the frame containing the channel switch
1164 * announcement was received. This is simply the rx.mactime parameter
1165 * the driver passed into mac80211.
1166 * @device_timestamp: arbitrary timestamp for the device, this is the
1167 * rx.device_timestamp parameter the driver passed to mac80211.
1168 * @block_tx: Indicates whether transmission must be blocked before the
1169 * scheduled channel switch, as indicated by the AP.
1170 * @chandef: the new channel to switch to
1171 * @count: the number of TBTT's until the channel switch event
1173 struct ieee80211_channel_switch {
1175 u32 device_timestamp;
1177 struct cfg80211_chan_def chandef;
1182 * enum ieee80211_vif_flags - virtual interface flags
1184 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1185 * on this virtual interface to avoid unnecessary CPU wakeups
1186 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1187 * monitoring on this virtual interface -- i.e. it can monitor
1188 * connection quality related parameters, such as the RSSI level and
1189 * provide notifications if configured trigger levels are reached.
1190 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1191 * interface. This flag should be set during interface addition,
1192 * but may be set/cleared as late as authentication to an AP. It is
1193 * only valid for managed/station mode interfaces.
1195 enum ieee80211_vif_flags {
1196 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1197 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1198 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1202 * struct ieee80211_vif - per-interface data
1204 * Data in this structure is continually present for driver
1205 * use during the life of a virtual interface.
1207 * @type: type of this virtual interface
1208 * @bss_conf: BSS configuration for this interface, either our own
1209 * or the BSS we're associated to
1210 * @addr: address of this interface
1211 * @p2p: indicates whether this AP or STA interface is a p2p
1212 * interface, i.e. a GO or p2p-sta respectively
1213 * @csa_active: marks whether a channel switch is going on. Internally it is
1214 * write-protected by sdata_lock and local->mtx so holding either is fine
1216 * @driver_flags: flags/capabilities the driver has for this interface,
1217 * these need to be set (or cleared) when the interface is added
1218 * or, if supported by the driver, the interface type is changed
1219 * at runtime, mac80211 will never touch this field
1220 * @hw_queue: hardware queue for each AC
1221 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1222 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1223 * when it is not assigned. This pointer is RCU-protected due to the TX
1224 * path needing to access it; even though the netdev carrier will always
1225 * be off when it is %NULL there can still be races and packets could be
1226 * processed after it switches back to %NULL.
1227 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1228 * interface debug files. Note that it will be NULL for the virtual
1229 * monitor interface (if that is requested.)
1230 * @drv_priv: data area for driver use, will always be aligned to
1233 struct ieee80211_vif {
1234 enum nl80211_iftype type;
1235 struct ieee80211_bss_conf bss_conf;
1241 u8 hw_queue[IEEE80211_NUM_ACS];
1243 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1247 #ifdef CONFIG_MAC80211_DEBUGFS
1248 struct dentry *debugfs_dir;
1252 u8 drv_priv[0] __aligned(sizeof(void *));
1255 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1257 #ifdef CONFIG_MAC80211_MESH
1258 return vif->type == NL80211_IFTYPE_MESH_POINT;
1264 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1265 * @wdev: the wdev to get the vif for
1267 * This can be used by mac80211 drivers with direct cfg80211 APIs
1268 * (like the vendor commands) that get a wdev.
1270 * Note that this function may return %NULL if the given wdev isn't
1271 * associated with a vif that the driver knows about (e.g. monitor
1272 * or AP_VLAN interfaces.)
1274 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1277 * enum ieee80211_key_flags - key flags
1279 * These flags are used for communication about keys between the driver
1280 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1282 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1283 * driver to indicate that it requires IV generation for this
1285 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1286 * the driver for a TKIP key if it requires Michael MIC
1287 * generation in software.
1288 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1289 * that the key is pairwise rather then a shared key.
1290 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1291 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1292 * be done in software.
1293 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1294 * if space should be prepared for the IV, but the IV
1295 * itself should not be generated. Do not set together with
1296 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1297 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1298 * management frames. The flag can help drivers that have a hardware
1299 * crypto implementation that doesn't deal with management frames
1300 * properly by allowing them to not upload the keys to hardware and
1301 * fall back to software crypto. Note that this flag deals only with
1302 * RX, if your crypto engine can't deal with TX you can also set the
1303 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1304 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1305 * driver for a CCMP key to indicate that is requires IV generation
1306 * only for managment frames (MFP).
1308 enum ieee80211_key_flags {
1309 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1310 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1311 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1312 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1313 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1314 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1315 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1319 * struct ieee80211_key_conf - key information
1321 * This key information is given by mac80211 to the driver by
1322 * the set_key() callback in &struct ieee80211_ops.
1324 * @hw_key_idx: To be set by the driver, this is the key index the driver
1325 * wants to be given when a frame is transmitted and needs to be
1326 * encrypted in hardware.
1327 * @cipher: The key's cipher suite selector.
1328 * @flags: key flags, see &enum ieee80211_key_flags.
1329 * @keyidx: the key index (0-3)
1330 * @keylen: key material length
1331 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1333 * - Temporal Encryption Key (128 bits)
1334 * - Temporal Authenticator Tx MIC Key (64 bits)
1335 * - Temporal Authenticator Rx MIC Key (64 bits)
1336 * @icv_len: The ICV length for this key type
1337 * @iv_len: The IV length for this key type
1339 struct ieee80211_key_conf {
1351 * struct ieee80211_cipher_scheme - cipher scheme
1353 * This structure contains a cipher scheme information defining
1354 * the secure packet crypto handling.
1356 * @cipher: a cipher suite selector
1357 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1358 * @hdr_len: a length of a security header used the cipher
1359 * @pn_len: a length of a packet number in the security header
1360 * @pn_off: an offset of pn from the beginning of the security header
1361 * @key_idx_off: an offset of key index byte in the security header
1362 * @key_idx_mask: a bit mask of key_idx bits
1363 * @key_idx_shift: a bit shift needed to get key_idx
1364 * key_idx value calculation:
1365 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1366 * @mic_len: a mic length in bytes
1368 struct ieee80211_cipher_scheme {
1381 * enum set_key_cmd - key command
1383 * Used with the set_key() callback in &struct ieee80211_ops, this
1384 * indicates whether a key is being removed or added.
1386 * @SET_KEY: a key is set
1387 * @DISABLE_KEY: a key must be disabled
1390 SET_KEY, DISABLE_KEY,
1394 * enum ieee80211_sta_state - station state
1396 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1397 * this is a special state for add/remove transitions
1398 * @IEEE80211_STA_NONE: station exists without special state
1399 * @IEEE80211_STA_AUTH: station is authenticated
1400 * @IEEE80211_STA_ASSOC: station is associated
1401 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1403 enum ieee80211_sta_state {
1404 /* NOTE: These need to be ordered correctly! */
1405 IEEE80211_STA_NOTEXIST,
1408 IEEE80211_STA_ASSOC,
1409 IEEE80211_STA_AUTHORIZED,
1413 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1414 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1415 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1416 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1417 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1418 * (including 80+80 MHz)
1420 * Implementation note: 20 must be zero to be initialized
1421 * correctly, the values must be sorted.
1423 enum ieee80211_sta_rx_bandwidth {
1424 IEEE80211_STA_RX_BW_20 = 0,
1425 IEEE80211_STA_RX_BW_40,
1426 IEEE80211_STA_RX_BW_80,
1427 IEEE80211_STA_RX_BW_160,
1431 * struct ieee80211_sta_rates - station rate selection table
1433 * @rcu_head: RCU head used for freeing the table on update
1434 * @rate: transmit rates/flags to be used by default.
1435 * Overriding entries per-packet is possible by using cb tx control.
1437 struct ieee80211_sta_rates {
1438 struct rcu_head rcu_head;
1445 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1449 * struct ieee80211_sta - station table entry
1451 * A station table entry represents a station we are possibly
1452 * communicating with. Since stations are RCU-managed in
1453 * mac80211, any ieee80211_sta pointer you get access to must
1454 * either be protected by rcu_read_lock() explicitly or implicitly,
1455 * or you must take good care to not use such a pointer after a
1456 * call to your sta_remove callback that removed it.
1458 * @addr: MAC address
1459 * @aid: AID we assigned to the station if we're an AP
1460 * @supp_rates: Bitmap of supported rates (per band)
1461 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1462 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1463 * @wme: indicates whether the STA supports QoS/WME.
1464 * @drv_priv: data area for driver use, will always be aligned to
1465 * sizeof(void *), size is determined in hw information.
1466 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1467 * if wme is supported.
1468 * @max_sp: max Service Period. Only valid if wme is supported.
1469 * @bandwidth: current bandwidth the station can receive with
1470 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1471 * station can receive at the moment, changed by operating mode
1472 * notifications and capabilities. The value is only valid after
1473 * the station moves to associated state.
1474 * @smps_mode: current SMPS mode (off, static or dynamic)
1475 * @rates: rate control selection table
1476 * @tdls: indicates whether the STA is a TDLS peer
1477 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1478 * valid if the STA is a TDLS peer in the first place.
1480 struct ieee80211_sta {
1481 u32 supp_rates[IEEE80211_NUM_BANDS];
1484 struct ieee80211_sta_ht_cap ht_cap;
1485 struct ieee80211_sta_vht_cap vht_cap;
1490 enum ieee80211_sta_rx_bandwidth bandwidth;
1491 enum ieee80211_smps_mode smps_mode;
1492 struct ieee80211_sta_rates __rcu *rates;
1494 bool tdls_initiator;
1497 u8 drv_priv[0] __aligned(sizeof(void *));
1501 * enum sta_notify_cmd - sta notify command
1503 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1504 * indicates if an associated station made a power state transition.
1506 * @STA_NOTIFY_SLEEP: a station is now sleeping
1507 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1509 enum sta_notify_cmd {
1510 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1514 * struct ieee80211_tx_control - TX control data
1516 * @sta: station table entry, this sta pointer may be NULL and
1517 * it is not allowed to copy the pointer, due to RCU.
1519 struct ieee80211_tx_control {
1520 struct ieee80211_sta *sta;
1524 * enum ieee80211_hw_flags - hardware flags
1526 * These flags are used to indicate hardware capabilities to
1527 * the stack. Generally, flags here should have their meaning
1528 * done in a way that the simplest hardware doesn't need setting
1529 * any particular flags. There are some exceptions to this rule,
1530 * however, so you are advised to review these flags carefully.
1532 * @IEEE80211_HW_HAS_RATE_CONTROL:
1533 * The hardware or firmware includes rate control, and cannot be
1534 * controlled by the stack. As such, no rate control algorithm
1535 * should be instantiated, and the TX rate reported to userspace
1536 * will be taken from the TX status instead of the rate control
1538 * Note that this requires that the driver implement a number of
1539 * callbacks so it has the correct information, it needs to have
1540 * the @set_rts_threshold callback and must look at the BSS config
1541 * @use_cts_prot for G/N protection, @use_short_slot for slot
1542 * timing in 2.4 GHz and @use_short_preamble for preambles for
1545 * @IEEE80211_HW_RX_INCLUDES_FCS:
1546 * Indicates that received frames passed to the stack include
1547 * the FCS at the end.
1549 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1550 * Some wireless LAN chipsets buffer broadcast/multicast frames
1551 * for power saving stations in the hardware/firmware and others
1552 * rely on the host system for such buffering. This option is used
1553 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1554 * multicast frames when there are power saving stations so that
1555 * the driver can fetch them with ieee80211_get_buffered_bc().
1557 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1558 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1560 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1561 * Hardware is not capable of receiving frames with short preamble on
1564 * @IEEE80211_HW_SIGNAL_UNSPEC:
1565 * Hardware can provide signal values but we don't know its units. We
1566 * expect values between 0 and @max_signal.
1567 * If possible please provide dB or dBm instead.
1569 * @IEEE80211_HW_SIGNAL_DBM:
1570 * Hardware gives signal values in dBm, decibel difference from
1571 * one milliwatt. This is the preferred method since it is standardized
1572 * between different devices. @max_signal does not need to be set.
1574 * @IEEE80211_HW_SPECTRUM_MGMT:
1575 * Hardware supports spectrum management defined in 802.11h
1576 * Measurement, Channel Switch, Quieting, TPC
1578 * @IEEE80211_HW_AMPDU_AGGREGATION:
1579 * Hardware supports 11n A-MPDU aggregation.
1581 * @IEEE80211_HW_SUPPORTS_PS:
1582 * Hardware has power save support (i.e. can go to sleep).
1584 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1585 * Hardware requires nullfunc frame handling in stack, implies
1586 * stack support for dynamic PS.
1588 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1589 * Hardware has support for dynamic PS.
1591 * @IEEE80211_HW_MFP_CAPABLE:
1592 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1594 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1595 * Hardware can provide ack status reports of Tx frames to
1598 * @IEEE80211_HW_CONNECTION_MONITOR:
1599 * The hardware performs its own connection monitoring, including
1600 * periodic keep-alives to the AP and probing the AP on beacon loss.
1602 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1603 * This device needs to get data from beacon before association (i.e.
1606 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1607 * per-station GTKs as used by IBSS RSN or during fast transition. If
1608 * the device doesn't support per-station GTKs, but can be asked not
1609 * to decrypt group addressed frames, then IBSS RSN support is still
1610 * possible but software crypto will be used. Advertise the wiphy flag
1611 * only in that case.
1613 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1614 * autonomously manages the PS status of connected stations. When
1615 * this flag is set mac80211 will not trigger PS mode for connected
1616 * stations based on the PM bit of incoming frames.
1617 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1618 * the PS mode of connected stations.
1620 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1621 * setup strictly in HW. mac80211 should not attempt to do this in
1624 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1625 * a virtual monitor interface when monitor interfaces are the only
1626 * active interfaces.
1628 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1629 * be created. It is expected user-space will create vifs as
1630 * desired (and thus have them named as desired).
1632 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1633 * queue mapping in order to use different queues (not just one per AC)
1634 * for different virtual interfaces. See the doc section on HW queue
1635 * control for more details.
1637 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1638 * selection table provided by the rate control algorithm.
1640 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1641 * P2P Interface. This will be honoured even if more than one interface
1644 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1645 * only, to allow getting TBTT of a DTIM beacon.
1647 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1648 * and can cope with CCK rates in an aggregation session (e.g. by not
1649 * using aggregation for such frames.)
1651 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1652 * for a single active channel while using channel contexts. When support
1653 * is not enabled the default action is to disconnect when getting the
1656 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1657 * or tailroom of TX skbs without copying them first.
1659 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1660 * in one command, mac80211 doesn't have to run separate scans per band.
1662 enum ieee80211_hw_flags {
1663 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1664 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1665 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1666 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1667 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1668 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1669 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1670 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1671 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1672 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1673 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1674 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1675 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1676 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1677 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1678 IEEE80211_HW_NO_AUTO_VIF = 1<<15,
1680 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1681 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1682 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1683 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1684 IEEE80211_HW_AP_LINK_PS = 1<<22,
1685 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1686 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1687 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1688 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1689 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1690 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1691 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29,
1692 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
1696 * struct ieee80211_hw - hardware information and state
1698 * This structure contains the configuration and hardware
1699 * information for an 802.11 PHY.
1701 * @wiphy: This points to the &struct wiphy allocated for this
1702 * 802.11 PHY. You must fill in the @perm_addr and @dev
1703 * members of this structure using SET_IEEE80211_DEV()
1704 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1705 * bands (with channels, bitrates) are registered here.
1707 * @conf: &struct ieee80211_conf, device configuration, don't use.
1709 * @priv: pointer to private area that was allocated for driver use
1710 * along with this structure.
1712 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1714 * @extra_tx_headroom: headroom to reserve in each transmit skb
1715 * for use by the driver (e.g. for transmit headers.)
1717 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1718 * Can be used by drivers to add extra IEs.
1720 * @max_signal: Maximum value for signal (rssi) in RX information, used
1721 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1723 * @max_listen_interval: max listen interval in units of beacon interval
1726 * @queues: number of available hardware transmit queues for
1727 * data packets. WMM/QoS requires at least four, these
1728 * queues need to have configurable access parameters.
1730 * @rate_control_algorithm: rate control algorithm for this hardware.
1731 * If unset (NULL), the default algorithm will be used. Must be
1732 * set before calling ieee80211_register_hw().
1734 * @vif_data_size: size (in bytes) of the drv_priv data area
1735 * within &struct ieee80211_vif.
1736 * @sta_data_size: size (in bytes) of the drv_priv data area
1737 * within &struct ieee80211_sta.
1738 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1739 * within &struct ieee80211_chanctx_conf.
1741 * @max_rates: maximum number of alternate rate retry stages the hw
1743 * @max_report_rates: maximum number of alternate rate retry stages
1744 * the hw can report back.
1745 * @max_rate_tries: maximum number of tries for each stage
1747 * @max_rx_aggregation_subframes: maximum buffer size (number of
1748 * sub-frames) to be used for A-MPDU block ack receiver
1750 * This is only relevant if the device has restrictions on the
1751 * number of subframes, if it relies on mac80211 to do reordering
1752 * it shouldn't be set.
1754 * @max_tx_aggregation_subframes: maximum number of subframes in an
1755 * aggregate an HT driver will transmit, used by the peer as a
1756 * hint to size its reorder buffer.
1758 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1759 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1761 * @radiotap_mcs_details: lists which MCS information can the HW
1762 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1763 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1764 * adding _BW is supported today.
1766 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1767 * the default is _GI | _BANDWIDTH.
1768 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1770 * @netdev_features: netdev features to be set in each netdev created
1771 * from this HW. Note only HW checksum features are currently
1772 * compatible with mac80211. Other feature bits will be rejected.
1774 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1775 * for each access category if it is uAPSD trigger-enabled and delivery-
1776 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1777 * Each bit corresponds to different AC. Value '1' in specific bit means
1778 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1781 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1782 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1783 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1785 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1786 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1789 struct ieee80211_hw {
1790 struct ieee80211_conf conf;
1791 struct wiphy *wiphy;
1792 const char *rate_control_algorithm;
1795 unsigned int extra_tx_headroom;
1796 unsigned int extra_beacon_tailroom;
1799 int chanctx_data_size;
1801 u16 max_listen_interval;
1804 u8 max_report_rates;
1806 u8 max_rx_aggregation_subframes;
1807 u8 max_tx_aggregation_subframes;
1808 u8 offchannel_tx_hw_queue;
1809 u8 radiotap_mcs_details;
1810 u16 radiotap_vht_details;
1811 netdev_features_t netdev_features;
1813 u8 uapsd_max_sp_len;
1814 u8 n_cipher_schemes;
1815 const struct ieee80211_cipher_scheme *cipher_schemes;
1819 * struct ieee80211_scan_request - hw scan request
1821 * @ies: pointers different parts of IEs (in req.ie)
1822 * @req: cfg80211 request.
1824 struct ieee80211_scan_request {
1825 struct ieee80211_scan_ies ies;
1828 struct cfg80211_scan_request req;
1832 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
1834 * @sta: peer this TDLS channel-switch request/response came from
1835 * @chandef: channel referenced in a TDLS channel-switch request
1836 * @action_code: see &enum ieee80211_tdls_actioncode
1837 * @status: channel-switch response status
1838 * @timestamp: time at which the frame was received
1839 * @switch_time: switch-timing parameter received in the frame
1840 * @switch_timeout: switch-timing parameter received in the frame
1841 * @tmpl_skb: TDLS switch-channel response template
1842 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
1844 struct ieee80211_tdls_ch_sw_params {
1845 struct ieee80211_sta *sta;
1846 struct cfg80211_chan_def *chandef;
1852 struct sk_buff *tmpl_skb;
1857 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1859 * @wiphy: the &struct wiphy which we want to query
1861 * mac80211 drivers can use this to get to their respective
1862 * &struct ieee80211_hw. Drivers wishing to get to their own private
1863 * structure can then access it via hw->priv. Note that mac802111 drivers should
1864 * not use wiphy_priv() to try to get their private driver structure as this
1865 * is already used internally by mac80211.
1867 * Return: The mac80211 driver hw struct of @wiphy.
1869 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1872 * SET_IEEE80211_DEV - set device for 802.11 hardware
1874 * @hw: the &struct ieee80211_hw to set the device for
1875 * @dev: the &struct device of this 802.11 device
1877 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1879 set_wiphy_dev(hw->wiphy, dev);
1883 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1885 * @hw: the &struct ieee80211_hw to set the MAC address for
1886 * @addr: the address to set
1888 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1890 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1893 static inline struct ieee80211_rate *
1894 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1895 const struct ieee80211_tx_info *c)
1897 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1899 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1902 static inline struct ieee80211_rate *
1903 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1904 const struct ieee80211_tx_info *c)
1906 if (c->control.rts_cts_rate_idx < 0)
1908 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1911 static inline struct ieee80211_rate *
1912 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1913 const struct ieee80211_tx_info *c, int idx)
1915 if (c->control.rates[idx + 1].idx < 0)
1917 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1921 * ieee80211_free_txskb - free TX skb
1925 * Free a transmit skb. Use this funtion when some failure
1926 * to transmit happened and thus status cannot be reported.
1928 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1931 * DOC: Hardware crypto acceleration
1933 * mac80211 is capable of taking advantage of many hardware
1934 * acceleration designs for encryption and decryption operations.
1936 * The set_key() callback in the &struct ieee80211_ops for a given
1937 * device is called to enable hardware acceleration of encryption and
1938 * decryption. The callback takes a @sta parameter that will be NULL
1939 * for default keys or keys used for transmission only, or point to
1940 * the station information for the peer for individual keys.
1941 * Multiple transmission keys with the same key index may be used when
1942 * VLANs are configured for an access point.
1944 * When transmitting, the TX control data will use the @hw_key_idx
1945 * selected by the driver by modifying the &struct ieee80211_key_conf
1946 * pointed to by the @key parameter to the set_key() function.
1948 * The set_key() call for the %SET_KEY command should return 0 if
1949 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1950 * added; if you return 0 then hw_key_idx must be assigned to the
1951 * hardware key index, you are free to use the full u8 range.
1953 * When the cmd is %DISABLE_KEY then it must succeed.
1955 * Note that it is permissible to not decrypt a frame even if a key
1956 * for it has been uploaded to hardware, the stack will not make any
1957 * decision based on whether a key has been uploaded or not but rather
1958 * based on the receive flags.
1960 * The &struct ieee80211_key_conf structure pointed to by the @key
1961 * parameter is guaranteed to be valid until another call to set_key()
1962 * removes it, but it can only be used as a cookie to differentiate
1965 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1966 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1968 * The update_tkip_key() call updates the driver with the new phase 1 key.
1969 * This happens every time the iv16 wraps around (every 65536 packets). The
1970 * set_key() call will happen only once for each key (unless the AP did
1971 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1972 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1973 * handler is software decryption with wrap around of iv16.
1975 * The set_default_unicast_key() call updates the default WEP key index
1976 * configured to the hardware for WEP encryption type. This is required
1977 * for devices that support offload of data packets (e.g. ARP responses).
1981 * DOC: Powersave support
1983 * mac80211 has support for various powersave implementations.
1985 * First, it can support hardware that handles all powersaving by itself,
1986 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1987 * flag. In that case, it will be told about the desired powersave mode
1988 * with the %IEEE80211_CONF_PS flag depending on the association status.
1989 * The hardware must take care of sending nullfunc frames when necessary,
1990 * i.e. when entering and leaving powersave mode. The hardware is required
1991 * to look at the AID in beacons and signal to the AP that it woke up when
1992 * it finds traffic directed to it.
1994 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1995 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1996 * with hardware wakeup and sleep states. Driver is responsible for waking
1997 * up the hardware before issuing commands to the hardware and putting it
1998 * back to sleep at appropriate times.
2000 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2001 * buffered multicast/broadcast frames after the beacon. Also it must be
2002 * possible to send frames and receive the acknowledment frame.
2004 * Other hardware designs cannot send nullfunc frames by themselves and also
2005 * need software support for parsing the TIM bitmap. This is also supported
2006 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2007 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2008 * required to pass up beacons. The hardware is still required to handle
2009 * waking up for multicast traffic; if it cannot the driver must handle that
2010 * as best as it can, mac80211 is too slow to do that.
2012 * Dynamic powersave is an extension to normal powersave in which the
2013 * hardware stays awake for a user-specified period of time after sending a
2014 * frame so that reply frames need not be buffered and therefore delayed to
2015 * the next wakeup. It's compromise of getting good enough latency when
2016 * there's data traffic and still saving significantly power in idle
2019 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2020 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2021 * flag and mac80211 will handle everything automatically. Additionally,
2022 * hardware having support for the dynamic PS feature may set the
2023 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2024 * dynamic PS mode itself. The driver needs to look at the
2025 * @dynamic_ps_timeout hardware configuration value and use it that value
2026 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2027 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2028 * enabled whenever user has enabled powersave.
2030 * Driver informs U-APSD client support by enabling
2031 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2032 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2033 * Nullfunc frames and stay awake until the service period has ended. To
2034 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2035 * from that AC are transmitted with powersave enabled.
2037 * Note: U-APSD client mode is not yet supported with
2038 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2042 * DOC: Beacon filter support
2044 * Some hardware have beacon filter support to reduce host cpu wakeups
2045 * which will reduce system power consumption. It usually works so that
2046 * the firmware creates a checksum of the beacon but omits all constantly
2047 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2048 * beacon is forwarded to the host, otherwise it will be just dropped. That
2049 * way the host will only receive beacons where some relevant information
2050 * (for example ERP protection or WMM settings) have changed.
2052 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2053 * interface capability. The driver needs to enable beacon filter support
2054 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2055 * power save is enabled, the stack will not check for beacon loss and the
2056 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2058 * The time (or number of beacons missed) until the firmware notifies the
2059 * driver of a beacon loss event (which in turn causes the driver to call
2060 * ieee80211_beacon_loss()) should be configurable and will be controlled
2061 * by mac80211 and the roaming algorithm in the future.
2063 * Since there may be constantly changing information elements that nothing
2064 * in the software stack cares about, we will, in the future, have mac80211
2065 * tell the driver which information elements are interesting in the sense
2066 * that we want to see changes in them. This will include
2067 * - a list of information element IDs
2068 * - a list of OUIs for the vendor information element
2070 * Ideally, the hardware would filter out any beacons without changes in the
2071 * requested elements, but if it cannot support that it may, at the expense
2072 * of some efficiency, filter out only a subset. For example, if the device
2073 * doesn't support checking for OUIs it should pass up all changes in all
2074 * vendor information elements.
2076 * Note that change, for the sake of simplification, also includes information
2077 * elements appearing or disappearing from the beacon.
2079 * Some hardware supports an "ignore list" instead, just make sure nothing
2080 * that was requested is on the ignore list, and include commonly changing
2081 * information element IDs in the ignore list, for example 11 (BSS load) and
2082 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2083 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2084 * it could also include some currently unused IDs.
2087 * In addition to these capabilities, hardware should support notifying the
2088 * host of changes in the beacon RSSI. This is relevant to implement roaming
2089 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2090 * the received data packets). This can consist in notifying the host when
2091 * the RSSI changes significantly or when it drops below or rises above
2092 * configurable thresholds. In the future these thresholds will also be
2093 * configured by mac80211 (which gets them from userspace) to implement
2094 * them as the roaming algorithm requires.
2096 * If the hardware cannot implement this, the driver should ask it to
2097 * periodically pass beacon frames to the host so that software can do the
2098 * signal strength threshold checking.
2102 * DOC: Spatial multiplexing power save
2104 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2105 * power in an 802.11n implementation. For details on the mechanism
2106 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2107 * "11.2.3 SM power save".
2109 * The mac80211 implementation is capable of sending action frames
2110 * to update the AP about the station's SMPS mode, and will instruct
2111 * the driver to enter the specific mode. It will also announce the
2112 * requested SMPS mode during the association handshake. Hardware
2113 * support for this feature is required, and can be indicated by
2116 * The default mode will be "automatic", which nl80211/cfg80211
2117 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2118 * turned off otherwise.
2120 * To support this feature, the driver must set the appropriate
2121 * hardware support flags, and handle the SMPS flag to the config()
2122 * operation. It will then with this mechanism be instructed to
2123 * enter the requested SMPS mode while associated to an HT AP.
2127 * DOC: Frame filtering
2129 * mac80211 requires to see many management frames for proper
2130 * operation, and users may want to see many more frames when
2131 * in monitor mode. However, for best CPU usage and power consumption,
2132 * having as few frames as possible percolate through the stack is
2133 * desirable. Hence, the hardware should filter as much as possible.
2135 * To achieve this, mac80211 uses filter flags (see below) to tell
2136 * the driver's configure_filter() function which frames should be
2137 * passed to mac80211 and which should be filtered out.
2139 * Before configure_filter() is invoked, the prepare_multicast()
2140 * callback is invoked with the parameters @mc_count and @mc_list
2141 * for the combined multicast address list of all virtual interfaces.
2142 * It's use is optional, and it returns a u64 that is passed to
2143 * configure_filter(). Additionally, configure_filter() has the
2144 * arguments @changed_flags telling which flags were changed and
2145 * @total_flags with the new flag states.
2147 * If your device has no multicast address filters your driver will
2148 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2149 * parameter to see whether multicast frames should be accepted
2152 * All unsupported flags in @total_flags must be cleared.
2153 * Hardware does not support a flag if it is incapable of _passing_
2154 * the frame to the stack. Otherwise the driver must ignore
2155 * the flag, but not clear it.
2156 * You must _only_ clear the flag (announce no support for the
2157 * flag to mac80211) if you are not able to pass the packet type
2158 * to the stack (so the hardware always filters it).
2159 * So for example, you should clear @FIF_CONTROL, if your hardware
2160 * always filters control frames. If your hardware always passes
2161 * control frames to the kernel and is incapable of filtering them,
2162 * you do _not_ clear the @FIF_CONTROL flag.
2163 * This rule applies to all other FIF flags as well.
2167 * DOC: AP support for powersaving clients
2169 * In order to implement AP and P2P GO modes, mac80211 has support for
2170 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2171 * There currently is no support for sAPSD.
2173 * There is one assumption that mac80211 makes, namely that a client
2174 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2175 * Both are supported, and both can be used by the same client, but
2176 * they can't be used concurrently by the same client. This simplifies
2179 * The first thing to keep in mind is that there is a flag for complete
2180 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2181 * mac80211 expects the driver to handle most of the state machine for
2182 * powersaving clients and will ignore the PM bit in incoming frames.
2183 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2184 * stations' powersave transitions. In this mode, mac80211 also doesn't
2185 * handle PS-Poll/uAPSD.
2187 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2188 * PM bit in incoming frames for client powersave transitions. When a
2189 * station goes to sleep, we will stop transmitting to it. There is,
2190 * however, a race condition: a station might go to sleep while there is
2191 * data buffered on hardware queues. If the device has support for this
2192 * it will reject frames, and the driver should give the frames back to
2193 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2194 * cause mac80211 to retry the frame when the station wakes up. The
2195 * driver is also notified of powersave transitions by calling its
2196 * @sta_notify callback.
2198 * When the station is asleep, it has three choices: it can wake up,
2199 * it can PS-Poll, or it can possibly start a uAPSD service period.
2200 * Waking up is implemented by simply transmitting all buffered (and
2201 * filtered) frames to the station. This is the easiest case. When
2202 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2203 * will inform the driver of this with the @allow_buffered_frames
2204 * callback; this callback is optional. mac80211 will then transmit
2205 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2206 * on each frame. The last frame in the service period (or the only
2207 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2208 * indicate that it ends the service period; as this frame must have
2209 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2210 * When TX status is reported for this frame, the service period is
2211 * marked has having ended and a new one can be started by the peer.
2213 * Additionally, non-bufferable MMPDUs can also be transmitted by
2214 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2216 * Another race condition can happen on some devices like iwlwifi
2217 * when there are frames queued for the station and it wakes up
2218 * or polls; the frames that are already queued could end up being
2219 * transmitted first instead, causing reordering and/or wrong
2220 * processing of the EOSP. The cause is that allowing frames to be
2221 * transmitted to a certain station is out-of-band communication to
2222 * the device. To allow this problem to be solved, the driver can
2223 * call ieee80211_sta_block_awake() if frames are buffered when it
2224 * is notified that the station went to sleep. When all these frames
2225 * have been filtered (see above), it must call the function again
2226 * to indicate that the station is no longer blocked.
2228 * If the driver buffers frames in the driver for aggregation in any
2229 * way, it must use the ieee80211_sta_set_buffered() call when it is
2230 * notified of the station going to sleep to inform mac80211 of any
2231 * TIDs that have frames buffered. Note that when a station wakes up
2232 * this information is reset (hence the requirement to call it when
2233 * informed of the station going to sleep). Then, when a service
2234 * period starts for any reason, @release_buffered_frames is called
2235 * with the number of frames to be released and which TIDs they are
2236 * to come from. In this case, the driver is responsible for setting
2237 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2238 * to help the @more_data parameter is passed to tell the driver if
2239 * there is more data on other TIDs -- the TIDs to release frames
2240 * from are ignored since mac80211 doesn't know how many frames the
2241 * buffers for those TIDs contain.
2243 * If the driver also implement GO mode, where absence periods may
2244 * shorten service periods (or abort PS-Poll responses), it must
2245 * filter those response frames except in the case of frames that
2246 * are buffered in the driver -- those must remain buffered to avoid
2247 * reordering. Because it is possible that no frames are released
2248 * in this case, the driver must call ieee80211_sta_eosp()
2249 * to indicate to mac80211 that the service period ended anyway.
2251 * Finally, if frames from multiple TIDs are released from mac80211
2252 * but the driver might reorder them, it must clear & set the flags
2253 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2254 * and also take care of the EOSP and MORE_DATA bits in the frame.
2255 * The driver may also use ieee80211_sta_eosp() in this case.
2257 * Note that if the driver ever buffers frames other than QoS-data
2258 * frames, it must take care to never send a non-QoS-data frame as
2259 * the last frame in a service period, adding a QoS-nulldata frame
2260 * after a non-QoS-data frame if needed.
2264 * DOC: HW queue control
2266 * Before HW queue control was introduced, mac80211 only had a single static
2267 * assignment of per-interface AC software queues to hardware queues. This
2268 * was problematic for a few reasons:
2269 * 1) off-channel transmissions might get stuck behind other frames
2270 * 2) multiple virtual interfaces couldn't be handled correctly
2271 * 3) after-DTIM frames could get stuck behind other frames
2273 * To solve this, hardware typically uses multiple different queues for all
2274 * the different usages, and this needs to be propagated into mac80211 so it
2275 * won't have the same problem with the software queues.
2277 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2278 * flag that tells it that the driver implements its own queue control. To do
2279 * so, the driver will set up the various queues in each &struct ieee80211_vif
2280 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2281 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2282 * if necessary will queue the frame on the right software queue that mirrors
2283 * the hardware queue.
2284 * Additionally, the driver has to then use these HW queue IDs for the queue
2285 * management functions (ieee80211_stop_queue() et al.)
2287 * The driver is free to set up the queue mappings as needed, multiple virtual
2288 * interfaces may map to the same hardware queues if needed. The setup has to
2289 * happen during add_interface or change_interface callbacks. For example, a
2290 * driver supporting station+station and station+AP modes might decide to have
2291 * 10 hardware queues to handle different scenarios:
2293 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2294 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2295 * after-DTIM queue for AP: 8
2296 * off-channel queue: 9
2298 * It would then set up the hardware like this:
2299 * hw.offchannel_tx_hw_queue = 9
2301 * and the first virtual interface that is added as follows:
2302 * vif.hw_queue[IEEE80211_AC_VO] = 0
2303 * vif.hw_queue[IEEE80211_AC_VI] = 1
2304 * vif.hw_queue[IEEE80211_AC_BE] = 2
2305 * vif.hw_queue[IEEE80211_AC_BK] = 3
2306 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2307 * and the second virtual interface with 4-7.
2309 * If queue 6 gets full, for example, mac80211 would only stop the second
2310 * virtual interface's BE queue since virtual interface queues are per AC.
2312 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2313 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2314 * queue could potentially be shared since mac80211 will look at cab_queue when
2315 * a queue is stopped/woken even if the interface is not in AP mode.
2319 * enum ieee80211_filter_flags - hardware filter flags
2321 * These flags determine what the filter in hardware should be
2322 * programmed to let through and what should not be passed to the
2323 * stack. It is always safe to pass more frames than requested,
2324 * but this has negative impact on power consumption.
2326 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2327 * think of the BSS as your network segment and then this corresponds
2328 * to the regular ethernet device promiscuous mode.
2330 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2331 * by the user or if the hardware is not capable of filtering by
2332 * multicast address.
2334 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2335 * %RX_FLAG_FAILED_FCS_CRC for them)
2337 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2338 * the %RX_FLAG_FAILED_PLCP_CRC for them
2340 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2341 * to the hardware that it should not filter beacons or probe responses
2342 * by BSSID. Filtering them can greatly reduce the amount of processing
2343 * mac80211 needs to do and the amount of CPU wakeups, so you should
2344 * honour this flag if possible.
2346 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2347 * is not set then only those addressed to this station.
2349 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2351 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2352 * those addressed to this station.
2354 * @FIF_PROBE_REQ: pass probe request frames
2356 enum ieee80211_filter_flags {
2357 FIF_PROMISC_IN_BSS = 1<<0,
2358 FIF_ALLMULTI = 1<<1,
2360 FIF_PLCPFAIL = 1<<3,
2361 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2363 FIF_OTHER_BSS = 1<<6,
2365 FIF_PROBE_REQ = 1<<8,
2369 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2371 * These flags are used with the ampdu_action() callback in
2372 * &struct ieee80211_ops to indicate which action is needed.
2374 * Note that drivers MUST be able to deal with a TX aggregation
2375 * session being stopped even before they OK'ed starting it by
2376 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2377 * might receive the addBA frame and send a delBA right away!
2379 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2380 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2381 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2382 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2383 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2384 * queued packets, now unaggregated. After all packets are transmitted the
2385 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2386 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2387 * called when the station is removed. There's no need or reason to call
2388 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2389 * session is gone and removes the station.
2390 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2391 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2392 * now the connection is dropped and the station will be removed. Drivers
2393 * should clean up and drop remaining packets when this is called.
2395 enum ieee80211_ampdu_mlme_action {
2396 IEEE80211_AMPDU_RX_START,
2397 IEEE80211_AMPDU_RX_STOP,
2398 IEEE80211_AMPDU_TX_START,
2399 IEEE80211_AMPDU_TX_STOP_CONT,
2400 IEEE80211_AMPDU_TX_STOP_FLUSH,
2401 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2402 IEEE80211_AMPDU_TX_OPERATIONAL,
2406 * enum ieee80211_frame_release_type - frame release reason
2407 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2408 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2409 * frame received on trigger-enabled AC
2411 enum ieee80211_frame_release_type {
2412 IEEE80211_FRAME_RELEASE_PSPOLL,
2413 IEEE80211_FRAME_RELEASE_UAPSD,
2417 * enum ieee80211_rate_control_changed - flags to indicate what changed
2419 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2420 * to this station changed. The actual bandwidth is in the station
2421 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2422 * flag changes, for HT and VHT the bandwidth field changes.
2423 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2424 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2425 * changed (in IBSS mode) due to discovering more information about
2427 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2430 enum ieee80211_rate_control_changed {
2431 IEEE80211_RC_BW_CHANGED = BIT(0),
2432 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2433 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2434 IEEE80211_RC_NSS_CHANGED = BIT(3),
2438 * enum ieee80211_roc_type - remain on channel type
2440 * With the support for multi channel contexts and multi channel operations,
2441 * remain on channel operations might be limited/deferred/aborted by other
2442 * flows/operations which have higher priority (and vise versa).
2443 * Specifying the ROC type can be used by devices to prioritize the ROC
2444 * operations compared to other operations/flows.
2446 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2447 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2448 * for sending managment frames offchannel.
2450 enum ieee80211_roc_type {
2451 IEEE80211_ROC_TYPE_NORMAL = 0,
2452 IEEE80211_ROC_TYPE_MGMT_TX,
2456 * enum ieee80211_reconfig_complete_type - reconfig type
2458 * This enum is used by the reconfig_complete() callback to indicate what
2459 * reconfiguration type was completed.
2461 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2462 * (also due to resume() callback returning 1)
2463 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2464 * of wowlan configuration)
2466 enum ieee80211_reconfig_type {
2467 IEEE80211_RECONFIG_TYPE_RESTART,
2468 IEEE80211_RECONFIG_TYPE_SUSPEND,
2472 * struct ieee80211_ops - callbacks from mac80211 to the driver
2474 * This structure contains various callbacks that the driver may
2475 * handle or, in some cases, must handle, for example to configure
2476 * the hardware to a new channel or to transmit a frame.
2478 * @tx: Handler that 802.11 module calls for each transmitted frame.
2479 * skb contains the buffer starting from the IEEE 802.11 header.
2480 * The low-level driver should send the frame out based on
2481 * configuration in the TX control data. This handler should,
2482 * preferably, never fail and stop queues appropriately.
2485 * @start: Called before the first netdevice attached to the hardware
2486 * is enabled. This should turn on the hardware and must turn on
2487 * frame reception (for possibly enabled monitor interfaces.)
2488 * Returns negative error codes, these may be seen in userspace,
2490 * When the device is started it should not have a MAC address
2491 * to avoid acknowledging frames before a non-monitor device
2493 * Must be implemented and can sleep.
2495 * @stop: Called after last netdevice attached to the hardware
2496 * is disabled. This should turn off the hardware (at least
2497 * it must turn off frame reception.)
2498 * May be called right after add_interface if that rejects
2499 * an interface. If you added any work onto the mac80211 workqueue
2500 * you should ensure to cancel it on this callback.
2501 * Must be implemented and can sleep.
2503 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2504 * stop transmitting and doing any other configuration, and then
2505 * ask the device to suspend. This is only invoked when WoWLAN is
2506 * configured, otherwise the device is deconfigured completely and
2507 * reconfigured at resume time.
2508 * The driver may also impose special conditions under which it
2509 * wants to use the "normal" suspend (deconfigure), say if it only
2510 * supports WoWLAN when the device is associated. In this case, it
2511 * must return 1 from this function.
2513 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2514 * now resuming its operation, after this the device must be fully
2515 * functional again. If this returns an error, the only way out is
2516 * to also unregister the device. If it returns 1, then mac80211
2517 * will also go through the regular complete restart on resume.
2519 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2520 * modified. The reason is that device_set_wakeup_enable() is
2521 * supposed to be called when the configuration changes, not only
2524 * @add_interface: Called when a netdevice attached to the hardware is
2525 * enabled. Because it is not called for monitor mode devices, @start
2526 * and @stop must be implemented.
2527 * The driver should perform any initialization it needs before
2528 * the device can be enabled. The initial configuration for the
2529 * interface is given in the conf parameter.
2530 * The callback may refuse to add an interface by returning a
2531 * negative error code (which will be seen in userspace.)
2532 * Must be implemented and can sleep.
2534 * @change_interface: Called when a netdevice changes type. This callback
2535 * is optional, but only if it is supported can interface types be
2536 * switched while the interface is UP. The callback may sleep.
2537 * Note that while an interface is being switched, it will not be
2538 * found by the interface iteration callbacks.
2540 * @remove_interface: Notifies a driver that an interface is going down.
2541 * The @stop callback is called after this if it is the last interface
2542 * and no monitor interfaces are present.
2543 * When all interfaces are removed, the MAC address in the hardware
2544 * must be cleared so the device no longer acknowledges packets,
2545 * the mac_addr member of the conf structure is, however, set to the
2546 * MAC address of the device going away.
2547 * Hence, this callback must be implemented. It can sleep.
2549 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2550 * function to change hardware configuration, e.g., channel.
2551 * This function should never fail but returns a negative error code
2552 * if it does. The callback can sleep.
2554 * @bss_info_changed: Handler for configuration requests related to BSS
2555 * parameters that may vary during BSS's lifespan, and may affect low
2556 * level driver (e.g. assoc/disassoc status, erp parameters).
2557 * This function should not be used if no BSS has been set, unless
2558 * for association indication. The @changed parameter indicates which
2559 * of the bss parameters has changed when a call is made. The callback
2562 * @prepare_multicast: Prepare for multicast filter configuration.
2563 * This callback is optional, and its return value is passed
2564 * to configure_filter(). This callback must be atomic.
2566 * @configure_filter: Configure the device's RX filter.
2567 * See the section "Frame filtering" for more information.
2568 * This callback must be implemented and can sleep.
2570 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2571 * must be set or cleared for a given STA. Must be atomic.
2573 * @set_key: See the section "Hardware crypto acceleration"
2574 * This callback is only called between add_interface and
2575 * remove_interface calls, i.e. while the given virtual interface
2577 * Returns a negative error code if the key can't be added.
2578 * The callback can sleep.
2580 * @update_tkip_key: See the section "Hardware crypto acceleration"
2581 * This callback will be called in the context of Rx. Called for drivers
2582 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2583 * The callback must be atomic.
2585 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2586 * host is suspended, it can assign this callback to retrieve the data
2587 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2588 * After rekeying was done it should (for example during resume) notify
2589 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2591 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2592 * WEP when the device sends data packets autonomously, e.g. for ARP
2593 * offloading. The index can be 0-3, or -1 for unsetting it.
2595 * @hw_scan: Ask the hardware to service the scan request, no need to start
2596 * the scan state machine in stack. The scan must honour the channel
2597 * configuration done by the regulatory agent in the wiphy's
2598 * registered bands. The hardware (or the driver) needs to make sure
2599 * that power save is disabled.
2600 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2601 * entire IEs after the SSID, so that drivers need not look at these
2602 * at all but just send them after the SSID -- mac80211 includes the
2603 * (extended) supported rates and HT information (where applicable).
2604 * When the scan finishes, ieee80211_scan_completed() must be called;
2605 * note that it also must be called when the scan cannot finish due to
2606 * any error unless this callback returned a negative error code.
2607 * The callback can sleep.
2609 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2610 * The driver should ask the hardware to cancel the scan (if possible),
2611 * but the scan will be completed only after the driver will call
2612 * ieee80211_scan_completed().
2613 * This callback is needed for wowlan, to prevent enqueueing a new
2614 * scan_work after the low-level driver was already suspended.
2615 * The callback can sleep.
2617 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2618 * specific intervals. The driver must call the
2619 * ieee80211_sched_scan_results() function whenever it finds results.
2620 * This process will continue until sched_scan_stop is called.
2622 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2623 * In this case, ieee80211_sched_scan_stopped() must not be called.
2625 * @sw_scan_start: Notifier function that is called just before a software scan
2626 * is started. Can be NULL, if the driver doesn't need this notification.
2627 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2628 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2629 * can use this parameter. The callback can sleep.
2631 * @sw_scan_complete: Notifier function that is called just after a
2632 * software scan finished. Can be NULL, if the driver doesn't need
2633 * this notification.
2634 * The callback can sleep.
2636 * @get_stats: Return low-level statistics.
2637 * Returns zero if statistics are available.
2638 * The callback can sleep.
2640 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2641 * callback should be provided to read the TKIP transmit IVs (both IV32
2642 * and IV16) for the given key from hardware.
2643 * The callback must be atomic.
2645 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2646 * if the device does fragmentation by itself; if this callback is
2647 * implemented then the stack will not do fragmentation.
2648 * The callback can sleep.
2650 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2651 * The callback can sleep.
2653 * @sta_add: Notifies low level driver about addition of an associated station,
2654 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2656 * @sta_remove: Notifies low level driver about removal of an associated
2657 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2658 * returns it isn't safe to use the pointer, not even RCU protected;
2659 * no RCU grace period is guaranteed between returning here and freeing
2660 * the station. See @sta_pre_rcu_remove if needed.
2661 * This callback can sleep.
2663 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2664 * when a station is added to mac80211's station list. This callback
2665 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2666 * conditional. This callback can sleep.
2668 * @sta_remove_debugfs: Remove the debugfs files which were added using
2669 * @sta_add_debugfs. This callback can sleep.
2671 * @sta_notify: Notifies low level driver about power state transition of an
2672 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2673 * in AP mode, this callback will not be called when the flag
2674 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2676 * @sta_state: Notifies low level driver about state transition of a
2677 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2678 * This callback is mutually exclusive with @sta_add/@sta_remove.
2679 * It must not fail for down transitions but may fail for transitions
2680 * up the list of states. Also note that after the callback returns it
2681 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2682 * period is guaranteed between returning here and freeing the station.
2683 * See @sta_pre_rcu_remove if needed.
2684 * The callback can sleep.
2686 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2687 * synchronisation. This is useful if a driver needs to have station
2688 * pointers protected using RCU, it can then use this call to clear
2689 * the pointers instead of waiting for an RCU grace period to elapse
2691 * The callback can sleep.
2693 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2694 * used to transmit to the station. The changes are advertised with bits
2695 * from &enum ieee80211_rate_control_changed and the values are reflected
2696 * in the station data. This callback should only be used when the driver
2697 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2698 * otherwise the rate control algorithm is notified directly.
2700 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2701 * is only used if the configured rate control algorithm actually uses
2702 * the new rate table API, and is therefore optional. Must be atomic.
2704 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2705 * bursting) for a hardware TX queue.
2706 * Returns a negative error code on failure.
2707 * The callback can sleep.
2709 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2710 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2711 * required function.
2712 * The callback can sleep.
2714 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2715 * Currently, this is only used for IBSS mode debugging. Is not a
2716 * required function.
2717 * The callback can sleep.
2719 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2720 * with other STAs in the IBSS. This is only used in IBSS mode. This
2721 * function is optional if the firmware/hardware takes full care of
2722 * TSF synchronization.
2723 * The callback can sleep.
2725 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2726 * This is needed only for IBSS mode and the result of this function is
2727 * used to determine whether to reply to Probe Requests.
2728 * Returns non-zero if this device sent the last beacon.
2729 * The callback can sleep.
2731 * @ampdu_action: Perform a certain A-MPDU action
2732 * The RA/TID combination determines the destination and TID we want
2733 * the ampdu action to be performed for. The action is defined through
2734 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2735 * is the first frame we expect to perform the action on. Notice
2736 * that TX/RX_STOP can pass NULL for this parameter.
2737 * The @buf_size parameter is only valid when the action is set to
2738 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2739 * buffer size (number of subframes) for this session -- the driver
2740 * may neither send aggregates containing more subframes than this
2741 * nor send aggregates in a way that lost frames would exceed the
2742 * buffer size. If just limiting the aggregate size, this would be
2743 * possible with a buf_size of 8:
2745 * - RX: 2....7 (lost frame #1)
2747 * which is invalid since #1 was now re-transmitted well past the
2748 * buffer size of 8. Correct ways to retransmit #1 would be:
2749 * - TX: 1 or 18 or 81
2750 * Even "189" would be wrong since 1 could be lost again.
2752 * Returns a negative error code on failure.
2753 * The callback can sleep.
2755 * @get_survey: Return per-channel survey information
2757 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2758 * need to set wiphy->rfkill_poll to %true before registration,
2759 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2760 * The callback can sleep.
2762 * @set_coverage_class: Set slot time for given coverage class as specified
2763 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2764 * accordingly; coverage class equals to -1 to enable ACK timeout
2765 * estimation algorithm (dynack). To disable dynack set valid value for
2766 * coverage class. This callback is not required and may sleep.
2768 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2769 * be %NULL. The callback can sleep.
2770 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2772 * @flush: Flush all pending frames from the hardware queue, making sure
2773 * that the hardware queues are empty. The @queues parameter is a bitmap
2774 * of queues to flush, which is useful if different virtual interfaces
2775 * use different hardware queues; it may also indicate all queues.
2776 * If the parameter @drop is set to %true, pending frames may be dropped.
2777 * Note that vif can be NULL.
2778 * The callback can sleep.
2780 * @channel_switch: Drivers that need (or want) to offload the channel
2781 * switch operation for CSAs received from the AP may implement this
2782 * callback. They must then call ieee80211_chswitch_done() to indicate
2783 * completion of the channel switch.
2785 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2786 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2787 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2788 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2790 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2792 * @remain_on_channel: Starts an off-channel period on the given channel, must
2793 * call back to ieee80211_ready_on_channel() when on that channel. Note
2794 * that normal channel traffic is not stopped as this is intended for hw
2795 * offload. Frames to transmit on the off-channel channel are transmitted
2796 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2797 * duration (which will always be non-zero) expires, the driver must call
2798 * ieee80211_remain_on_channel_expired().
2799 * Note that this callback may be called while the device is in IDLE and
2800 * must be accepted in this case.
2801 * This callback may sleep.
2802 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2803 * aborted before it expires. This callback may sleep.
2805 * @set_ringparam: Set tx and rx ring sizes.
2807 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2809 * @tx_frames_pending: Check if there is any pending frame in the hardware
2810 * queues before entering power save.
2812 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2813 * when transmitting a frame. Currently only legacy rates are handled.
2814 * The callback can sleep.
2815 * @rssi_callback: Notify driver when the average RSSI goes above/below
2816 * thresholds that were registered previously. The callback can sleep.
2818 * @release_buffered_frames: Release buffered frames according to the given
2819 * parameters. In the case where the driver buffers some frames for
2820 * sleeping stations mac80211 will use this callback to tell the driver
2821 * to release some frames, either for PS-poll or uAPSD.
2822 * Note that if the @more_data parameter is %false the driver must check
2823 * if there are more frames on the given TIDs, and if there are more than
2824 * the frames being released then it must still set the more-data bit in
2825 * the frame. If the @more_data parameter is %true, then of course the
2826 * more-data bit must always be set.
2827 * The @tids parameter tells the driver which TIDs to release frames
2828 * from, for PS-poll it will always have only a single bit set.
2829 * In the case this is used for a PS-poll initiated release, the
2830 * @num_frames parameter will always be 1 so code can be shared. In
2831 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2832 * on the TX status (and must report TX status) so that the PS-poll
2833 * period is properly ended. This is used to avoid sending multiple
2834 * responses for a retried PS-poll frame.
2835 * In the case this is used for uAPSD, the @num_frames parameter may be
2836 * bigger than one, but the driver may send fewer frames (it must send
2837 * at least one, however). In this case it is also responsible for
2838 * setting the EOSP flag in the QoS header of the frames. Also, when the
2839 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2840 * on the last frame in the SP. Alternatively, it may call the function
2841 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2842 * This callback must be atomic.
2843 * @allow_buffered_frames: Prepare device to allow the given number of frames
2844 * to go out to the given station. The frames will be sent by mac80211
2845 * via the usual TX path after this call. The TX information for frames
2846 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2847 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2848 * frames from multiple TIDs are released and the driver might reorder
2849 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2850 * on the last frame and clear it on all others and also handle the EOSP
2851 * bit in the QoS header correctly. Alternatively, it can also call the
2852 * ieee80211_sta_eosp() function.
2853 * The @tids parameter is a bitmap and tells the driver which TIDs the
2854 * frames will be on; it will at most have two bits set.
2855 * This callback must be atomic.
2857 * @get_et_sset_count: Ethtool API to get string-set count.
2859 * @get_et_stats: Ethtool API to get a set of u64 stats.
2861 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2862 * and perhaps other supported types of ethtool data-sets.
2864 * @get_rssi: Get current signal strength in dBm, the function is optional
2867 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2868 * before associated. In multi-channel scenarios, a virtual interface is
2869 * bound to a channel before it is associated, but as it isn't associated
2870 * yet it need not necessarily be given airtime, in particular since any
2871 * transmission to a P2P GO needs to be synchronized against the GO's
2872 * powersave state. mac80211 will call this function before transmitting a
2873 * management frame prior to having successfully associated to allow the
2874 * driver to give it channel time for the transmission, to get a response
2875 * and to be able to synchronize with the GO.
2876 * The callback will be called before each transmission and upon return
2877 * mac80211 will transmit the frame right away.
2878 * The callback is optional and can (should!) sleep.
2880 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2881 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2882 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2883 * setup-response is a direct packet not buffered by the AP.
2884 * mac80211 will call this function just before the transmission of a TDLS
2885 * discovery-request. The recommended period of protection is at least
2886 * 2 * (DTIM period).
2887 * The callback is optional and can sleep.
2889 * @add_chanctx: Notifies device driver about new channel context creation.
2890 * @remove_chanctx: Notifies device driver about channel context destruction.
2891 * @change_chanctx: Notifies device driver about channel context changes that
2892 * may happen when combining different virtual interfaces on the same
2893 * channel context with different settings
2894 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2895 * to vif. Possible use is for hw queue remapping.
2896 * @unassign_vif_chanctx: Notifies device driver about channel context being
2898 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2899 * another, as specified in the list of
2900 * @ieee80211_vif_chanctx_switch passed to the driver, according
2901 * to the mode defined in &ieee80211_chanctx_switch_mode.
2903 * @start_ap: Start operation on the AP interface, this is called after all the
2904 * information in bss_conf is set and beacon can be retrieved. A channel
2905 * context is bound before this is called. Note that if the driver uses
2906 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2907 * just "paused" for scanning/ROC, which is indicated by the beacon being
2908 * disabled/enabled via @bss_info_changed.
2909 * @stop_ap: Stop operation on the AP interface.
2911 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
2912 * during resume, when the reconfiguration has completed.
2913 * This can help the driver implement the reconfiguration step (and
2914 * indicate mac80211 is ready to receive frames).
2915 * This callback may sleep.
2917 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2918 * Currently, this is only called for managed or P2P client interfaces.
2919 * This callback is optional; it must not sleep.
2921 * @channel_switch_beacon: Starts a channel switch to a new channel.
2922 * Beacons are modified to include CSA or ECSA IEs before calling this
2923 * function. The corresponding count fields in these IEs must be
2924 * decremented, and when they reach 1 the driver must call
2925 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2926 * get the csa counter decremented by mac80211, but must check if it is
2927 * 1 using ieee80211_csa_is_complete() after the beacon has been
2928 * transmitted and then call ieee80211_csa_finish().
2929 * If the CSA count starts as zero or 1, this function will not be called,
2930 * since there won't be any time to beacon before the switch anyway.
2931 * @pre_channel_switch: This is an optional callback that is called
2932 * before a channel switch procedure is started (ie. when a STA
2933 * gets a CSA or an userspace initiated channel-switch), allowing
2934 * the driver to prepare for the channel switch.
2935 * @post_channel_switch: This is an optional callback that is called
2936 * after a channel switch procedure is completed, allowing the
2937 * driver to go back to a normal configuration.
2939 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2940 * information in bss_conf is set up and the beacon can be retrieved. A
2941 * channel context is bound before this is called.
2942 * @leave_ibss: Leave the IBSS again.
2944 * @get_expected_throughput: extract the expected throughput towards the
2945 * specified station. The returned value is expressed in Kbps. It returns 0
2946 * if the RC algorithm does not have proper data to provide.
2948 * @get_txpower: get current maximum tx power (in dBm) based on configuration
2949 * and hardware limits.
2951 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2952 * is responsible for continually initiating channel-switching operations
2953 * and returning to the base channel for communication with the AP. The
2954 * driver receives a channel-switch request template and the location of
2955 * the switch-timing IE within the template as part of the invocation.
2956 * The template is valid only within the call, and the driver can
2957 * optionally copy the skb for further re-use.
2958 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2959 * peers must be on the base channel when the call completes.
2960 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
2961 * response) has been received from a remote peer. The driver gets
2962 * parameters parsed from the incoming frame and may use them to continue
2963 * an ongoing channel-switch operation. In addition, a channel-switch
2964 * response template is provided, together with the location of the
2965 * switch-timing IE within the template. The skb can only be used within
2966 * the function call.
2968 struct ieee80211_ops {
2969 void (*tx)(struct ieee80211_hw *hw,
2970 struct ieee80211_tx_control *control,
2971 struct sk_buff *skb);
2972 int (*start)(struct ieee80211_hw *hw);
2973 void (*stop)(struct ieee80211_hw *hw);
2975 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2976 int (*resume)(struct ieee80211_hw *hw);
2977 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2979 int (*add_interface)(struct ieee80211_hw *hw,
2980 struct ieee80211_vif *vif);
2981 int (*change_interface)(struct ieee80211_hw *hw,
2982 struct ieee80211_vif *vif,
2983 enum nl80211_iftype new_type, bool p2p);
2984 void (*remove_interface)(struct ieee80211_hw *hw,
2985 struct ieee80211_vif *vif);
2986 int (*config)(struct ieee80211_hw *hw, u32 changed);
2987 void (*bss_info_changed)(struct ieee80211_hw *hw,
2988 struct ieee80211_vif *vif,
2989 struct ieee80211_bss_conf *info,
2992 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2993 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2995 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2996 struct netdev_hw_addr_list *mc_list);
2997 void (*configure_filter)(struct ieee80211_hw *hw,
2998 unsigned int changed_flags,
2999 unsigned int *total_flags,
3001 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3003 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3004 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3005 struct ieee80211_key_conf *key);
3006 void (*update_tkip_key)(struct ieee80211_hw *hw,
3007 struct ieee80211_vif *vif,
3008 struct ieee80211_key_conf *conf,
3009 struct ieee80211_sta *sta,
3010 u32 iv32, u16 *phase1key);
3011 void (*set_rekey_data)(struct ieee80211_hw *hw,
3012 struct ieee80211_vif *vif,
3013 struct cfg80211_gtk_rekey_data *data);
3014 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3015 struct ieee80211_vif *vif, int idx);
3016 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3017 struct ieee80211_scan_request *req);
3018 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3019 struct ieee80211_vif *vif);
3020 int (*sched_scan_start)(struct ieee80211_hw *hw,
3021 struct ieee80211_vif *vif,
3022 struct cfg80211_sched_scan_request *req,
3023 struct ieee80211_scan_ies *ies);
3024 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3025 struct ieee80211_vif *vif);
3026 void (*sw_scan_start)(struct ieee80211_hw *hw,
3027 struct ieee80211_vif *vif,
3028 const u8 *mac_addr);
3029 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3030 struct ieee80211_vif *vif);
3031 int (*get_stats)(struct ieee80211_hw *hw,
3032 struct ieee80211_low_level_stats *stats);
3033 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
3034 u32 *iv32, u16 *iv16);
3035 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3036 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3037 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3038 struct ieee80211_sta *sta);
3039 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3040 struct ieee80211_sta *sta);
3041 #ifdef CONFIG_MAC80211_DEBUGFS
3042 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3043 struct ieee80211_vif *vif,
3044 struct ieee80211_sta *sta,
3045 struct dentry *dir);
3046 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3047 struct ieee80211_vif *vif,
3048 struct ieee80211_sta *sta,
3049 struct dentry *dir);
3051 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3052 enum sta_notify_cmd, struct ieee80211_sta *sta);
3053 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3054 struct ieee80211_sta *sta,
3055 enum ieee80211_sta_state old_state,
3056 enum ieee80211_sta_state new_state);
3057 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3058 struct ieee80211_vif *vif,
3059 struct ieee80211_sta *sta);
3060 void (*sta_rc_update)(struct ieee80211_hw *hw,
3061 struct ieee80211_vif *vif,
3062 struct ieee80211_sta *sta,
3064 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3065 struct ieee80211_vif *vif,
3066 struct ieee80211_sta *sta);
3067 int (*conf_tx)(struct ieee80211_hw *hw,
3068 struct ieee80211_vif *vif, u16 ac,
3069 const struct ieee80211_tx_queue_params *params);
3070 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3071 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3073 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3074 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3075 int (*ampdu_action)(struct ieee80211_hw *hw,
3076 struct ieee80211_vif *vif,
3077 enum ieee80211_ampdu_mlme_action action,
3078 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3080 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3081 struct survey_info *survey);
3082 void (*rfkill_poll)(struct ieee80211_hw *hw);
3083 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3084 #ifdef CONFIG_NL80211_TESTMODE
3085 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3086 void *data, int len);
3087 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3088 struct netlink_callback *cb,
3089 void *data, int len);
3091 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3092 u32 queues, bool drop);
3093 void (*channel_switch)(struct ieee80211_hw *hw,
3094 struct ieee80211_vif *vif,
3095 struct ieee80211_channel_switch *ch_switch);
3096 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3097 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3099 int (*remain_on_channel)(struct ieee80211_hw *hw,
3100 struct ieee80211_vif *vif,
3101 struct ieee80211_channel *chan,
3103 enum ieee80211_roc_type type);
3104 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3105 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3106 void (*get_ringparam)(struct ieee80211_hw *hw,
3107 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3108 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3109 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3110 const struct cfg80211_bitrate_mask *mask);
3111 void (*rssi_callback)(struct ieee80211_hw *hw,
3112 struct ieee80211_vif *vif,
3113 enum ieee80211_rssi_event rssi_event);
3115 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3116 struct ieee80211_sta *sta,
3117 u16 tids, int num_frames,
3118 enum ieee80211_frame_release_type reason,
3120 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3121 struct ieee80211_sta *sta,
3122 u16 tids, int num_frames,
3123 enum ieee80211_frame_release_type reason,
3126 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3127 struct ieee80211_vif *vif, int sset);
3128 void (*get_et_stats)(struct ieee80211_hw *hw,
3129 struct ieee80211_vif *vif,
3130 struct ethtool_stats *stats, u64 *data);
3131 void (*get_et_strings)(struct ieee80211_hw *hw,
3132 struct ieee80211_vif *vif,
3133 u32 sset, u8 *data);
3134 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3135 struct ieee80211_sta *sta, s8 *rssi_dbm);
3137 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3138 struct ieee80211_vif *vif);
3140 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3141 struct ieee80211_vif *vif);
3143 int (*add_chanctx)(struct ieee80211_hw *hw,
3144 struct ieee80211_chanctx_conf *ctx);
3145 void (*remove_chanctx)(struct ieee80211_hw *hw,
3146 struct ieee80211_chanctx_conf *ctx);
3147 void (*change_chanctx)(struct ieee80211_hw *hw,
3148 struct ieee80211_chanctx_conf *ctx,
3150 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3151 struct ieee80211_vif *vif,
3152 struct ieee80211_chanctx_conf *ctx);
3153 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3154 struct ieee80211_vif *vif,
3155 struct ieee80211_chanctx_conf *ctx);
3156 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3157 struct ieee80211_vif_chanctx_switch *vifs,
3159 enum ieee80211_chanctx_switch_mode mode);
3161 void (*reconfig_complete)(struct ieee80211_hw *hw,
3162 enum ieee80211_reconfig_type reconfig_type);
3164 #if IS_ENABLED(CONFIG_IPV6)
3165 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3166 struct ieee80211_vif *vif,
3167 struct inet6_dev *idev);
3169 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3170 struct ieee80211_vif *vif,
3171 struct cfg80211_chan_def *chandef);
3172 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3173 struct ieee80211_vif *vif,
3174 struct ieee80211_channel_switch *ch_switch);
3176 int (*post_channel_switch)(struct ieee80211_hw *hw,
3177 struct ieee80211_vif *vif);
3179 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3180 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3181 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3182 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3185 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3186 struct ieee80211_vif *vif,
3187 struct ieee80211_sta *sta, u8 oper_class,
3188 struct cfg80211_chan_def *chandef,
3189 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3190 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3191 struct ieee80211_vif *vif,
3192 struct ieee80211_sta *sta);
3193 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3194 struct ieee80211_vif *vif,
3195 struct ieee80211_tdls_ch_sw_params *params);
3199 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3201 * This must be called once for each hardware device. The returned pointer
3202 * must be used to refer to this device when calling other functions.
3203 * mac80211 allocates a private data area for the driver pointed to by
3204 * @priv in &struct ieee80211_hw, the size of this area is given as
3207 * @priv_data_len: length of private data
3208 * @ops: callbacks for this device
3209 * @requested_name: Requested name for this device.
3210 * NULL is valid value, and means use the default naming (phy%d)
3212 * Return: A pointer to the new hardware device, or %NULL on error.
3214 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3215 const struct ieee80211_ops *ops,
3216 const char *requested_name);
3219 * ieee80211_alloc_hw - Allocate a new hardware device
3221 * This must be called once for each hardware device. The returned pointer
3222 * must be used to refer to this device when calling other functions.
3223 * mac80211 allocates a private data area for the driver pointed to by
3224 * @priv in &struct ieee80211_hw, the size of this area is given as
3227 * @priv_data_len: length of private data
3228 * @ops: callbacks for this device
3230 * Return: A pointer to the new hardware device, or %NULL on error.
3233 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3234 const struct ieee80211_ops *ops)
3236 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3240 * ieee80211_register_hw - Register hardware device
3242 * You must call this function before any other functions in
3243 * mac80211. Note that before a hardware can be registered, you
3244 * need to fill the contained wiphy's information.
3246 * @hw: the device to register as returned by ieee80211_alloc_hw()
3248 * Return: 0 on success. An error code otherwise.
3250 int ieee80211_register_hw(struct ieee80211_hw *hw);
3253 * struct ieee80211_tpt_blink - throughput blink description
3254 * @throughput: throughput in Kbit/sec
3255 * @blink_time: blink time in milliseconds
3256 * (full cycle, ie. one off + one on period)
3258 struct ieee80211_tpt_blink {
3264 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3265 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3266 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3267 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3268 * interface is connected in some way, including being an AP
3270 enum ieee80211_tpt_led_trigger_flags {
3271 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3272 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3273 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3276 #ifdef CONFIG_MAC80211_LEDS
3277 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3278 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3279 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3280 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3281 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3283 const struct ieee80211_tpt_blink *blink_table,
3284 unsigned int blink_table_len);
3287 * ieee80211_get_tx_led_name - get name of TX LED
3289 * mac80211 creates a transmit LED trigger for each wireless hardware
3290 * that can be used to drive LEDs if your driver registers a LED device.
3291 * This function returns the name (or %NULL if not configured for LEDs)
3292 * of the trigger so you can automatically link the LED device.
3294 * @hw: the hardware to get the LED trigger name for
3296 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3298 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3300 #ifdef CONFIG_MAC80211_LEDS
3301 return __ieee80211_get_tx_led_name(hw);
3308 * ieee80211_get_rx_led_name - get name of RX LED
3310 * mac80211 creates a receive LED trigger for each wireless hardware
3311 * that can be used to drive LEDs if your driver registers a LED device.
3312 * This function returns the name (or %NULL if not configured for LEDs)
3313 * of the trigger so you can automatically link the LED device.
3315 * @hw: the hardware to get the LED trigger name for
3317 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3319 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3321 #ifdef CONFIG_MAC80211_LEDS
3322 return __ieee80211_get_rx_led_name(hw);
3329 * ieee80211_get_assoc_led_name - get name of association LED
3331 * mac80211 creates a association LED trigger for each wireless hardware
3332 * that can be used to drive LEDs if your driver registers a LED device.
3333 * This function returns the name (or %NULL if not configured for LEDs)
3334 * of the trigger so you can automatically link the LED device.
3336 * @hw: the hardware to get the LED trigger name for
3338 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3340 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3342 #ifdef CONFIG_MAC80211_LEDS
3343 return __ieee80211_get_assoc_led_name(hw);
3350 * ieee80211_get_radio_led_name - get name of radio LED
3352 * mac80211 creates a radio change LED trigger for each wireless hardware
3353 * that can be used to drive LEDs if your driver registers a LED device.
3354 * This function returns the name (or %NULL if not configured for LEDs)
3355 * of the trigger so you can automatically link the LED device.
3357 * @hw: the hardware to get the LED trigger name for
3359 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3361 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3363 #ifdef CONFIG_MAC80211_LEDS
3364 return __ieee80211_get_radio_led_name(hw);
3371 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3372 * @hw: the hardware to create the trigger for
3373 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3374 * @blink_table: the blink table -- needs to be ordered by throughput
3375 * @blink_table_len: size of the blink table
3377 * Return: %NULL (in case of error, or if no LED triggers are
3378 * configured) or the name of the new trigger.
3380 * Note: This function must be called before ieee80211_register_hw().
3382 static inline char *
3383 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3384 const struct ieee80211_tpt_blink *blink_table,
3385 unsigned int blink_table_len)
3387 #ifdef CONFIG_MAC80211_LEDS
3388 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3396 * ieee80211_unregister_hw - Unregister a hardware device
3398 * This function instructs mac80211 to free allocated resources
3399 * and unregister netdevices from the networking subsystem.
3401 * @hw: the hardware to unregister
3403 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3406 * ieee80211_free_hw - free hardware descriptor
3408 * This function frees everything that was allocated, including the
3409 * private data for the driver. You must call ieee80211_unregister_hw()
3410 * before calling this function.
3412 * @hw: the hardware to free
3414 void ieee80211_free_hw(struct ieee80211_hw *hw);
3417 * ieee80211_restart_hw - restart hardware completely
3419 * Call this function when the hardware was restarted for some reason
3420 * (hardware error, ...) and the driver is unable to restore its state
3421 * by itself. mac80211 assumes that at this point the driver/hardware
3422 * is completely uninitialised and stopped, it starts the process by
3423 * calling the ->start() operation. The driver will need to reset all
3424 * internal state that it has prior to calling this function.
3426 * @hw: the hardware to restart
3428 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3431 * ieee80211_napi_add - initialize mac80211 NAPI context
3432 * @hw: the hardware to initialize the NAPI context on
3433 * @napi: the NAPI context to initialize
3434 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3435 * driver doesn't use NAPI
3436 * @poll: poll function
3437 * @weight: default weight
3439 * See also netif_napi_add().
3441 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3442 struct net_device *napi_dev,
3443 int (*poll)(struct napi_struct *, int),
3447 * ieee80211_rx - receive frame
3449 * Use this function to hand received frames to mac80211. The receive
3450 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3451 * paged @skb is used, the driver is recommended to put the ieee80211
3452 * header of the frame on the linear part of the @skb to avoid memory
3453 * allocation and/or memcpy by the stack.
3455 * This function may not be called in IRQ context. Calls to this function
3456 * for a single hardware must be synchronized against each other. Calls to
3457 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3458 * mixed for a single hardware. Must not run concurrently with
3459 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3461 * In process context use instead ieee80211_rx_ni().
3463 * @hw: the hardware this frame came in on
3464 * @skb: the buffer to receive, owned by mac80211 after this call
3466 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3469 * ieee80211_rx_irqsafe - receive frame
3471 * Like ieee80211_rx() but can be called in IRQ context
3472 * (internally defers to a tasklet.)
3474 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3475 * be mixed for a single hardware.Must not run concurrently with
3476 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3478 * @hw: the hardware this frame came in on
3479 * @skb: the buffer to receive, owned by mac80211 after this call
3481 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3484 * ieee80211_rx_ni - receive frame (in process context)
3486 * Like ieee80211_rx() but can be called in process context
3487 * (internally disables bottom halves).
3489 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3490 * not be mixed for a single hardware. Must not run concurrently with
3491 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3493 * @hw: the hardware this frame came in on
3494 * @skb: the buffer to receive, owned by mac80211 after this call
3496 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3497 struct sk_buff *skb)
3500 ieee80211_rx(hw, skb);
3505 * ieee80211_sta_ps_transition - PS transition for connected sta
3507 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3508 * flag set, use this function to inform mac80211 about a connected station
3509 * entering/leaving PS mode.
3511 * This function may not be called in IRQ context or with softirqs enabled.
3513 * Calls to this function for a single hardware must be synchronized against
3516 * @sta: currently connected sta
3517 * @start: start or stop PS
3519 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3521 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3524 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3525 * (in process context)
3527 * Like ieee80211_sta_ps_transition() but can be called in process context
3528 * (internally disables bottom halves). Concurrent call restriction still
3531 * @sta: currently connected sta
3532 * @start: start or stop PS
3534 * Return: Like ieee80211_sta_ps_transition().
3536 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3542 ret = ieee80211_sta_ps_transition(sta, start);
3549 * The TX headroom reserved by mac80211 for its own tx_status functions.
3550 * This is enough for the radiotap header.
3552 #define IEEE80211_TX_STATUS_HEADROOM 14
3555 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3556 * @sta: &struct ieee80211_sta pointer for the sleeping station
3557 * @tid: the TID that has buffered frames
3558 * @buffered: indicates whether or not frames are buffered for this TID
3560 * If a driver buffers frames for a powersave station instead of passing
3561 * them back to mac80211 for retransmission, the station may still need
3562 * to be told that there are buffered frames via the TIM bit.
3564 * This function informs mac80211 whether or not there are frames that are
3565 * buffered in the driver for a given TID; mac80211 can then use this data
3566 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3567 * call! Beware of the locking!)
3569 * If all frames are released to the station (due to PS-poll or uAPSD)
3570 * then the driver needs to inform mac80211 that there no longer are
3571 * frames buffered. However, when the station wakes up mac80211 assumes
3572 * that all buffered frames will be transmitted and clears this data,
3573 * drivers need to make sure they inform mac80211 about all buffered
3574 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3576 * Note that technically mac80211 only needs to know this per AC, not per
3577 * TID, but since driver buffering will inevitably happen per TID (since
3578 * it is related to aggregation) it is easier to make mac80211 map the
3579 * TID to the AC as required instead of keeping track in all drivers that
3582 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3583 u8 tid, bool buffered);
3586 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3588 * Call this function in a driver with per-packet rate selection support
3589 * to combine the rate info in the packet tx info with the most recent
3590 * rate selection table for the station entry.
3592 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3593 * @sta: the receiver station to which this packet is sent.
3594 * @skb: the frame to be transmitted.
3595 * @dest: buffer for extracted rate/retry information
3596 * @max_rates: maximum number of rates to fetch
3598 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3599 struct ieee80211_sta *sta,
3600 struct sk_buff *skb,
3601 struct ieee80211_tx_rate *dest,
3605 * ieee80211_tx_status - transmit status callback
3607 * Call this function for all transmitted frames after they have been
3608 * transmitted. It is permissible to not call this function for
3609 * multicast frames but this can affect statistics.
3611 * This function may not be called in IRQ context. Calls to this function
3612 * for a single hardware must be synchronized against each other. Calls
3613 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3614 * may not be mixed for a single hardware. Must not run concurrently with
3615 * ieee80211_rx() or ieee80211_rx_ni().
3617 * @hw: the hardware the frame was transmitted by
3618 * @skb: the frame that was transmitted, owned by mac80211 after this call
3620 void ieee80211_tx_status(struct ieee80211_hw *hw,
3621 struct sk_buff *skb);
3624 * ieee80211_tx_status_noskb - transmit status callback without skb
3626 * This function can be used as a replacement for ieee80211_tx_status
3627 * in drivers that cannot reliably map tx status information back to
3630 * Calls to this function for a single hardware must be synchronized
3631 * against each other. Calls to this function, ieee80211_tx_status_ni()
3632 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3634 * @hw: the hardware the frame was transmitted by
3635 * @sta: the receiver station to which this packet is sent
3636 * (NULL for multicast packets)
3637 * @info: tx status information
3639 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3640 struct ieee80211_sta *sta,
3641 struct ieee80211_tx_info *info);
3644 * ieee80211_tx_status_ni - transmit status callback (in process context)
3646 * Like ieee80211_tx_status() but can be called in process context.
3648 * Calls to this function, ieee80211_tx_status() and
3649 * ieee80211_tx_status_irqsafe() may not be mixed
3650 * for a single hardware.
3652 * @hw: the hardware the frame was transmitted by
3653 * @skb: the frame that was transmitted, owned by mac80211 after this call
3655 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3656 struct sk_buff *skb)
3659 ieee80211_tx_status(hw, skb);
3664 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3666 * Like ieee80211_tx_status() but can be called in IRQ context
3667 * (internally defers to a tasklet.)
3669 * Calls to this function, ieee80211_tx_status() and
3670 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3672 * @hw: the hardware the frame was transmitted by
3673 * @skb: the frame that was transmitted, owned by mac80211 after this call
3675 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3676 struct sk_buff *skb);
3679 * ieee80211_report_low_ack - report non-responding station
3681 * When operating in AP-mode, call this function to report a non-responding
3684 * @sta: the non-responding connected sta
3685 * @num_packets: number of packets sent to @sta without a response
3687 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3689 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3692 * struct ieee80211_mutable_offsets - mutable beacon offsets
3693 * @tim_offset: position of TIM element
3694 * @tim_length: size of TIM element
3695 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3696 * to CSA counters. This array can contain zero values which
3697 * should be ignored.
3699 struct ieee80211_mutable_offsets {
3703 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3707 * ieee80211_beacon_get_template - beacon template generation function
3708 * @hw: pointer obtained from ieee80211_alloc_hw().
3709 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3710 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3711 * receive the offsets that may be updated by the driver.
3713 * If the driver implements beaconing modes, it must use this function to
3714 * obtain the beacon template.
3716 * This function should be used if the beacon frames are generated by the
3717 * device, and then the driver must use the returned beacon as the template
3718 * The driver or the device are responsible to update the DTIM and, when
3719 * applicable, the CSA count.
3721 * The driver is responsible for freeing the returned skb.
3723 * Return: The beacon template. %NULL on error.
3726 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3727 struct ieee80211_vif *vif,
3728 struct ieee80211_mutable_offsets *offs);
3731 * ieee80211_beacon_get_tim - beacon generation function
3732 * @hw: pointer obtained from ieee80211_alloc_hw().
3733 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3734 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3735 * Set to 0 if invalid (in non-AP modes).
3736 * @tim_length: pointer to variable that will receive the TIM IE length,
3737 * (including the ID and length bytes!).
3738 * Set to 0 if invalid (in non-AP modes).
3740 * If the driver implements beaconing modes, it must use this function to
3741 * obtain the beacon frame.
3743 * If the beacon frames are generated by the host system (i.e., not in
3744 * hardware/firmware), the driver uses this function to get each beacon
3745 * frame from mac80211 -- it is responsible for calling this function exactly
3746 * once before the beacon is needed (e.g. based on hardware interrupt).
3748 * The driver is responsible for freeing the returned skb.
3750 * Return: The beacon template. %NULL on error.
3752 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3753 struct ieee80211_vif *vif,
3754 u16 *tim_offset, u16 *tim_length);
3757 * ieee80211_beacon_get - beacon generation function
3758 * @hw: pointer obtained from ieee80211_alloc_hw().
3759 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3761 * See ieee80211_beacon_get_tim().
3763 * Return: See ieee80211_beacon_get_tim().
3765 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3766 struct ieee80211_vif *vif)
3768 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3772 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3773 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3775 * The csa counter should be updated after each beacon transmission.
3776 * This function is called implicitly when
3777 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3778 * beacon frames are generated by the device, the driver should call this
3779 * function after each beacon transmission to sync mac80211's csa counters.
3781 * Return: new csa counter value
3783 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3786 * ieee80211_csa_finish - notify mac80211 about channel switch
3787 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3789 * After a channel switch announcement was scheduled and the counter in this
3790 * announcement hits 1, this function must be called by the driver to
3791 * notify mac80211 that the channel can be changed.
3793 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3796 * ieee80211_csa_is_complete - find out if counters reached 1
3797 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3799 * This function returns whether the channel switch counters reached zero.
3801 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3805 * ieee80211_proberesp_get - retrieve a Probe Response template
3806 * @hw: pointer obtained from ieee80211_alloc_hw().
3807 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3809 * Creates a Probe Response template which can, for example, be uploaded to
3810 * hardware. The destination address should be set by the caller.
3812 * Can only be called in AP mode.
3814 * Return: The Probe Response template. %NULL on error.
3816 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3817 struct ieee80211_vif *vif);
3820 * ieee80211_pspoll_get - retrieve a PS Poll template
3821 * @hw: pointer obtained from ieee80211_alloc_hw().
3822 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3824 * Creates a PS Poll a template which can, for example, uploaded to
3825 * hardware. The template must be updated after association so that correct
3826 * AID, BSSID and MAC address is used.
3828 * Note: Caller (or hardware) is responsible for setting the
3829 * &IEEE80211_FCTL_PM bit.
3831 * Return: The PS Poll template. %NULL on error.
3833 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3834 struct ieee80211_vif *vif);
3837 * ieee80211_nullfunc_get - retrieve a nullfunc template
3838 * @hw: pointer obtained from ieee80211_alloc_hw().
3839 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3841 * Creates a Nullfunc template which can, for example, uploaded to
3842 * hardware. The template must be updated after association so that correct
3843 * BSSID and address is used.
3845 * Note: Caller (or hardware) is responsible for setting the
3846 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3848 * Return: The nullfunc template. %NULL on error.
3850 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3851 struct ieee80211_vif *vif);
3854 * ieee80211_probereq_get - retrieve a Probe Request template
3855 * @hw: pointer obtained from ieee80211_alloc_hw().
3856 * @src_addr: source MAC address
3857 * @ssid: SSID buffer
3858 * @ssid_len: length of SSID
3859 * @tailroom: tailroom to reserve at end of SKB for IEs
3861 * Creates a Probe Request template which can, for example, be uploaded to
3864 * Return: The Probe Request template. %NULL on error.
3866 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3868 const u8 *ssid, size_t ssid_len,
3872 * ieee80211_rts_get - RTS frame generation function
3873 * @hw: pointer obtained from ieee80211_alloc_hw().
3874 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3875 * @frame: pointer to the frame that is going to be protected by the RTS.
3876 * @frame_len: the frame length (in octets).
3877 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3878 * @rts: The buffer where to store the RTS frame.
3880 * If the RTS frames are generated by the host system (i.e., not in
3881 * hardware/firmware), the low-level driver uses this function to receive
3882 * the next RTS frame from the 802.11 code. The low-level is responsible
3883 * for calling this function before and RTS frame is needed.
3885 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3886 const void *frame, size_t frame_len,
3887 const struct ieee80211_tx_info *frame_txctl,
3888 struct ieee80211_rts *rts);
3891 * ieee80211_rts_duration - Get the duration field for an RTS frame
3892 * @hw: pointer obtained from ieee80211_alloc_hw().
3893 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3894 * @frame_len: the length of the frame that is going to be protected by the RTS.
3895 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3897 * If the RTS is generated in firmware, but the host system must provide
3898 * the duration field, the low-level driver uses this function to receive
3899 * the duration field value in little-endian byteorder.
3901 * Return: The duration.
3903 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3904 struct ieee80211_vif *vif, size_t frame_len,
3905 const struct ieee80211_tx_info *frame_txctl);
3908 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3909 * @hw: pointer obtained from ieee80211_alloc_hw().
3910 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3911 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3912 * @frame_len: the frame length (in octets).
3913 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3914 * @cts: The buffer where to store the CTS-to-self frame.
3916 * If the CTS-to-self frames are generated by the host system (i.e., not in
3917 * hardware/firmware), the low-level driver uses this function to receive
3918 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3919 * for calling this function before and CTS-to-self frame is needed.
3921 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3922 struct ieee80211_vif *vif,
3923 const void *frame, size_t frame_len,
3924 const struct ieee80211_tx_info *frame_txctl,
3925 struct ieee80211_cts *cts);
3928 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3929 * @hw: pointer obtained from ieee80211_alloc_hw().
3930 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3931 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3932 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3934 * If the CTS-to-self is generated in firmware, but the host system must provide
3935 * the duration field, the low-level driver uses this function to receive
3936 * the duration field value in little-endian byteorder.
3938 * Return: The duration.
3940 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3941 struct ieee80211_vif *vif,
3943 const struct ieee80211_tx_info *frame_txctl);
3946 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3947 * @hw: pointer obtained from ieee80211_alloc_hw().
3948 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3949 * @band: the band to calculate the frame duration on
3950 * @frame_len: the length of the frame.
3951 * @rate: the rate at which the frame is going to be transmitted.
3953 * Calculate the duration field of some generic frame, given its
3954 * length and transmission rate (in 100kbps).
3956 * Return: The duration.
3958 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3959 struct ieee80211_vif *vif,
3960 enum ieee80211_band band,
3962 struct ieee80211_rate *rate);
3965 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3966 * @hw: pointer as obtained from ieee80211_alloc_hw().
3967 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3969 * Function for accessing buffered broadcast and multicast frames. If
3970 * hardware/firmware does not implement buffering of broadcast/multicast
3971 * frames when power saving is used, 802.11 code buffers them in the host
3972 * memory. The low-level driver uses this function to fetch next buffered
3973 * frame. In most cases, this is used when generating beacon frame.
3975 * Return: A pointer to the next buffered skb or NULL if no more buffered
3976 * frames are available.
3978 * Note: buffered frames are returned only after DTIM beacon frame was
3979 * generated with ieee80211_beacon_get() and the low-level driver must thus
3980 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3981 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3982 * does not need to check for DTIM beacons separately and should be able to
3983 * use common code for all beacons.
3986 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3989 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3991 * This function returns the TKIP phase 1 key for the given IV32.
3993 * @keyconf: the parameter passed with the set key
3994 * @iv32: IV32 to get the P1K for
3995 * @p1k: a buffer to which the key will be written, as 5 u16 values
3997 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3998 u32 iv32, u16 *p1k);
4001 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4003 * This function returns the TKIP phase 1 key for the IV32 taken
4004 * from the given packet.
4006 * @keyconf: the parameter passed with the set key
4007 * @skb: the packet to take the IV32 value from that will be encrypted
4009 * @p1k: a buffer to which the key will be written, as 5 u16 values
4011 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4012 struct sk_buff *skb, u16 *p1k)
4014 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4015 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4016 u32 iv32 = get_unaligned_le32(&data[4]);
4018 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4022 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4024 * This function returns the TKIP phase 1 key for the given IV32
4025 * and transmitter address.
4027 * @keyconf: the parameter passed with the set key
4028 * @ta: TA that will be used with the key
4029 * @iv32: IV32 to get the P1K for
4030 * @p1k: a buffer to which the key will be written, as 5 u16 values
4032 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4033 const u8 *ta, u32 iv32, u16 *p1k);
4036 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4038 * This function computes the TKIP RC4 key for the IV values
4041 * @keyconf: the parameter passed with the set key
4042 * @skb: the packet to take the IV32/IV16 values from that will be
4043 * encrypted with this key
4044 * @p2k: a buffer to which the key will be written, 16 bytes
4046 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4047 struct sk_buff *skb, u8 *p2k);
4050 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
4052 * This function computes the two AES-CMAC sub-keys, based on the
4053 * previously installed master key.
4055 * @keyconf: the parameter passed with the set key
4056 * @k1: a buffer to be filled with the 1st sub-key
4057 * @k2: a buffer to be filled with the 2nd sub-key
4059 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
4063 * struct ieee80211_key_seq - key sequence counter
4065 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
4066 * @ccmp: PN data, most significant byte first (big endian,
4067 * reverse order than in packet)
4068 * @aes_cmac: PN data, most significant byte first (big endian,
4069 * reverse order than in packet)
4071 struct ieee80211_key_seq {
4087 * ieee80211_get_key_tx_seq - get key TX sequence counter
4089 * @keyconf: the parameter passed with the set key
4090 * @seq: buffer to receive the sequence data
4092 * This function allows a driver to retrieve the current TX IV/PN
4093 * for the given key. It must not be called if IV generation is
4094 * offloaded to the device.
4096 * Note that this function may only be called when no TX processing
4097 * can be done concurrently, for example when queues are stopped
4098 * and the stop has been synchronized.
4100 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4101 struct ieee80211_key_seq *seq);
4104 * ieee80211_get_key_rx_seq - get key RX sequence counter
4106 * @keyconf: the parameter passed with the set key
4107 * @tid: The TID, or -1 for the management frame value (CCMP only);
4108 * the value on TID 0 is also used for non-QoS frames. For
4109 * CMAC, only TID 0 is valid.
4110 * @seq: buffer to receive the sequence data
4112 * This function allows a driver to retrieve the current RX IV/PNs
4113 * for the given key. It must not be called if IV checking is done
4114 * by the device and not by mac80211.
4116 * Note that this function may only be called when no RX processing
4117 * can be done concurrently.
4119 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4120 int tid, struct ieee80211_key_seq *seq);
4123 * ieee80211_set_key_tx_seq - set key TX sequence counter
4125 * @keyconf: the parameter passed with the set key
4126 * @seq: new sequence data
4128 * This function allows a driver to set the current TX IV/PNs for the
4129 * given key. This is useful when resuming from WoWLAN sleep and the
4130 * device may have transmitted frames using the PTK, e.g. replies to
4133 * Note that this function may only be called when no TX processing
4134 * can be done concurrently.
4136 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4137 struct ieee80211_key_seq *seq);
4140 * ieee80211_set_key_rx_seq - set key RX sequence counter
4142 * @keyconf: the parameter passed with the set key
4143 * @tid: The TID, or -1 for the management frame value (CCMP only);
4144 * the value on TID 0 is also used for non-QoS frames. For
4145 * CMAC, only TID 0 is valid.
4146 * @seq: new sequence data
4148 * This function allows a driver to set the current RX IV/PNs for the
4149 * given key. This is useful when resuming from WoWLAN sleep and GTK
4150 * rekey may have been done while suspended. It should not be called
4151 * if IV checking is done by the device and not by mac80211.
4153 * Note that this function may only be called when no RX processing
4154 * can be done concurrently.
4156 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4157 int tid, struct ieee80211_key_seq *seq);
4160 * ieee80211_remove_key - remove the given key
4161 * @keyconf: the parameter passed with the set key
4163 * Remove the given key. If the key was uploaded to the hardware at the
4164 * time this function is called, it is not deleted in the hardware but
4165 * instead assumed to have been removed already.
4167 * Note that due to locking considerations this function can (currently)
4168 * only be called during key iteration (ieee80211_iter_keys().)
4170 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4173 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4174 * @vif: the virtual interface to add the key on
4175 * @keyconf: new key data
4177 * When GTK rekeying was done while the system was suspended, (a) new
4178 * key(s) will be available. These will be needed by mac80211 for proper
4179 * RX processing, so this function allows setting them.
4181 * The function returns the newly allocated key structure, which will
4182 * have similar contents to the passed key configuration but point to
4183 * mac80211-owned memory. In case of errors, the function returns an
4184 * ERR_PTR(), use IS_ERR() etc.
4186 * Note that this function assumes the key isn't added to hardware
4187 * acceleration, so no TX will be done with the key. Since it's a GTK
4188 * on managed (station) networks, this is true anyway. If the driver
4189 * calls this function from the resume callback and subsequently uses
4190 * the return code 1 to reconfigure the device, this key will be part
4191 * of the reconfiguration.
4193 * Note that the driver should also call ieee80211_set_key_rx_seq()
4194 * for the new key for each TID to set up sequence counters properly.
4196 * IMPORTANT: If this replaces a key that is present in the hardware,
4197 * then it will attempt to remove it during this call. In many cases
4198 * this isn't what you want, so call ieee80211_remove_key() first for
4199 * the key that's being replaced.
4201 struct ieee80211_key_conf *
4202 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4203 struct ieee80211_key_conf *keyconf);
4206 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4207 * @vif: virtual interface the rekeying was done on
4208 * @bssid: The BSSID of the AP, for checking association
4209 * @replay_ctr: the new replay counter after GTK rekeying
4210 * @gfp: allocation flags
4212 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4213 const u8 *replay_ctr, gfp_t gfp);
4216 * ieee80211_wake_queue - wake specific queue
4217 * @hw: pointer as obtained from ieee80211_alloc_hw().
4218 * @queue: queue number (counted from zero).
4220 * Drivers should use this function instead of netif_wake_queue.
4222 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4225 * ieee80211_stop_queue - stop specific queue
4226 * @hw: pointer as obtained from ieee80211_alloc_hw().
4227 * @queue: queue number (counted from zero).
4229 * Drivers should use this function instead of netif_stop_queue.
4231 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4234 * ieee80211_queue_stopped - test status of the queue
4235 * @hw: pointer as obtained from ieee80211_alloc_hw().
4236 * @queue: queue number (counted from zero).
4238 * Drivers should use this function instead of netif_stop_queue.
4240 * Return: %true if the queue is stopped. %false otherwise.
4243 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4246 * ieee80211_stop_queues - stop all queues
4247 * @hw: pointer as obtained from ieee80211_alloc_hw().
4249 * Drivers should use this function instead of netif_stop_queue.
4251 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4254 * ieee80211_wake_queues - wake all queues
4255 * @hw: pointer as obtained from ieee80211_alloc_hw().
4257 * Drivers should use this function instead of netif_wake_queue.
4259 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4262 * ieee80211_scan_completed - completed hardware scan
4264 * When hardware scan offload is used (i.e. the hw_scan() callback is
4265 * assigned) this function needs to be called by the driver to notify
4266 * mac80211 that the scan finished. This function can be called from
4267 * any context, including hardirq context.
4269 * @hw: the hardware that finished the scan
4270 * @aborted: set to true if scan was aborted
4272 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4275 * ieee80211_sched_scan_results - got results from scheduled scan
4277 * When a scheduled scan is running, this function needs to be called by the
4278 * driver whenever there are new scan results available.
4280 * @hw: the hardware that is performing scheduled scans
4282 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4285 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4287 * When a scheduled scan is running, this function can be called by
4288 * the driver if it needs to stop the scan to perform another task.
4289 * Usual scenarios are drivers that cannot continue the scheduled scan
4290 * while associating, for instance.
4292 * @hw: the hardware that is performing scheduled scans
4294 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4297 * enum ieee80211_interface_iteration_flags - interface iteration flags
4298 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4299 * been added to the driver; However, note that during hardware
4300 * reconfiguration (after restart_hw) it will iterate over a new
4301 * interface and over all the existing interfaces even if they
4302 * haven't been re-added to the driver yet.
4303 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4304 * interfaces, even if they haven't been re-added to the driver yet.
4306 enum ieee80211_interface_iteration_flags {
4307 IEEE80211_IFACE_ITER_NORMAL = 0,
4308 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4312 * ieee80211_iterate_active_interfaces - iterate active interfaces
4314 * This function iterates over the interfaces associated with a given
4315 * hardware that are currently active and calls the callback for them.
4316 * This function allows the iterator function to sleep, when the iterator
4317 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4319 * Does not iterate over a new interface during add_interface().
4321 * @hw: the hardware struct of which the interfaces should be iterated over
4322 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4323 * @iterator: the iterator function to call
4324 * @data: first argument of the iterator function
4326 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
4328 void (*iterator)(void *data, u8 *mac,
4329 struct ieee80211_vif *vif),
4333 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4335 * This function iterates over the interfaces associated with a given
4336 * hardware that are currently active and calls the callback for them.
4337 * This function requires the iterator callback function to be atomic,
4338 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4339 * Does not iterate over a new interface during add_interface().
4341 * @hw: the hardware struct of which the interfaces should be iterated over
4342 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4343 * @iterator: the iterator function to call, cannot sleep
4344 * @data: first argument of the iterator function
4346 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4348 void (*iterator)(void *data,
4350 struct ieee80211_vif *vif),
4354 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4356 * This function iterates over the interfaces associated with a given
4357 * hardware that are currently active and calls the callback for them.
4358 * This version can only be used while holding the RTNL.
4360 * @hw: the hardware struct of which the interfaces should be iterated over
4361 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4362 * @iterator: the iterator function to call, cannot sleep
4363 * @data: first argument of the iterator function
4365 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4367 void (*iterator)(void *data,
4369 struct ieee80211_vif *vif),
4373 * ieee80211_iterate_stations_atomic - iterate stations
4375 * This function iterates over all stations associated with a given
4376 * hardware that are currently uploaded to the driver and calls the callback
4377 * function for them.
4378 * This function requires the iterator callback function to be atomic,
4380 * @hw: the hardware struct of which the interfaces should be iterated over
4381 * @iterator: the iterator function to call, cannot sleep
4382 * @data: first argument of the iterator function
4384 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4385 void (*iterator)(void *data,
4386 struct ieee80211_sta *sta),
4389 * ieee80211_queue_work - add work onto the mac80211 workqueue
4391 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4392 * This helper ensures drivers are not queueing work when they should not be.
4394 * @hw: the hardware struct for the interface we are adding work for
4395 * @work: the work we want to add onto the mac80211 workqueue
4397 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4400 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4402 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4405 * @hw: the hardware struct for the interface we are adding work for
4406 * @dwork: delayable work to queue onto the mac80211 workqueue
4407 * @delay: number of jiffies to wait before queueing
4409 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4410 struct delayed_work *dwork,
4411 unsigned long delay);
4414 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4415 * @sta: the station for which to start a BA session
4416 * @tid: the TID to BA on.
4417 * @timeout: session timeout value (in TUs)
4419 * Return: success if addBA request was sent, failure otherwise
4421 * Although mac80211/low level driver/user space application can estimate
4422 * the need to start aggregation on a certain RA/TID, the session level
4423 * will be managed by the mac80211.
4425 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4429 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4430 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4431 * @ra: receiver address of the BA session recipient.
4432 * @tid: the TID to BA on.
4434 * This function must be called by low level driver once it has
4435 * finished with preparations for the BA session. It can be called
4438 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4442 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4443 * @sta: the station whose BA session to stop
4444 * @tid: the TID to stop BA.
4446 * Return: negative error if the TID is invalid, or no aggregation active
4448 * Although mac80211/low level driver/user space application can estimate
4449 * the need to stop aggregation on a certain RA/TID, the session level
4450 * will be managed by the mac80211.
4452 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4455 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4456 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4457 * @ra: receiver address of the BA session recipient.
4458 * @tid: the desired TID to BA on.
4460 * This function must be called by low level driver once it has
4461 * finished with preparations for the BA session tear down. It
4462 * can be called from any context.
4464 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4468 * ieee80211_find_sta - find a station
4470 * @vif: virtual interface to look for station on
4471 * @addr: station's address
4473 * Return: The station, if found. %NULL otherwise.
4475 * Note: This function must be called under RCU lock and the
4476 * resulting pointer is only valid under RCU lock as well.
4478 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4482 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4484 * @hw: pointer as obtained from ieee80211_alloc_hw()
4485 * @addr: remote station's address
4486 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4488 * Return: The station, if found. %NULL otherwise.
4490 * Note: This function must be called under RCU lock and the
4491 * resulting pointer is only valid under RCU lock as well.
4493 * NOTE: You may pass NULL for localaddr, but then you will just get
4494 * the first STA that matches the remote address 'addr'.
4495 * We can have multiple STA associated with multiple
4496 * logical stations (e.g. consider a station connecting to another
4497 * BSSID on the same AP hardware without disconnecting first).
4498 * In this case, the result of this method with localaddr NULL
4501 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4503 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4505 const u8 *localaddr);
4508 * ieee80211_sta_block_awake - block station from waking up
4510 * @pubsta: the station
4511 * @block: whether to block or unblock
4513 * Some devices require that all frames that are on the queues
4514 * for a specific station that went to sleep are flushed before
4515 * a poll response or frames after the station woke up can be
4516 * delivered to that it. Note that such frames must be rejected
4517 * by the driver as filtered, with the appropriate status flag.
4519 * This function allows implementing this mode in a race-free
4522 * To do this, a driver must keep track of the number of frames
4523 * still enqueued for a specific station. If this number is not
4524 * zero when the station goes to sleep, the driver must call
4525 * this function to force mac80211 to consider the station to
4526 * be asleep regardless of the station's actual state. Once the
4527 * number of outstanding frames reaches zero, the driver must
4528 * call this function again to unblock the station. That will
4529 * cause mac80211 to be able to send ps-poll responses, and if
4530 * the station queried in the meantime then frames will also
4531 * be sent out as a result of this. Additionally, the driver
4532 * will be notified that the station woke up some time after
4533 * it is unblocked, regardless of whether the station actually
4534 * woke up while blocked or not.
4536 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4537 struct ieee80211_sta *pubsta, bool block);
4540 * ieee80211_sta_eosp - notify mac80211 about end of SP
4541 * @pubsta: the station
4543 * When a device transmits frames in a way that it can't tell
4544 * mac80211 in the TX status about the EOSP, it must clear the
4545 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4546 * This applies for PS-Poll as well as uAPSD.
4548 * Note that just like with _tx_status() and _rx() drivers must
4549 * not mix calls to irqsafe/non-irqsafe versions, this function
4550 * must not be mixed with those either. Use the all irqsafe, or
4551 * all non-irqsafe, don't mix!
4553 * NB: the _irqsafe version of this function doesn't exist, no
4554 * driver needs it right now. Don't call this function if
4555 * you'd need the _irqsafe version, look at the git history
4556 * and restore the _irqsafe version!
4558 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4561 * ieee80211_iter_keys - iterate keys programmed into the device
4562 * @hw: pointer obtained from ieee80211_alloc_hw()
4563 * @vif: virtual interface to iterate, may be %NULL for all
4564 * @iter: iterator function that will be called for each key
4565 * @iter_data: custom data to pass to the iterator function
4567 * This function can be used to iterate all the keys known to
4568 * mac80211, even those that weren't previously programmed into
4569 * the device. This is intended for use in WoWLAN if the device
4570 * needs reprogramming of the keys during suspend. Note that due
4571 * to locking reasons, it is also only safe to call this at few
4572 * spots since it must hold the RTNL and be able to sleep.
4574 * The order in which the keys are iterated matches the order
4575 * in which they were originally installed and handed to the
4578 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4579 struct ieee80211_vif *vif,
4580 void (*iter)(struct ieee80211_hw *hw,
4581 struct ieee80211_vif *vif,
4582 struct ieee80211_sta *sta,
4583 struct ieee80211_key_conf *key,
4588 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4589 * @hw: pointre obtained from ieee80211_alloc_hw().
4590 * @iter: iterator function
4591 * @iter_data: data passed to iterator function
4593 * Iterate all active channel contexts. This function is atomic and
4594 * doesn't acquire any locks internally that might be held in other
4595 * places while calling into the driver.
4597 * The iterator will not find a context that's being added (during
4598 * the driver callback to add it) but will find it while it's being
4601 * Note that during hardware restart, all contexts that existed
4602 * before the restart are considered already present so will be
4603 * found while iterating, whether they've been re-added already
4606 void ieee80211_iter_chan_contexts_atomic(
4607 struct ieee80211_hw *hw,
4608 void (*iter)(struct ieee80211_hw *hw,
4609 struct ieee80211_chanctx_conf *chanctx_conf,
4614 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4615 * @hw: pointer obtained from ieee80211_alloc_hw().
4616 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4618 * Creates a Probe Request template which can, for example, be uploaded to
4619 * hardware. The template is filled with bssid, ssid and supported rate
4620 * information. This function must only be called from within the
4621 * .bss_info_changed callback function and only in managed mode. The function
4622 * is only useful when the interface is associated, otherwise it will return
4625 * Return: The Probe Request template. %NULL on error.
4627 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4628 struct ieee80211_vif *vif);
4631 * ieee80211_beacon_loss - inform hardware does not receive beacons
4633 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4635 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4636 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4637 * hardware is not receiving beacons with this function.
4639 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4642 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4644 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4646 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4647 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4648 * needs to inform if the connection to the AP has been lost.
4649 * The function may also be called if the connection needs to be terminated
4650 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4652 * This function will cause immediate change to disassociated state,
4653 * without connection recovery attempts.
4655 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4658 * ieee80211_resume_disconnect - disconnect from AP after resume
4660 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4662 * Instructs mac80211 to disconnect from the AP after resume.
4663 * Drivers can use this after WoWLAN if they know that the
4664 * connection cannot be kept up, for example because keys were
4665 * used while the device was asleep but the replay counters or
4666 * similar cannot be retrieved from the device during resume.
4668 * Note that due to implementation issues, if the driver uses
4669 * the reconfiguration functionality during resume the interface
4670 * will still be added as associated first during resume and then
4671 * disconnect normally later.
4673 * This function can only be called from the resume callback and
4674 * the driver must not be holding any of its own locks while it
4675 * calls this function, or at least not any locks it needs in the
4676 * key configuration paths (if it supports HW crypto).
4678 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4681 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4682 * rssi threshold triggered
4684 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4685 * @rssi_event: the RSSI trigger event type
4686 * @gfp: context flags
4688 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4689 * monitoring is configured with an rssi threshold, the driver will inform
4690 * whenever the rssi level reaches the threshold.
4692 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4693 enum nl80211_cqm_rssi_threshold_event rssi_event,
4697 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4699 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4700 * @gfp: context flags
4702 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
4705 * ieee80211_radar_detected - inform that a radar was detected
4707 * @hw: pointer as obtained from ieee80211_alloc_hw()
4709 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4712 * ieee80211_chswitch_done - Complete channel switch process
4713 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4714 * @success: make the channel switch successful or not
4716 * Complete the channel switch post-process: set the new operational channel
4717 * and wake up the suspended queues.
4719 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4722 * ieee80211_request_smps - request SM PS transition
4723 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4724 * @smps_mode: new SM PS mode
4726 * This allows the driver to request an SM PS transition in managed
4727 * mode. This is useful when the driver has more information than
4728 * the stack about possible interference, for example by bluetooth.
4730 void ieee80211_request_smps(struct ieee80211_vif *vif,
4731 enum ieee80211_smps_mode smps_mode);
4734 * ieee80211_ready_on_channel - notification of remain-on-channel start
4735 * @hw: pointer as obtained from ieee80211_alloc_hw()
4737 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4740 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4741 * @hw: pointer as obtained from ieee80211_alloc_hw()
4743 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4746 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4748 * in order not to harm the system performance and user experience, the device
4749 * may request not to allow any rx ba session and tear down existing rx ba
4750 * sessions based on system constraints such as periodic BT activity that needs
4751 * to limit wlan activity (eg.sco or a2dp)."
4752 * in such cases, the intention is to limit the duration of the rx ppdu and
4753 * therefore prevent the peer device to use a-mpdu aggregation.
4755 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4756 * @ba_rx_bitmap: Bit map of open rx ba per tid
4757 * @addr: & to bssid mac address
4759 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4763 * ieee80211_send_bar - send a BlockAckReq frame
4765 * can be used to flush pending frames from the peer's aggregation reorder
4768 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4769 * @ra: the peer's destination address
4770 * @tid: the TID of the aggregation session
4771 * @ssn: the new starting sequence number for the receiver
4773 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4776 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
4778 * Some device drivers may offload part of the Rx aggregation flow including
4779 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4782 * Create structures responsible for reordering so device drivers may call here
4783 * when they complete AddBa negotiation.
4785 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4786 * @addr: station mac address
4789 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
4790 const u8 *addr, u16 tid);
4793 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
4795 * Some device drivers may offload part of the Rx aggregation flow including
4796 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4799 * Destroy structures responsible for reordering so device drivers may call here
4800 * when they complete DelBa negotiation.
4802 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4803 * @addr: station mac address
4806 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
4807 const u8 *addr, u16 tid);
4809 /* Rate control API */
4812 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4814 * @hw: The hardware the algorithm is invoked for.
4815 * @sband: The band this frame is being transmitted on.
4816 * @bss_conf: the current BSS configuration
4817 * @skb: the skb that will be transmitted, the control information in it needs
4819 * @reported_rate: The rate control algorithm can fill this in to indicate
4820 * which rate should be reported to userspace as the current rate and
4821 * used for rate calculations in the mesh network.
4822 * @rts: whether RTS will be used for this frame because it is longer than the
4824 * @short_preamble: whether mac80211 will request short-preamble transmission
4825 * if the selected rate supports it
4826 * @max_rate_idx: user-requested maximum (legacy) rate
4827 * (deprecated; this will be removed once drivers get updated to use
4829 * @rate_idx_mask: user-requested (legacy) rate mask
4830 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4831 * @bss: whether this frame is sent out in AP or IBSS mode
4833 struct ieee80211_tx_rate_control {
4834 struct ieee80211_hw *hw;
4835 struct ieee80211_supported_band *sband;
4836 struct ieee80211_bss_conf *bss_conf;
4837 struct sk_buff *skb;
4838 struct ieee80211_tx_rate reported_rate;
4839 bool rts, short_preamble;
4842 u8 *rate_idx_mcs_mask;
4846 struct rate_control_ops {
4848 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4849 void (*free)(void *priv);
4851 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4852 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4853 struct cfg80211_chan_def *chandef,
4854 struct ieee80211_sta *sta, void *priv_sta);
4855 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4856 struct cfg80211_chan_def *chandef,
4857 struct ieee80211_sta *sta, void *priv_sta,
4859 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4862 void (*tx_status_noskb)(void *priv,
4863 struct ieee80211_supported_band *sband,
4864 struct ieee80211_sta *sta, void *priv_sta,
4865 struct ieee80211_tx_info *info);
4866 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4867 struct ieee80211_sta *sta, void *priv_sta,
4868 struct sk_buff *skb);
4869 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4870 struct ieee80211_tx_rate_control *txrc);
4872 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4873 struct dentry *dir);
4874 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4876 u32 (*get_expected_throughput)(void *priv_sta);
4879 static inline int rate_supported(struct ieee80211_sta *sta,
4880 enum ieee80211_band band,
4883 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4887 * rate_control_send_low - helper for drivers for management/no-ack frames
4889 * Rate control algorithms that agree to use the lowest rate to
4890 * send management frames and NO_ACK data with the respective hw
4891 * retries should use this in the beginning of their mac80211 get_rate
4892 * callback. If true is returned the rate control can simply return.
4893 * If false is returned we guarantee that sta and sta and priv_sta is
4896 * Rate control algorithms wishing to do more intelligent selection of
4897 * rate for multicast/broadcast frames may choose to not use this.
4899 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4900 * that this may be null.
4901 * @priv_sta: private rate control structure. This may be null.
4902 * @txrc: rate control information we sholud populate for mac80211.
4904 bool rate_control_send_low(struct ieee80211_sta *sta,
4906 struct ieee80211_tx_rate_control *txrc);
4910 rate_lowest_index(struct ieee80211_supported_band *sband,
4911 struct ieee80211_sta *sta)
4915 for (i = 0; i < sband->n_bitrates; i++)
4916 if (rate_supported(sta, sband->band, i))
4919 /* warn when we cannot find a rate. */
4922 /* and return 0 (the lowest index) */
4927 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4928 struct ieee80211_sta *sta)
4932 for (i = 0; i < sband->n_bitrates; i++)
4933 if (rate_supported(sta, sband->band, i))
4939 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4941 * When not doing a rate control probe to test rates, rate control should pass
4942 * its rate selection to mac80211. If the driver supports receiving a station
4943 * rate table, it will use it to ensure that frames are always sent based on
4944 * the most recent rate control module decision.
4946 * @hw: pointer as obtained from ieee80211_alloc_hw()
4947 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4948 * @rates: new tx rate set to be used for this station.
4950 int rate_control_set_rates(struct ieee80211_hw *hw,
4951 struct ieee80211_sta *pubsta,
4952 struct ieee80211_sta_rates *rates);
4954 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4955 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4958 conf_is_ht20(struct ieee80211_conf *conf)
4960 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4964 conf_is_ht40_minus(struct ieee80211_conf *conf)
4966 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4967 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4971 conf_is_ht40_plus(struct ieee80211_conf *conf)
4973 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4974 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4978 conf_is_ht40(struct ieee80211_conf *conf)
4980 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4984 conf_is_ht(struct ieee80211_conf *conf)
4986 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
4987 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
4988 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
4991 static inline enum nl80211_iftype
4992 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4996 case NL80211_IFTYPE_STATION:
4997 return NL80211_IFTYPE_P2P_CLIENT;
4998 case NL80211_IFTYPE_AP:
4999 return NL80211_IFTYPE_P2P_GO;
5007 static inline enum nl80211_iftype
5008 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5010 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5013 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5015 int rssi_max_thold);
5017 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5020 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5022 * @vif: the specified virtual interface
5024 * Note: This function assumes that the given vif is valid.
5026 * Return: The average RSSI value for the requested interface, or 0 if not
5029 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5032 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5033 * @vif: virtual interface
5034 * @wakeup: wakeup reason(s)
5035 * @gfp: allocation flags
5037 * See cfg80211_report_wowlan_wakeup().
5039 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5040 struct cfg80211_wowlan_wakeup *wakeup,
5044 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5045 * @hw: pointer as obtained from ieee80211_alloc_hw()
5046 * @vif: virtual interface
5047 * @skb: frame to be sent from within the driver
5048 * @band: the band to transmit on
5049 * @sta: optional pointer to get the station to send the frame to
5051 * Note: must be called under RCU lock
5053 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5054 struct ieee80211_vif *vif, struct sk_buff *skb,
5055 int band, struct ieee80211_sta **sta);
5058 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5060 * @next_tsf: TSF timestamp of the next absent state change
5061 * @has_next_tsf: next absent state change event pending
5063 * @absent: descriptor bitmask, set if GO is currently absent
5067 * @count: count fields from the NoA descriptors
5068 * @desc: adjusted data from the NoA
5070 struct ieee80211_noa_data {
5076 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5081 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5085 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5088 * @data: NoA tracking data
5089 * @tsf: current TSF timestamp
5091 * Return: number of successfully parsed descriptors
5093 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5094 struct ieee80211_noa_data *data, u32 tsf);
5097 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5099 * @data: NoA tracking data
5100 * @tsf: current TSF timestamp
5102 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5105 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5106 * @vif: virtual interface
5107 * @peer: the peer's destination address
5108 * @oper: the requested TDLS operation
5109 * @reason_code: reason code for the operation, valid for TDLS teardown
5110 * @gfp: allocation flags
5112 * See cfg80211_tdls_oper_request().
5114 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5115 enum nl80211_tdls_operation oper,
5116 u16 reason_code, gfp_t gfp);
5119 * ieee80211_reserve_tid - request to reserve a specific TID
5121 * There is sometimes a need (such as in TDLS) for blocking the driver from
5122 * using a specific TID so that the FW can use it for certain operations such
5123 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5124 * this function must be called as it flushes out packets on this TID and marks
5125 * it as blocked, so that any transmit for the station on this TID will be
5126 * redirected to the alternative TID in the same AC.
5128 * Note that this function blocks and may call back into the driver, so it
5129 * should be called without driver locks held. Also note this function should
5130 * only be called from the driver's @sta_state callback.
5132 * @sta: the station to reserve the TID for
5133 * @tid: the TID to reserve
5135 * Returns: 0 on success, else on failure
5137 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5140 * ieee80211_unreserve_tid - request to unreserve a specific TID
5142 * Once there is no longer any need for reserving a certain TID, this function
5143 * should be called, and no longer will packets have their TID modified for
5144 * preventing use of this TID in the driver.
5146 * Note that this function blocks and acquires a lock, so it should be called
5147 * without driver locks held. Also note this function should only be called
5148 * from the driver's @sta_state callback.
5151 * @tid: the TID to unreserve
5153 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5156 * ieee80211_ie_split - split an IE buffer according to ordering
5158 * @ies: the IE buffer
5159 * @ielen: the length of the IE buffer
5160 * @ids: an array with element IDs that are allowed before
5162 * @n_ids: the size of the element ID array
5163 * @offset: offset where to start splitting in the buffer
5165 * This function splits an IE buffer by updating the @offset
5166 * variable to point to the location where the buffer should be
5169 * It assumes that the given IE buffer is well-formed, this
5170 * has to be guaranteed by the caller!
5172 * It also assumes that the IEs in the buffer are ordered
5173 * correctly, if not the result of using this function will not
5174 * be ordered correctly either, i.e. it does no reordering.
5176 * The function returns the offset where the next part of the
5177 * buffer starts, which may be @ielen if the entire (remainder)
5178 * of the buffer should be used.
5180 size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5181 const u8 *ids, int n_ids, size_t offset);
5182 #endif /* MAC80211_H */