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.
267 enum ieee80211_bss_change {
268 BSS_CHANGED_ASSOC = 1<<0,
269 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
270 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
271 BSS_CHANGED_ERP_SLOT = 1<<3,
272 BSS_CHANGED_HT = 1<<4,
273 BSS_CHANGED_BASIC_RATES = 1<<5,
274 BSS_CHANGED_BEACON_INT = 1<<6,
275 BSS_CHANGED_BSSID = 1<<7,
276 BSS_CHANGED_BEACON = 1<<8,
277 BSS_CHANGED_BEACON_ENABLED = 1<<9,
278 BSS_CHANGED_CQM = 1<<10,
279 BSS_CHANGED_IBSS = 1<<11,
280 BSS_CHANGED_ARP_FILTER = 1<<12,
281 BSS_CHANGED_QOS = 1<<13,
282 BSS_CHANGED_IDLE = 1<<14,
283 BSS_CHANGED_SSID = 1<<15,
284 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
285 BSS_CHANGED_PS = 1<<17,
286 BSS_CHANGED_TXPOWER = 1<<18,
287 BSS_CHANGED_P2P_PS = 1<<19,
288 BSS_CHANGED_BEACON_INFO = 1<<20,
289 BSS_CHANGED_BANDWIDTH = 1<<21,
291 /* when adding here, make sure to change ieee80211_reconfig */
295 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
296 * of addresses for an interface increase beyond this value, hardware ARP
297 * filtering will be disabled.
299 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
302 * enum ieee80211_rssi_event - RSSI threshold event
303 * An indicator for when RSSI goes below/above a certain threshold.
304 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
305 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
307 enum ieee80211_rssi_event {
313 * struct ieee80211_bss_conf - holds the BSS's changing parameters
315 * This structure keeps information about a BSS (and an association
316 * to that BSS) that can change during the lifetime of the BSS.
318 * @assoc: association status
319 * @ibss_joined: indicates whether this station is part of an IBSS
321 * @ibss_creator: indicates if a new IBSS network is being created
322 * @aid: association ID number, valid only when @assoc is true
323 * @use_cts_prot: use CTS protection
324 * @use_short_preamble: use 802.11b short preamble;
325 * if the hardware cannot handle this it must set the
326 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
327 * @use_short_slot: use short slot time (only relevant for ERP);
328 * if the hardware cannot handle this it must set the
329 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
330 * @dtim_period: num of beacons before the next DTIM, for beaconing,
331 * valid in station mode only if after the driver was notified
332 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
333 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
334 * as it may have been received during scanning long ago). If the
335 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
336 * only come from a beacon, but might not become valid until after
337 * association when a beacon is received (which is notified with the
338 * %BSS_CHANGED_DTIM flag.)
339 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
340 * the driver/device can use this to calculate synchronisation
342 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
343 * is requested, see @sync_tsf/@sync_device_ts.
344 * @beacon_int: beacon interval
345 * @assoc_capability: capabilities taken from assoc resp
346 * @basic_rates: bitmap of basic rates, each bit stands for an
347 * index into the rate table configured by the driver in
349 * @beacon_rate: associated AP's beacon TX rate
350 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
351 * @bssid: The BSSID for this BSS
352 * @enable_beacon: whether beaconing should be enabled or not
353 * @chandef: Channel definition for this BSS -- the hardware might be
354 * configured a higher bandwidth than this BSS uses, for example.
355 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
356 * This field is only valid when the channel type is one of the HT types.
357 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
359 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
360 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
361 * may filter ARP queries targeted for other addresses than listed here.
362 * The driver must allow ARP queries targeted for all address listed here
363 * to pass through. An empty list implies no ARP queries need to pass.
364 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
365 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
366 * array size), it's up to the driver what to do in that case.
367 * @qos: This is a QoS-enabled BSS.
368 * @idle: This interface is idle. There's also a global idle flag in the
369 * hardware config which may be more appropriate depending on what
370 * your driver/device needs to do.
371 * @ps: power-save mode (STA only). This flag is NOT affected by
372 * offchannel/dynamic_ps operations.
373 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
374 * @ssid_len: Length of SSID given in @ssid.
375 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
376 * @txpower: TX power in dBm
377 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
379 struct ieee80211_bss_conf {
381 /* association related data */
382 bool assoc, ibss_joined;
385 /* erp related data */
387 bool use_short_preamble;
392 u16 assoc_capability;
397 struct ieee80211_rate *beacon_rate;
398 int mcast_rate[IEEE80211_NUM_BANDS];
399 u16 ht_operation_mode;
402 struct cfg80211_chan_def chandef;
403 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
408 u8 ssid[IEEE80211_MAX_SSID_LEN];
412 struct ieee80211_p2p_noa_attr p2p_noa_attr;
416 * enum mac80211_tx_info_flags - flags to describe transmission information/status
418 * These flags are used with the @flags member of &ieee80211_tx_info.
420 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
421 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
422 * number to this frame, taking care of not overwriting the fragment
423 * number and increasing the sequence number only when the
424 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
425 * assign sequence numbers to QoS-data frames but cannot do so correctly
426 * for non-QoS-data and management frames because beacons need them from
427 * that counter as well and mac80211 cannot guarantee proper sequencing.
428 * If this flag is set, the driver should instruct the hardware to
429 * assign a sequence number to the frame or assign one itself. Cf. IEEE
430 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
431 * beacons and always be clear for frames without a sequence number field.
432 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
433 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
435 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
436 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
437 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
438 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
439 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
440 * because the destination STA was in powersave mode. Note that to
441 * avoid race conditions, the filter must be set by the hardware or
442 * firmware upon receiving a frame that indicates that the station
443 * went to sleep (must be done on device to filter frames already on
444 * the queue) and may only be unset after mac80211 gives the OK for
445 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
446 * since only then is it guaranteed that no more frames are in the
448 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
449 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
450 * is for the whole aggregation.
451 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
452 * so consider using block ack request (BAR).
453 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
454 * set by rate control algorithms to indicate probe rate, will
455 * be cleared for fragmented frames (except on the last fragment)
456 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
457 * that a frame can be transmitted while the queues are stopped for
458 * off-channel operation.
459 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
460 * used to indicate that a pending frame requires TX processing before
461 * it can be sent out.
462 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
463 * used to indicate that a frame was already retried due to PS
464 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
465 * used to indicate frame should not be encrypted
466 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
467 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
468 * be sent although the station is in powersave mode.
469 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
470 * transmit function after the current frame, this can be used
471 * by drivers to kick the DMA queue only if unset or when the
473 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
474 * after TX status because the destination was asleep, it must not
475 * be modified again (no seqno assignment, crypto, etc.)
476 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
477 * code for connection establishment, this indicates that its status
478 * should kick the MLME state machine.
479 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
480 * MLME command (internal to mac80211 to figure out whether to send TX
481 * status to user space)
482 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
483 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
484 * frame and selects the maximum number of streams that it can use.
485 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
486 * the off-channel channel when a remain-on-channel offload is done
487 * in hardware -- normal packets still flow and are expected to be
488 * handled properly by the device.
489 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
490 * testing. It will be sent out with incorrect Michael MIC key to allow
491 * TKIP countermeasures to be tested.
492 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
493 * This flag is actually used for management frame especially for P2P
494 * frames not being sent at CCK rate in 2GHz band.
495 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
496 * when its status is reported the service period ends. For frames in
497 * an SP that mac80211 transmits, it is already set; for driver frames
498 * the driver may set this flag. It is also used to do the same for
500 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
501 * This flag is used to send nullfunc frame at minimum rate when
502 * the nullfunc is used for connection monitoring purpose.
503 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
504 * would be fragmented by size (this is optional, only used for
505 * monitor injection).
506 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
507 * frame (PS-Poll or uAPSD).
509 * Note: If you have to add new flags to the enumeration, then don't
510 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
512 enum mac80211_tx_info_flags {
513 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
514 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
515 IEEE80211_TX_CTL_NO_ACK = BIT(2),
516 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
517 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
518 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
519 IEEE80211_TX_CTL_AMPDU = BIT(6),
520 IEEE80211_TX_CTL_INJECTED = BIT(7),
521 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
522 IEEE80211_TX_STAT_ACK = BIT(9),
523 IEEE80211_TX_STAT_AMPDU = BIT(10),
524 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
525 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
526 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
527 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
528 IEEE80211_TX_INTFL_RETRIED = BIT(15),
529 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
530 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
531 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
532 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
533 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
534 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
535 IEEE80211_TX_CTL_LDPC = BIT(22),
536 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
537 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
538 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
539 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
540 IEEE80211_TX_STATUS_EOSP = BIT(28),
541 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
542 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
543 IEEE80211_TX_CTL_PS_RESPONSE = BIT(31),
546 #define IEEE80211_TX_CTL_STBC_SHIFT 23
549 * enum mac80211_tx_control_flags - flags to describe transmit control
551 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
552 * protocol frame (e.g. EAP)
554 * These flags are used in tx_info->control.flags.
556 enum mac80211_tx_control_flags {
557 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
561 * This definition is used as a mask to clear all temporary flags, which are
562 * set by the tx handlers for each transmission attempt by the mac80211 stack.
564 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
565 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
566 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
567 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
568 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
569 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
570 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
571 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
574 * enum mac80211_rate_control_flags - per-rate flags set by the
575 * Rate Control algorithm.
577 * These flags are set by the Rate control algorithm for each rate during tx,
578 * in the @flags member of struct ieee80211_tx_rate.
580 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
581 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
582 * This is set if the current BSS requires ERP protection.
583 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
584 * @IEEE80211_TX_RC_MCS: HT rate.
585 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
586 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
587 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
589 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
590 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
591 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
592 * (80+80 isn't supported yet)
593 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
594 * adjacent 20 MHz channels, if the current channel type is
595 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
596 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
598 enum mac80211_rate_control_flags {
599 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
600 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
601 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
603 /* rate index is an HT/VHT MCS instead of an index */
604 IEEE80211_TX_RC_MCS = BIT(3),
605 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
606 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
607 IEEE80211_TX_RC_DUP_DATA = BIT(6),
608 IEEE80211_TX_RC_SHORT_GI = BIT(7),
609 IEEE80211_TX_RC_VHT_MCS = BIT(8),
610 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
611 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
615 /* there are 40 bytes if you don't need the rateset to be kept */
616 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
618 /* if you do need the rateset, then you have less space */
619 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
621 /* maximum number of rate stages */
622 #define IEEE80211_TX_MAX_RATES 4
624 /* maximum number of rate table entries */
625 #define IEEE80211_TX_RATE_TABLE_SIZE 4
628 * struct ieee80211_tx_rate - rate selection/status
630 * @idx: rate index to attempt to send with
631 * @flags: rate control flags (&enum mac80211_rate_control_flags)
632 * @count: number of tries in this rate before going to the next rate
634 * A value of -1 for @idx indicates an invalid rate and, if used
635 * in an array of retry rates, that no more rates should be tried.
637 * When used for transmit status reporting, the driver should
638 * always report the rate along with the flags it used.
640 * &struct ieee80211_tx_info contains an array of these structs
641 * in the control information, and it will be filled by the rate
642 * control algorithm according to what should be sent. For example,
643 * if this array contains, in the format { <idx>, <count> } the
645 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
646 * then this means that the frame should be transmitted
647 * up to twice at rate 3, up to twice at rate 2, and up to four
648 * times at rate 1 if it doesn't get acknowledged. Say it gets
649 * acknowledged by the peer after the fifth attempt, the status
650 * information should then contain
651 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
652 * since it was transmitted twice at rate 3, twice at rate 2
653 * and once at rate 1 after which we received an acknowledgement.
655 struct ieee80211_tx_rate {
661 #define IEEE80211_MAX_TX_RETRY 31
663 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
667 WARN_ON((nss - 1) & ~0x7);
668 rate->idx = ((nss - 1) << 4) | mcs;
672 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
674 return rate->idx & 0xF;
678 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
680 return (rate->idx >> 4) + 1;
684 * struct ieee80211_tx_info - skb transmit information
686 * This structure is placed in skb->cb for three uses:
687 * (1) mac80211 TX control - mac80211 tells the driver what to do
688 * (2) driver internal use (if applicable)
689 * (3) TX status information - driver tells mac80211 what happened
691 * @flags: transmit info flags, defined above
692 * @band: the band to transmit on (use for checking for races)
693 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
694 * @ack_frame_id: internal frame ID for TX status, used internally
695 * @control: union for control data
696 * @status: union for status data
697 * @driver_data: array of driver_data pointers
698 * @ampdu_ack_len: number of acked aggregated frames.
699 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
700 * @ampdu_len: number of aggregated frames.
701 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
702 * @ack_signal: signal strength of the ACK frame
704 struct ieee80211_tx_info {
705 /* common information */
718 struct ieee80211_tx_rate rates[
719 IEEE80211_TX_MAX_RATES];
727 /* only needed before rate control */
728 unsigned long jiffies;
730 /* NB: vif can be NULL for injected frames */
731 struct ieee80211_vif *vif;
732 struct ieee80211_key_conf *hw_key;
737 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
742 void *status_driver_data[21 / sizeof(void *)];
745 struct ieee80211_tx_rate driver_rates[
746 IEEE80211_TX_MAX_RATES];
749 void *rate_driver_data[
750 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
753 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
758 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
760 * This structure is used to point to different blocks of IEs in HW scan
761 * and scheduled scan. These blocks contain the IEs passed by userspace
762 * and the ones generated by mac80211.
764 * @ies: pointers to band specific IEs.
765 * @len: lengths of band_specific IEs.
766 * @common_ies: IEs for all bands (especially vendor specific ones)
767 * @common_ie_len: length of the common_ies
769 struct ieee80211_scan_ies {
770 const u8 *ies[IEEE80211_NUM_BANDS];
771 size_t len[IEEE80211_NUM_BANDS];
772 const u8 *common_ies;
773 size_t common_ie_len;
777 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
779 return (struct ieee80211_tx_info *)skb->cb;
782 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
784 return (struct ieee80211_rx_status *)skb->cb;
788 * ieee80211_tx_info_clear_status - clear TX status
790 * @info: The &struct ieee80211_tx_info to be cleared.
792 * When the driver passes an skb back to mac80211, it must report
793 * a number of things in TX status. This function clears everything
794 * in the TX status but the rate control information (it does clear
795 * the count since you need to fill that in anyway).
797 * NOTE: You can only use this function if you do NOT use
798 * info->driver_data! Use info->rate_driver_data
799 * instead if you need only the less space that allows.
802 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
806 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
807 offsetof(struct ieee80211_tx_info, control.rates));
808 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
809 offsetof(struct ieee80211_tx_info, driver_rates));
810 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
811 /* clear the rate counts */
812 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
813 info->status.rates[i].count = 0;
816 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
817 memset(&info->status.ampdu_ack_len, 0,
818 sizeof(struct ieee80211_tx_info) -
819 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
824 * enum mac80211_rx_flags - receive flags
826 * These flags are used with the @flag member of &struct ieee80211_rx_status.
827 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
828 * Use together with %RX_FLAG_MMIC_STRIPPED.
829 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
830 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
831 * verification has been done by the hardware.
832 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
833 * If this flag is set, the stack cannot do any replay detection
834 * hence the driver or hardware will have to do that.
835 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
837 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
839 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
840 * field) is valid and contains the time the first symbol of the MPDU
841 * was received. This is useful in monitor mode and for proper IBSS
843 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
844 * field) is valid and contains the time the last symbol of the MPDU
845 * (including FCS) was received.
846 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
847 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
848 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
849 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
850 * @RX_FLAG_SHORT_GI: Short guard interval was used
851 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
852 * Valid only for data frames (mainly A-MPDU)
853 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
854 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
855 * to hw.radiotap_mcs_details to advertise that fact
856 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
857 * number (@ampdu_reference) must be populated and be a distinct number for
859 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
860 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
861 * monitoring purposes only
862 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
863 * subframes of a single A-MPDU
864 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
865 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
867 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
868 * is stored in the @ampdu_delimiter_crc field)
869 * @RX_FLAG_LDPC: LDPC was used
870 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
871 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
872 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
873 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
874 * subframes instead of a one huge frame for performance reasons.
875 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
876 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
877 * the 3rd (last) one must not have this flag set. The flag is used to
878 * deal with retransmission/duplication recovery properly since A-MSDU
879 * subframes share the same sequence number. Reported subframes can be
880 * either regular MSDU or singly A-MSDUs. Subframes must not be
881 * interleaved with other frames.
883 enum mac80211_rx_flags {
884 RX_FLAG_MMIC_ERROR = BIT(0),
885 RX_FLAG_DECRYPTED = BIT(1),
886 RX_FLAG_MMIC_STRIPPED = BIT(3),
887 RX_FLAG_IV_STRIPPED = BIT(4),
888 RX_FLAG_FAILED_FCS_CRC = BIT(5),
889 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
890 RX_FLAG_MACTIME_START = BIT(7),
891 RX_FLAG_SHORTPRE = BIT(8),
893 RX_FLAG_40MHZ = BIT(10),
894 RX_FLAG_SHORT_GI = BIT(11),
895 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
896 RX_FLAG_HT_GF = BIT(13),
897 RX_FLAG_AMPDU_DETAILS = BIT(14),
898 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
899 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
900 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
901 RX_FLAG_AMPDU_IS_LAST = BIT(18),
902 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
903 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
904 RX_FLAG_MACTIME_END = BIT(21),
905 RX_FLAG_VHT = BIT(22),
906 RX_FLAG_LDPC = BIT(23),
907 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
908 RX_FLAG_10MHZ = BIT(28),
909 RX_FLAG_5MHZ = BIT(29),
910 RX_FLAG_AMSDU_MORE = BIT(30),
913 #define RX_FLAG_STBC_SHIFT 26
916 * enum mac80211_rx_vht_flags - receive VHT flags
918 * These flags are used with the @vht_flag member of
919 * &struct ieee80211_rx_status.
920 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
921 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
922 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
923 * @RX_VHT_FLAG_BF: packet was beamformed
925 enum mac80211_rx_vht_flags {
926 RX_VHT_FLAG_80MHZ = BIT(0),
927 RX_VHT_FLAG_80P80MHZ = BIT(1),
928 RX_VHT_FLAG_160MHZ = BIT(2),
929 RX_VHT_FLAG_BF = BIT(3),
933 * struct ieee80211_rx_status - receive status
935 * The low-level driver should provide this information (the subset
936 * supported by hardware) to the 802.11 code with each received
937 * frame, in the skb's control buffer (cb).
939 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
940 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
941 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
942 * it but can store it and pass it back to the driver for synchronisation
943 * @band: the active band when this frame was received
944 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
945 * @signal: signal strength when receiving this frame, either in dBm, in dB or
946 * unspecified depending on the hardware capabilities flags
947 * @IEEE80211_HW_SIGNAL_*
948 * @chains: bitmask of receive chains for which separate signal strength
949 * values were filled.
950 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
951 * support dB or unspecified units)
952 * @antenna: antenna used
953 * @rate_idx: index of data rate into band's supported rates or MCS index if
954 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
955 * @vht_nss: number of streams (VHT only)
957 * @vht_flag: %RX_VHT_FLAG_*
958 * @rx_flags: internal RX flags for mac80211
959 * @ampdu_reference: A-MPDU reference number, must be a different value for
960 * each A-MPDU but the same for each subframe within one A-MPDU
961 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
963 struct ieee80211_rx_status {
965 u32 device_timestamp;
977 s8 chain_signal[IEEE80211_MAX_CHAINS];
978 u8 ampdu_delimiter_crc;
982 * enum ieee80211_conf_flags - configuration flags
984 * Flags to define PHY configuration options
986 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
987 * to determine for example whether to calculate timestamps for packets
988 * or not, do not use instead of filter flags!
989 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
990 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
991 * meaning that the hardware still wakes up for beacons, is able to
992 * transmit frames and receive the possible acknowledgment frames.
993 * Not to be confused with hardware specific wakeup/sleep states,
994 * driver is responsible for that. See the section "Powersave support"
996 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
997 * the driver should be prepared to handle configuration requests but
998 * may turn the device off as much as possible. Typically, this flag will
999 * be set when an interface is set UP but not associated or scanning, but
1000 * it can also be unset in that case when monitor interfaces are active.
1001 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1002 * operating channel.
1004 enum ieee80211_conf_flags {
1005 IEEE80211_CONF_MONITOR = (1<<0),
1006 IEEE80211_CONF_PS = (1<<1),
1007 IEEE80211_CONF_IDLE = (1<<2),
1008 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1013 * enum ieee80211_conf_changed - denotes which configuration changed
1015 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1016 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1017 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1018 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1019 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1020 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1021 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1022 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1023 * Note that this is only valid if channel contexts are not used,
1024 * otherwise each channel context has the number of chains listed.
1026 enum ieee80211_conf_changed {
1027 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1028 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1029 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1030 IEEE80211_CONF_CHANGE_PS = BIT(4),
1031 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1032 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1033 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1034 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1038 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1040 * @IEEE80211_SMPS_AUTOMATIC: automatic
1041 * @IEEE80211_SMPS_OFF: off
1042 * @IEEE80211_SMPS_STATIC: static
1043 * @IEEE80211_SMPS_DYNAMIC: dynamic
1044 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1046 enum ieee80211_smps_mode {
1047 IEEE80211_SMPS_AUTOMATIC,
1049 IEEE80211_SMPS_STATIC,
1050 IEEE80211_SMPS_DYNAMIC,
1053 IEEE80211_SMPS_NUM_MODES,
1057 * struct ieee80211_conf - configuration of the device
1059 * This struct indicates how the driver shall configure the hardware.
1061 * @flags: configuration flags defined above
1063 * @listen_interval: listen interval in units of beacon interval
1064 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1065 * before checking the beacon for a TIM bit (managed mode only); this
1066 * value will be only achievable between DTIM frames, the hardware
1067 * needs to check for the multicast traffic bit in DTIM beacons.
1068 * This variable is valid only when the CONF_PS flag is set.
1069 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1070 * in power saving. Power saving will not be enabled until a beacon
1071 * has been received and the DTIM period is known.
1072 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1073 * powersave documentation below. This variable is valid only when
1074 * the CONF_PS flag is set.
1076 * @power_level: requested transmit power (in dBm), backward compatibility
1077 * value only that is set to the minimum of all interfaces
1079 * @chandef: the channel definition to tune to
1080 * @radar_enabled: whether radar detection is enabled
1082 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1083 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1084 * but actually means the number of transmissions not the number of retries
1085 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1086 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1087 * number of transmissions not the number of retries
1089 * @smps_mode: spatial multiplexing powersave mode; note that
1090 * %IEEE80211_SMPS_STATIC is used when the device is not
1091 * configured for an HT channel.
1092 * Note that this is only valid if channel contexts are not used,
1093 * otherwise each channel context has the number of chains listed.
1095 struct ieee80211_conf {
1097 int power_level, dynamic_ps_timeout;
1098 int max_sleep_period;
1100 u16 listen_interval;
1103 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1105 struct cfg80211_chan_def chandef;
1107 enum ieee80211_smps_mode smps_mode;
1111 * struct ieee80211_channel_switch - holds the channel switch data
1113 * The information provided in this structure is required for channel switch
1116 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1117 * Function (TSF) timer when the frame containing the channel switch
1118 * announcement was received. This is simply the rx.mactime parameter
1119 * the driver passed into mac80211.
1120 * @block_tx: Indicates whether transmission must be blocked before the
1121 * scheduled channel switch, as indicated by the AP.
1122 * @chandef: the new channel to switch to
1123 * @count: the number of TBTT's until the channel switch event
1125 struct ieee80211_channel_switch {
1128 struct cfg80211_chan_def chandef;
1133 * enum ieee80211_vif_flags - virtual interface flags
1135 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1136 * on this virtual interface to avoid unnecessary CPU wakeups
1137 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1138 * monitoring on this virtual interface -- i.e. it can monitor
1139 * connection quality related parameters, such as the RSSI level and
1140 * provide notifications if configured trigger levels are reached.
1142 enum ieee80211_vif_flags {
1143 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1144 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1148 * struct ieee80211_vif - per-interface data
1150 * Data in this structure is continually present for driver
1151 * use during the life of a virtual interface.
1153 * @type: type of this virtual interface
1154 * @bss_conf: BSS configuration for this interface, either our own
1155 * or the BSS we're associated to
1156 * @addr: address of this interface
1157 * @p2p: indicates whether this AP or STA interface is a p2p
1158 * interface, i.e. a GO or p2p-sta respectively
1159 * @csa_active: marks whether a channel switch is going on. Internally it is
1160 * write-protected by sdata_lock and local->mtx so holding either is fine
1162 * @driver_flags: flags/capabilities the driver has for this interface,
1163 * these need to be set (or cleared) when the interface is added
1164 * or, if supported by the driver, the interface type is changed
1165 * at runtime, mac80211 will never touch this field
1166 * @hw_queue: hardware queue for each AC
1167 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1168 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1169 * when it is not assigned. This pointer is RCU-protected due to the TX
1170 * path needing to access it; even though the netdev carrier will always
1171 * be off when it is %NULL there can still be races and packets could be
1172 * processed after it switches back to %NULL.
1173 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1174 * interface debug files. Note that it will be NULL for the virtual
1175 * monitor interface (if that is requested.)
1176 * @drv_priv: data area for driver use, will always be aligned to
1179 struct ieee80211_vif {
1180 enum nl80211_iftype type;
1181 struct ieee80211_bss_conf bss_conf;
1187 u8 hw_queue[IEEE80211_NUM_ACS];
1189 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1193 #ifdef CONFIG_MAC80211_DEBUGFS
1194 struct dentry *debugfs_dir;
1198 u8 drv_priv[0] __aligned(sizeof(void *));
1201 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1203 #ifdef CONFIG_MAC80211_MESH
1204 return vif->type == NL80211_IFTYPE_MESH_POINT;
1210 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1211 * @wdev: the wdev to get the vif for
1213 * This can be used by mac80211 drivers with direct cfg80211 APIs
1214 * (like the vendor commands) that get a wdev.
1216 * Note that this function may return %NULL if the given wdev isn't
1217 * associated with a vif that the driver knows about (e.g. monitor
1218 * or AP_VLAN interfaces.)
1220 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1223 * enum ieee80211_key_flags - key flags
1225 * These flags are used for communication about keys between the driver
1226 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1228 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1229 * driver to indicate that it requires IV generation for this
1230 * particular key. Setting this flag does not necessarily mean that SKBs
1231 * will have sufficient tailroom for ICV or MIC.
1232 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1233 * the driver for a TKIP key if it requires Michael MIC
1234 * generation in software.
1235 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1236 * that the key is pairwise rather then a shared key.
1237 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1238 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1239 * be done in software.
1240 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1241 * if space should be prepared for the IV, but the IV
1242 * itself should not be generated. Do not set together with
1243 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1244 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1246 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1247 * management frames. The flag can help drivers that have a hardware
1248 * crypto implementation that doesn't deal with management frames
1249 * properly by allowing them to not upload the keys to hardware and
1250 * fall back to software crypto. Note that this flag deals only with
1251 * RX, if your crypto engine can't deal with TX you can also set the
1252 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1253 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1254 * driver for a CCMP key to indicate that is requires IV generation
1255 * only for managment frames (MFP).
1257 enum ieee80211_key_flags {
1258 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1259 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1260 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1261 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1262 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1263 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1264 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1268 * struct ieee80211_key_conf - key information
1270 * This key information is given by mac80211 to the driver by
1271 * the set_key() callback in &struct ieee80211_ops.
1273 * @hw_key_idx: To be set by the driver, this is the key index the driver
1274 * wants to be given when a frame is transmitted and needs to be
1275 * encrypted in hardware.
1276 * @cipher: The key's cipher suite selector.
1277 * @flags: key flags, see &enum ieee80211_key_flags.
1278 * @keyidx: the key index (0-3)
1279 * @keylen: key material length
1280 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1282 * - Temporal Encryption Key (128 bits)
1283 * - Temporal Authenticator Tx MIC Key (64 bits)
1284 * - Temporal Authenticator Rx MIC Key (64 bits)
1285 * @icv_len: The ICV length for this key type
1286 * @iv_len: The IV length for this key type
1288 struct ieee80211_key_conf {
1300 * struct ieee80211_cipher_scheme - cipher scheme
1302 * This structure contains a cipher scheme information defining
1303 * the secure packet crypto handling.
1305 * @cipher: a cipher suite selector
1306 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1307 * @hdr_len: a length of a security header used the cipher
1308 * @pn_len: a length of a packet number in the security header
1309 * @pn_off: an offset of pn from the beginning of the security header
1310 * @key_idx_off: an offset of key index byte in the security header
1311 * @key_idx_mask: a bit mask of key_idx bits
1312 * @key_idx_shift: a bit shift needed to get key_idx
1313 * key_idx value calculation:
1314 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1315 * @mic_len: a mic length in bytes
1317 struct ieee80211_cipher_scheme {
1330 * enum set_key_cmd - key command
1332 * Used with the set_key() callback in &struct ieee80211_ops, this
1333 * indicates whether a key is being removed or added.
1335 * @SET_KEY: a key is set
1336 * @DISABLE_KEY: a key must be disabled
1339 SET_KEY, DISABLE_KEY,
1343 * enum ieee80211_sta_state - station state
1345 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1346 * this is a special state for add/remove transitions
1347 * @IEEE80211_STA_NONE: station exists without special state
1348 * @IEEE80211_STA_AUTH: station is authenticated
1349 * @IEEE80211_STA_ASSOC: station is associated
1350 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1352 enum ieee80211_sta_state {
1353 /* NOTE: These need to be ordered correctly! */
1354 IEEE80211_STA_NOTEXIST,
1357 IEEE80211_STA_ASSOC,
1358 IEEE80211_STA_AUTHORIZED,
1362 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1363 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1364 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1365 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1366 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1367 * (including 80+80 MHz)
1369 * Implementation note: 20 must be zero to be initialized
1370 * correctly, the values must be sorted.
1372 enum ieee80211_sta_rx_bandwidth {
1373 IEEE80211_STA_RX_BW_20 = 0,
1374 IEEE80211_STA_RX_BW_40,
1375 IEEE80211_STA_RX_BW_80,
1376 IEEE80211_STA_RX_BW_160,
1380 * struct ieee80211_sta_rates - station rate selection table
1382 * @rcu_head: RCU head used for freeing the table on update
1383 * @rate: transmit rates/flags to be used by default.
1384 * Overriding entries per-packet is possible by using cb tx control.
1386 struct ieee80211_sta_rates {
1387 struct rcu_head rcu_head;
1394 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1398 * struct ieee80211_sta - station table entry
1400 * A station table entry represents a station we are possibly
1401 * communicating with. Since stations are RCU-managed in
1402 * mac80211, any ieee80211_sta pointer you get access to must
1403 * either be protected by rcu_read_lock() explicitly or implicitly,
1404 * or you must take good care to not use such a pointer after a
1405 * call to your sta_remove callback that removed it.
1407 * @addr: MAC address
1408 * @aid: AID we assigned to the station if we're an AP
1409 * @supp_rates: Bitmap of supported rates (per band)
1410 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1411 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1412 * @wme: indicates whether the STA supports QoS/WME.
1413 * @drv_priv: data area for driver use, will always be aligned to
1414 * sizeof(void *), size is determined in hw information.
1415 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1416 * if wme is supported.
1417 * @max_sp: max Service Period. Only valid if wme is supported.
1418 * @bandwidth: current bandwidth the station can receive with
1419 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1420 * station can receive at the moment, changed by operating mode
1421 * notifications and capabilities. The value is only valid after
1422 * the station moves to associated state.
1423 * @smps_mode: current SMPS mode (off, static or dynamic)
1424 * @rates: rate control selection table
1425 * @tdls: indicates whether the STA is a TDLS peer
1427 struct ieee80211_sta {
1428 u32 supp_rates[IEEE80211_NUM_BANDS];
1431 struct ieee80211_sta_ht_cap ht_cap;
1432 struct ieee80211_sta_vht_cap vht_cap;
1437 enum ieee80211_sta_rx_bandwidth bandwidth;
1438 enum ieee80211_smps_mode smps_mode;
1439 struct ieee80211_sta_rates __rcu *rates;
1443 u8 drv_priv[0] __aligned(sizeof(void *));
1447 * enum sta_notify_cmd - sta notify command
1449 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1450 * indicates if an associated station made a power state transition.
1452 * @STA_NOTIFY_SLEEP: a station is now sleeping
1453 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1455 enum sta_notify_cmd {
1456 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1460 * struct ieee80211_tx_control - TX control data
1462 * @sta: station table entry, this sta pointer may be NULL and
1463 * it is not allowed to copy the pointer, due to RCU.
1465 struct ieee80211_tx_control {
1466 struct ieee80211_sta *sta;
1470 * enum ieee80211_hw_flags - hardware flags
1472 * These flags are used to indicate hardware capabilities to
1473 * the stack. Generally, flags here should have their meaning
1474 * done in a way that the simplest hardware doesn't need setting
1475 * any particular flags. There are some exceptions to this rule,
1476 * however, so you are advised to review these flags carefully.
1478 * @IEEE80211_HW_HAS_RATE_CONTROL:
1479 * The hardware or firmware includes rate control, and cannot be
1480 * controlled by the stack. As such, no rate control algorithm
1481 * should be instantiated, and the TX rate reported to userspace
1482 * will be taken from the TX status instead of the rate control
1484 * Note that this requires that the driver implement a number of
1485 * callbacks so it has the correct information, it needs to have
1486 * the @set_rts_threshold callback and must look at the BSS config
1487 * @use_cts_prot for G/N protection, @use_short_slot for slot
1488 * timing in 2.4 GHz and @use_short_preamble for preambles for
1491 * @IEEE80211_HW_RX_INCLUDES_FCS:
1492 * Indicates that received frames passed to the stack include
1493 * the FCS at the end.
1495 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1496 * Some wireless LAN chipsets buffer broadcast/multicast frames
1497 * for power saving stations in the hardware/firmware and others
1498 * rely on the host system for such buffering. This option is used
1499 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1500 * multicast frames when there are power saving stations so that
1501 * the driver can fetch them with ieee80211_get_buffered_bc().
1503 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1504 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1506 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1507 * Hardware is not capable of receiving frames with short preamble on
1510 * @IEEE80211_HW_SIGNAL_UNSPEC:
1511 * Hardware can provide signal values but we don't know its units. We
1512 * expect values between 0 and @max_signal.
1513 * If possible please provide dB or dBm instead.
1515 * @IEEE80211_HW_SIGNAL_DBM:
1516 * Hardware gives signal values in dBm, decibel difference from
1517 * one milliwatt. This is the preferred method since it is standardized
1518 * between different devices. @max_signal does not need to be set.
1520 * @IEEE80211_HW_SPECTRUM_MGMT:
1521 * Hardware supports spectrum management defined in 802.11h
1522 * Measurement, Channel Switch, Quieting, TPC
1524 * @IEEE80211_HW_AMPDU_AGGREGATION:
1525 * Hardware supports 11n A-MPDU aggregation.
1527 * @IEEE80211_HW_SUPPORTS_PS:
1528 * Hardware has power save support (i.e. can go to sleep).
1530 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1531 * Hardware requires nullfunc frame handling in stack, implies
1532 * stack support for dynamic PS.
1534 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1535 * Hardware has support for dynamic PS.
1537 * @IEEE80211_HW_MFP_CAPABLE:
1538 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1540 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1541 * Hardware supports static spatial multiplexing powersave,
1542 * ie. can turn off all but one chain even on HT connections
1543 * that should be using more chains.
1545 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1546 * Hardware supports dynamic spatial multiplexing powersave,
1547 * ie. can turn off all but one chain and then wake the rest
1548 * up as required after, for example, rts/cts handshake.
1550 * @IEEE80211_HW_SUPPORTS_UAPSD:
1551 * Hardware supports Unscheduled Automatic Power Save Delivery
1552 * (U-APSD) in managed mode. The mode is configured with
1553 * conf_tx() operation.
1555 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1556 * Hardware can provide ack status reports of Tx frames to
1559 * @IEEE80211_HW_CONNECTION_MONITOR:
1560 * The hardware performs its own connection monitoring, including
1561 * periodic keep-alives to the AP and probing the AP on beacon loss.
1563 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1564 * This device needs to get data from beacon before association (i.e.
1567 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1568 * per-station GTKs as used by IBSS RSN or during fast transition. If
1569 * the device doesn't support per-station GTKs, but can be asked not
1570 * to decrypt group addressed frames, then IBSS RSN support is still
1571 * possible but software crypto will be used. Advertise the wiphy flag
1572 * only in that case.
1574 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1575 * autonomously manages the PS status of connected stations. When
1576 * this flag is set mac80211 will not trigger PS mode for connected
1577 * stations based on the PM bit of incoming frames.
1578 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1579 * the PS mode of connected stations.
1581 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1582 * setup strictly in HW. mac80211 should not attempt to do this in
1585 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1586 * a virtual monitor interface when monitor interfaces are the only
1587 * active interfaces.
1589 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1590 * queue mapping in order to use different queues (not just one per AC)
1591 * for different virtual interfaces. See the doc section on HW queue
1592 * control for more details.
1594 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1595 * selection table provided by the rate control algorithm.
1597 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1598 * P2P Interface. This will be honoured even if more than one interface
1601 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1602 * only, to allow getting TBTT of a DTIM beacon.
1604 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1605 * and can cope with CCK rates in an aggregation session (e.g. by not
1606 * using aggregation for such frames.)
1608 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1609 * for a single active channel while using channel contexts. When support
1610 * is not enabled the default action is to disconnect when getting the
1613 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1614 * or tailroom of TX skbs without copying them first.
1616 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1617 * in one command, mac80211 doesn't have to run separate scans per band.
1619 enum ieee80211_hw_flags {
1620 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1621 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1622 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1623 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1624 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1625 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1626 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1627 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1628 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1629 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1630 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1631 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1632 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1633 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1634 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1635 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1636 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1637 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1638 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1639 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1640 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1641 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1642 IEEE80211_HW_AP_LINK_PS = 1<<22,
1643 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1644 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1645 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1646 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1647 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1648 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1649 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29,
1650 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
1654 * struct ieee80211_hw - hardware information and state
1656 * This structure contains the configuration and hardware
1657 * information for an 802.11 PHY.
1659 * @wiphy: This points to the &struct wiphy allocated for this
1660 * 802.11 PHY. You must fill in the @perm_addr and @dev
1661 * members of this structure using SET_IEEE80211_DEV()
1662 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1663 * bands (with channels, bitrates) are registered here.
1665 * @conf: &struct ieee80211_conf, device configuration, don't use.
1667 * @priv: pointer to private area that was allocated for driver use
1668 * along with this structure.
1670 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1672 * @extra_tx_headroom: headroom to reserve in each transmit skb
1673 * for use by the driver (e.g. for transmit headers.)
1675 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1676 * Can be used by drivers to add extra IEs.
1678 * @max_signal: Maximum value for signal (rssi) in RX information, used
1679 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1681 * @max_listen_interval: max listen interval in units of beacon interval
1684 * @queues: number of available hardware transmit queues for
1685 * data packets. WMM/QoS requires at least four, these
1686 * queues need to have configurable access parameters.
1688 * @rate_control_algorithm: rate control algorithm for this hardware.
1689 * If unset (NULL), the default algorithm will be used. Must be
1690 * set before calling ieee80211_register_hw().
1692 * @vif_data_size: size (in bytes) of the drv_priv data area
1693 * within &struct ieee80211_vif.
1694 * @sta_data_size: size (in bytes) of the drv_priv data area
1695 * within &struct ieee80211_sta.
1696 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1697 * within &struct ieee80211_chanctx_conf.
1699 * @max_rates: maximum number of alternate rate retry stages the hw
1701 * @max_report_rates: maximum number of alternate rate retry stages
1702 * the hw can report back.
1703 * @max_rate_tries: maximum number of tries for each stage
1705 * @max_rx_aggregation_subframes: maximum buffer size (number of
1706 * sub-frames) to be used for A-MPDU block ack receiver
1708 * This is only relevant if the device has restrictions on the
1709 * number of subframes, if it relies on mac80211 to do reordering
1710 * it shouldn't be set.
1712 * @max_tx_aggregation_subframes: maximum number of subframes in an
1713 * aggregate an HT driver will transmit, used by the peer as a
1714 * hint to size its reorder buffer.
1716 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1717 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1719 * @radiotap_mcs_details: lists which MCS information can the HW
1720 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1721 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1722 * adding _BW is supported today.
1724 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1725 * the default is _GI | _BANDWIDTH.
1726 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1728 * @netdev_features: netdev features to be set in each netdev created
1729 * from this HW. Note only HW checksum features are currently
1730 * compatible with mac80211. Other feature bits will be rejected.
1732 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1733 * for each access category if it is uAPSD trigger-enabled and delivery-
1734 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1735 * Each bit corresponds to different AC. Value '1' in specific bit means
1736 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1739 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1740 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1741 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1743 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1744 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1747 struct ieee80211_hw {
1748 struct ieee80211_conf conf;
1749 struct wiphy *wiphy;
1750 const char *rate_control_algorithm;
1753 unsigned int extra_tx_headroom;
1754 unsigned int extra_beacon_tailroom;
1757 int chanctx_data_size;
1759 u16 max_listen_interval;
1762 u8 max_report_rates;
1764 u8 max_rx_aggregation_subframes;
1765 u8 max_tx_aggregation_subframes;
1766 u8 offchannel_tx_hw_queue;
1767 u8 radiotap_mcs_details;
1768 u16 radiotap_vht_details;
1769 netdev_features_t netdev_features;
1771 u8 uapsd_max_sp_len;
1772 u8 n_cipher_schemes;
1773 const struct ieee80211_cipher_scheme *cipher_schemes;
1777 * struct ieee80211_scan_request - hw scan request
1779 * @ies: pointers different parts of IEs (in req.ie)
1780 * @req: cfg80211 request.
1782 struct ieee80211_scan_request {
1783 struct ieee80211_scan_ies ies;
1786 struct cfg80211_scan_request req;
1790 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1792 * @wiphy: the &struct wiphy which we want to query
1794 * mac80211 drivers can use this to get to their respective
1795 * &struct ieee80211_hw. Drivers wishing to get to their own private
1796 * structure can then access it via hw->priv. Note that mac802111 drivers should
1797 * not use wiphy_priv() to try to get their private driver structure as this
1798 * is already used internally by mac80211.
1800 * Return: The mac80211 driver hw struct of @wiphy.
1802 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1805 * SET_IEEE80211_DEV - set device for 802.11 hardware
1807 * @hw: the &struct ieee80211_hw to set the device for
1808 * @dev: the &struct device of this 802.11 device
1810 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1812 set_wiphy_dev(hw->wiphy, dev);
1816 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1818 * @hw: the &struct ieee80211_hw to set the MAC address for
1819 * @addr: the address to set
1821 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1823 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1826 static inline struct ieee80211_rate *
1827 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1828 const struct ieee80211_tx_info *c)
1830 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1832 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1835 static inline struct ieee80211_rate *
1836 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1837 const struct ieee80211_tx_info *c)
1839 if (c->control.rts_cts_rate_idx < 0)
1841 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1844 static inline struct ieee80211_rate *
1845 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1846 const struct ieee80211_tx_info *c, int idx)
1848 if (c->control.rates[idx + 1].idx < 0)
1850 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1854 * ieee80211_free_txskb - free TX skb
1858 * Free a transmit skb. Use this funtion when some failure
1859 * to transmit happened and thus status cannot be reported.
1861 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1864 * DOC: Hardware crypto acceleration
1866 * mac80211 is capable of taking advantage of many hardware
1867 * acceleration designs for encryption and decryption operations.
1869 * The set_key() callback in the &struct ieee80211_ops for a given
1870 * device is called to enable hardware acceleration of encryption and
1871 * decryption. The callback takes a @sta parameter that will be NULL
1872 * for default keys or keys used for transmission only, or point to
1873 * the station information for the peer for individual keys.
1874 * Multiple transmission keys with the same key index may be used when
1875 * VLANs are configured for an access point.
1877 * When transmitting, the TX control data will use the @hw_key_idx
1878 * selected by the driver by modifying the &struct ieee80211_key_conf
1879 * pointed to by the @key parameter to the set_key() function.
1881 * The set_key() call for the %SET_KEY command should return 0 if
1882 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1883 * added; if you return 0 then hw_key_idx must be assigned to the
1884 * hardware key index, you are free to use the full u8 range.
1886 * When the cmd is %DISABLE_KEY then it must succeed.
1888 * Note that it is permissible to not decrypt a frame even if a key
1889 * for it has been uploaded to hardware, the stack will not make any
1890 * decision based on whether a key has been uploaded or not but rather
1891 * based on the receive flags.
1893 * The &struct ieee80211_key_conf structure pointed to by the @key
1894 * parameter is guaranteed to be valid until another call to set_key()
1895 * removes it, but it can only be used as a cookie to differentiate
1898 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1899 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1901 * The update_tkip_key() call updates the driver with the new phase 1 key.
1902 * This happens every time the iv16 wraps around (every 65536 packets). The
1903 * set_key() call will happen only once for each key (unless the AP did
1904 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1905 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1906 * handler is software decryption with wrap around of iv16.
1908 * The set_default_unicast_key() call updates the default WEP key index
1909 * configured to the hardware for WEP encryption type. This is required
1910 * for devices that support offload of data packets (e.g. ARP responses).
1914 * DOC: Powersave support
1916 * mac80211 has support for various powersave implementations.
1918 * First, it can support hardware that handles all powersaving by itself,
1919 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1920 * flag. In that case, it will be told about the desired powersave mode
1921 * with the %IEEE80211_CONF_PS flag depending on the association status.
1922 * The hardware must take care of sending nullfunc frames when necessary,
1923 * i.e. when entering and leaving powersave mode. The hardware is required
1924 * to look at the AID in beacons and signal to the AP that it woke up when
1925 * it finds traffic directed to it.
1927 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1928 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1929 * with hardware wakeup and sleep states. Driver is responsible for waking
1930 * up the hardware before issuing commands to the hardware and putting it
1931 * back to sleep at appropriate times.
1933 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1934 * buffered multicast/broadcast frames after the beacon. Also it must be
1935 * possible to send frames and receive the acknowledment frame.
1937 * Other hardware designs cannot send nullfunc frames by themselves and also
1938 * need software support for parsing the TIM bitmap. This is also supported
1939 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1940 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1941 * required to pass up beacons. The hardware is still required to handle
1942 * waking up for multicast traffic; if it cannot the driver must handle that
1943 * as best as it can, mac80211 is too slow to do that.
1945 * Dynamic powersave is an extension to normal powersave in which the
1946 * hardware stays awake for a user-specified period of time after sending a
1947 * frame so that reply frames need not be buffered and therefore delayed to
1948 * the next wakeup. It's compromise of getting good enough latency when
1949 * there's data traffic and still saving significantly power in idle
1952 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1953 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1954 * flag and mac80211 will handle everything automatically. Additionally,
1955 * hardware having support for the dynamic PS feature may set the
1956 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1957 * dynamic PS mode itself. The driver needs to look at the
1958 * @dynamic_ps_timeout hardware configuration value and use it that value
1959 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1960 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1961 * enabled whenever user has enabled powersave.
1963 * Driver informs U-APSD client support by enabling
1964 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1965 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
1966 * Nullfunc frames and stay awake until the service period has ended. To
1967 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1968 * from that AC are transmitted with powersave enabled.
1970 * Note: U-APSD client mode is not yet supported with
1971 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1975 * DOC: Beacon filter support
1977 * Some hardware have beacon filter support to reduce host cpu wakeups
1978 * which will reduce system power consumption. It usually works so that
1979 * the firmware creates a checksum of the beacon but omits all constantly
1980 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1981 * beacon is forwarded to the host, otherwise it will be just dropped. That
1982 * way the host will only receive beacons where some relevant information
1983 * (for example ERP protection or WMM settings) have changed.
1985 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1986 * interface capability. The driver needs to enable beacon filter support
1987 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1988 * power save is enabled, the stack will not check for beacon loss and the
1989 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1991 * The time (or number of beacons missed) until the firmware notifies the
1992 * driver of a beacon loss event (which in turn causes the driver to call
1993 * ieee80211_beacon_loss()) should be configurable and will be controlled
1994 * by mac80211 and the roaming algorithm in the future.
1996 * Since there may be constantly changing information elements that nothing
1997 * in the software stack cares about, we will, in the future, have mac80211
1998 * tell the driver which information elements are interesting in the sense
1999 * that we want to see changes in them. This will include
2000 * - a list of information element IDs
2001 * - a list of OUIs for the vendor information element
2003 * Ideally, the hardware would filter out any beacons without changes in the
2004 * requested elements, but if it cannot support that it may, at the expense
2005 * of some efficiency, filter out only a subset. For example, if the device
2006 * doesn't support checking for OUIs it should pass up all changes in all
2007 * vendor information elements.
2009 * Note that change, for the sake of simplification, also includes information
2010 * elements appearing or disappearing from the beacon.
2012 * Some hardware supports an "ignore list" instead, just make sure nothing
2013 * that was requested is on the ignore list, and include commonly changing
2014 * information element IDs in the ignore list, for example 11 (BSS load) and
2015 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2016 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2017 * it could also include some currently unused IDs.
2020 * In addition to these capabilities, hardware should support notifying the
2021 * host of changes in the beacon RSSI. This is relevant to implement roaming
2022 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2023 * the received data packets). This can consist in notifying the host when
2024 * the RSSI changes significantly or when it drops below or rises above
2025 * configurable thresholds. In the future these thresholds will also be
2026 * configured by mac80211 (which gets them from userspace) to implement
2027 * them as the roaming algorithm requires.
2029 * If the hardware cannot implement this, the driver should ask it to
2030 * periodically pass beacon frames to the host so that software can do the
2031 * signal strength threshold checking.
2035 * DOC: Spatial multiplexing power save
2037 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2038 * power in an 802.11n implementation. For details on the mechanism
2039 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2040 * "11.2.3 SM power save".
2042 * The mac80211 implementation is capable of sending action frames
2043 * to update the AP about the station's SMPS mode, and will instruct
2044 * the driver to enter the specific mode. It will also announce the
2045 * requested SMPS mode during the association handshake. Hardware
2046 * support for this feature is required, and can be indicated by
2049 * The default mode will be "automatic", which nl80211/cfg80211
2050 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2051 * turned off otherwise.
2053 * To support this feature, the driver must set the appropriate
2054 * hardware support flags, and handle the SMPS flag to the config()
2055 * operation. It will then with this mechanism be instructed to
2056 * enter the requested SMPS mode while associated to an HT AP.
2060 * DOC: Frame filtering
2062 * mac80211 requires to see many management frames for proper
2063 * operation, and users may want to see many more frames when
2064 * in monitor mode. However, for best CPU usage and power consumption,
2065 * having as few frames as possible percolate through the stack is
2066 * desirable. Hence, the hardware should filter as much as possible.
2068 * To achieve this, mac80211 uses filter flags (see below) to tell
2069 * the driver's configure_filter() function which frames should be
2070 * passed to mac80211 and which should be filtered out.
2072 * Before configure_filter() is invoked, the prepare_multicast()
2073 * callback is invoked with the parameters @mc_count and @mc_list
2074 * for the combined multicast address list of all virtual interfaces.
2075 * It's use is optional, and it returns a u64 that is passed to
2076 * configure_filter(). Additionally, configure_filter() has the
2077 * arguments @changed_flags telling which flags were changed and
2078 * @total_flags with the new flag states.
2080 * If your device has no multicast address filters your driver will
2081 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2082 * parameter to see whether multicast frames should be accepted
2085 * All unsupported flags in @total_flags must be cleared.
2086 * Hardware does not support a flag if it is incapable of _passing_
2087 * the frame to the stack. Otherwise the driver must ignore
2088 * the flag, but not clear it.
2089 * You must _only_ clear the flag (announce no support for the
2090 * flag to mac80211) if you are not able to pass the packet type
2091 * to the stack (so the hardware always filters it).
2092 * So for example, you should clear @FIF_CONTROL, if your hardware
2093 * always filters control frames. If your hardware always passes
2094 * control frames to the kernel and is incapable of filtering them,
2095 * you do _not_ clear the @FIF_CONTROL flag.
2096 * This rule applies to all other FIF flags as well.
2100 * DOC: AP support for powersaving clients
2102 * In order to implement AP and P2P GO modes, mac80211 has support for
2103 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2104 * There currently is no support for sAPSD.
2106 * There is one assumption that mac80211 makes, namely that a client
2107 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2108 * Both are supported, and both can be used by the same client, but
2109 * they can't be used concurrently by the same client. This simplifies
2112 * The first thing to keep in mind is that there is a flag for complete
2113 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2114 * mac80211 expects the driver to handle most of the state machine for
2115 * powersaving clients and will ignore the PM bit in incoming frames.
2116 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2117 * stations' powersave transitions. In this mode, mac80211 also doesn't
2118 * handle PS-Poll/uAPSD.
2120 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2121 * PM bit in incoming frames for client powersave transitions. When a
2122 * station goes to sleep, we will stop transmitting to it. There is,
2123 * however, a race condition: a station might go to sleep while there is
2124 * data buffered on hardware queues. If the device has support for this
2125 * it will reject frames, and the driver should give the frames back to
2126 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2127 * cause mac80211 to retry the frame when the station wakes up. The
2128 * driver is also notified of powersave transitions by calling its
2129 * @sta_notify callback.
2131 * When the station is asleep, it has three choices: it can wake up,
2132 * it can PS-Poll, or it can possibly start a uAPSD service period.
2133 * Waking up is implemented by simply transmitting all buffered (and
2134 * filtered) frames to the station. This is the easiest case. When
2135 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2136 * will inform the driver of this with the @allow_buffered_frames
2137 * callback; this callback is optional. mac80211 will then transmit
2138 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2139 * on each frame. The last frame in the service period (or the only
2140 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2141 * indicate that it ends the service period; as this frame must have
2142 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2143 * When TX status is reported for this frame, the service period is
2144 * marked has having ended and a new one can be started by the peer.
2146 * Additionally, non-bufferable MMPDUs can also be transmitted by
2147 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2149 * Another race condition can happen on some devices like iwlwifi
2150 * when there are frames queued for the station and it wakes up
2151 * or polls; the frames that are already queued could end up being
2152 * transmitted first instead, causing reordering and/or wrong
2153 * processing of the EOSP. The cause is that allowing frames to be
2154 * transmitted to a certain station is out-of-band communication to
2155 * the device. To allow this problem to be solved, the driver can
2156 * call ieee80211_sta_block_awake() if frames are buffered when it
2157 * is notified that the station went to sleep. When all these frames
2158 * have been filtered (see above), it must call the function again
2159 * to indicate that the station is no longer blocked.
2161 * If the driver buffers frames in the driver for aggregation in any
2162 * way, it must use the ieee80211_sta_set_buffered() call when it is
2163 * notified of the station going to sleep to inform mac80211 of any
2164 * TIDs that have frames buffered. Note that when a station wakes up
2165 * this information is reset (hence the requirement to call it when
2166 * informed of the station going to sleep). Then, when a service
2167 * period starts for any reason, @release_buffered_frames is called
2168 * with the number of frames to be released and which TIDs they are
2169 * to come from. In this case, the driver is responsible for setting
2170 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2171 * to help the @more_data parameter is passed to tell the driver if
2172 * there is more data on other TIDs -- the TIDs to release frames
2173 * from are ignored since mac80211 doesn't know how many frames the
2174 * buffers for those TIDs contain.
2176 * If the driver also implement GO mode, where absence periods may
2177 * shorten service periods (or abort PS-Poll responses), it must
2178 * filter those response frames except in the case of frames that
2179 * are buffered in the driver -- those must remain buffered to avoid
2180 * reordering. Because it is possible that no frames are released
2181 * in this case, the driver must call ieee80211_sta_eosp()
2182 * to indicate to mac80211 that the service period ended anyway.
2184 * Finally, if frames from multiple TIDs are released from mac80211
2185 * but the driver might reorder them, it must clear & set the flags
2186 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2187 * and also take care of the EOSP and MORE_DATA bits in the frame.
2188 * The driver may also use ieee80211_sta_eosp() in this case.
2190 * Note that if the driver ever buffers frames other than QoS-data
2191 * frames, it must take care to never send a non-QoS-data frame as
2192 * the last frame in a service period, adding a QoS-nulldata frame
2193 * after a non-QoS-data frame if needed.
2197 * DOC: HW queue control
2199 * Before HW queue control was introduced, mac80211 only had a single static
2200 * assignment of per-interface AC software queues to hardware queues. This
2201 * was problematic for a few reasons:
2202 * 1) off-channel transmissions might get stuck behind other frames
2203 * 2) multiple virtual interfaces couldn't be handled correctly
2204 * 3) after-DTIM frames could get stuck behind other frames
2206 * To solve this, hardware typically uses multiple different queues for all
2207 * the different usages, and this needs to be propagated into mac80211 so it
2208 * won't have the same problem with the software queues.
2210 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2211 * flag that tells it that the driver implements its own queue control. To do
2212 * so, the driver will set up the various queues in each &struct ieee80211_vif
2213 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2214 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2215 * if necessary will queue the frame on the right software queue that mirrors
2216 * the hardware queue.
2217 * Additionally, the driver has to then use these HW queue IDs for the queue
2218 * management functions (ieee80211_stop_queue() et al.)
2220 * The driver is free to set up the queue mappings as needed, multiple virtual
2221 * interfaces may map to the same hardware queues if needed. The setup has to
2222 * happen during add_interface or change_interface callbacks. For example, a
2223 * driver supporting station+station and station+AP modes might decide to have
2224 * 10 hardware queues to handle different scenarios:
2226 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2227 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2228 * after-DTIM queue for AP: 8
2229 * off-channel queue: 9
2231 * It would then set up the hardware like this:
2232 * hw.offchannel_tx_hw_queue = 9
2234 * and the first virtual interface that is added as follows:
2235 * vif.hw_queue[IEEE80211_AC_VO] = 0
2236 * vif.hw_queue[IEEE80211_AC_VI] = 1
2237 * vif.hw_queue[IEEE80211_AC_BE] = 2
2238 * vif.hw_queue[IEEE80211_AC_BK] = 3
2239 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2240 * and the second virtual interface with 4-7.
2242 * If queue 6 gets full, for example, mac80211 would only stop the second
2243 * virtual interface's BE queue since virtual interface queues are per AC.
2245 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2246 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2247 * queue could potentially be shared since mac80211 will look at cab_queue when
2248 * a queue is stopped/woken even if the interface is not in AP mode.
2252 * enum ieee80211_filter_flags - hardware filter flags
2254 * These flags determine what the filter in hardware should be
2255 * programmed to let through and what should not be passed to the
2256 * stack. It is always safe to pass more frames than requested,
2257 * but this has negative impact on power consumption.
2259 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2260 * think of the BSS as your network segment and then this corresponds
2261 * to the regular ethernet device promiscuous mode.
2263 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2264 * by the user or if the hardware is not capable of filtering by
2265 * multicast address.
2267 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2268 * %RX_FLAG_FAILED_FCS_CRC for them)
2270 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2271 * the %RX_FLAG_FAILED_PLCP_CRC for them
2273 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2274 * to the hardware that it should not filter beacons or probe responses
2275 * by BSSID. Filtering them can greatly reduce the amount of processing
2276 * mac80211 needs to do and the amount of CPU wakeups, so you should
2277 * honour this flag if possible.
2279 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2280 * is not set then only those addressed to this station.
2282 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2284 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2285 * those addressed to this station.
2287 * @FIF_PROBE_REQ: pass probe request frames
2289 enum ieee80211_filter_flags {
2290 FIF_PROMISC_IN_BSS = 1<<0,
2291 FIF_ALLMULTI = 1<<1,
2293 FIF_PLCPFAIL = 1<<3,
2294 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2296 FIF_OTHER_BSS = 1<<6,
2298 FIF_PROBE_REQ = 1<<8,
2302 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2304 * These flags are used with the ampdu_action() callback in
2305 * &struct ieee80211_ops to indicate which action is needed.
2307 * Note that drivers MUST be able to deal with a TX aggregation
2308 * session being stopped even before they OK'ed starting it by
2309 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2310 * might receive the addBA frame and send a delBA right away!
2312 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2313 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2314 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2315 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2316 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2317 * queued packets, now unaggregated. After all packets are transmitted the
2318 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2319 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2320 * called when the station is removed. There's no need or reason to call
2321 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2322 * session is gone and removes the station.
2323 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2324 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2325 * now the connection is dropped and the station will be removed. Drivers
2326 * should clean up and drop remaining packets when this is called.
2328 enum ieee80211_ampdu_mlme_action {
2329 IEEE80211_AMPDU_RX_START,
2330 IEEE80211_AMPDU_RX_STOP,
2331 IEEE80211_AMPDU_TX_START,
2332 IEEE80211_AMPDU_TX_STOP_CONT,
2333 IEEE80211_AMPDU_TX_STOP_FLUSH,
2334 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2335 IEEE80211_AMPDU_TX_OPERATIONAL,
2339 * enum ieee80211_frame_release_type - frame release reason
2340 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2341 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2342 * frame received on trigger-enabled AC
2344 enum ieee80211_frame_release_type {
2345 IEEE80211_FRAME_RELEASE_PSPOLL,
2346 IEEE80211_FRAME_RELEASE_UAPSD,
2350 * enum ieee80211_rate_control_changed - flags to indicate what changed
2352 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2353 * to this station changed. The actual bandwidth is in the station
2354 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2355 * flag changes, for HT and VHT the bandwidth field changes.
2356 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2357 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2358 * changed (in IBSS mode) due to discovering more information about
2360 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2363 enum ieee80211_rate_control_changed {
2364 IEEE80211_RC_BW_CHANGED = BIT(0),
2365 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2366 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2367 IEEE80211_RC_NSS_CHANGED = BIT(3),
2371 * enum ieee80211_roc_type - remain on channel type
2373 * With the support for multi channel contexts and multi channel operations,
2374 * remain on channel operations might be limited/deferred/aborted by other
2375 * flows/operations which have higher priority (and vise versa).
2376 * Specifying the ROC type can be used by devices to prioritize the ROC
2377 * operations compared to other operations/flows.
2379 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2380 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2381 * for sending managment frames offchannel.
2383 enum ieee80211_roc_type {
2384 IEEE80211_ROC_TYPE_NORMAL = 0,
2385 IEEE80211_ROC_TYPE_MGMT_TX,
2389 * struct ieee80211_ops - callbacks from mac80211 to the driver
2391 * This structure contains various callbacks that the driver may
2392 * handle or, in some cases, must handle, for example to configure
2393 * the hardware to a new channel or to transmit a frame.
2395 * @tx: Handler that 802.11 module calls for each transmitted frame.
2396 * skb contains the buffer starting from the IEEE 802.11 header.
2397 * The low-level driver should send the frame out based on
2398 * configuration in the TX control data. This handler should,
2399 * preferably, never fail and stop queues appropriately.
2402 * @start: Called before the first netdevice attached to the hardware
2403 * is enabled. This should turn on the hardware and must turn on
2404 * frame reception (for possibly enabled monitor interfaces.)
2405 * Returns negative error codes, these may be seen in userspace,
2407 * When the device is started it should not have a MAC address
2408 * to avoid acknowledging frames before a non-monitor device
2410 * Must be implemented and can sleep.
2412 * @stop: Called after last netdevice attached to the hardware
2413 * is disabled. This should turn off the hardware (at least
2414 * it must turn off frame reception.)
2415 * May be called right after add_interface if that rejects
2416 * an interface. If you added any work onto the mac80211 workqueue
2417 * you should ensure to cancel it on this callback.
2418 * Must be implemented and can sleep.
2420 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2421 * stop transmitting and doing any other configuration, and then
2422 * ask the device to suspend. This is only invoked when WoWLAN is
2423 * configured, otherwise the device is deconfigured completely and
2424 * reconfigured at resume time.
2425 * The driver may also impose special conditions under which it
2426 * wants to use the "normal" suspend (deconfigure), say if it only
2427 * supports WoWLAN when the device is associated. In this case, it
2428 * must return 1 from this function.
2430 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2431 * now resuming its operation, after this the device must be fully
2432 * functional again. If this returns an error, the only way out is
2433 * to also unregister the device. If it returns 1, then mac80211
2434 * will also go through the regular complete restart on resume.
2436 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2437 * modified. The reason is that device_set_wakeup_enable() is
2438 * supposed to be called when the configuration changes, not only
2441 * @add_interface: Called when a netdevice attached to the hardware is
2442 * enabled. Because it is not called for monitor mode devices, @start
2443 * and @stop must be implemented.
2444 * The driver should perform any initialization it needs before
2445 * the device can be enabled. The initial configuration for the
2446 * interface is given in the conf parameter.
2447 * The callback may refuse to add an interface by returning a
2448 * negative error code (which will be seen in userspace.)
2449 * Must be implemented and can sleep.
2451 * @change_interface: Called when a netdevice changes type. This callback
2452 * is optional, but only if it is supported can interface types be
2453 * switched while the interface is UP. The callback may sleep.
2454 * Note that while an interface is being switched, it will not be
2455 * found by the interface iteration callbacks.
2457 * @remove_interface: Notifies a driver that an interface is going down.
2458 * The @stop callback is called after this if it is the last interface
2459 * and no monitor interfaces are present.
2460 * When all interfaces are removed, the MAC address in the hardware
2461 * must be cleared so the device no longer acknowledges packets,
2462 * the mac_addr member of the conf structure is, however, set to the
2463 * MAC address of the device going away.
2464 * Hence, this callback must be implemented. It can sleep.
2466 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2467 * function to change hardware configuration, e.g., channel.
2468 * This function should never fail but returns a negative error code
2469 * if it does. The callback can sleep.
2471 * @bss_info_changed: Handler for configuration requests related to BSS
2472 * parameters that may vary during BSS's lifespan, and may affect low
2473 * level driver (e.g. assoc/disassoc status, erp parameters).
2474 * This function should not be used if no BSS has been set, unless
2475 * for association indication. The @changed parameter indicates which
2476 * of the bss parameters has changed when a call is made. The callback
2479 * @prepare_multicast: Prepare for multicast filter configuration.
2480 * This callback is optional, and its return value is passed
2481 * to configure_filter(). This callback must be atomic.
2483 * @configure_filter: Configure the device's RX filter.
2484 * See the section "Frame filtering" for more information.
2485 * This callback must be implemented and can sleep.
2487 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2488 * must be set or cleared for a given STA. Must be atomic.
2490 * @set_key: See the section "Hardware crypto acceleration"
2491 * This callback is only called between add_interface and
2492 * remove_interface calls, i.e. while the given virtual interface
2494 * Returns a negative error code if the key can't be added.
2495 * The callback can sleep.
2497 * @update_tkip_key: See the section "Hardware crypto acceleration"
2498 * This callback will be called in the context of Rx. Called for drivers
2499 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2500 * The callback must be atomic.
2502 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2503 * host is suspended, it can assign this callback to retrieve the data
2504 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2505 * After rekeying was done it should (for example during resume) notify
2506 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2508 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2509 * WEP when the device sends data packets autonomously, e.g. for ARP
2510 * offloading. The index can be 0-3, or -1 for unsetting it.
2512 * @hw_scan: Ask the hardware to service the scan request, no need to start
2513 * the scan state machine in stack. The scan must honour the channel
2514 * configuration done by the regulatory agent in the wiphy's
2515 * registered bands. The hardware (or the driver) needs to make sure
2516 * that power save is disabled.
2517 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2518 * entire IEs after the SSID, so that drivers need not look at these
2519 * at all but just send them after the SSID -- mac80211 includes the
2520 * (extended) supported rates and HT information (where applicable).
2521 * When the scan finishes, ieee80211_scan_completed() must be called;
2522 * note that it also must be called when the scan cannot finish due to
2523 * any error unless this callback returned a negative error code.
2524 * The callback can sleep.
2526 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2527 * The driver should ask the hardware to cancel the scan (if possible),
2528 * but the scan will be completed only after the driver will call
2529 * ieee80211_scan_completed().
2530 * This callback is needed for wowlan, to prevent enqueueing a new
2531 * scan_work after the low-level driver was already suspended.
2532 * The callback can sleep.
2534 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2535 * specific intervals. The driver must call the
2536 * ieee80211_sched_scan_results() function whenever it finds results.
2537 * This process will continue until sched_scan_stop is called.
2539 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2540 * In this case, ieee80211_sched_scan_stopped() must not be called.
2542 * @sw_scan_start: Notifier function that is called just before a software scan
2543 * is started. Can be NULL, if the driver doesn't need this notification.
2544 * The callback can sleep.
2546 * @sw_scan_complete: Notifier function that is called just after a
2547 * software scan finished. Can be NULL, if the driver doesn't need
2548 * this notification.
2549 * The callback can sleep.
2551 * @get_stats: Return low-level statistics.
2552 * Returns zero if statistics are available.
2553 * The callback can sleep.
2555 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2556 * callback should be provided to read the TKIP transmit IVs (both IV32
2557 * and IV16) for the given key from hardware.
2558 * The callback must be atomic.
2560 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2561 * if the device does fragmentation by itself; if this callback is
2562 * implemented then the stack will not do fragmentation.
2563 * The callback can sleep.
2565 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2566 * The callback can sleep.
2568 * @sta_add: Notifies low level driver about addition of an associated station,
2569 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2571 * @sta_remove: Notifies low level driver about removal of an associated
2572 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2573 * returns it isn't safe to use the pointer, not even RCU protected;
2574 * no RCU grace period is guaranteed between returning here and freeing
2575 * the station. See @sta_pre_rcu_remove if needed.
2576 * This callback can sleep.
2578 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2579 * when a station is added to mac80211's station list. This callback
2580 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2581 * conditional. This callback can sleep.
2583 * @sta_remove_debugfs: Remove the debugfs files which were added using
2584 * @sta_add_debugfs. This callback can sleep.
2586 * @sta_notify: Notifies low level driver about power state transition of an
2587 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2588 * in AP mode, this callback will not be called when the flag
2589 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2591 * @sta_state: Notifies low level driver about state transition of a
2592 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2593 * This callback is mutually exclusive with @sta_add/@sta_remove.
2594 * It must not fail for down transitions but may fail for transitions
2595 * up the list of states. Also note that after the callback returns it
2596 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2597 * period is guaranteed between returning here and freeing the station.
2598 * See @sta_pre_rcu_remove if needed.
2599 * The callback can sleep.
2601 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2602 * synchronisation. This is useful if a driver needs to have station
2603 * pointers protected using RCU, it can then use this call to clear
2604 * the pointers instead of waiting for an RCU grace period to elapse
2606 * The callback can sleep.
2608 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2609 * used to transmit to the station. The changes are advertised with bits
2610 * from &enum ieee80211_rate_control_changed and the values are reflected
2611 * in the station data. This callback should only be used when the driver
2612 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2613 * otherwise the rate control algorithm is notified directly.
2616 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2617 * bursting) for a hardware TX queue.
2618 * Returns a negative error code on failure.
2619 * The callback can sleep.
2621 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2622 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2623 * required function.
2624 * The callback can sleep.
2626 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2627 * Currently, this is only used for IBSS mode debugging. Is not a
2628 * required function.
2629 * The callback can sleep.
2631 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2632 * with other STAs in the IBSS. This is only used in IBSS mode. This
2633 * function is optional if the firmware/hardware takes full care of
2634 * TSF synchronization.
2635 * The callback can sleep.
2637 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2638 * This is needed only for IBSS mode and the result of this function is
2639 * used to determine whether to reply to Probe Requests.
2640 * Returns non-zero if this device sent the last beacon.
2641 * The callback can sleep.
2643 * @ampdu_action: Perform a certain A-MPDU action
2644 * The RA/TID combination determines the destination and TID we want
2645 * the ampdu action to be performed for. The action is defined through
2646 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2647 * is the first frame we expect to perform the action on. Notice
2648 * that TX/RX_STOP can pass NULL for this parameter.
2649 * The @buf_size parameter is only valid when the action is set to
2650 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2651 * buffer size (number of subframes) for this session -- the driver
2652 * may neither send aggregates containing more subframes than this
2653 * nor send aggregates in a way that lost frames would exceed the
2654 * buffer size. If just limiting the aggregate size, this would be
2655 * possible with a buf_size of 8:
2657 * - RX: 2....7 (lost frame #1)
2659 * which is invalid since #1 was now re-transmitted well past the
2660 * buffer size of 8. Correct ways to retransmit #1 would be:
2661 * - TX: 1 or 18 or 81
2662 * Even "189" would be wrong since 1 could be lost again.
2664 * Returns a negative error code on failure.
2665 * The callback can sleep.
2667 * @get_survey: Return per-channel survey information
2669 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2670 * need to set wiphy->rfkill_poll to %true before registration,
2671 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2672 * The callback can sleep.
2674 * @set_coverage_class: Set slot time for given coverage class as specified
2675 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2676 * accordingly. This callback is not required and may sleep.
2678 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2679 * be %NULL. The callback can sleep.
2680 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2682 * @flush: Flush all pending frames from the hardware queue, making sure
2683 * that the hardware queues are empty. The @queues parameter is a bitmap
2684 * of queues to flush, which is useful if different virtual interfaces
2685 * use different hardware queues; it may also indicate all queues.
2686 * If the parameter @drop is set to %true, pending frames may be dropped.
2687 * Note that vif can be NULL.
2688 * The callback can sleep.
2690 * @channel_switch: Drivers that need (or want) to offload the channel
2691 * switch operation for CSAs received from the AP may implement this
2692 * callback. They must then call ieee80211_chswitch_done() to indicate
2693 * completion of the channel switch.
2695 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2696 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2697 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2698 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2700 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2702 * @remain_on_channel: Starts an off-channel period on the given channel, must
2703 * call back to ieee80211_ready_on_channel() when on that channel. Note
2704 * that normal channel traffic is not stopped as this is intended for hw
2705 * offload. Frames to transmit on the off-channel channel are transmitted
2706 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2707 * duration (which will always be non-zero) expires, the driver must call
2708 * ieee80211_remain_on_channel_expired().
2709 * Note that this callback may be called while the device is in IDLE and
2710 * must be accepted in this case.
2711 * This callback may sleep.
2712 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2713 * aborted before it expires. This callback may sleep.
2715 * @set_ringparam: Set tx and rx ring sizes.
2717 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2719 * @tx_frames_pending: Check if there is any pending frame in the hardware
2720 * queues before entering power save.
2722 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2723 * when transmitting a frame. Currently only legacy rates are handled.
2724 * The callback can sleep.
2725 * @rssi_callback: Notify driver when the average RSSI goes above/below
2726 * thresholds that were registered previously. The callback can sleep.
2728 * @release_buffered_frames: Release buffered frames according to the given
2729 * parameters. In the case where the driver buffers some frames for
2730 * sleeping stations mac80211 will use this callback to tell the driver
2731 * to release some frames, either for PS-poll or uAPSD.
2732 * Note that if the @more_data parameter is %false the driver must check
2733 * if there are more frames on the given TIDs, and if there are more than
2734 * the frames being released then it must still set the more-data bit in
2735 * the frame. If the @more_data parameter is %true, then of course the
2736 * more-data bit must always be set.
2737 * The @tids parameter tells the driver which TIDs to release frames
2738 * from, for PS-poll it will always have only a single bit set.
2739 * In the case this is used for a PS-poll initiated release, the
2740 * @num_frames parameter will always be 1 so code can be shared. In
2741 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2742 * on the TX status (and must report TX status) so that the PS-poll
2743 * period is properly ended. This is used to avoid sending multiple
2744 * responses for a retried PS-poll frame.
2745 * In the case this is used for uAPSD, the @num_frames parameter may be
2746 * bigger than one, but the driver may send fewer frames (it must send
2747 * at least one, however). In this case it is also responsible for
2748 * setting the EOSP flag in the QoS header of the frames. Also, when the
2749 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2750 * on the last frame in the SP. Alternatively, it may call the function
2751 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2752 * This callback must be atomic.
2753 * @allow_buffered_frames: Prepare device to allow the given number of frames
2754 * to go out to the given station. The frames will be sent by mac80211
2755 * via the usual TX path after this call. The TX information for frames
2756 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2757 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2758 * frames from multiple TIDs are released and the driver might reorder
2759 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2760 * on the last frame and clear it on all others and also handle the EOSP
2761 * bit in the QoS header correctly. Alternatively, it can also call the
2762 * ieee80211_sta_eosp() function.
2763 * The @tids parameter is a bitmap and tells the driver which TIDs the
2764 * frames will be on; it will at most have two bits set.
2765 * This callback must be atomic.
2767 * @get_et_sset_count: Ethtool API to get string-set count.
2769 * @get_et_stats: Ethtool API to get a set of u64 stats.
2771 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2772 * and perhaps other supported types of ethtool data-sets.
2774 * @get_rssi: Get current signal strength in dBm, the function is optional
2777 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2778 * before associated. In multi-channel scenarios, a virtual interface is
2779 * bound to a channel before it is associated, but as it isn't associated
2780 * yet it need not necessarily be given airtime, in particular since any
2781 * transmission to a P2P GO needs to be synchronized against the GO's
2782 * powersave state. mac80211 will call this function before transmitting a
2783 * management frame prior to having successfully associated to allow the
2784 * driver to give it channel time for the transmission, to get a response
2785 * and to be able to synchronize with the GO.
2786 * The callback will be called before each transmission and upon return
2787 * mac80211 will transmit the frame right away.
2788 * The callback is optional and can (should!) sleep.
2790 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2791 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2792 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2793 * setup-response is a direct packet not buffered by the AP.
2794 * mac80211 will call this function just before the transmission of a TDLS
2795 * discovery-request. The recommended period of protection is at least
2796 * 2 * (DTIM period).
2797 * The callback is optional and can sleep.
2799 * @add_chanctx: Notifies device driver about new channel context creation.
2800 * @remove_chanctx: Notifies device driver about channel context destruction.
2801 * @change_chanctx: Notifies device driver about channel context changes that
2802 * may happen when combining different virtual interfaces on the same
2803 * channel context with different settings
2804 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2805 * to vif. Possible use is for hw queue remapping.
2806 * @unassign_vif_chanctx: Notifies device driver about channel context being
2808 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2809 * another, as specified in the list of
2810 * @ieee80211_vif_chanctx_switch passed to the driver, according
2811 * to the mode defined in &ieee80211_chanctx_switch_mode.
2813 * @start_ap: Start operation on the AP interface, this is called after all the
2814 * information in bss_conf is set and beacon can be retrieved. A channel
2815 * context is bound before this is called. Note that if the driver uses
2816 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2817 * just "paused" for scanning/ROC, which is indicated by the beacon being
2818 * disabled/enabled via @bss_info_changed.
2819 * @stop_ap: Stop operation on the AP interface.
2821 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2822 * reconfiguration has completed. This can help the driver implement the
2823 * reconfiguration step. Also called when reconfiguring because the
2824 * driver's resume function returned 1, as this is just like an "inline"
2825 * hardware restart. This callback may sleep.
2827 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2828 * Currently, this is only called for managed or P2P client interfaces.
2829 * This callback is optional; it must not sleep.
2831 * @channel_switch_beacon: Starts a channel switch to a new channel.
2832 * Beacons are modified to include CSA or ECSA IEs before calling this
2833 * function. The corresponding count fields in these IEs must be
2834 * decremented, and when they reach 1 the driver must call
2835 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2836 * get the csa counter decremented by mac80211, but must check if it is
2837 * 1 using ieee80211_csa_is_complete() after the beacon has been
2838 * transmitted and then call ieee80211_csa_finish().
2839 * If the CSA count starts as zero or 1, this function will not be called,
2840 * since there won't be any time to beacon before the switch anyway.
2842 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2843 * information in bss_conf is set up and the beacon can be retrieved. A
2844 * channel context is bound before this is called.
2845 * @leave_ibss: Leave the IBSS again.
2847 * @get_expected_throughput: extract the expected throughput towards the
2848 * specified station. The returned value is expressed in Kbps. It returns 0
2849 * if the RC algorithm does not have proper data to provide.
2851 struct ieee80211_ops {
2852 void (*tx)(struct ieee80211_hw *hw,
2853 struct ieee80211_tx_control *control,
2854 struct sk_buff *skb);
2855 int (*start)(struct ieee80211_hw *hw);
2856 void (*stop)(struct ieee80211_hw *hw);
2858 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2859 int (*resume)(struct ieee80211_hw *hw);
2860 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2862 int (*add_interface)(struct ieee80211_hw *hw,
2863 struct ieee80211_vif *vif);
2864 int (*change_interface)(struct ieee80211_hw *hw,
2865 struct ieee80211_vif *vif,
2866 enum nl80211_iftype new_type, bool p2p);
2867 void (*remove_interface)(struct ieee80211_hw *hw,
2868 struct ieee80211_vif *vif);
2869 int (*config)(struct ieee80211_hw *hw, u32 changed);
2870 void (*bss_info_changed)(struct ieee80211_hw *hw,
2871 struct ieee80211_vif *vif,
2872 struct ieee80211_bss_conf *info,
2875 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2876 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2878 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2879 struct netdev_hw_addr_list *mc_list);
2880 void (*configure_filter)(struct ieee80211_hw *hw,
2881 unsigned int changed_flags,
2882 unsigned int *total_flags,
2884 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2886 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2887 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2888 struct ieee80211_key_conf *key);
2889 void (*update_tkip_key)(struct ieee80211_hw *hw,
2890 struct ieee80211_vif *vif,
2891 struct ieee80211_key_conf *conf,
2892 struct ieee80211_sta *sta,
2893 u32 iv32, u16 *phase1key);
2894 void (*set_rekey_data)(struct ieee80211_hw *hw,
2895 struct ieee80211_vif *vif,
2896 struct cfg80211_gtk_rekey_data *data);
2897 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2898 struct ieee80211_vif *vif, int idx);
2899 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2900 struct ieee80211_scan_request *req);
2901 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2902 struct ieee80211_vif *vif);
2903 int (*sched_scan_start)(struct ieee80211_hw *hw,
2904 struct ieee80211_vif *vif,
2905 struct cfg80211_sched_scan_request *req,
2906 struct ieee80211_scan_ies *ies);
2907 int (*sched_scan_stop)(struct ieee80211_hw *hw,
2908 struct ieee80211_vif *vif);
2909 void (*sw_scan_start)(struct ieee80211_hw *hw);
2910 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2911 int (*get_stats)(struct ieee80211_hw *hw,
2912 struct ieee80211_low_level_stats *stats);
2913 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2914 u32 *iv32, u16 *iv16);
2915 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2916 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2917 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2918 struct ieee80211_sta *sta);
2919 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2920 struct ieee80211_sta *sta);
2921 #ifdef CONFIG_MAC80211_DEBUGFS
2922 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2923 struct ieee80211_vif *vif,
2924 struct ieee80211_sta *sta,
2925 struct dentry *dir);
2926 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2927 struct ieee80211_vif *vif,
2928 struct ieee80211_sta *sta,
2929 struct dentry *dir);
2931 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2932 enum sta_notify_cmd, struct ieee80211_sta *sta);
2933 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2934 struct ieee80211_sta *sta,
2935 enum ieee80211_sta_state old_state,
2936 enum ieee80211_sta_state new_state);
2937 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
2938 struct ieee80211_vif *vif,
2939 struct ieee80211_sta *sta);
2940 void (*sta_rc_update)(struct ieee80211_hw *hw,
2941 struct ieee80211_vif *vif,
2942 struct ieee80211_sta *sta,
2944 int (*conf_tx)(struct ieee80211_hw *hw,
2945 struct ieee80211_vif *vif, u16 ac,
2946 const struct ieee80211_tx_queue_params *params);
2947 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2948 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2950 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2951 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2952 int (*ampdu_action)(struct ieee80211_hw *hw,
2953 struct ieee80211_vif *vif,
2954 enum ieee80211_ampdu_mlme_action action,
2955 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2957 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2958 struct survey_info *survey);
2959 void (*rfkill_poll)(struct ieee80211_hw *hw);
2960 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2961 #ifdef CONFIG_NL80211_TESTMODE
2962 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2963 void *data, int len);
2964 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2965 struct netlink_callback *cb,
2966 void *data, int len);
2968 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2969 u32 queues, bool drop);
2970 void (*channel_switch)(struct ieee80211_hw *hw,
2971 struct ieee80211_channel_switch *ch_switch);
2972 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2973 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2975 int (*remain_on_channel)(struct ieee80211_hw *hw,
2976 struct ieee80211_vif *vif,
2977 struct ieee80211_channel *chan,
2979 enum ieee80211_roc_type type);
2980 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2981 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2982 void (*get_ringparam)(struct ieee80211_hw *hw,
2983 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2984 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2985 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2986 const struct cfg80211_bitrate_mask *mask);
2987 void (*rssi_callback)(struct ieee80211_hw *hw,
2988 struct ieee80211_vif *vif,
2989 enum ieee80211_rssi_event rssi_event);
2991 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2992 struct ieee80211_sta *sta,
2993 u16 tids, int num_frames,
2994 enum ieee80211_frame_release_type reason,
2996 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2997 struct ieee80211_sta *sta,
2998 u16 tids, int num_frames,
2999 enum ieee80211_frame_release_type reason,
3002 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3003 struct ieee80211_vif *vif, int sset);
3004 void (*get_et_stats)(struct ieee80211_hw *hw,
3005 struct ieee80211_vif *vif,
3006 struct ethtool_stats *stats, u64 *data);
3007 void (*get_et_strings)(struct ieee80211_hw *hw,
3008 struct ieee80211_vif *vif,
3009 u32 sset, u8 *data);
3010 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3011 struct ieee80211_sta *sta, s8 *rssi_dbm);
3013 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3014 struct ieee80211_vif *vif);
3016 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3017 struct ieee80211_vif *vif);
3019 int (*add_chanctx)(struct ieee80211_hw *hw,
3020 struct ieee80211_chanctx_conf *ctx);
3021 void (*remove_chanctx)(struct ieee80211_hw *hw,
3022 struct ieee80211_chanctx_conf *ctx);
3023 void (*change_chanctx)(struct ieee80211_hw *hw,
3024 struct ieee80211_chanctx_conf *ctx,
3026 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3027 struct ieee80211_vif *vif,
3028 struct ieee80211_chanctx_conf *ctx);
3029 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3030 struct ieee80211_vif *vif,
3031 struct ieee80211_chanctx_conf *ctx);
3032 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3033 struct ieee80211_vif_chanctx_switch *vifs,
3035 enum ieee80211_chanctx_switch_mode mode);
3037 void (*restart_complete)(struct ieee80211_hw *hw);
3039 #if IS_ENABLED(CONFIG_IPV6)
3040 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3041 struct ieee80211_vif *vif,
3042 struct inet6_dev *idev);
3044 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3045 struct ieee80211_vif *vif,
3046 struct cfg80211_chan_def *chandef);
3048 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3049 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3050 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3054 * ieee80211_alloc_hw - Allocate a new hardware device
3056 * This must be called once for each hardware device. The returned pointer
3057 * must be used to refer to this device when calling other functions.
3058 * mac80211 allocates a private data area for the driver pointed to by
3059 * @priv in &struct ieee80211_hw, the size of this area is given as
3062 * @priv_data_len: length of private data
3063 * @ops: callbacks for this device
3065 * Return: A pointer to the new hardware device, or %NULL on error.
3067 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3068 const struct ieee80211_ops *ops);
3071 * ieee80211_register_hw - Register hardware device
3073 * You must call this function before any other functions in
3074 * mac80211. Note that before a hardware can be registered, you
3075 * need to fill the contained wiphy's information.
3077 * @hw: the device to register as returned by ieee80211_alloc_hw()
3079 * Return: 0 on success. An error code otherwise.
3081 int ieee80211_register_hw(struct ieee80211_hw *hw);
3084 * struct ieee80211_tpt_blink - throughput blink description
3085 * @throughput: throughput in Kbit/sec
3086 * @blink_time: blink time in milliseconds
3087 * (full cycle, ie. one off + one on period)
3089 struct ieee80211_tpt_blink {
3095 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3096 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3097 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3098 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3099 * interface is connected in some way, including being an AP
3101 enum ieee80211_tpt_led_trigger_flags {
3102 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3103 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3104 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3107 #ifdef CONFIG_MAC80211_LEDS
3108 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3109 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3110 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3111 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3112 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3114 const struct ieee80211_tpt_blink *blink_table,
3115 unsigned int blink_table_len);
3118 * ieee80211_get_tx_led_name - get name of TX LED
3120 * mac80211 creates a transmit LED trigger for each wireless hardware
3121 * that can be used to drive LEDs if your driver registers a LED device.
3122 * This function returns the name (or %NULL if not configured for LEDs)
3123 * of the trigger so you can automatically link the LED device.
3125 * @hw: the hardware to get the LED trigger name for
3127 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3129 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3131 #ifdef CONFIG_MAC80211_LEDS
3132 return __ieee80211_get_tx_led_name(hw);
3139 * ieee80211_get_rx_led_name - get name of RX LED
3141 * mac80211 creates a receive LED trigger for each wireless hardware
3142 * that can be used to drive LEDs if your driver registers a LED device.
3143 * This function returns the name (or %NULL if not configured for LEDs)
3144 * of the trigger so you can automatically link the LED device.
3146 * @hw: the hardware to get the LED trigger name for
3148 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3150 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3152 #ifdef CONFIG_MAC80211_LEDS
3153 return __ieee80211_get_rx_led_name(hw);
3160 * ieee80211_get_assoc_led_name - get name of association LED
3162 * mac80211 creates a association LED trigger for each wireless hardware
3163 * that can be used to drive LEDs if your driver registers a LED device.
3164 * This function returns the name (or %NULL if not configured for LEDs)
3165 * of the trigger so you can automatically link the LED device.
3167 * @hw: the hardware to get the LED trigger name for
3169 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3171 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3173 #ifdef CONFIG_MAC80211_LEDS
3174 return __ieee80211_get_assoc_led_name(hw);
3181 * ieee80211_get_radio_led_name - get name of radio LED
3183 * mac80211 creates a radio change LED trigger for each wireless hardware
3184 * that can be used to drive LEDs if your driver registers a LED device.
3185 * This function returns the name (or %NULL if not configured for LEDs)
3186 * of the trigger so you can automatically link the LED device.
3188 * @hw: the hardware to get the LED trigger name for
3190 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3192 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3194 #ifdef CONFIG_MAC80211_LEDS
3195 return __ieee80211_get_radio_led_name(hw);
3202 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3203 * @hw: the hardware to create the trigger for
3204 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3205 * @blink_table: the blink table -- needs to be ordered by throughput
3206 * @blink_table_len: size of the blink table
3208 * Return: %NULL (in case of error, or if no LED triggers are
3209 * configured) or the name of the new trigger.
3211 * Note: This function must be called before ieee80211_register_hw().
3213 static inline char *
3214 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3215 const struct ieee80211_tpt_blink *blink_table,
3216 unsigned int blink_table_len)
3218 #ifdef CONFIG_MAC80211_LEDS
3219 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3227 * ieee80211_unregister_hw - Unregister a hardware device
3229 * This function instructs mac80211 to free allocated resources
3230 * and unregister netdevices from the networking subsystem.
3232 * @hw: the hardware to unregister
3234 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3237 * ieee80211_free_hw - free hardware descriptor
3239 * This function frees everything that was allocated, including the
3240 * private data for the driver. You must call ieee80211_unregister_hw()
3241 * before calling this function.
3243 * @hw: the hardware to free
3245 void ieee80211_free_hw(struct ieee80211_hw *hw);
3248 * ieee80211_restart_hw - restart hardware completely
3250 * Call this function when the hardware was restarted for some reason
3251 * (hardware error, ...) and the driver is unable to restore its state
3252 * by itself. mac80211 assumes that at this point the driver/hardware
3253 * is completely uninitialised and stopped, it starts the process by
3254 * calling the ->start() operation. The driver will need to reset all
3255 * internal state that it has prior to calling this function.
3257 * @hw: the hardware to restart
3259 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3262 * ieee80211_napi_add - initialize mac80211 NAPI context
3263 * @hw: the hardware to initialize the NAPI context on
3264 * @napi: the NAPI context to initialize
3265 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3266 * driver doesn't use NAPI
3267 * @poll: poll function
3268 * @weight: default weight
3270 * See also netif_napi_add().
3272 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3273 struct net_device *napi_dev,
3274 int (*poll)(struct napi_struct *, int),
3278 * ieee80211_rx - receive frame
3280 * Use this function to hand received frames to mac80211. The receive
3281 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3282 * paged @skb is used, the driver is recommended to put the ieee80211
3283 * header of the frame on the linear part of the @skb to avoid memory
3284 * allocation and/or memcpy by the stack.
3286 * This function may not be called in IRQ context. Calls to this function
3287 * for a single hardware must be synchronized against each other. Calls to
3288 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3289 * mixed for a single hardware. Must not run concurrently with
3290 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3292 * In process context use instead ieee80211_rx_ni().
3294 * @hw: the hardware this frame came in on
3295 * @skb: the buffer to receive, owned by mac80211 after this call
3297 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3300 * ieee80211_rx_irqsafe - receive frame
3302 * Like ieee80211_rx() but can be called in IRQ context
3303 * (internally defers to a tasklet.)
3305 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3306 * be mixed for a single hardware.Must not run concurrently with
3307 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3309 * @hw: the hardware this frame came in on
3310 * @skb: the buffer to receive, owned by mac80211 after this call
3312 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3315 * ieee80211_rx_ni - receive frame (in process context)
3317 * Like ieee80211_rx() but can be called in process context
3318 * (internally disables bottom halves).
3320 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3321 * not be mixed for a single hardware. Must not run concurrently with
3322 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3324 * @hw: the hardware this frame came in on
3325 * @skb: the buffer to receive, owned by mac80211 after this call
3327 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3328 struct sk_buff *skb)
3331 ieee80211_rx(hw, skb);
3336 * ieee80211_sta_ps_transition - PS transition for connected sta
3338 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3339 * flag set, use this function to inform mac80211 about a connected station
3340 * entering/leaving PS mode.
3342 * This function may not be called in IRQ context or with softirqs enabled.
3344 * Calls to this function for a single hardware must be synchronized against
3347 * @sta: currently connected sta
3348 * @start: start or stop PS
3350 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3352 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3355 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3356 * (in process context)
3358 * Like ieee80211_sta_ps_transition() but can be called in process context
3359 * (internally disables bottom halves). Concurrent call restriction still
3362 * @sta: currently connected sta
3363 * @start: start or stop PS
3365 * Return: Like ieee80211_sta_ps_transition().
3367 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3373 ret = ieee80211_sta_ps_transition(sta, start);
3380 * The TX headroom reserved by mac80211 for its own tx_status functions.
3381 * This is enough for the radiotap header.
3383 #define IEEE80211_TX_STATUS_HEADROOM 14
3386 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3387 * @sta: &struct ieee80211_sta pointer for the sleeping station
3388 * @tid: the TID that has buffered frames
3389 * @buffered: indicates whether or not frames are buffered for this TID
3391 * If a driver buffers frames for a powersave station instead of passing
3392 * them back to mac80211 for retransmission, the station may still need
3393 * to be told that there are buffered frames via the TIM bit.
3395 * This function informs mac80211 whether or not there are frames that are
3396 * buffered in the driver for a given TID; mac80211 can then use this data
3397 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3398 * call! Beware of the locking!)
3400 * If all frames are released to the station (due to PS-poll or uAPSD)
3401 * then the driver needs to inform mac80211 that there no longer are
3402 * frames buffered. However, when the station wakes up mac80211 assumes
3403 * that all buffered frames will be transmitted and clears this data,
3404 * drivers need to make sure they inform mac80211 about all buffered
3405 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3407 * Note that technically mac80211 only needs to know this per AC, not per
3408 * TID, but since driver buffering will inevitably happen per TID (since
3409 * it is related to aggregation) it is easier to make mac80211 map the
3410 * TID to the AC as required instead of keeping track in all drivers that
3413 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3414 u8 tid, bool buffered);
3417 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3419 * Call this function in a driver with per-packet rate selection support
3420 * to combine the rate info in the packet tx info with the most recent
3421 * rate selection table for the station entry.
3423 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3424 * @sta: the receiver station to which this packet is sent.
3425 * @skb: the frame to be transmitted.
3426 * @dest: buffer for extracted rate/retry information
3427 * @max_rates: maximum number of rates to fetch
3429 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3430 struct ieee80211_sta *sta,
3431 struct sk_buff *skb,
3432 struct ieee80211_tx_rate *dest,
3436 * ieee80211_tx_status - transmit status callback
3438 * Call this function for all transmitted frames after they have been
3439 * transmitted. It is permissible to not call this function for
3440 * multicast frames but this can affect statistics.
3442 * This function may not be called in IRQ context. Calls to this function
3443 * for a single hardware must be synchronized against each other. Calls
3444 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3445 * may not be mixed for a single hardware. Must not run concurrently with
3446 * ieee80211_rx() or ieee80211_rx_ni().
3448 * @hw: the hardware the frame was transmitted by
3449 * @skb: the frame that was transmitted, owned by mac80211 after this call
3451 void ieee80211_tx_status(struct ieee80211_hw *hw,
3452 struct sk_buff *skb);
3455 * ieee80211_tx_status_ni - transmit status callback (in process context)
3457 * Like ieee80211_tx_status() but can be called in process context.
3459 * Calls to this function, ieee80211_tx_status() and
3460 * ieee80211_tx_status_irqsafe() may not be mixed
3461 * for a single hardware.
3463 * @hw: the hardware the frame was transmitted by
3464 * @skb: the frame that was transmitted, owned by mac80211 after this call
3466 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3467 struct sk_buff *skb)
3470 ieee80211_tx_status(hw, skb);
3475 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3477 * Like ieee80211_tx_status() but can be called in IRQ context
3478 * (internally defers to a tasklet.)
3480 * Calls to this function, ieee80211_tx_status() and
3481 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3483 * @hw: the hardware the frame was transmitted by
3484 * @skb: the frame that was transmitted, owned by mac80211 after this call
3486 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3487 struct sk_buff *skb);
3490 * ieee80211_report_low_ack - report non-responding station
3492 * When operating in AP-mode, call this function to report a non-responding
3495 * @sta: the non-responding connected sta
3496 * @num_packets: number of packets sent to @sta without a response
3498 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3500 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3503 * struct ieee80211_mutable_offsets - mutable beacon offsets
3504 * @tim_offset: position of TIM element
3505 * @tim_length: size of TIM element
3506 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3507 * to CSA counters. This array can contain zero values which
3508 * should be ignored.
3510 struct ieee80211_mutable_offsets {
3514 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3518 * ieee80211_beacon_get_template - beacon template generation function
3519 * @hw: pointer obtained from ieee80211_alloc_hw().
3520 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3521 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3522 * receive the offsets that may be updated by the driver.
3524 * If the driver implements beaconing modes, it must use this function to
3525 * obtain the beacon template.
3527 * This function should be used if the beacon frames are generated by the
3528 * device, and then the driver must use the returned beacon as the template
3529 * The driver or the device are responsible to update the DTIM and, when
3530 * applicable, the CSA count.
3532 * The driver is responsible for freeing the returned skb.
3534 * Return: The beacon template. %NULL on error.
3537 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3538 struct ieee80211_vif *vif,
3539 struct ieee80211_mutable_offsets *offs);
3542 * ieee80211_beacon_get_tim - beacon generation function
3543 * @hw: pointer obtained from ieee80211_alloc_hw().
3544 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3545 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3546 * Set to 0 if invalid (in non-AP modes).
3547 * @tim_length: pointer to variable that will receive the TIM IE length,
3548 * (including the ID and length bytes!).
3549 * Set to 0 if invalid (in non-AP modes).
3551 * If the driver implements beaconing modes, it must use this function to
3552 * obtain the beacon frame.
3554 * If the beacon frames are generated by the host system (i.e., not in
3555 * hardware/firmware), the driver uses this function to get each beacon
3556 * frame from mac80211 -- it is responsible for calling this function exactly
3557 * once before the beacon is needed (e.g. based on hardware interrupt).
3559 * The driver is responsible for freeing the returned skb.
3561 * Return: The beacon template. %NULL on error.
3563 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3564 struct ieee80211_vif *vif,
3565 u16 *tim_offset, u16 *tim_length);
3568 * ieee80211_beacon_get - beacon generation function
3569 * @hw: pointer obtained from ieee80211_alloc_hw().
3570 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3572 * See ieee80211_beacon_get_tim().
3574 * Return: See ieee80211_beacon_get_tim().
3576 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3577 struct ieee80211_vif *vif)
3579 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3583 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3584 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3586 * The csa counter should be updated after each beacon transmission.
3587 * This function is called implicitly when
3588 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3589 * beacon frames are generated by the device, the driver should call this
3590 * function after each beacon transmission to sync mac80211's csa counters.
3592 * Return: new csa counter value
3594 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3597 * ieee80211_csa_finish - notify mac80211 about channel switch
3598 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3600 * After a channel switch announcement was scheduled and the counter in this
3601 * announcement hits 1, this function must be called by the driver to
3602 * notify mac80211 that the channel can be changed.
3604 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3607 * ieee80211_csa_is_complete - find out if counters reached 1
3608 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3610 * This function returns whether the channel switch counters reached zero.
3612 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3616 * ieee80211_proberesp_get - retrieve a Probe Response template
3617 * @hw: pointer obtained from ieee80211_alloc_hw().
3618 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3620 * Creates a Probe Response template which can, for example, be uploaded to
3621 * hardware. The destination address should be set by the caller.
3623 * Can only be called in AP mode.
3625 * Return: The Probe Response template. %NULL on error.
3627 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3628 struct ieee80211_vif *vif);
3631 * ieee80211_pspoll_get - retrieve a PS Poll template
3632 * @hw: pointer obtained from ieee80211_alloc_hw().
3633 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3635 * Creates a PS Poll a template which can, for example, uploaded to
3636 * hardware. The template must be updated after association so that correct
3637 * AID, BSSID and MAC address is used.
3639 * Note: Caller (or hardware) is responsible for setting the
3640 * &IEEE80211_FCTL_PM bit.
3642 * Return: The PS Poll template. %NULL on error.
3644 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3645 struct ieee80211_vif *vif);
3648 * ieee80211_nullfunc_get - retrieve a nullfunc template
3649 * @hw: pointer obtained from ieee80211_alloc_hw().
3650 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3652 * Creates a Nullfunc template which can, for example, uploaded to
3653 * hardware. The template must be updated after association so that correct
3654 * BSSID and address is used.
3656 * Note: Caller (or hardware) is responsible for setting the
3657 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3659 * Return: The nullfunc template. %NULL on error.
3661 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3662 struct ieee80211_vif *vif);
3665 * ieee80211_probereq_get - retrieve a Probe Request template
3666 * @hw: pointer obtained from ieee80211_alloc_hw().
3667 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3668 * @ssid: SSID buffer
3669 * @ssid_len: length of SSID
3670 * @tailroom: tailroom to reserve at end of SKB for IEs
3672 * Creates a Probe Request template which can, for example, be uploaded to
3675 * Return: The Probe Request template. %NULL on error.
3677 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3678 struct ieee80211_vif *vif,
3679 const u8 *ssid, size_t ssid_len,
3683 * ieee80211_rts_get - RTS frame generation function
3684 * @hw: pointer obtained from ieee80211_alloc_hw().
3685 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3686 * @frame: pointer to the frame that is going to be protected by the RTS.
3687 * @frame_len: the frame length (in octets).
3688 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3689 * @rts: The buffer where to store the RTS frame.
3691 * If the RTS frames are generated by the host system (i.e., not in
3692 * hardware/firmware), the low-level driver uses this function to receive
3693 * the next RTS frame from the 802.11 code. The low-level is responsible
3694 * for calling this function before and RTS frame is needed.
3696 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3697 const void *frame, size_t frame_len,
3698 const struct ieee80211_tx_info *frame_txctl,
3699 struct ieee80211_rts *rts);
3702 * ieee80211_rts_duration - Get the duration field for an RTS frame
3703 * @hw: pointer obtained from ieee80211_alloc_hw().
3704 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3705 * @frame_len: the length of the frame that is going to be protected by the RTS.
3706 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3708 * If the RTS is generated in firmware, but the host system must provide
3709 * the duration field, the low-level driver uses this function to receive
3710 * the duration field value in little-endian byteorder.
3712 * Return: The duration.
3714 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3715 struct ieee80211_vif *vif, size_t frame_len,
3716 const struct ieee80211_tx_info *frame_txctl);
3719 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3720 * @hw: pointer obtained from ieee80211_alloc_hw().
3721 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3722 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3723 * @frame_len: the frame length (in octets).
3724 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3725 * @cts: The buffer where to store the CTS-to-self frame.
3727 * If the CTS-to-self frames are generated by the host system (i.e., not in
3728 * hardware/firmware), the low-level driver uses this function to receive
3729 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3730 * for calling this function before and CTS-to-self frame is needed.
3732 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3733 struct ieee80211_vif *vif,
3734 const void *frame, size_t frame_len,
3735 const struct ieee80211_tx_info *frame_txctl,
3736 struct ieee80211_cts *cts);
3739 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3740 * @hw: pointer obtained from ieee80211_alloc_hw().
3741 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3742 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3743 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3745 * If the CTS-to-self is generated in firmware, but the host system must provide
3746 * the duration field, the low-level driver uses this function to receive
3747 * the duration field value in little-endian byteorder.
3749 * Return: The duration.
3751 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3752 struct ieee80211_vif *vif,
3754 const struct ieee80211_tx_info *frame_txctl);
3757 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3758 * @hw: pointer obtained from ieee80211_alloc_hw().
3759 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3760 * @band: the band to calculate the frame duration on
3761 * @frame_len: the length of the frame.
3762 * @rate: the rate at which the frame is going to be transmitted.
3764 * Calculate the duration field of some generic frame, given its
3765 * length and transmission rate (in 100kbps).
3767 * Return: The duration.
3769 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3770 struct ieee80211_vif *vif,
3771 enum ieee80211_band band,
3773 struct ieee80211_rate *rate);
3776 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3777 * @hw: pointer as obtained from ieee80211_alloc_hw().
3778 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3780 * Function for accessing buffered broadcast and multicast frames. If
3781 * hardware/firmware does not implement buffering of broadcast/multicast
3782 * frames when power saving is used, 802.11 code buffers them in the host
3783 * memory. The low-level driver uses this function to fetch next buffered
3784 * frame. In most cases, this is used when generating beacon frame.
3786 * Return: A pointer to the next buffered skb or NULL if no more buffered
3787 * frames are available.
3789 * Note: buffered frames are returned only after DTIM beacon frame was
3790 * generated with ieee80211_beacon_get() and the low-level driver must thus
3791 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3792 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3793 * does not need to check for DTIM beacons separately and should be able to
3794 * use common code for all beacons.
3797 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3800 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3802 * This function returns the TKIP phase 1 key for the given IV32.
3804 * @keyconf: the parameter passed with the set key
3805 * @iv32: IV32 to get the P1K for
3806 * @p1k: a buffer to which the key will be written, as 5 u16 values
3808 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3809 u32 iv32, u16 *p1k);
3812 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3814 * This function returns the TKIP phase 1 key for the IV32 taken
3815 * from the given packet.
3817 * @keyconf: the parameter passed with the set key
3818 * @skb: the packet to take the IV32 value from that will be encrypted
3820 * @p1k: a buffer to which the key will be written, as 5 u16 values
3822 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3823 struct sk_buff *skb, u16 *p1k)
3825 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3826 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3827 u32 iv32 = get_unaligned_le32(&data[4]);
3829 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3833 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3835 * This function returns the TKIP phase 1 key for the given IV32
3836 * and transmitter address.
3838 * @keyconf: the parameter passed with the set key
3839 * @ta: TA that will be used with the key
3840 * @iv32: IV32 to get the P1K for
3841 * @p1k: a buffer to which the key will be written, as 5 u16 values
3843 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3844 const u8 *ta, u32 iv32, u16 *p1k);
3847 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3849 * This function computes the TKIP RC4 key for the IV values
3852 * @keyconf: the parameter passed with the set key
3853 * @skb: the packet to take the IV32/IV16 values from that will be
3854 * encrypted with this key
3855 * @p2k: a buffer to which the key will be written, 16 bytes
3857 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3858 struct sk_buff *skb, u8 *p2k);
3861 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3863 * This function computes the two AES-CMAC sub-keys, based on the
3864 * previously installed master key.
3866 * @keyconf: the parameter passed with the set key
3867 * @k1: a buffer to be filled with the 1st sub-key
3868 * @k2: a buffer to be filled with the 2nd sub-key
3870 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3874 * struct ieee80211_key_seq - key sequence counter
3876 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3877 * @ccmp: PN data, most significant byte first (big endian,
3878 * reverse order than in packet)
3879 * @aes_cmac: PN data, most significant byte first (big endian,
3880 * reverse order than in packet)
3882 struct ieee80211_key_seq {
3898 * ieee80211_get_key_tx_seq - get key TX sequence counter
3900 * @keyconf: the parameter passed with the set key
3901 * @seq: buffer to receive the sequence data
3903 * This function allows a driver to retrieve the current TX IV/PN
3904 * for the given key. It must not be called if IV generation is
3905 * offloaded to the device.
3907 * Note that this function may only be called when no TX processing
3908 * can be done concurrently, for example when queues are stopped
3909 * and the stop has been synchronized.
3911 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3912 struct ieee80211_key_seq *seq);
3915 * ieee80211_get_key_rx_seq - get key RX sequence counter
3917 * @keyconf: the parameter passed with the set key
3918 * @tid: The TID, or -1 for the management frame value (CCMP only);
3919 * the value on TID 0 is also used for non-QoS frames. For
3920 * CMAC, only TID 0 is valid.
3921 * @seq: buffer to receive the sequence data
3923 * This function allows a driver to retrieve the current RX IV/PNs
3924 * for the given key. It must not be called if IV checking is done
3925 * by the device and not by mac80211.
3927 * Note that this function may only be called when no RX processing
3928 * can be done concurrently.
3930 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3931 int tid, struct ieee80211_key_seq *seq);
3934 * ieee80211_set_key_tx_seq - set key TX sequence counter
3936 * @keyconf: the parameter passed with the set key
3937 * @seq: new sequence data
3939 * This function allows a driver to set the current TX IV/PNs for the
3940 * given key. This is useful when resuming from WoWLAN sleep and the
3941 * device may have transmitted frames using the PTK, e.g. replies to
3944 * Note that this function may only be called when no TX processing
3945 * can be done concurrently.
3947 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3948 struct ieee80211_key_seq *seq);
3951 * ieee80211_set_key_rx_seq - set key RX sequence counter
3953 * @keyconf: the parameter passed with the set key
3954 * @tid: The TID, or -1 for the management frame value (CCMP only);
3955 * the value on TID 0 is also used for non-QoS frames. For
3956 * CMAC, only TID 0 is valid.
3957 * @seq: new sequence data
3959 * This function allows a driver to set the current RX IV/PNs for the
3960 * given key. This is useful when resuming from WoWLAN sleep and GTK
3961 * rekey may have been done while suspended. It should not be called
3962 * if IV checking is done by the device and not by mac80211.
3964 * Note that this function may only be called when no RX processing
3965 * can be done concurrently.
3967 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
3968 int tid, struct ieee80211_key_seq *seq);
3971 * ieee80211_remove_key - remove the given key
3972 * @keyconf: the parameter passed with the set key
3974 * Remove the given key. If the key was uploaded to the hardware at the
3975 * time this function is called, it is not deleted in the hardware but
3976 * instead assumed to have been removed already.
3978 * Note that due to locking considerations this function can (currently)
3979 * only be called during key iteration (ieee80211_iter_keys().)
3981 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
3984 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3985 * @vif: the virtual interface to add the key on
3986 * @keyconf: new key data
3988 * When GTK rekeying was done while the system was suspended, (a) new
3989 * key(s) will be available. These will be needed by mac80211 for proper
3990 * RX processing, so this function allows setting them.
3992 * The function returns the newly allocated key structure, which will
3993 * have similar contents to the passed key configuration but point to
3994 * mac80211-owned memory. In case of errors, the function returns an
3995 * ERR_PTR(), use IS_ERR() etc.
3997 * Note that this function assumes the key isn't added to hardware
3998 * acceleration, so no TX will be done with the key. Since it's a GTK
3999 * on managed (station) networks, this is true anyway. If the driver
4000 * calls this function from the resume callback and subsequently uses
4001 * the return code 1 to reconfigure the device, this key will be part
4002 * of the reconfiguration.
4004 * Note that the driver should also call ieee80211_set_key_rx_seq()
4005 * for the new key for each TID to set up sequence counters properly.
4007 * IMPORTANT: If this replaces a key that is present in the hardware,
4008 * then it will attempt to remove it during this call. In many cases
4009 * this isn't what you want, so call ieee80211_remove_key() first for
4010 * the key that's being replaced.
4012 struct ieee80211_key_conf *
4013 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4014 struct ieee80211_key_conf *keyconf);
4017 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4018 * @vif: virtual interface the rekeying was done on
4019 * @bssid: The BSSID of the AP, for checking association
4020 * @replay_ctr: the new replay counter after GTK rekeying
4021 * @gfp: allocation flags
4023 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4024 const u8 *replay_ctr, gfp_t gfp);
4027 * ieee80211_wake_queue - wake specific queue
4028 * @hw: pointer as obtained from ieee80211_alloc_hw().
4029 * @queue: queue number (counted from zero).
4031 * Drivers should use this function instead of netif_wake_queue.
4033 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4036 * ieee80211_stop_queue - stop specific queue
4037 * @hw: pointer as obtained from ieee80211_alloc_hw().
4038 * @queue: queue number (counted from zero).
4040 * Drivers should use this function instead of netif_stop_queue.
4042 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4045 * ieee80211_queue_stopped - test status of the queue
4046 * @hw: pointer as obtained from ieee80211_alloc_hw().
4047 * @queue: queue number (counted from zero).
4049 * Drivers should use this function instead of netif_stop_queue.
4051 * Return: %true if the queue is stopped. %false otherwise.
4054 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4057 * ieee80211_stop_queues - stop all queues
4058 * @hw: pointer as obtained from ieee80211_alloc_hw().
4060 * Drivers should use this function instead of netif_stop_queue.
4062 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4065 * ieee80211_wake_queues - wake all queues
4066 * @hw: pointer as obtained from ieee80211_alloc_hw().
4068 * Drivers should use this function instead of netif_wake_queue.
4070 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4073 * ieee80211_scan_completed - completed hardware scan
4075 * When hardware scan offload is used (i.e. the hw_scan() callback is
4076 * assigned) this function needs to be called by the driver to notify
4077 * mac80211 that the scan finished. This function can be called from
4078 * any context, including hardirq context.
4080 * @hw: the hardware that finished the scan
4081 * @aborted: set to true if scan was aborted
4083 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4086 * ieee80211_sched_scan_results - got results from scheduled scan
4088 * When a scheduled scan is running, this function needs to be called by the
4089 * driver whenever there are new scan results available.
4091 * @hw: the hardware that is performing scheduled scans
4093 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4096 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4098 * When a scheduled scan is running, this function can be called by
4099 * the driver if it needs to stop the scan to perform another task.
4100 * Usual scenarios are drivers that cannot continue the scheduled scan
4101 * while associating, for instance.
4103 * @hw: the hardware that is performing scheduled scans
4105 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4108 * enum ieee80211_interface_iteration_flags - interface iteration flags
4109 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4110 * been added to the driver; However, note that during hardware
4111 * reconfiguration (after restart_hw) it will iterate over a new
4112 * interface and over all the existing interfaces even if they
4113 * haven't been re-added to the driver yet.
4114 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4115 * interfaces, even if they haven't been re-added to the driver yet.
4117 enum ieee80211_interface_iteration_flags {
4118 IEEE80211_IFACE_ITER_NORMAL = 0,
4119 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4123 * ieee80211_iterate_active_interfaces - iterate active interfaces
4125 * This function iterates over the interfaces associated with a given
4126 * hardware that are currently active and calls the callback for them.
4127 * This function allows the iterator function to sleep, when the iterator
4128 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4130 * Does not iterate over a new interface during add_interface().
4132 * @hw: the hardware struct of which the interfaces should be iterated over
4133 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4134 * @iterator: the iterator function to call
4135 * @data: first argument of the iterator function
4137 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
4139 void (*iterator)(void *data, u8 *mac,
4140 struct ieee80211_vif *vif),
4144 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4146 * This function iterates over the interfaces associated with a given
4147 * hardware that are currently active and calls the callback for them.
4148 * This function requires the iterator callback function to be atomic,
4149 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4150 * Does not iterate over a new interface during add_interface().
4152 * @hw: the hardware struct of which the interfaces should be iterated over
4153 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4154 * @iterator: the iterator function to call, cannot sleep
4155 * @data: first argument of the iterator function
4157 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4159 void (*iterator)(void *data,
4161 struct ieee80211_vif *vif),
4165 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4167 * This function iterates over the interfaces associated with a given
4168 * hardware that are currently active and calls the callback for them.
4169 * This version can only be used while holding the RTNL.
4171 * @hw: the hardware struct of which the interfaces should be iterated over
4172 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4173 * @iterator: the iterator function to call, cannot sleep
4174 * @data: first argument of the iterator function
4176 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4178 void (*iterator)(void *data,
4180 struct ieee80211_vif *vif),
4184 * ieee80211_queue_work - add work onto the mac80211 workqueue
4186 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4187 * This helper ensures drivers are not queueing work when they should not be.
4189 * @hw: the hardware struct for the interface we are adding work for
4190 * @work: the work we want to add onto the mac80211 workqueue
4192 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4195 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4197 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4200 * @hw: the hardware struct for the interface we are adding work for
4201 * @dwork: delayable work to queue onto the mac80211 workqueue
4202 * @delay: number of jiffies to wait before queueing
4204 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4205 struct delayed_work *dwork,
4206 unsigned long delay);
4209 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4210 * @sta: the station for which to start a BA session
4211 * @tid: the TID to BA on.
4212 * @timeout: session timeout value (in TUs)
4214 * Return: success if addBA request was sent, failure otherwise
4216 * Although mac80211/low level driver/user space application can estimate
4217 * the need to start aggregation on a certain RA/TID, the session level
4218 * will be managed by the mac80211.
4220 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4224 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4225 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4226 * @ra: receiver address of the BA session recipient.
4227 * @tid: the TID to BA on.
4229 * This function must be called by low level driver once it has
4230 * finished with preparations for the BA session. It can be called
4233 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4237 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4238 * @sta: the station whose BA session to stop
4239 * @tid: the TID to stop BA.
4241 * Return: negative error if the TID is invalid, or no aggregation active
4243 * Although mac80211/low level driver/user space application can estimate
4244 * the need to stop aggregation on a certain RA/TID, the session level
4245 * will be managed by the mac80211.
4247 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4250 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4251 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4252 * @ra: receiver address of the BA session recipient.
4253 * @tid: the desired TID to BA on.
4255 * This function must be called by low level driver once it has
4256 * finished with preparations for the BA session tear down. It
4257 * can be called from any context.
4259 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4263 * ieee80211_find_sta - find a station
4265 * @vif: virtual interface to look for station on
4266 * @addr: station's address
4268 * Return: The station, if found. %NULL otherwise.
4270 * Note: This function must be called under RCU lock and the
4271 * resulting pointer is only valid under RCU lock as well.
4273 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4277 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4279 * @hw: pointer as obtained from ieee80211_alloc_hw()
4280 * @addr: remote station's address
4281 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4283 * Return: The station, if found. %NULL otherwise.
4285 * Note: This function must be called under RCU lock and the
4286 * resulting pointer is only valid under RCU lock as well.
4288 * NOTE: You may pass NULL for localaddr, but then you will just get
4289 * the first STA that matches the remote address 'addr'.
4290 * We can have multiple STA associated with multiple
4291 * logical stations (e.g. consider a station connecting to another
4292 * BSSID on the same AP hardware without disconnecting first).
4293 * In this case, the result of this method with localaddr NULL
4296 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4298 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4300 const u8 *localaddr);
4303 * ieee80211_sta_block_awake - block station from waking up
4305 * @pubsta: the station
4306 * @block: whether to block or unblock
4308 * Some devices require that all frames that are on the queues
4309 * for a specific station that went to sleep are flushed before
4310 * a poll response or frames after the station woke up can be
4311 * delivered to that it. Note that such frames must be rejected
4312 * by the driver as filtered, with the appropriate status flag.
4314 * This function allows implementing this mode in a race-free
4317 * To do this, a driver must keep track of the number of frames
4318 * still enqueued for a specific station. If this number is not
4319 * zero when the station goes to sleep, the driver must call
4320 * this function to force mac80211 to consider the station to
4321 * be asleep regardless of the station's actual state. Once the
4322 * number of outstanding frames reaches zero, the driver must
4323 * call this function again to unblock the station. That will
4324 * cause mac80211 to be able to send ps-poll responses, and if
4325 * the station queried in the meantime then frames will also
4326 * be sent out as a result of this. Additionally, the driver
4327 * will be notified that the station woke up some time after
4328 * it is unblocked, regardless of whether the station actually
4329 * woke up while blocked or not.
4331 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4332 struct ieee80211_sta *pubsta, bool block);
4335 * ieee80211_sta_eosp - notify mac80211 about end of SP
4336 * @pubsta: the station
4338 * When a device transmits frames in a way that it can't tell
4339 * mac80211 in the TX status about the EOSP, it must clear the
4340 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4341 * This applies for PS-Poll as well as uAPSD.
4343 * Note that just like with _tx_status() and _rx() drivers must
4344 * not mix calls to irqsafe/non-irqsafe versions, this function
4345 * must not be mixed with those either. Use the all irqsafe, or
4346 * all non-irqsafe, don't mix!
4348 * NB: the _irqsafe version of this function doesn't exist, no
4349 * driver needs it right now. Don't call this function if
4350 * you'd need the _irqsafe version, look at the git history
4351 * and restore the _irqsafe version!
4353 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4356 * ieee80211_iter_keys - iterate keys programmed into the device
4357 * @hw: pointer obtained from ieee80211_alloc_hw()
4358 * @vif: virtual interface to iterate, may be %NULL for all
4359 * @iter: iterator function that will be called for each key
4360 * @iter_data: custom data to pass to the iterator function
4362 * This function can be used to iterate all the keys known to
4363 * mac80211, even those that weren't previously programmed into
4364 * the device. This is intended for use in WoWLAN if the device
4365 * needs reprogramming of the keys during suspend. Note that due
4366 * to locking reasons, it is also only safe to call this at few
4367 * spots since it must hold the RTNL and be able to sleep.
4369 * The order in which the keys are iterated matches the order
4370 * in which they were originally installed and handed to the
4373 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4374 struct ieee80211_vif *vif,
4375 void (*iter)(struct ieee80211_hw *hw,
4376 struct ieee80211_vif *vif,
4377 struct ieee80211_sta *sta,
4378 struct ieee80211_key_conf *key,
4383 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4384 * @hw: pointre obtained from ieee80211_alloc_hw().
4385 * @iter: iterator function
4386 * @iter_data: data passed to iterator function
4388 * Iterate all active channel contexts. This function is atomic and
4389 * doesn't acquire any locks internally that might be held in other
4390 * places while calling into the driver.
4392 * The iterator will not find a context that's being added (during
4393 * the driver callback to add it) but will find it while it's being
4396 * Note that during hardware restart, all contexts that existed
4397 * before the restart are considered already present so will be
4398 * found while iterating, whether they've been re-added already
4401 void ieee80211_iter_chan_contexts_atomic(
4402 struct ieee80211_hw *hw,
4403 void (*iter)(struct ieee80211_hw *hw,
4404 struct ieee80211_chanctx_conf *chanctx_conf,
4409 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4410 * @hw: pointer obtained from ieee80211_alloc_hw().
4411 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4413 * Creates a Probe Request template which can, for example, be uploaded to
4414 * hardware. The template is filled with bssid, ssid and supported rate
4415 * information. This function must only be called from within the
4416 * .bss_info_changed callback function and only in managed mode. The function
4417 * is only useful when the interface is associated, otherwise it will return
4420 * Return: The Probe Request template. %NULL on error.
4422 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4423 struct ieee80211_vif *vif);
4426 * ieee80211_beacon_loss - inform hardware does not receive beacons
4428 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4430 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4431 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4432 * hardware is not receiving beacons with this function.
4434 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4437 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4439 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4441 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4442 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4443 * needs to inform if the connection to the AP has been lost.
4444 * The function may also be called if the connection needs to be terminated
4445 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4447 * This function will cause immediate change to disassociated state,
4448 * without connection recovery attempts.
4450 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4453 * ieee80211_resume_disconnect - disconnect from AP after resume
4455 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4457 * Instructs mac80211 to disconnect from the AP after resume.
4458 * Drivers can use this after WoWLAN if they know that the
4459 * connection cannot be kept up, for example because keys were
4460 * used while the device was asleep but the replay counters or
4461 * similar cannot be retrieved from the device during resume.
4463 * Note that due to implementation issues, if the driver uses
4464 * the reconfiguration functionality during resume the interface
4465 * will still be added as associated first during resume and then
4466 * disconnect normally later.
4468 * This function can only be called from the resume callback and
4469 * the driver must not be holding any of its own locks while it
4470 * calls this function, or at least not any locks it needs in the
4471 * key configuration paths (if it supports HW crypto).
4473 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4476 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4477 * rssi threshold triggered
4479 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4480 * @rssi_event: the RSSI trigger event type
4481 * @gfp: context flags
4483 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4484 * monitoring is configured with an rssi threshold, the driver will inform
4485 * whenever the rssi level reaches the threshold.
4487 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4488 enum nl80211_cqm_rssi_threshold_event rssi_event,
4492 * ieee80211_radar_detected - inform that a radar was detected
4494 * @hw: pointer as obtained from ieee80211_alloc_hw()
4496 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4499 * ieee80211_chswitch_done - Complete channel switch process
4500 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4501 * @success: make the channel switch successful or not
4503 * Complete the channel switch post-process: set the new operational channel
4504 * and wake up the suspended queues.
4506 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4509 * ieee80211_request_smps - request SM PS transition
4510 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4511 * @smps_mode: new SM PS mode
4513 * This allows the driver to request an SM PS transition in managed
4514 * mode. This is useful when the driver has more information than
4515 * the stack about possible interference, for example by bluetooth.
4517 void ieee80211_request_smps(struct ieee80211_vif *vif,
4518 enum ieee80211_smps_mode smps_mode);
4521 * ieee80211_ready_on_channel - notification of remain-on-channel start
4522 * @hw: pointer as obtained from ieee80211_alloc_hw()
4524 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4527 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4528 * @hw: pointer as obtained from ieee80211_alloc_hw()
4530 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4533 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4535 * in order not to harm the system performance and user experience, the device
4536 * may request not to allow any rx ba session and tear down existing rx ba
4537 * sessions based on system constraints such as periodic BT activity that needs
4538 * to limit wlan activity (eg.sco or a2dp)."
4539 * in such cases, the intention is to limit the duration of the rx ppdu and
4540 * therefore prevent the peer device to use a-mpdu aggregation.
4542 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4543 * @ba_rx_bitmap: Bit map of open rx ba per tid
4544 * @addr: & to bssid mac address
4546 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4550 * ieee80211_send_bar - send a BlockAckReq frame
4552 * can be used to flush pending frames from the peer's aggregation reorder
4555 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4556 * @ra: the peer's destination address
4557 * @tid: the TID of the aggregation session
4558 * @ssn: the new starting sequence number for the receiver
4560 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4563 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
4565 * Some device drivers may offload part of the Rx aggregation flow including
4566 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4569 * Create structures responsible for reordering so device drivers may call here
4570 * when they complete AddBa negotiation.
4572 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4573 * @addr: station mac address
4576 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
4577 const u8 *addr, u16 tid);
4580 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
4582 * Some device drivers may offload part of the Rx aggregation flow including
4583 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4586 * Destroy structures responsible for reordering so device drivers may call here
4587 * when they complete DelBa negotiation.
4589 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4590 * @addr: station mac address
4593 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
4594 const u8 *addr, u16 tid);
4596 /* Rate control API */
4599 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4601 * @hw: The hardware the algorithm is invoked for.
4602 * @sband: The band this frame is being transmitted on.
4603 * @bss_conf: the current BSS configuration
4604 * @skb: the skb that will be transmitted, the control information in it needs
4606 * @reported_rate: The rate control algorithm can fill this in to indicate
4607 * which rate should be reported to userspace as the current rate and
4608 * used for rate calculations in the mesh network.
4609 * @rts: whether RTS will be used for this frame because it is longer than the
4611 * @short_preamble: whether mac80211 will request short-preamble transmission
4612 * if the selected rate supports it
4613 * @max_rate_idx: user-requested maximum (legacy) rate
4614 * (deprecated; this will be removed once drivers get updated to use
4616 * @rate_idx_mask: user-requested (legacy) rate mask
4617 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4618 * @bss: whether this frame is sent out in AP or IBSS mode
4620 struct ieee80211_tx_rate_control {
4621 struct ieee80211_hw *hw;
4622 struct ieee80211_supported_band *sband;
4623 struct ieee80211_bss_conf *bss_conf;
4624 struct sk_buff *skb;
4625 struct ieee80211_tx_rate reported_rate;
4626 bool rts, short_preamble;
4629 u8 *rate_idx_mcs_mask;
4633 struct rate_control_ops {
4635 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4636 void (*free)(void *priv);
4638 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4639 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4640 struct cfg80211_chan_def *chandef,
4641 struct ieee80211_sta *sta, void *priv_sta);
4642 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4643 struct cfg80211_chan_def *chandef,
4644 struct ieee80211_sta *sta, void *priv_sta,
4646 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4649 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4650 struct ieee80211_sta *sta, void *priv_sta,
4651 struct sk_buff *skb);
4652 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4653 struct ieee80211_tx_rate_control *txrc);
4655 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4656 struct dentry *dir);
4657 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4659 u32 (*get_expected_throughput)(void *priv_sta);
4662 static inline int rate_supported(struct ieee80211_sta *sta,
4663 enum ieee80211_band band,
4666 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4670 * rate_control_send_low - helper for drivers for management/no-ack frames
4672 * Rate control algorithms that agree to use the lowest rate to
4673 * send management frames and NO_ACK data with the respective hw
4674 * retries should use this in the beginning of their mac80211 get_rate
4675 * callback. If true is returned the rate control can simply return.
4676 * If false is returned we guarantee that sta and sta and priv_sta is
4679 * Rate control algorithms wishing to do more intelligent selection of
4680 * rate for multicast/broadcast frames may choose to not use this.
4682 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4683 * that this may be null.
4684 * @priv_sta: private rate control structure. This may be null.
4685 * @txrc: rate control information we sholud populate for mac80211.
4687 bool rate_control_send_low(struct ieee80211_sta *sta,
4689 struct ieee80211_tx_rate_control *txrc);
4693 rate_lowest_index(struct ieee80211_supported_band *sband,
4694 struct ieee80211_sta *sta)
4698 for (i = 0; i < sband->n_bitrates; i++)
4699 if (rate_supported(sta, sband->band, i))
4702 /* warn when we cannot find a rate. */
4705 /* and return 0 (the lowest index) */
4710 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4711 struct ieee80211_sta *sta)
4715 for (i = 0; i < sband->n_bitrates; i++)
4716 if (rate_supported(sta, sband->band, i))
4722 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4724 * When not doing a rate control probe to test rates, rate control should pass
4725 * its rate selection to mac80211. If the driver supports receiving a station
4726 * rate table, it will use it to ensure that frames are always sent based on
4727 * the most recent rate control module decision.
4729 * @hw: pointer as obtained from ieee80211_alloc_hw()
4730 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4731 * @rates: new tx rate set to be used for this station.
4733 int rate_control_set_rates(struct ieee80211_hw *hw,
4734 struct ieee80211_sta *pubsta,
4735 struct ieee80211_sta_rates *rates);
4737 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4738 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4741 conf_is_ht20(struct ieee80211_conf *conf)
4743 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4747 conf_is_ht40_minus(struct ieee80211_conf *conf)
4749 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4750 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4754 conf_is_ht40_plus(struct ieee80211_conf *conf)
4756 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4757 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4761 conf_is_ht40(struct ieee80211_conf *conf)
4763 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4767 conf_is_ht(struct ieee80211_conf *conf)
4769 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
4770 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
4771 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
4774 static inline enum nl80211_iftype
4775 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4779 case NL80211_IFTYPE_STATION:
4780 return NL80211_IFTYPE_P2P_CLIENT;
4781 case NL80211_IFTYPE_AP:
4782 return NL80211_IFTYPE_P2P_GO;
4790 static inline enum nl80211_iftype
4791 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4793 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4796 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4798 int rssi_max_thold);
4800 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4803 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4805 * @vif: the specified virtual interface
4807 * Note: This function assumes that the given vif is valid.
4809 * Return: The average RSSI value for the requested interface, or 0 if not
4812 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4815 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4816 * @vif: virtual interface
4817 * @wakeup: wakeup reason(s)
4818 * @gfp: allocation flags
4820 * See cfg80211_report_wowlan_wakeup().
4822 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4823 struct cfg80211_wowlan_wakeup *wakeup,
4827 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4828 * @hw: pointer as obtained from ieee80211_alloc_hw()
4829 * @vif: virtual interface
4830 * @skb: frame to be sent from within the driver
4831 * @band: the band to transmit on
4832 * @sta: optional pointer to get the station to send the frame to
4834 * Note: must be called under RCU lock
4836 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4837 struct ieee80211_vif *vif, struct sk_buff *skb,
4838 int band, struct ieee80211_sta **sta);
4841 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4843 * @next_tsf: TSF timestamp of the next absent state change
4844 * @has_next_tsf: next absent state change event pending
4846 * @absent: descriptor bitmask, set if GO is currently absent
4850 * @count: count fields from the NoA descriptors
4851 * @desc: adjusted data from the NoA
4853 struct ieee80211_noa_data {
4859 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
4864 } desc[IEEE80211_P2P_NOA_DESC_MAX];
4868 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4871 * @data: NoA tracking data
4872 * @tsf: current TSF timestamp
4874 * Return: number of successfully parsed descriptors
4876 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
4877 struct ieee80211_noa_data *data, u32 tsf);
4880 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4882 * @data: NoA tracking data
4883 * @tsf: current TSF timestamp
4885 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
4888 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
4889 * @vif: virtual interface
4890 * @peer: the peer's destination address
4891 * @oper: the requested TDLS operation
4892 * @reason_code: reason code for the operation, valid for TDLS teardown
4893 * @gfp: allocation flags
4895 * See cfg80211_tdls_oper_request().
4897 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
4898 enum nl80211_tdls_operation oper,
4899 u16 reason_code, gfp_t gfp);
4900 #endif /* MAC80211_H */