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];
743 void *status_driver_data[19 / sizeof(void *)];
746 struct ieee80211_tx_rate driver_rates[
747 IEEE80211_TX_MAX_RATES];
750 void *rate_driver_data[
751 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
754 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
759 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
761 * This structure is used to point to different blocks of IEs in HW scan
762 * and scheduled scan. These blocks contain the IEs passed by userspace
763 * and the ones generated by mac80211.
765 * @ies: pointers to band specific IEs.
766 * @len: lengths of band_specific IEs.
767 * @common_ies: IEs for all bands (especially vendor specific ones)
768 * @common_ie_len: length of the common_ies
770 struct ieee80211_scan_ies {
771 const u8 *ies[IEEE80211_NUM_BANDS];
772 size_t len[IEEE80211_NUM_BANDS];
773 const u8 *common_ies;
774 size_t common_ie_len;
778 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
780 return (struct ieee80211_tx_info *)skb->cb;
783 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
785 return (struct ieee80211_rx_status *)skb->cb;
789 * ieee80211_tx_info_clear_status - clear TX status
791 * @info: The &struct ieee80211_tx_info to be cleared.
793 * When the driver passes an skb back to mac80211, it must report
794 * a number of things in TX status. This function clears everything
795 * in the TX status but the rate control information (it does clear
796 * the count since you need to fill that in anyway).
798 * NOTE: You can only use this function if you do NOT use
799 * info->driver_data! Use info->rate_driver_data
800 * instead if you need only the less space that allows.
803 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
807 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
808 offsetof(struct ieee80211_tx_info, control.rates));
809 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
810 offsetof(struct ieee80211_tx_info, driver_rates));
811 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
812 /* clear the rate counts */
813 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
814 info->status.rates[i].count = 0;
817 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
818 memset(&info->status.ampdu_ack_len, 0,
819 sizeof(struct ieee80211_tx_info) -
820 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
825 * enum mac80211_rx_flags - receive flags
827 * These flags are used with the @flag member of &struct ieee80211_rx_status.
828 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
829 * Use together with %RX_FLAG_MMIC_STRIPPED.
830 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
831 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
832 * verification has been done by the hardware.
833 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
834 * If this flag is set, the stack cannot do any replay detection
835 * hence the driver or hardware will have to do that.
836 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
838 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
840 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
841 * field) is valid and contains the time the first symbol of the MPDU
842 * was received. This is useful in monitor mode and for proper IBSS
844 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
845 * field) is valid and contains the time the last symbol of the MPDU
846 * (including FCS) was received.
847 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
848 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
849 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
850 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
851 * @RX_FLAG_SHORT_GI: Short guard interval was used
852 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
853 * Valid only for data frames (mainly A-MPDU)
854 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
855 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
856 * to hw.radiotap_mcs_details to advertise that fact
857 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
858 * number (@ampdu_reference) must be populated and be a distinct number for
860 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
861 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
862 * monitoring purposes only
863 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
864 * subframes of a single A-MPDU
865 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
866 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
868 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
869 * is stored in the @ampdu_delimiter_crc field)
870 * @RX_FLAG_LDPC: LDPC was used
871 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
872 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
873 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
874 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
875 * subframes instead of a one huge frame for performance reasons.
876 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
877 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
878 * the 3rd (last) one must not have this flag set. The flag is used to
879 * deal with retransmission/duplication recovery properly since A-MSDU
880 * subframes share the same sequence number. Reported subframes can be
881 * either regular MSDU or singly A-MSDUs. Subframes must not be
882 * interleaved with other frames.
884 enum mac80211_rx_flags {
885 RX_FLAG_MMIC_ERROR = BIT(0),
886 RX_FLAG_DECRYPTED = BIT(1),
887 RX_FLAG_MMIC_STRIPPED = BIT(3),
888 RX_FLAG_IV_STRIPPED = BIT(4),
889 RX_FLAG_FAILED_FCS_CRC = BIT(5),
890 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
891 RX_FLAG_MACTIME_START = BIT(7),
892 RX_FLAG_SHORTPRE = BIT(8),
894 RX_FLAG_40MHZ = BIT(10),
895 RX_FLAG_SHORT_GI = BIT(11),
896 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
897 RX_FLAG_HT_GF = BIT(13),
898 RX_FLAG_AMPDU_DETAILS = BIT(14),
899 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
900 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
901 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
902 RX_FLAG_AMPDU_IS_LAST = BIT(18),
903 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
904 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
905 RX_FLAG_MACTIME_END = BIT(21),
906 RX_FLAG_VHT = BIT(22),
907 RX_FLAG_LDPC = BIT(23),
908 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
909 RX_FLAG_10MHZ = BIT(28),
910 RX_FLAG_5MHZ = BIT(29),
911 RX_FLAG_AMSDU_MORE = BIT(30),
914 #define RX_FLAG_STBC_SHIFT 26
917 * enum mac80211_rx_vht_flags - receive VHT flags
919 * These flags are used with the @vht_flag member of
920 * &struct ieee80211_rx_status.
921 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
922 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
923 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
924 * @RX_VHT_FLAG_BF: packet was beamformed
926 enum mac80211_rx_vht_flags {
927 RX_VHT_FLAG_80MHZ = BIT(0),
928 RX_VHT_FLAG_80P80MHZ = BIT(1),
929 RX_VHT_FLAG_160MHZ = BIT(2),
930 RX_VHT_FLAG_BF = BIT(3),
934 * struct ieee80211_rx_status - receive status
936 * The low-level driver should provide this information (the subset
937 * supported by hardware) to the 802.11 code with each received
938 * frame, in the skb's control buffer (cb).
940 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
941 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
942 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
943 * it but can store it and pass it back to the driver for synchronisation
944 * @band: the active band when this frame was received
945 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
946 * @signal: signal strength when receiving this frame, either in dBm, in dB or
947 * unspecified depending on the hardware capabilities flags
948 * @IEEE80211_HW_SIGNAL_*
949 * @chains: bitmask of receive chains for which separate signal strength
950 * values were filled.
951 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
952 * support dB or unspecified units)
953 * @antenna: antenna used
954 * @rate_idx: index of data rate into band's supported rates or MCS index if
955 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
956 * @vht_nss: number of streams (VHT only)
958 * @vht_flag: %RX_VHT_FLAG_*
959 * @rx_flags: internal RX flags for mac80211
960 * @ampdu_reference: A-MPDU reference number, must be a different value for
961 * each A-MPDU but the same for each subframe within one A-MPDU
962 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
964 struct ieee80211_rx_status {
966 u32 device_timestamp;
978 s8 chain_signal[IEEE80211_MAX_CHAINS];
979 u8 ampdu_delimiter_crc;
983 * enum ieee80211_conf_flags - configuration flags
985 * Flags to define PHY configuration options
987 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
988 * to determine for example whether to calculate timestamps for packets
989 * or not, do not use instead of filter flags!
990 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
991 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
992 * meaning that the hardware still wakes up for beacons, is able to
993 * transmit frames and receive the possible acknowledgment frames.
994 * Not to be confused with hardware specific wakeup/sleep states,
995 * driver is responsible for that. See the section "Powersave support"
997 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
998 * the driver should be prepared to handle configuration requests but
999 * may turn the device off as much as possible. Typically, this flag will
1000 * be set when an interface is set UP but not associated or scanning, but
1001 * it can also be unset in that case when monitor interfaces are active.
1002 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1003 * operating channel.
1005 enum ieee80211_conf_flags {
1006 IEEE80211_CONF_MONITOR = (1<<0),
1007 IEEE80211_CONF_PS = (1<<1),
1008 IEEE80211_CONF_IDLE = (1<<2),
1009 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1014 * enum ieee80211_conf_changed - denotes which configuration changed
1016 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1017 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1018 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1019 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1020 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1021 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1022 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1023 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1024 * Note that this is only valid if channel contexts are not used,
1025 * otherwise each channel context has the number of chains listed.
1027 enum ieee80211_conf_changed {
1028 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1029 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1030 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1031 IEEE80211_CONF_CHANGE_PS = BIT(4),
1032 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1033 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1034 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1035 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1039 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1041 * @IEEE80211_SMPS_AUTOMATIC: automatic
1042 * @IEEE80211_SMPS_OFF: off
1043 * @IEEE80211_SMPS_STATIC: static
1044 * @IEEE80211_SMPS_DYNAMIC: dynamic
1045 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1047 enum ieee80211_smps_mode {
1048 IEEE80211_SMPS_AUTOMATIC,
1050 IEEE80211_SMPS_STATIC,
1051 IEEE80211_SMPS_DYNAMIC,
1054 IEEE80211_SMPS_NUM_MODES,
1058 * struct ieee80211_conf - configuration of the device
1060 * This struct indicates how the driver shall configure the hardware.
1062 * @flags: configuration flags defined above
1064 * @listen_interval: listen interval in units of beacon interval
1065 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1066 * before checking the beacon for a TIM bit (managed mode only); this
1067 * value will be only achievable between DTIM frames, the hardware
1068 * needs to check for the multicast traffic bit in DTIM beacons.
1069 * This variable is valid only when the CONF_PS flag is set.
1070 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1071 * in power saving. Power saving will not be enabled until a beacon
1072 * has been received and the DTIM period is known.
1073 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1074 * powersave documentation below. This variable is valid only when
1075 * the CONF_PS flag is set.
1077 * @power_level: requested transmit power (in dBm), backward compatibility
1078 * value only that is set to the minimum of all interfaces
1080 * @chandef: the channel definition to tune to
1081 * @radar_enabled: whether radar detection is enabled
1083 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1084 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1085 * but actually means the number of transmissions not the number of retries
1086 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1087 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1088 * number of transmissions not the number of retries
1090 * @smps_mode: spatial multiplexing powersave mode; note that
1091 * %IEEE80211_SMPS_STATIC is used when the device is not
1092 * configured for an HT channel.
1093 * Note that this is only valid if channel contexts are not used,
1094 * otherwise each channel context has the number of chains listed.
1096 struct ieee80211_conf {
1098 int power_level, dynamic_ps_timeout;
1099 int max_sleep_period;
1101 u16 listen_interval;
1104 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1106 struct cfg80211_chan_def chandef;
1108 enum ieee80211_smps_mode smps_mode;
1112 * struct ieee80211_channel_switch - holds the channel switch data
1114 * The information provided in this structure is required for channel switch
1117 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1118 * Function (TSF) timer when the frame containing the channel switch
1119 * announcement was received. This is simply the rx.mactime parameter
1120 * the driver passed into mac80211.
1121 * @device_timestamp: arbitrary timestamp for the device, this is the
1122 * rx.device_timestamp parameter the driver passed to mac80211.
1123 * @block_tx: Indicates whether transmission must be blocked before the
1124 * scheduled channel switch, as indicated by the AP.
1125 * @chandef: the new channel to switch to
1126 * @count: the number of TBTT's until the channel switch event
1128 struct ieee80211_channel_switch {
1130 u32 device_timestamp;
1132 struct cfg80211_chan_def chandef;
1137 * enum ieee80211_vif_flags - virtual interface flags
1139 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1140 * on this virtual interface to avoid unnecessary CPU wakeups
1141 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1142 * monitoring on this virtual interface -- i.e. it can monitor
1143 * connection quality related parameters, such as the RSSI level and
1144 * provide notifications if configured trigger levels are reached.
1146 enum ieee80211_vif_flags {
1147 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1148 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1152 * struct ieee80211_vif - per-interface data
1154 * Data in this structure is continually present for driver
1155 * use during the life of a virtual interface.
1157 * @type: type of this virtual interface
1158 * @bss_conf: BSS configuration for this interface, either our own
1159 * or the BSS we're associated to
1160 * @addr: address of this interface
1161 * @p2p: indicates whether this AP or STA interface is a p2p
1162 * interface, i.e. a GO or p2p-sta respectively
1163 * @csa_active: marks whether a channel switch is going on. Internally it is
1164 * write-protected by sdata_lock and local->mtx so holding either is fine
1166 * @driver_flags: flags/capabilities the driver has for this interface,
1167 * these need to be set (or cleared) when the interface is added
1168 * or, if supported by the driver, the interface type is changed
1169 * at runtime, mac80211 will never touch this field
1170 * @hw_queue: hardware queue for each AC
1171 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1172 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1173 * when it is not assigned. This pointer is RCU-protected due to the TX
1174 * path needing to access it; even though the netdev carrier will always
1175 * be off when it is %NULL there can still be races and packets could be
1176 * processed after it switches back to %NULL.
1177 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1178 * interface debug files. Note that it will be NULL for the virtual
1179 * monitor interface (if that is requested.)
1180 * @drv_priv: data area for driver use, will always be aligned to
1183 struct ieee80211_vif {
1184 enum nl80211_iftype type;
1185 struct ieee80211_bss_conf bss_conf;
1191 u8 hw_queue[IEEE80211_NUM_ACS];
1193 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1197 #ifdef CONFIG_MAC80211_DEBUGFS
1198 struct dentry *debugfs_dir;
1202 u8 drv_priv[0] __aligned(sizeof(void *));
1205 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1207 #ifdef CONFIG_MAC80211_MESH
1208 return vif->type == NL80211_IFTYPE_MESH_POINT;
1214 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1215 * @wdev: the wdev to get the vif for
1217 * This can be used by mac80211 drivers with direct cfg80211 APIs
1218 * (like the vendor commands) that get a wdev.
1220 * Note that this function may return %NULL if the given wdev isn't
1221 * associated with a vif that the driver knows about (e.g. monitor
1222 * or AP_VLAN interfaces.)
1224 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1227 * enum ieee80211_key_flags - key flags
1229 * These flags are used for communication about keys between the driver
1230 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1232 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1233 * driver to indicate that it requires IV generation for this
1234 * particular key. Setting this flag does not necessarily mean that SKBs
1235 * will have sufficient tailroom for ICV or MIC.
1236 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1237 * the driver for a TKIP key if it requires Michael MIC
1238 * generation in software.
1239 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1240 * that the key is pairwise rather then a shared key.
1241 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1242 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1243 * be done in software.
1244 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1245 * if space should be prepared for the IV, but the IV
1246 * itself should not be generated. Do not set together with
1247 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1248 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1250 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1251 * management frames. The flag can help drivers that have a hardware
1252 * crypto implementation that doesn't deal with management frames
1253 * properly by allowing them to not upload the keys to hardware and
1254 * fall back to software crypto. Note that this flag deals only with
1255 * RX, if your crypto engine can't deal with TX you can also set the
1256 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1257 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1258 * driver for a CCMP key to indicate that is requires IV generation
1259 * only for managment frames (MFP).
1261 enum ieee80211_key_flags {
1262 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1263 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1264 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1265 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1266 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1267 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1268 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1272 * struct ieee80211_key_conf - key information
1274 * This key information is given by mac80211 to the driver by
1275 * the set_key() callback in &struct ieee80211_ops.
1277 * @hw_key_idx: To be set by the driver, this is the key index the driver
1278 * wants to be given when a frame is transmitted and needs to be
1279 * encrypted in hardware.
1280 * @cipher: The key's cipher suite selector.
1281 * @flags: key flags, see &enum ieee80211_key_flags.
1282 * @keyidx: the key index (0-3)
1283 * @keylen: key material length
1284 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1286 * - Temporal Encryption Key (128 bits)
1287 * - Temporal Authenticator Tx MIC Key (64 bits)
1288 * - Temporal Authenticator Rx MIC Key (64 bits)
1289 * @icv_len: The ICV length for this key type
1290 * @iv_len: The IV length for this key type
1292 struct ieee80211_key_conf {
1304 * struct ieee80211_cipher_scheme - cipher scheme
1306 * This structure contains a cipher scheme information defining
1307 * the secure packet crypto handling.
1309 * @cipher: a cipher suite selector
1310 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1311 * @hdr_len: a length of a security header used the cipher
1312 * @pn_len: a length of a packet number in the security header
1313 * @pn_off: an offset of pn from the beginning of the security header
1314 * @key_idx_off: an offset of key index byte in the security header
1315 * @key_idx_mask: a bit mask of key_idx bits
1316 * @key_idx_shift: a bit shift needed to get key_idx
1317 * key_idx value calculation:
1318 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1319 * @mic_len: a mic length in bytes
1321 struct ieee80211_cipher_scheme {
1334 * enum set_key_cmd - key command
1336 * Used with the set_key() callback in &struct ieee80211_ops, this
1337 * indicates whether a key is being removed or added.
1339 * @SET_KEY: a key is set
1340 * @DISABLE_KEY: a key must be disabled
1343 SET_KEY, DISABLE_KEY,
1347 * enum ieee80211_sta_state - station state
1349 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1350 * this is a special state for add/remove transitions
1351 * @IEEE80211_STA_NONE: station exists without special state
1352 * @IEEE80211_STA_AUTH: station is authenticated
1353 * @IEEE80211_STA_ASSOC: station is associated
1354 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1356 enum ieee80211_sta_state {
1357 /* NOTE: These need to be ordered correctly! */
1358 IEEE80211_STA_NOTEXIST,
1361 IEEE80211_STA_ASSOC,
1362 IEEE80211_STA_AUTHORIZED,
1366 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1367 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1368 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1369 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1370 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1371 * (including 80+80 MHz)
1373 * Implementation note: 20 must be zero to be initialized
1374 * correctly, the values must be sorted.
1376 enum ieee80211_sta_rx_bandwidth {
1377 IEEE80211_STA_RX_BW_20 = 0,
1378 IEEE80211_STA_RX_BW_40,
1379 IEEE80211_STA_RX_BW_80,
1380 IEEE80211_STA_RX_BW_160,
1384 * struct ieee80211_sta_rates - station rate selection table
1386 * @rcu_head: RCU head used for freeing the table on update
1387 * @rate: transmit rates/flags to be used by default.
1388 * Overriding entries per-packet is possible by using cb tx control.
1390 struct ieee80211_sta_rates {
1391 struct rcu_head rcu_head;
1398 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1402 * struct ieee80211_sta - station table entry
1404 * A station table entry represents a station we are possibly
1405 * communicating with. Since stations are RCU-managed in
1406 * mac80211, any ieee80211_sta pointer you get access to must
1407 * either be protected by rcu_read_lock() explicitly or implicitly,
1408 * or you must take good care to not use such a pointer after a
1409 * call to your sta_remove callback that removed it.
1411 * @addr: MAC address
1412 * @aid: AID we assigned to the station if we're an AP
1413 * @supp_rates: Bitmap of supported rates (per band)
1414 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1415 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1416 * @wme: indicates whether the STA supports QoS/WME.
1417 * @drv_priv: data area for driver use, will always be aligned to
1418 * sizeof(void *), size is determined in hw information.
1419 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1420 * if wme is supported.
1421 * @max_sp: max Service Period. Only valid if wme is supported.
1422 * @bandwidth: current bandwidth the station can receive with
1423 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1424 * station can receive at the moment, changed by operating mode
1425 * notifications and capabilities. The value is only valid after
1426 * the station moves to associated state.
1427 * @smps_mode: current SMPS mode (off, static or dynamic)
1428 * @rates: rate control selection table
1429 * @tdls: indicates whether the STA is a TDLS peer
1430 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1431 * valid if the STA is a TDLS peer in the first place.
1433 struct ieee80211_sta {
1434 u32 supp_rates[IEEE80211_NUM_BANDS];
1437 struct ieee80211_sta_ht_cap ht_cap;
1438 struct ieee80211_sta_vht_cap vht_cap;
1443 enum ieee80211_sta_rx_bandwidth bandwidth;
1444 enum ieee80211_smps_mode smps_mode;
1445 struct ieee80211_sta_rates __rcu *rates;
1447 bool tdls_initiator;
1450 u8 drv_priv[0] __aligned(sizeof(void *));
1454 * enum sta_notify_cmd - sta notify command
1456 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1457 * indicates if an associated station made a power state transition.
1459 * @STA_NOTIFY_SLEEP: a station is now sleeping
1460 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1462 enum sta_notify_cmd {
1463 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1467 * struct ieee80211_tx_control - TX control data
1469 * @sta: station table entry, this sta pointer may be NULL and
1470 * it is not allowed to copy the pointer, due to RCU.
1472 struct ieee80211_tx_control {
1473 struct ieee80211_sta *sta;
1477 * enum ieee80211_hw_flags - hardware flags
1479 * These flags are used to indicate hardware capabilities to
1480 * the stack. Generally, flags here should have their meaning
1481 * done in a way that the simplest hardware doesn't need setting
1482 * any particular flags. There are some exceptions to this rule,
1483 * however, so you are advised to review these flags carefully.
1485 * @IEEE80211_HW_HAS_RATE_CONTROL:
1486 * The hardware or firmware includes rate control, and cannot be
1487 * controlled by the stack. As such, no rate control algorithm
1488 * should be instantiated, and the TX rate reported to userspace
1489 * will be taken from the TX status instead of the rate control
1491 * Note that this requires that the driver implement a number of
1492 * callbacks so it has the correct information, it needs to have
1493 * the @set_rts_threshold callback and must look at the BSS config
1494 * @use_cts_prot for G/N protection, @use_short_slot for slot
1495 * timing in 2.4 GHz and @use_short_preamble for preambles for
1498 * @IEEE80211_HW_RX_INCLUDES_FCS:
1499 * Indicates that received frames passed to the stack include
1500 * the FCS at the end.
1502 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1503 * Some wireless LAN chipsets buffer broadcast/multicast frames
1504 * for power saving stations in the hardware/firmware and others
1505 * rely on the host system for such buffering. This option is used
1506 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1507 * multicast frames when there are power saving stations so that
1508 * the driver can fetch them with ieee80211_get_buffered_bc().
1510 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1511 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1513 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1514 * Hardware is not capable of receiving frames with short preamble on
1517 * @IEEE80211_HW_SIGNAL_UNSPEC:
1518 * Hardware can provide signal values but we don't know its units. We
1519 * expect values between 0 and @max_signal.
1520 * If possible please provide dB or dBm instead.
1522 * @IEEE80211_HW_SIGNAL_DBM:
1523 * Hardware gives signal values in dBm, decibel difference from
1524 * one milliwatt. This is the preferred method since it is standardized
1525 * between different devices. @max_signal does not need to be set.
1527 * @IEEE80211_HW_SPECTRUM_MGMT:
1528 * Hardware supports spectrum management defined in 802.11h
1529 * Measurement, Channel Switch, Quieting, TPC
1531 * @IEEE80211_HW_AMPDU_AGGREGATION:
1532 * Hardware supports 11n A-MPDU aggregation.
1534 * @IEEE80211_HW_SUPPORTS_PS:
1535 * Hardware has power save support (i.e. can go to sleep).
1537 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1538 * Hardware requires nullfunc frame handling in stack, implies
1539 * stack support for dynamic PS.
1541 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1542 * Hardware has support for dynamic PS.
1544 * @IEEE80211_HW_MFP_CAPABLE:
1545 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1547 * @IEEE80211_HW_SUPPORTS_UAPSD:
1548 * Hardware supports Unscheduled Automatic Power Save Delivery
1549 * (U-APSD) in managed mode. The mode is configured with
1550 * conf_tx() operation.
1552 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1553 * Hardware can provide ack status reports of Tx frames to
1556 * @IEEE80211_HW_CONNECTION_MONITOR:
1557 * The hardware performs its own connection monitoring, including
1558 * periodic keep-alives to the AP and probing the AP on beacon loss.
1560 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1561 * This device needs to get data from beacon before association (i.e.
1564 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1565 * per-station GTKs as used by IBSS RSN or during fast transition. If
1566 * the device doesn't support per-station GTKs, but can be asked not
1567 * to decrypt group addressed frames, then IBSS RSN support is still
1568 * possible but software crypto will be used. Advertise the wiphy flag
1569 * only in that case.
1571 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1572 * autonomously manages the PS status of connected stations. When
1573 * this flag is set mac80211 will not trigger PS mode for connected
1574 * stations based on the PM bit of incoming frames.
1575 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1576 * the PS mode of connected stations.
1578 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1579 * setup strictly in HW. mac80211 should not attempt to do this in
1582 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1583 * a virtual monitor interface when monitor interfaces are the only
1584 * active interfaces.
1586 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1587 * queue mapping in order to use different queues (not just one per AC)
1588 * for different virtual interfaces. See the doc section on HW queue
1589 * control for more details.
1591 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1592 * selection table provided by the rate control algorithm.
1594 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1595 * P2P Interface. This will be honoured even if more than one interface
1598 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1599 * only, to allow getting TBTT of a DTIM beacon.
1601 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1602 * and can cope with CCK rates in an aggregation session (e.g. by not
1603 * using aggregation for such frames.)
1605 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1606 * for a single active channel while using channel contexts. When support
1607 * is not enabled the default action is to disconnect when getting the
1610 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1611 * or tailroom of TX skbs without copying them first.
1613 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1614 * in one command, mac80211 doesn't have to run separate scans per band.
1616 enum ieee80211_hw_flags {
1617 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1618 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1619 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1620 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1621 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1622 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1623 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1624 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1625 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1626 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1627 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1628 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1629 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1630 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1631 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1633 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1634 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1635 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1636 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1637 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1638 IEEE80211_HW_AP_LINK_PS = 1<<22,
1639 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1640 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1641 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1642 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1643 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1644 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1645 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29,
1646 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
1650 * struct ieee80211_hw - hardware information and state
1652 * This structure contains the configuration and hardware
1653 * information for an 802.11 PHY.
1655 * @wiphy: This points to the &struct wiphy allocated for this
1656 * 802.11 PHY. You must fill in the @perm_addr and @dev
1657 * members of this structure using SET_IEEE80211_DEV()
1658 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1659 * bands (with channels, bitrates) are registered here.
1661 * @conf: &struct ieee80211_conf, device configuration, don't use.
1663 * @priv: pointer to private area that was allocated for driver use
1664 * along with this structure.
1666 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1668 * @extra_tx_headroom: headroom to reserve in each transmit skb
1669 * for use by the driver (e.g. for transmit headers.)
1671 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1672 * Can be used by drivers to add extra IEs.
1674 * @max_signal: Maximum value for signal (rssi) in RX information, used
1675 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1677 * @max_listen_interval: max listen interval in units of beacon interval
1680 * @queues: number of available hardware transmit queues for
1681 * data packets. WMM/QoS requires at least four, these
1682 * queues need to have configurable access parameters.
1684 * @rate_control_algorithm: rate control algorithm for this hardware.
1685 * If unset (NULL), the default algorithm will be used. Must be
1686 * set before calling ieee80211_register_hw().
1688 * @vif_data_size: size (in bytes) of the drv_priv data area
1689 * within &struct ieee80211_vif.
1690 * @sta_data_size: size (in bytes) of the drv_priv data area
1691 * within &struct ieee80211_sta.
1692 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1693 * within &struct ieee80211_chanctx_conf.
1695 * @max_rates: maximum number of alternate rate retry stages the hw
1697 * @max_report_rates: maximum number of alternate rate retry stages
1698 * the hw can report back.
1699 * @max_rate_tries: maximum number of tries for each stage
1701 * @max_rx_aggregation_subframes: maximum buffer size (number of
1702 * sub-frames) to be used for A-MPDU block ack receiver
1704 * This is only relevant if the device has restrictions on the
1705 * number of subframes, if it relies on mac80211 to do reordering
1706 * it shouldn't be set.
1708 * @max_tx_aggregation_subframes: maximum number of subframes in an
1709 * aggregate an HT driver will transmit, used by the peer as a
1710 * hint to size its reorder buffer.
1712 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1713 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1715 * @radiotap_mcs_details: lists which MCS information can the HW
1716 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1717 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1718 * adding _BW is supported today.
1720 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1721 * the default is _GI | _BANDWIDTH.
1722 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1724 * @netdev_features: netdev features to be set in each netdev created
1725 * from this HW. Note only HW checksum features are currently
1726 * compatible with mac80211. Other feature bits will be rejected.
1728 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1729 * for each access category if it is uAPSD trigger-enabled and delivery-
1730 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1731 * Each bit corresponds to different AC. Value '1' in specific bit means
1732 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1735 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1736 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1737 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1739 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1740 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1743 struct ieee80211_hw {
1744 struct ieee80211_conf conf;
1745 struct wiphy *wiphy;
1746 const char *rate_control_algorithm;
1749 unsigned int extra_tx_headroom;
1750 unsigned int extra_beacon_tailroom;
1753 int chanctx_data_size;
1755 u16 max_listen_interval;
1758 u8 max_report_rates;
1760 u8 max_rx_aggregation_subframes;
1761 u8 max_tx_aggregation_subframes;
1762 u8 offchannel_tx_hw_queue;
1763 u8 radiotap_mcs_details;
1764 u16 radiotap_vht_details;
1765 netdev_features_t netdev_features;
1767 u8 uapsd_max_sp_len;
1768 u8 n_cipher_schemes;
1769 const struct ieee80211_cipher_scheme *cipher_schemes;
1773 * struct ieee80211_scan_request - hw scan request
1775 * @ies: pointers different parts of IEs (in req.ie)
1776 * @req: cfg80211 request.
1778 struct ieee80211_scan_request {
1779 struct ieee80211_scan_ies ies;
1782 struct cfg80211_scan_request req;
1786 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1788 * @wiphy: the &struct wiphy which we want to query
1790 * mac80211 drivers can use this to get to their respective
1791 * &struct ieee80211_hw. Drivers wishing to get to their own private
1792 * structure can then access it via hw->priv. Note that mac802111 drivers should
1793 * not use wiphy_priv() to try to get their private driver structure as this
1794 * is already used internally by mac80211.
1796 * Return: The mac80211 driver hw struct of @wiphy.
1798 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1801 * SET_IEEE80211_DEV - set device for 802.11 hardware
1803 * @hw: the &struct ieee80211_hw to set the device for
1804 * @dev: the &struct device of this 802.11 device
1806 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1808 set_wiphy_dev(hw->wiphy, dev);
1812 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1814 * @hw: the &struct ieee80211_hw to set the MAC address for
1815 * @addr: the address to set
1817 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1819 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1822 static inline struct ieee80211_rate *
1823 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1824 const struct ieee80211_tx_info *c)
1826 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1828 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1831 static inline struct ieee80211_rate *
1832 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1833 const struct ieee80211_tx_info *c)
1835 if (c->control.rts_cts_rate_idx < 0)
1837 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1840 static inline struct ieee80211_rate *
1841 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1842 const struct ieee80211_tx_info *c, int idx)
1844 if (c->control.rates[idx + 1].idx < 0)
1846 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1850 * ieee80211_free_txskb - free TX skb
1854 * Free a transmit skb. Use this funtion when some failure
1855 * to transmit happened and thus status cannot be reported.
1857 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1860 * DOC: Hardware crypto acceleration
1862 * mac80211 is capable of taking advantage of many hardware
1863 * acceleration designs for encryption and decryption operations.
1865 * The set_key() callback in the &struct ieee80211_ops for a given
1866 * device is called to enable hardware acceleration of encryption and
1867 * decryption. The callback takes a @sta parameter that will be NULL
1868 * for default keys or keys used for transmission only, or point to
1869 * the station information for the peer for individual keys.
1870 * Multiple transmission keys with the same key index may be used when
1871 * VLANs are configured for an access point.
1873 * When transmitting, the TX control data will use the @hw_key_idx
1874 * selected by the driver by modifying the &struct ieee80211_key_conf
1875 * pointed to by the @key parameter to the set_key() function.
1877 * The set_key() call for the %SET_KEY command should return 0 if
1878 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1879 * added; if you return 0 then hw_key_idx must be assigned to the
1880 * hardware key index, you are free to use the full u8 range.
1882 * When the cmd is %DISABLE_KEY then it must succeed.
1884 * Note that it is permissible to not decrypt a frame even if a key
1885 * for it has been uploaded to hardware, the stack will not make any
1886 * decision based on whether a key has been uploaded or not but rather
1887 * based on the receive flags.
1889 * The &struct ieee80211_key_conf structure pointed to by the @key
1890 * parameter is guaranteed to be valid until another call to set_key()
1891 * removes it, but it can only be used as a cookie to differentiate
1894 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1895 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1897 * The update_tkip_key() call updates the driver with the new phase 1 key.
1898 * This happens every time the iv16 wraps around (every 65536 packets). The
1899 * set_key() call will happen only once for each key (unless the AP did
1900 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1901 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1902 * handler is software decryption with wrap around of iv16.
1904 * The set_default_unicast_key() call updates the default WEP key index
1905 * configured to the hardware for WEP encryption type. This is required
1906 * for devices that support offload of data packets (e.g. ARP responses).
1910 * DOC: Powersave support
1912 * mac80211 has support for various powersave implementations.
1914 * First, it can support hardware that handles all powersaving by itself,
1915 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1916 * flag. In that case, it will be told about the desired powersave mode
1917 * with the %IEEE80211_CONF_PS flag depending on the association status.
1918 * The hardware must take care of sending nullfunc frames when necessary,
1919 * i.e. when entering and leaving powersave mode. The hardware is required
1920 * to look at the AID in beacons and signal to the AP that it woke up when
1921 * it finds traffic directed to it.
1923 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1924 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1925 * with hardware wakeup and sleep states. Driver is responsible for waking
1926 * up the hardware before issuing commands to the hardware and putting it
1927 * back to sleep at appropriate times.
1929 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1930 * buffered multicast/broadcast frames after the beacon. Also it must be
1931 * possible to send frames and receive the acknowledment frame.
1933 * Other hardware designs cannot send nullfunc frames by themselves and also
1934 * need software support for parsing the TIM bitmap. This is also supported
1935 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1936 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1937 * required to pass up beacons. The hardware is still required to handle
1938 * waking up for multicast traffic; if it cannot the driver must handle that
1939 * as best as it can, mac80211 is too slow to do that.
1941 * Dynamic powersave is an extension to normal powersave in which the
1942 * hardware stays awake for a user-specified period of time after sending a
1943 * frame so that reply frames need not be buffered and therefore delayed to
1944 * the next wakeup. It's compromise of getting good enough latency when
1945 * there's data traffic and still saving significantly power in idle
1948 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1949 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1950 * flag and mac80211 will handle everything automatically. Additionally,
1951 * hardware having support for the dynamic PS feature may set the
1952 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1953 * dynamic PS mode itself. The driver needs to look at the
1954 * @dynamic_ps_timeout hardware configuration value and use it that value
1955 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1956 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1957 * enabled whenever user has enabled powersave.
1959 * Driver informs U-APSD client support by enabling
1960 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1961 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
1962 * Nullfunc frames and stay awake until the service period has ended. To
1963 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1964 * from that AC are transmitted with powersave enabled.
1966 * Note: U-APSD client mode is not yet supported with
1967 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1971 * DOC: Beacon filter support
1973 * Some hardware have beacon filter support to reduce host cpu wakeups
1974 * which will reduce system power consumption. It usually works so that
1975 * the firmware creates a checksum of the beacon but omits all constantly
1976 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1977 * beacon is forwarded to the host, otherwise it will be just dropped. That
1978 * way the host will only receive beacons where some relevant information
1979 * (for example ERP protection or WMM settings) have changed.
1981 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1982 * interface capability. The driver needs to enable beacon filter support
1983 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1984 * power save is enabled, the stack will not check for beacon loss and the
1985 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1987 * The time (or number of beacons missed) until the firmware notifies the
1988 * driver of a beacon loss event (which in turn causes the driver to call
1989 * ieee80211_beacon_loss()) should be configurable and will be controlled
1990 * by mac80211 and the roaming algorithm in the future.
1992 * Since there may be constantly changing information elements that nothing
1993 * in the software stack cares about, we will, in the future, have mac80211
1994 * tell the driver which information elements are interesting in the sense
1995 * that we want to see changes in them. This will include
1996 * - a list of information element IDs
1997 * - a list of OUIs for the vendor information element
1999 * Ideally, the hardware would filter out any beacons without changes in the
2000 * requested elements, but if it cannot support that it may, at the expense
2001 * of some efficiency, filter out only a subset. For example, if the device
2002 * doesn't support checking for OUIs it should pass up all changes in all
2003 * vendor information elements.
2005 * Note that change, for the sake of simplification, also includes information
2006 * elements appearing or disappearing from the beacon.
2008 * Some hardware supports an "ignore list" instead, just make sure nothing
2009 * that was requested is on the ignore list, and include commonly changing
2010 * information element IDs in the ignore list, for example 11 (BSS load) and
2011 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2012 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2013 * it could also include some currently unused IDs.
2016 * In addition to these capabilities, hardware should support notifying the
2017 * host of changes in the beacon RSSI. This is relevant to implement roaming
2018 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2019 * the received data packets). This can consist in notifying the host when
2020 * the RSSI changes significantly or when it drops below or rises above
2021 * configurable thresholds. In the future these thresholds will also be
2022 * configured by mac80211 (which gets them from userspace) to implement
2023 * them as the roaming algorithm requires.
2025 * If the hardware cannot implement this, the driver should ask it to
2026 * periodically pass beacon frames to the host so that software can do the
2027 * signal strength threshold checking.
2031 * DOC: Spatial multiplexing power save
2033 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2034 * power in an 802.11n implementation. For details on the mechanism
2035 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2036 * "11.2.3 SM power save".
2038 * The mac80211 implementation is capable of sending action frames
2039 * to update the AP about the station's SMPS mode, and will instruct
2040 * the driver to enter the specific mode. It will also announce the
2041 * requested SMPS mode during the association handshake. Hardware
2042 * support for this feature is required, and can be indicated by
2045 * The default mode will be "automatic", which nl80211/cfg80211
2046 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2047 * turned off otherwise.
2049 * To support this feature, the driver must set the appropriate
2050 * hardware support flags, and handle the SMPS flag to the config()
2051 * operation. It will then with this mechanism be instructed to
2052 * enter the requested SMPS mode while associated to an HT AP.
2056 * DOC: Frame filtering
2058 * mac80211 requires to see many management frames for proper
2059 * operation, and users may want to see many more frames when
2060 * in monitor mode. However, for best CPU usage and power consumption,
2061 * having as few frames as possible percolate through the stack is
2062 * desirable. Hence, the hardware should filter as much as possible.
2064 * To achieve this, mac80211 uses filter flags (see below) to tell
2065 * the driver's configure_filter() function which frames should be
2066 * passed to mac80211 and which should be filtered out.
2068 * Before configure_filter() is invoked, the prepare_multicast()
2069 * callback is invoked with the parameters @mc_count and @mc_list
2070 * for the combined multicast address list of all virtual interfaces.
2071 * It's use is optional, and it returns a u64 that is passed to
2072 * configure_filter(). Additionally, configure_filter() has the
2073 * arguments @changed_flags telling which flags were changed and
2074 * @total_flags with the new flag states.
2076 * If your device has no multicast address filters your driver will
2077 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2078 * parameter to see whether multicast frames should be accepted
2081 * All unsupported flags in @total_flags must be cleared.
2082 * Hardware does not support a flag if it is incapable of _passing_
2083 * the frame to the stack. Otherwise the driver must ignore
2084 * the flag, but not clear it.
2085 * You must _only_ clear the flag (announce no support for the
2086 * flag to mac80211) if you are not able to pass the packet type
2087 * to the stack (so the hardware always filters it).
2088 * So for example, you should clear @FIF_CONTROL, if your hardware
2089 * always filters control frames. If your hardware always passes
2090 * control frames to the kernel and is incapable of filtering them,
2091 * you do _not_ clear the @FIF_CONTROL flag.
2092 * This rule applies to all other FIF flags as well.
2096 * DOC: AP support for powersaving clients
2098 * In order to implement AP and P2P GO modes, mac80211 has support for
2099 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2100 * There currently is no support for sAPSD.
2102 * There is one assumption that mac80211 makes, namely that a client
2103 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2104 * Both are supported, and both can be used by the same client, but
2105 * they can't be used concurrently by the same client. This simplifies
2108 * The first thing to keep in mind is that there is a flag for complete
2109 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2110 * mac80211 expects the driver to handle most of the state machine for
2111 * powersaving clients and will ignore the PM bit in incoming frames.
2112 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2113 * stations' powersave transitions. In this mode, mac80211 also doesn't
2114 * handle PS-Poll/uAPSD.
2116 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2117 * PM bit in incoming frames for client powersave transitions. When a
2118 * station goes to sleep, we will stop transmitting to it. There is,
2119 * however, a race condition: a station might go to sleep while there is
2120 * data buffered on hardware queues. If the device has support for this
2121 * it will reject frames, and the driver should give the frames back to
2122 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2123 * cause mac80211 to retry the frame when the station wakes up. The
2124 * driver is also notified of powersave transitions by calling its
2125 * @sta_notify callback.
2127 * When the station is asleep, it has three choices: it can wake up,
2128 * it can PS-Poll, or it can possibly start a uAPSD service period.
2129 * Waking up is implemented by simply transmitting all buffered (and
2130 * filtered) frames to the station. This is the easiest case. When
2131 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2132 * will inform the driver of this with the @allow_buffered_frames
2133 * callback; this callback is optional. mac80211 will then transmit
2134 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2135 * on each frame. The last frame in the service period (or the only
2136 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2137 * indicate that it ends the service period; as this frame must have
2138 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2139 * When TX status is reported for this frame, the service period is
2140 * marked has having ended and a new one can be started by the peer.
2142 * Additionally, non-bufferable MMPDUs can also be transmitted by
2143 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2145 * Another race condition can happen on some devices like iwlwifi
2146 * when there are frames queued for the station and it wakes up
2147 * or polls; the frames that are already queued could end up being
2148 * transmitted first instead, causing reordering and/or wrong
2149 * processing of the EOSP. The cause is that allowing frames to be
2150 * transmitted to a certain station is out-of-band communication to
2151 * the device. To allow this problem to be solved, the driver can
2152 * call ieee80211_sta_block_awake() if frames are buffered when it
2153 * is notified that the station went to sleep. When all these frames
2154 * have been filtered (see above), it must call the function again
2155 * to indicate that the station is no longer blocked.
2157 * If the driver buffers frames in the driver for aggregation in any
2158 * way, it must use the ieee80211_sta_set_buffered() call when it is
2159 * notified of the station going to sleep to inform mac80211 of any
2160 * TIDs that have frames buffered. Note that when a station wakes up
2161 * this information is reset (hence the requirement to call it when
2162 * informed of the station going to sleep). Then, when a service
2163 * period starts for any reason, @release_buffered_frames is called
2164 * with the number of frames to be released and which TIDs they are
2165 * to come from. In this case, the driver is responsible for setting
2166 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2167 * to help the @more_data parameter is passed to tell the driver if
2168 * there is more data on other TIDs -- the TIDs to release frames
2169 * from are ignored since mac80211 doesn't know how many frames the
2170 * buffers for those TIDs contain.
2172 * If the driver also implement GO mode, where absence periods may
2173 * shorten service periods (or abort PS-Poll responses), it must
2174 * filter those response frames except in the case of frames that
2175 * are buffered in the driver -- those must remain buffered to avoid
2176 * reordering. Because it is possible that no frames are released
2177 * in this case, the driver must call ieee80211_sta_eosp()
2178 * to indicate to mac80211 that the service period ended anyway.
2180 * Finally, if frames from multiple TIDs are released from mac80211
2181 * but the driver might reorder them, it must clear & set the flags
2182 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2183 * and also take care of the EOSP and MORE_DATA bits in the frame.
2184 * The driver may also use ieee80211_sta_eosp() in this case.
2186 * Note that if the driver ever buffers frames other than QoS-data
2187 * frames, it must take care to never send a non-QoS-data frame as
2188 * the last frame in a service period, adding a QoS-nulldata frame
2189 * after a non-QoS-data frame if needed.
2193 * DOC: HW queue control
2195 * Before HW queue control was introduced, mac80211 only had a single static
2196 * assignment of per-interface AC software queues to hardware queues. This
2197 * was problematic for a few reasons:
2198 * 1) off-channel transmissions might get stuck behind other frames
2199 * 2) multiple virtual interfaces couldn't be handled correctly
2200 * 3) after-DTIM frames could get stuck behind other frames
2202 * To solve this, hardware typically uses multiple different queues for all
2203 * the different usages, and this needs to be propagated into mac80211 so it
2204 * won't have the same problem with the software queues.
2206 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2207 * flag that tells it that the driver implements its own queue control. To do
2208 * so, the driver will set up the various queues in each &struct ieee80211_vif
2209 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2210 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2211 * if necessary will queue the frame on the right software queue that mirrors
2212 * the hardware queue.
2213 * Additionally, the driver has to then use these HW queue IDs for the queue
2214 * management functions (ieee80211_stop_queue() et al.)
2216 * The driver is free to set up the queue mappings as needed, multiple virtual
2217 * interfaces may map to the same hardware queues if needed. The setup has to
2218 * happen during add_interface or change_interface callbacks. For example, a
2219 * driver supporting station+station and station+AP modes might decide to have
2220 * 10 hardware queues to handle different scenarios:
2222 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2223 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2224 * after-DTIM queue for AP: 8
2225 * off-channel queue: 9
2227 * It would then set up the hardware like this:
2228 * hw.offchannel_tx_hw_queue = 9
2230 * and the first virtual interface that is added as follows:
2231 * vif.hw_queue[IEEE80211_AC_VO] = 0
2232 * vif.hw_queue[IEEE80211_AC_VI] = 1
2233 * vif.hw_queue[IEEE80211_AC_BE] = 2
2234 * vif.hw_queue[IEEE80211_AC_BK] = 3
2235 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2236 * and the second virtual interface with 4-7.
2238 * If queue 6 gets full, for example, mac80211 would only stop the second
2239 * virtual interface's BE queue since virtual interface queues are per AC.
2241 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2242 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2243 * queue could potentially be shared since mac80211 will look at cab_queue when
2244 * a queue is stopped/woken even if the interface is not in AP mode.
2248 * enum ieee80211_filter_flags - hardware filter flags
2250 * These flags determine what the filter in hardware should be
2251 * programmed to let through and what should not be passed to the
2252 * stack. It is always safe to pass more frames than requested,
2253 * but this has negative impact on power consumption.
2255 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2256 * think of the BSS as your network segment and then this corresponds
2257 * to the regular ethernet device promiscuous mode.
2259 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2260 * by the user or if the hardware is not capable of filtering by
2261 * multicast address.
2263 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2264 * %RX_FLAG_FAILED_FCS_CRC for them)
2266 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2267 * the %RX_FLAG_FAILED_PLCP_CRC for them
2269 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2270 * to the hardware that it should not filter beacons or probe responses
2271 * by BSSID. Filtering them can greatly reduce the amount of processing
2272 * mac80211 needs to do and the amount of CPU wakeups, so you should
2273 * honour this flag if possible.
2275 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2276 * is not set then only those addressed to this station.
2278 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2280 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2281 * those addressed to this station.
2283 * @FIF_PROBE_REQ: pass probe request frames
2285 enum ieee80211_filter_flags {
2286 FIF_PROMISC_IN_BSS = 1<<0,
2287 FIF_ALLMULTI = 1<<1,
2289 FIF_PLCPFAIL = 1<<3,
2290 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2292 FIF_OTHER_BSS = 1<<6,
2294 FIF_PROBE_REQ = 1<<8,
2298 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2300 * These flags are used with the ampdu_action() callback in
2301 * &struct ieee80211_ops to indicate which action is needed.
2303 * Note that drivers MUST be able to deal with a TX aggregation
2304 * session being stopped even before they OK'ed starting it by
2305 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2306 * might receive the addBA frame and send a delBA right away!
2308 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2309 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2310 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2311 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2312 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2313 * queued packets, now unaggregated. After all packets are transmitted the
2314 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2315 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2316 * called when the station is removed. There's no need or reason to call
2317 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2318 * session is gone and removes the station.
2319 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2320 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2321 * now the connection is dropped and the station will be removed. Drivers
2322 * should clean up and drop remaining packets when this is called.
2324 enum ieee80211_ampdu_mlme_action {
2325 IEEE80211_AMPDU_RX_START,
2326 IEEE80211_AMPDU_RX_STOP,
2327 IEEE80211_AMPDU_TX_START,
2328 IEEE80211_AMPDU_TX_STOP_CONT,
2329 IEEE80211_AMPDU_TX_STOP_FLUSH,
2330 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2331 IEEE80211_AMPDU_TX_OPERATIONAL,
2335 * enum ieee80211_frame_release_type - frame release reason
2336 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2337 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2338 * frame received on trigger-enabled AC
2340 enum ieee80211_frame_release_type {
2341 IEEE80211_FRAME_RELEASE_PSPOLL,
2342 IEEE80211_FRAME_RELEASE_UAPSD,
2346 * enum ieee80211_rate_control_changed - flags to indicate what changed
2348 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2349 * to this station changed. The actual bandwidth is in the station
2350 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2351 * flag changes, for HT and VHT the bandwidth field changes.
2352 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2353 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2354 * changed (in IBSS mode) due to discovering more information about
2356 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2359 enum ieee80211_rate_control_changed {
2360 IEEE80211_RC_BW_CHANGED = BIT(0),
2361 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2362 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2363 IEEE80211_RC_NSS_CHANGED = BIT(3),
2367 * enum ieee80211_roc_type - remain on channel type
2369 * With the support for multi channel contexts and multi channel operations,
2370 * remain on channel operations might be limited/deferred/aborted by other
2371 * flows/operations which have higher priority (and vise versa).
2372 * Specifying the ROC type can be used by devices to prioritize the ROC
2373 * operations compared to other operations/flows.
2375 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2376 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2377 * for sending managment frames offchannel.
2379 enum ieee80211_roc_type {
2380 IEEE80211_ROC_TYPE_NORMAL = 0,
2381 IEEE80211_ROC_TYPE_MGMT_TX,
2385 * struct ieee80211_ops - callbacks from mac80211 to the driver
2387 * This structure contains various callbacks that the driver may
2388 * handle or, in some cases, must handle, for example to configure
2389 * the hardware to a new channel or to transmit a frame.
2391 * @tx: Handler that 802.11 module calls for each transmitted frame.
2392 * skb contains the buffer starting from the IEEE 802.11 header.
2393 * The low-level driver should send the frame out based on
2394 * configuration in the TX control data. This handler should,
2395 * preferably, never fail and stop queues appropriately.
2398 * @start: Called before the first netdevice attached to the hardware
2399 * is enabled. This should turn on the hardware and must turn on
2400 * frame reception (for possibly enabled monitor interfaces.)
2401 * Returns negative error codes, these may be seen in userspace,
2403 * When the device is started it should not have a MAC address
2404 * to avoid acknowledging frames before a non-monitor device
2406 * Must be implemented and can sleep.
2408 * @stop: Called after last netdevice attached to the hardware
2409 * is disabled. This should turn off the hardware (at least
2410 * it must turn off frame reception.)
2411 * May be called right after add_interface if that rejects
2412 * an interface. If you added any work onto the mac80211 workqueue
2413 * you should ensure to cancel it on this callback.
2414 * Must be implemented and can sleep.
2416 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2417 * stop transmitting and doing any other configuration, and then
2418 * ask the device to suspend. This is only invoked when WoWLAN is
2419 * configured, otherwise the device is deconfigured completely and
2420 * reconfigured at resume time.
2421 * The driver may also impose special conditions under which it
2422 * wants to use the "normal" suspend (deconfigure), say if it only
2423 * supports WoWLAN when the device is associated. In this case, it
2424 * must return 1 from this function.
2426 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2427 * now resuming its operation, after this the device must be fully
2428 * functional again. If this returns an error, the only way out is
2429 * to also unregister the device. If it returns 1, then mac80211
2430 * will also go through the regular complete restart on resume.
2432 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2433 * modified. The reason is that device_set_wakeup_enable() is
2434 * supposed to be called when the configuration changes, not only
2437 * @add_interface: Called when a netdevice attached to the hardware is
2438 * enabled. Because it is not called for monitor mode devices, @start
2439 * and @stop must be implemented.
2440 * The driver should perform any initialization it needs before
2441 * the device can be enabled. The initial configuration for the
2442 * interface is given in the conf parameter.
2443 * The callback may refuse to add an interface by returning a
2444 * negative error code (which will be seen in userspace.)
2445 * Must be implemented and can sleep.
2447 * @change_interface: Called when a netdevice changes type. This callback
2448 * is optional, but only if it is supported can interface types be
2449 * switched while the interface is UP. The callback may sleep.
2450 * Note that while an interface is being switched, it will not be
2451 * found by the interface iteration callbacks.
2453 * @remove_interface: Notifies a driver that an interface is going down.
2454 * The @stop callback is called after this if it is the last interface
2455 * and no monitor interfaces are present.
2456 * When all interfaces are removed, the MAC address in the hardware
2457 * must be cleared so the device no longer acknowledges packets,
2458 * the mac_addr member of the conf structure is, however, set to the
2459 * MAC address of the device going away.
2460 * Hence, this callback must be implemented. It can sleep.
2462 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2463 * function to change hardware configuration, e.g., channel.
2464 * This function should never fail but returns a negative error code
2465 * if it does. The callback can sleep.
2467 * @bss_info_changed: Handler for configuration requests related to BSS
2468 * parameters that may vary during BSS's lifespan, and may affect low
2469 * level driver (e.g. assoc/disassoc status, erp parameters).
2470 * This function should not be used if no BSS has been set, unless
2471 * for association indication. The @changed parameter indicates which
2472 * of the bss parameters has changed when a call is made. The callback
2475 * @prepare_multicast: Prepare for multicast filter configuration.
2476 * This callback is optional, and its return value is passed
2477 * to configure_filter(). This callback must be atomic.
2479 * @configure_filter: Configure the device's RX filter.
2480 * See the section "Frame filtering" for more information.
2481 * This callback must be implemented and can sleep.
2483 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2484 * must be set or cleared for a given STA. Must be atomic.
2486 * @set_key: See the section "Hardware crypto acceleration"
2487 * This callback is only called between add_interface and
2488 * remove_interface calls, i.e. while the given virtual interface
2490 * Returns a negative error code if the key can't be added.
2491 * The callback can sleep.
2493 * @update_tkip_key: See the section "Hardware crypto acceleration"
2494 * This callback will be called in the context of Rx. Called for drivers
2495 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2496 * The callback must be atomic.
2498 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2499 * host is suspended, it can assign this callback to retrieve the data
2500 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2501 * After rekeying was done it should (for example during resume) notify
2502 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2504 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2505 * WEP when the device sends data packets autonomously, e.g. for ARP
2506 * offloading. The index can be 0-3, or -1 for unsetting it.
2508 * @hw_scan: Ask the hardware to service the scan request, no need to start
2509 * the scan state machine in stack. The scan must honour the channel
2510 * configuration done by the regulatory agent in the wiphy's
2511 * registered bands. The hardware (or the driver) needs to make sure
2512 * that power save is disabled.
2513 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2514 * entire IEs after the SSID, so that drivers need not look at these
2515 * at all but just send them after the SSID -- mac80211 includes the
2516 * (extended) supported rates and HT information (where applicable).
2517 * When the scan finishes, ieee80211_scan_completed() must be called;
2518 * note that it also must be called when the scan cannot finish due to
2519 * any error unless this callback returned a negative error code.
2520 * The callback can sleep.
2522 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2523 * The driver should ask the hardware to cancel the scan (if possible),
2524 * but the scan will be completed only after the driver will call
2525 * ieee80211_scan_completed().
2526 * This callback is needed for wowlan, to prevent enqueueing a new
2527 * scan_work after the low-level driver was already suspended.
2528 * The callback can sleep.
2530 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2531 * specific intervals. The driver must call the
2532 * ieee80211_sched_scan_results() function whenever it finds results.
2533 * This process will continue until sched_scan_stop is called.
2535 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2536 * In this case, ieee80211_sched_scan_stopped() must not be called.
2538 * @sw_scan_start: Notifier function that is called just before a software scan
2539 * is started. Can be NULL, if the driver doesn't need this notification.
2540 * The callback can sleep.
2542 * @sw_scan_complete: Notifier function that is called just after a
2543 * software scan finished. Can be NULL, if the driver doesn't need
2544 * this notification.
2545 * The callback can sleep.
2547 * @get_stats: Return low-level statistics.
2548 * Returns zero if statistics are available.
2549 * The callback can sleep.
2551 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2552 * callback should be provided to read the TKIP transmit IVs (both IV32
2553 * and IV16) for the given key from hardware.
2554 * The callback must be atomic.
2556 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2557 * if the device does fragmentation by itself; if this callback is
2558 * implemented then the stack will not do fragmentation.
2559 * The callback can sleep.
2561 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2562 * The callback can sleep.
2564 * @sta_add: Notifies low level driver about addition of an associated station,
2565 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2567 * @sta_remove: Notifies low level driver about removal of an associated
2568 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2569 * returns it isn't safe to use the pointer, not even RCU protected;
2570 * no RCU grace period is guaranteed between returning here and freeing
2571 * the station. See @sta_pre_rcu_remove if needed.
2572 * This callback can sleep.
2574 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2575 * when a station is added to mac80211's station list. This callback
2576 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2577 * conditional. This callback can sleep.
2579 * @sta_remove_debugfs: Remove the debugfs files which were added using
2580 * @sta_add_debugfs. This callback can sleep.
2582 * @sta_notify: Notifies low level driver about power state transition of an
2583 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2584 * in AP mode, this callback will not be called when the flag
2585 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2587 * @sta_state: Notifies low level driver about state transition of a
2588 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2589 * This callback is mutually exclusive with @sta_add/@sta_remove.
2590 * It must not fail for down transitions but may fail for transitions
2591 * up the list of states. Also note that after the callback returns it
2592 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2593 * period is guaranteed between returning here and freeing the station.
2594 * See @sta_pre_rcu_remove if needed.
2595 * The callback can sleep.
2597 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2598 * synchronisation. This is useful if a driver needs to have station
2599 * pointers protected using RCU, it can then use this call to clear
2600 * the pointers instead of waiting for an RCU grace period to elapse
2602 * The callback can sleep.
2604 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2605 * used to transmit to the station. The changes are advertised with bits
2606 * from &enum ieee80211_rate_control_changed and the values are reflected
2607 * in the station data. This callback should only be used when the driver
2608 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2609 * otherwise the rate control algorithm is notified directly.
2612 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2613 * bursting) for a hardware TX queue.
2614 * Returns a negative error code on failure.
2615 * The callback can sleep.
2617 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2618 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2619 * required function.
2620 * The callback can sleep.
2622 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2623 * Currently, this is only used for IBSS mode debugging. Is not a
2624 * required function.
2625 * The callback can sleep.
2627 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2628 * with other STAs in the IBSS. This is only used in IBSS mode. This
2629 * function is optional if the firmware/hardware takes full care of
2630 * TSF synchronization.
2631 * The callback can sleep.
2633 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2634 * This is needed only for IBSS mode and the result of this function is
2635 * used to determine whether to reply to Probe Requests.
2636 * Returns non-zero if this device sent the last beacon.
2637 * The callback can sleep.
2639 * @ampdu_action: Perform a certain A-MPDU action
2640 * The RA/TID combination determines the destination and TID we want
2641 * the ampdu action to be performed for. The action is defined through
2642 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2643 * is the first frame we expect to perform the action on. Notice
2644 * that TX/RX_STOP can pass NULL for this parameter.
2645 * The @buf_size parameter is only valid when the action is set to
2646 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2647 * buffer size (number of subframes) for this session -- the driver
2648 * may neither send aggregates containing more subframes than this
2649 * nor send aggregates in a way that lost frames would exceed the
2650 * buffer size. If just limiting the aggregate size, this would be
2651 * possible with a buf_size of 8:
2653 * - RX: 2....7 (lost frame #1)
2655 * which is invalid since #1 was now re-transmitted well past the
2656 * buffer size of 8. Correct ways to retransmit #1 would be:
2657 * - TX: 1 or 18 or 81
2658 * Even "189" would be wrong since 1 could be lost again.
2660 * Returns a negative error code on failure.
2661 * The callback can sleep.
2663 * @get_survey: Return per-channel survey information
2665 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2666 * need to set wiphy->rfkill_poll to %true before registration,
2667 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2668 * The callback can sleep.
2670 * @set_coverage_class: Set slot time for given coverage class as specified
2671 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2672 * accordingly; coverage class equals to -1 to enable ACK timeout
2673 * estimation algorithm (dynack). To disable dynack set valid value for
2674 * coverage class. This callback is not required and may sleep.
2676 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2677 * be %NULL. The callback can sleep.
2678 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2680 * @flush: Flush all pending frames from the hardware queue, making sure
2681 * that the hardware queues are empty. The @queues parameter is a bitmap
2682 * of queues to flush, which is useful if different virtual interfaces
2683 * use different hardware queues; it may also indicate all queues.
2684 * If the parameter @drop is set to %true, pending frames may be dropped.
2685 * Note that vif can be NULL.
2686 * The callback can sleep.
2688 * @channel_switch: Drivers that need (or want) to offload the channel
2689 * switch operation for CSAs received from the AP may implement this
2690 * callback. They must then call ieee80211_chswitch_done() to indicate
2691 * completion of the channel switch.
2693 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2694 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2695 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2696 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2698 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2700 * @remain_on_channel: Starts an off-channel period on the given channel, must
2701 * call back to ieee80211_ready_on_channel() when on that channel. Note
2702 * that normal channel traffic is not stopped as this is intended for hw
2703 * offload. Frames to transmit on the off-channel channel are transmitted
2704 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2705 * duration (which will always be non-zero) expires, the driver must call
2706 * ieee80211_remain_on_channel_expired().
2707 * Note that this callback may be called while the device is in IDLE and
2708 * must be accepted in this case.
2709 * This callback may sleep.
2710 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2711 * aborted before it expires. This callback may sleep.
2713 * @set_ringparam: Set tx and rx ring sizes.
2715 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2717 * @tx_frames_pending: Check if there is any pending frame in the hardware
2718 * queues before entering power save.
2720 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2721 * when transmitting a frame. Currently only legacy rates are handled.
2722 * The callback can sleep.
2723 * @rssi_callback: Notify driver when the average RSSI goes above/below
2724 * thresholds that were registered previously. The callback can sleep.
2726 * @release_buffered_frames: Release buffered frames according to the given
2727 * parameters. In the case where the driver buffers some frames for
2728 * sleeping stations mac80211 will use this callback to tell the driver
2729 * to release some frames, either for PS-poll or uAPSD.
2730 * Note that if the @more_data parameter is %false the driver must check
2731 * if there are more frames on the given TIDs, and if there are more than
2732 * the frames being released then it must still set the more-data bit in
2733 * the frame. If the @more_data parameter is %true, then of course the
2734 * more-data bit must always be set.
2735 * The @tids parameter tells the driver which TIDs to release frames
2736 * from, for PS-poll it will always have only a single bit set.
2737 * In the case this is used for a PS-poll initiated release, the
2738 * @num_frames parameter will always be 1 so code can be shared. In
2739 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2740 * on the TX status (and must report TX status) so that the PS-poll
2741 * period is properly ended. This is used to avoid sending multiple
2742 * responses for a retried PS-poll frame.
2743 * In the case this is used for uAPSD, the @num_frames parameter may be
2744 * bigger than one, but the driver may send fewer frames (it must send
2745 * at least one, however). In this case it is also responsible for
2746 * setting the EOSP flag in the QoS header of the frames. Also, when the
2747 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2748 * on the last frame in the SP. Alternatively, it may call the function
2749 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2750 * This callback must be atomic.
2751 * @allow_buffered_frames: Prepare device to allow the given number of frames
2752 * to go out to the given station. The frames will be sent by mac80211
2753 * via the usual TX path after this call. The TX information for frames
2754 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2755 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2756 * frames from multiple TIDs are released and the driver might reorder
2757 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2758 * on the last frame and clear it on all others and also handle the EOSP
2759 * bit in the QoS header correctly. Alternatively, it can also call the
2760 * ieee80211_sta_eosp() function.
2761 * The @tids parameter is a bitmap and tells the driver which TIDs the
2762 * frames will be on; it will at most have two bits set.
2763 * This callback must be atomic.
2765 * @get_et_sset_count: Ethtool API to get string-set count.
2767 * @get_et_stats: Ethtool API to get a set of u64 stats.
2769 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2770 * and perhaps other supported types of ethtool data-sets.
2772 * @get_rssi: Get current signal strength in dBm, the function is optional
2775 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2776 * before associated. In multi-channel scenarios, a virtual interface is
2777 * bound to a channel before it is associated, but as it isn't associated
2778 * yet it need not necessarily be given airtime, in particular since any
2779 * transmission to a P2P GO needs to be synchronized against the GO's
2780 * powersave state. mac80211 will call this function before transmitting a
2781 * management frame prior to having successfully associated to allow the
2782 * driver to give it channel time for the transmission, to get a response
2783 * and to be able to synchronize with the GO.
2784 * The callback will be called before each transmission and upon return
2785 * mac80211 will transmit the frame right away.
2786 * The callback is optional and can (should!) sleep.
2788 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2789 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2790 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2791 * setup-response is a direct packet not buffered by the AP.
2792 * mac80211 will call this function just before the transmission of a TDLS
2793 * discovery-request. The recommended period of protection is at least
2794 * 2 * (DTIM period).
2795 * The callback is optional and can sleep.
2797 * @add_chanctx: Notifies device driver about new channel context creation.
2798 * @remove_chanctx: Notifies device driver about channel context destruction.
2799 * @change_chanctx: Notifies device driver about channel context changes that
2800 * may happen when combining different virtual interfaces on the same
2801 * channel context with different settings
2802 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2803 * to vif. Possible use is for hw queue remapping.
2804 * @unassign_vif_chanctx: Notifies device driver about channel context being
2806 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2807 * another, as specified in the list of
2808 * @ieee80211_vif_chanctx_switch passed to the driver, according
2809 * to the mode defined in &ieee80211_chanctx_switch_mode.
2811 * @start_ap: Start operation on the AP interface, this is called after all the
2812 * information in bss_conf is set and beacon can be retrieved. A channel
2813 * context is bound before this is called. Note that if the driver uses
2814 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2815 * just "paused" for scanning/ROC, which is indicated by the beacon being
2816 * disabled/enabled via @bss_info_changed.
2817 * @stop_ap: Stop operation on the AP interface.
2819 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2820 * reconfiguration has completed. This can help the driver implement the
2821 * reconfiguration step. Also called when reconfiguring because the
2822 * driver's resume function returned 1, as this is just like an "inline"
2823 * hardware restart. This callback may sleep.
2825 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2826 * Currently, this is only called for managed or P2P client interfaces.
2827 * This callback is optional; it must not sleep.
2829 * @channel_switch_beacon: Starts a channel switch to a new channel.
2830 * Beacons are modified to include CSA or ECSA IEs before calling this
2831 * function. The corresponding count fields in these IEs must be
2832 * decremented, and when they reach 1 the driver must call
2833 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2834 * get the csa counter decremented by mac80211, but must check if it is
2835 * 1 using ieee80211_csa_is_complete() after the beacon has been
2836 * transmitted and then call ieee80211_csa_finish().
2837 * If the CSA count starts as zero or 1, this function will not be called,
2838 * since there won't be any time to beacon before the switch anyway.
2839 * @pre_channel_switch: This is an optional callback that is called
2840 * before a channel switch procedure is started (ie. when a STA
2841 * gets a CSA or an userspace initiated channel-switch), allowing
2842 * the driver to prepare for the channel switch.
2843 * @post_channel_switch: This is an optional callback that is called
2844 * after a channel switch procedure is completed, allowing the
2845 * driver to go back to a normal configuration.
2847 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2848 * information in bss_conf is set up and the beacon can be retrieved. A
2849 * channel context is bound before this is called.
2850 * @leave_ibss: Leave the IBSS again.
2852 * @get_expected_throughput: extract the expected throughput towards the
2853 * specified station. The returned value is expressed in Kbps. It returns 0
2854 * if the RC algorithm does not have proper data to provide.
2856 struct ieee80211_ops {
2857 void (*tx)(struct ieee80211_hw *hw,
2858 struct ieee80211_tx_control *control,
2859 struct sk_buff *skb);
2860 int (*start)(struct ieee80211_hw *hw);
2861 void (*stop)(struct ieee80211_hw *hw);
2863 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2864 int (*resume)(struct ieee80211_hw *hw);
2865 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2867 int (*add_interface)(struct ieee80211_hw *hw,
2868 struct ieee80211_vif *vif);
2869 int (*change_interface)(struct ieee80211_hw *hw,
2870 struct ieee80211_vif *vif,
2871 enum nl80211_iftype new_type, bool p2p);
2872 void (*remove_interface)(struct ieee80211_hw *hw,
2873 struct ieee80211_vif *vif);
2874 int (*config)(struct ieee80211_hw *hw, u32 changed);
2875 void (*bss_info_changed)(struct ieee80211_hw *hw,
2876 struct ieee80211_vif *vif,
2877 struct ieee80211_bss_conf *info,
2880 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2881 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2883 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2884 struct netdev_hw_addr_list *mc_list);
2885 void (*configure_filter)(struct ieee80211_hw *hw,
2886 unsigned int changed_flags,
2887 unsigned int *total_flags,
2889 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2891 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2892 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2893 struct ieee80211_key_conf *key);
2894 void (*update_tkip_key)(struct ieee80211_hw *hw,
2895 struct ieee80211_vif *vif,
2896 struct ieee80211_key_conf *conf,
2897 struct ieee80211_sta *sta,
2898 u32 iv32, u16 *phase1key);
2899 void (*set_rekey_data)(struct ieee80211_hw *hw,
2900 struct ieee80211_vif *vif,
2901 struct cfg80211_gtk_rekey_data *data);
2902 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2903 struct ieee80211_vif *vif, int idx);
2904 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2905 struct ieee80211_scan_request *req);
2906 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2907 struct ieee80211_vif *vif);
2908 int (*sched_scan_start)(struct ieee80211_hw *hw,
2909 struct ieee80211_vif *vif,
2910 struct cfg80211_sched_scan_request *req,
2911 struct ieee80211_scan_ies *ies);
2912 int (*sched_scan_stop)(struct ieee80211_hw *hw,
2913 struct ieee80211_vif *vif);
2914 void (*sw_scan_start)(struct ieee80211_hw *hw);
2915 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2916 int (*get_stats)(struct ieee80211_hw *hw,
2917 struct ieee80211_low_level_stats *stats);
2918 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2919 u32 *iv32, u16 *iv16);
2920 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2921 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2922 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2923 struct ieee80211_sta *sta);
2924 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2925 struct ieee80211_sta *sta);
2926 #ifdef CONFIG_MAC80211_DEBUGFS
2927 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2928 struct ieee80211_vif *vif,
2929 struct ieee80211_sta *sta,
2930 struct dentry *dir);
2931 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2932 struct ieee80211_vif *vif,
2933 struct ieee80211_sta *sta,
2934 struct dentry *dir);
2936 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2937 enum sta_notify_cmd, struct ieee80211_sta *sta);
2938 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2939 struct ieee80211_sta *sta,
2940 enum ieee80211_sta_state old_state,
2941 enum ieee80211_sta_state new_state);
2942 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
2943 struct ieee80211_vif *vif,
2944 struct ieee80211_sta *sta);
2945 void (*sta_rc_update)(struct ieee80211_hw *hw,
2946 struct ieee80211_vif *vif,
2947 struct ieee80211_sta *sta,
2949 int (*conf_tx)(struct ieee80211_hw *hw,
2950 struct ieee80211_vif *vif, u16 ac,
2951 const struct ieee80211_tx_queue_params *params);
2952 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2953 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2955 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2956 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2957 int (*ampdu_action)(struct ieee80211_hw *hw,
2958 struct ieee80211_vif *vif,
2959 enum ieee80211_ampdu_mlme_action action,
2960 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2962 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2963 struct survey_info *survey);
2964 void (*rfkill_poll)(struct ieee80211_hw *hw);
2965 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
2966 #ifdef CONFIG_NL80211_TESTMODE
2967 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2968 void *data, int len);
2969 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2970 struct netlink_callback *cb,
2971 void *data, int len);
2973 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2974 u32 queues, bool drop);
2975 void (*channel_switch)(struct ieee80211_hw *hw,
2976 struct ieee80211_vif *vif,
2977 struct ieee80211_channel_switch *ch_switch);
2978 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2979 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2981 int (*remain_on_channel)(struct ieee80211_hw *hw,
2982 struct ieee80211_vif *vif,
2983 struct ieee80211_channel *chan,
2985 enum ieee80211_roc_type type);
2986 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2987 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2988 void (*get_ringparam)(struct ieee80211_hw *hw,
2989 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2990 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2991 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2992 const struct cfg80211_bitrate_mask *mask);
2993 void (*rssi_callback)(struct ieee80211_hw *hw,
2994 struct ieee80211_vif *vif,
2995 enum ieee80211_rssi_event rssi_event);
2997 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2998 struct ieee80211_sta *sta,
2999 u16 tids, int num_frames,
3000 enum ieee80211_frame_release_type reason,
3002 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3003 struct ieee80211_sta *sta,
3004 u16 tids, int num_frames,
3005 enum ieee80211_frame_release_type reason,
3008 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3009 struct ieee80211_vif *vif, int sset);
3010 void (*get_et_stats)(struct ieee80211_hw *hw,
3011 struct ieee80211_vif *vif,
3012 struct ethtool_stats *stats, u64 *data);
3013 void (*get_et_strings)(struct ieee80211_hw *hw,
3014 struct ieee80211_vif *vif,
3015 u32 sset, u8 *data);
3016 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3017 struct ieee80211_sta *sta, s8 *rssi_dbm);
3019 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3020 struct ieee80211_vif *vif);
3022 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3023 struct ieee80211_vif *vif);
3025 int (*add_chanctx)(struct ieee80211_hw *hw,
3026 struct ieee80211_chanctx_conf *ctx);
3027 void (*remove_chanctx)(struct ieee80211_hw *hw,
3028 struct ieee80211_chanctx_conf *ctx);
3029 void (*change_chanctx)(struct ieee80211_hw *hw,
3030 struct ieee80211_chanctx_conf *ctx,
3032 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3033 struct ieee80211_vif *vif,
3034 struct ieee80211_chanctx_conf *ctx);
3035 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3036 struct ieee80211_vif *vif,
3037 struct ieee80211_chanctx_conf *ctx);
3038 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3039 struct ieee80211_vif_chanctx_switch *vifs,
3041 enum ieee80211_chanctx_switch_mode mode);
3043 void (*restart_complete)(struct ieee80211_hw *hw);
3045 #if IS_ENABLED(CONFIG_IPV6)
3046 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3047 struct ieee80211_vif *vif,
3048 struct inet6_dev *idev);
3050 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3051 struct ieee80211_vif *vif,
3052 struct cfg80211_chan_def *chandef);
3053 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3054 struct ieee80211_vif *vif,
3055 struct ieee80211_channel_switch *ch_switch);
3057 int (*post_channel_switch)(struct ieee80211_hw *hw,
3058 struct ieee80211_vif *vif);
3060 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3061 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3062 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3066 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3068 * This must be called once for each hardware device. The returned pointer
3069 * must be used to refer to this device when calling other functions.
3070 * mac80211 allocates a private data area for the driver pointed to by
3071 * @priv in &struct ieee80211_hw, the size of this area is given as
3074 * @priv_data_len: length of private data
3075 * @ops: callbacks for this device
3076 * @requested_name: Requested name for this device.
3077 * NULL is valid value, and means use the default naming (phy%d)
3079 * Return: A pointer to the new hardware device, or %NULL on error.
3081 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3082 const struct ieee80211_ops *ops,
3083 const char *requested_name);
3086 * ieee80211_alloc_hw - Allocate a new hardware device
3088 * This must be called once for each hardware device. The returned pointer
3089 * must be used to refer to this device when calling other functions.
3090 * mac80211 allocates a private data area for the driver pointed to by
3091 * @priv in &struct ieee80211_hw, the size of this area is given as
3094 * @priv_data_len: length of private data
3095 * @ops: callbacks for this device
3097 * Return: A pointer to the new hardware device, or %NULL on error.
3100 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3101 const struct ieee80211_ops *ops)
3103 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3107 * ieee80211_register_hw - Register hardware device
3109 * You must call this function before any other functions in
3110 * mac80211. Note that before a hardware can be registered, you
3111 * need to fill the contained wiphy's information.
3113 * @hw: the device to register as returned by ieee80211_alloc_hw()
3115 * Return: 0 on success. An error code otherwise.
3117 int ieee80211_register_hw(struct ieee80211_hw *hw);
3120 * struct ieee80211_tpt_blink - throughput blink description
3121 * @throughput: throughput in Kbit/sec
3122 * @blink_time: blink time in milliseconds
3123 * (full cycle, ie. one off + one on period)
3125 struct ieee80211_tpt_blink {
3131 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3132 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3133 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3134 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3135 * interface is connected in some way, including being an AP
3137 enum ieee80211_tpt_led_trigger_flags {
3138 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3139 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3140 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3143 #ifdef CONFIG_MAC80211_LEDS
3144 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3145 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3146 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3147 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3148 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3150 const struct ieee80211_tpt_blink *blink_table,
3151 unsigned int blink_table_len);
3154 * ieee80211_get_tx_led_name - get name of TX LED
3156 * mac80211 creates a transmit LED trigger for each wireless hardware
3157 * that can be used to drive LEDs if your driver registers a LED device.
3158 * This function returns the name (or %NULL if not configured for LEDs)
3159 * of the trigger so you can automatically link the LED device.
3161 * @hw: the hardware to get the LED trigger name for
3163 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3165 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3167 #ifdef CONFIG_MAC80211_LEDS
3168 return __ieee80211_get_tx_led_name(hw);
3175 * ieee80211_get_rx_led_name - get name of RX LED
3177 * mac80211 creates a receive LED trigger for each wireless hardware
3178 * that can be used to drive LEDs if your driver registers a LED device.
3179 * This function returns the name (or %NULL if not configured for LEDs)
3180 * of the trigger so you can automatically link the LED device.
3182 * @hw: the hardware to get the LED trigger name for
3184 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3186 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3188 #ifdef CONFIG_MAC80211_LEDS
3189 return __ieee80211_get_rx_led_name(hw);
3196 * ieee80211_get_assoc_led_name - get name of association LED
3198 * mac80211 creates a association LED trigger for each wireless hardware
3199 * that can be used to drive LEDs if your driver registers a LED device.
3200 * This function returns the name (or %NULL if not configured for LEDs)
3201 * of the trigger so you can automatically link the LED device.
3203 * @hw: the hardware to get the LED trigger name for
3205 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3207 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3209 #ifdef CONFIG_MAC80211_LEDS
3210 return __ieee80211_get_assoc_led_name(hw);
3217 * ieee80211_get_radio_led_name - get name of radio LED
3219 * mac80211 creates a radio change LED trigger for each wireless hardware
3220 * that can be used to drive LEDs if your driver registers a LED device.
3221 * This function returns the name (or %NULL if not configured for LEDs)
3222 * of the trigger so you can automatically link the LED device.
3224 * @hw: the hardware to get the LED trigger name for
3226 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3228 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3230 #ifdef CONFIG_MAC80211_LEDS
3231 return __ieee80211_get_radio_led_name(hw);
3238 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3239 * @hw: the hardware to create the trigger for
3240 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3241 * @blink_table: the blink table -- needs to be ordered by throughput
3242 * @blink_table_len: size of the blink table
3244 * Return: %NULL (in case of error, or if no LED triggers are
3245 * configured) or the name of the new trigger.
3247 * Note: This function must be called before ieee80211_register_hw().
3249 static inline char *
3250 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3251 const struct ieee80211_tpt_blink *blink_table,
3252 unsigned int blink_table_len)
3254 #ifdef CONFIG_MAC80211_LEDS
3255 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3263 * ieee80211_unregister_hw - Unregister a hardware device
3265 * This function instructs mac80211 to free allocated resources
3266 * and unregister netdevices from the networking subsystem.
3268 * @hw: the hardware to unregister
3270 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3273 * ieee80211_free_hw - free hardware descriptor
3275 * This function frees everything that was allocated, including the
3276 * private data for the driver. You must call ieee80211_unregister_hw()
3277 * before calling this function.
3279 * @hw: the hardware to free
3281 void ieee80211_free_hw(struct ieee80211_hw *hw);
3284 * ieee80211_restart_hw - restart hardware completely
3286 * Call this function when the hardware was restarted for some reason
3287 * (hardware error, ...) and the driver is unable to restore its state
3288 * by itself. mac80211 assumes that at this point the driver/hardware
3289 * is completely uninitialised and stopped, it starts the process by
3290 * calling the ->start() operation. The driver will need to reset all
3291 * internal state that it has prior to calling this function.
3293 * @hw: the hardware to restart
3295 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3298 * ieee80211_napi_add - initialize mac80211 NAPI context
3299 * @hw: the hardware to initialize the NAPI context on
3300 * @napi: the NAPI context to initialize
3301 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3302 * driver doesn't use NAPI
3303 * @poll: poll function
3304 * @weight: default weight
3306 * See also netif_napi_add().
3308 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3309 struct net_device *napi_dev,
3310 int (*poll)(struct napi_struct *, int),
3314 * ieee80211_rx - receive frame
3316 * Use this function to hand received frames to mac80211. The receive
3317 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3318 * paged @skb is used, the driver is recommended to put the ieee80211
3319 * header of the frame on the linear part of the @skb to avoid memory
3320 * allocation and/or memcpy by the stack.
3322 * This function may not be called in IRQ context. Calls to this function
3323 * for a single hardware must be synchronized against each other. Calls to
3324 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3325 * mixed for a single hardware. Must not run concurrently with
3326 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3328 * In process context use instead ieee80211_rx_ni().
3330 * @hw: the hardware this frame came in on
3331 * @skb: the buffer to receive, owned by mac80211 after this call
3333 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3336 * ieee80211_rx_irqsafe - receive frame
3338 * Like ieee80211_rx() but can be called in IRQ context
3339 * (internally defers to a tasklet.)
3341 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3342 * be mixed for a single hardware.Must not run concurrently with
3343 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3345 * @hw: the hardware this frame came in on
3346 * @skb: the buffer to receive, owned by mac80211 after this call
3348 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3351 * ieee80211_rx_ni - receive frame (in process context)
3353 * Like ieee80211_rx() but can be called in process context
3354 * (internally disables bottom halves).
3356 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3357 * not be mixed for a single hardware. Must not run concurrently with
3358 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3360 * @hw: the hardware this frame came in on
3361 * @skb: the buffer to receive, owned by mac80211 after this call
3363 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3364 struct sk_buff *skb)
3367 ieee80211_rx(hw, skb);
3372 * ieee80211_sta_ps_transition - PS transition for connected sta
3374 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3375 * flag set, use this function to inform mac80211 about a connected station
3376 * entering/leaving PS mode.
3378 * This function may not be called in IRQ context or with softirqs enabled.
3380 * Calls to this function for a single hardware must be synchronized against
3383 * @sta: currently connected sta
3384 * @start: start or stop PS
3386 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3388 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3391 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3392 * (in process context)
3394 * Like ieee80211_sta_ps_transition() but can be called in process context
3395 * (internally disables bottom halves). Concurrent call restriction still
3398 * @sta: currently connected sta
3399 * @start: start or stop PS
3401 * Return: Like ieee80211_sta_ps_transition().
3403 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3409 ret = ieee80211_sta_ps_transition(sta, start);
3416 * The TX headroom reserved by mac80211 for its own tx_status functions.
3417 * This is enough for the radiotap header.
3419 #define IEEE80211_TX_STATUS_HEADROOM 14
3422 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3423 * @sta: &struct ieee80211_sta pointer for the sleeping station
3424 * @tid: the TID that has buffered frames
3425 * @buffered: indicates whether or not frames are buffered for this TID
3427 * If a driver buffers frames for a powersave station instead of passing
3428 * them back to mac80211 for retransmission, the station may still need
3429 * to be told that there are buffered frames via the TIM bit.
3431 * This function informs mac80211 whether or not there are frames that are
3432 * buffered in the driver for a given TID; mac80211 can then use this data
3433 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3434 * call! Beware of the locking!)
3436 * If all frames are released to the station (due to PS-poll or uAPSD)
3437 * then the driver needs to inform mac80211 that there no longer are
3438 * frames buffered. However, when the station wakes up mac80211 assumes
3439 * that all buffered frames will be transmitted and clears this data,
3440 * drivers need to make sure they inform mac80211 about all buffered
3441 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3443 * Note that technically mac80211 only needs to know this per AC, not per
3444 * TID, but since driver buffering will inevitably happen per TID (since
3445 * it is related to aggregation) it is easier to make mac80211 map the
3446 * TID to the AC as required instead of keeping track in all drivers that
3449 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3450 u8 tid, bool buffered);
3453 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3455 * Call this function in a driver with per-packet rate selection support
3456 * to combine the rate info in the packet tx info with the most recent
3457 * rate selection table for the station entry.
3459 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3460 * @sta: the receiver station to which this packet is sent.
3461 * @skb: the frame to be transmitted.
3462 * @dest: buffer for extracted rate/retry information
3463 * @max_rates: maximum number of rates to fetch
3465 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3466 struct ieee80211_sta *sta,
3467 struct sk_buff *skb,
3468 struct ieee80211_tx_rate *dest,
3472 * ieee80211_tx_status - transmit status callback
3474 * Call this function for all transmitted frames after they have been
3475 * transmitted. It is permissible to not call this function for
3476 * multicast frames but this can affect statistics.
3478 * This function may not be called in IRQ context. Calls to this function
3479 * for a single hardware must be synchronized against each other. Calls
3480 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3481 * may not be mixed for a single hardware. Must not run concurrently with
3482 * ieee80211_rx() or ieee80211_rx_ni().
3484 * @hw: the hardware the frame was transmitted by
3485 * @skb: the frame that was transmitted, owned by mac80211 after this call
3487 void ieee80211_tx_status(struct ieee80211_hw *hw,
3488 struct sk_buff *skb);
3491 * ieee80211_tx_status_ni - transmit status callback (in process context)
3493 * Like ieee80211_tx_status() but can be called in process context.
3495 * Calls to this function, ieee80211_tx_status() and
3496 * ieee80211_tx_status_irqsafe() may not be mixed
3497 * for a single hardware.
3499 * @hw: the hardware the frame was transmitted by
3500 * @skb: the frame that was transmitted, owned by mac80211 after this call
3502 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3503 struct sk_buff *skb)
3506 ieee80211_tx_status(hw, skb);
3511 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3513 * Like ieee80211_tx_status() but can be called in IRQ context
3514 * (internally defers to a tasklet.)
3516 * Calls to this function, ieee80211_tx_status() and
3517 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3519 * @hw: the hardware the frame was transmitted by
3520 * @skb: the frame that was transmitted, owned by mac80211 after this call
3522 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3523 struct sk_buff *skb);
3526 * ieee80211_report_low_ack - report non-responding station
3528 * When operating in AP-mode, call this function to report a non-responding
3531 * @sta: the non-responding connected sta
3532 * @num_packets: number of packets sent to @sta without a response
3534 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3536 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3539 * struct ieee80211_mutable_offsets - mutable beacon offsets
3540 * @tim_offset: position of TIM element
3541 * @tim_length: size of TIM element
3542 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3543 * to CSA counters. This array can contain zero values which
3544 * should be ignored.
3546 struct ieee80211_mutable_offsets {
3550 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3554 * ieee80211_beacon_get_template - beacon template generation function
3555 * @hw: pointer obtained from ieee80211_alloc_hw().
3556 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3557 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3558 * receive the offsets that may be updated by the driver.
3560 * If the driver implements beaconing modes, it must use this function to
3561 * obtain the beacon template.
3563 * This function should be used if the beacon frames are generated by the
3564 * device, and then the driver must use the returned beacon as the template
3565 * The driver or the device are responsible to update the DTIM and, when
3566 * applicable, the CSA count.
3568 * The driver is responsible for freeing the returned skb.
3570 * Return: The beacon template. %NULL on error.
3573 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3574 struct ieee80211_vif *vif,
3575 struct ieee80211_mutable_offsets *offs);
3578 * ieee80211_beacon_get_tim - beacon generation function
3579 * @hw: pointer obtained from ieee80211_alloc_hw().
3580 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3581 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3582 * Set to 0 if invalid (in non-AP modes).
3583 * @tim_length: pointer to variable that will receive the TIM IE length,
3584 * (including the ID and length bytes!).
3585 * Set to 0 if invalid (in non-AP modes).
3587 * If the driver implements beaconing modes, it must use this function to
3588 * obtain the beacon frame.
3590 * If the beacon frames are generated by the host system (i.e., not in
3591 * hardware/firmware), the driver uses this function to get each beacon
3592 * frame from mac80211 -- it is responsible for calling this function exactly
3593 * once before the beacon is needed (e.g. based on hardware interrupt).
3595 * The driver is responsible for freeing the returned skb.
3597 * Return: The beacon template. %NULL on error.
3599 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3600 struct ieee80211_vif *vif,
3601 u16 *tim_offset, u16 *tim_length);
3604 * ieee80211_beacon_get - beacon generation function
3605 * @hw: pointer obtained from ieee80211_alloc_hw().
3606 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3608 * See ieee80211_beacon_get_tim().
3610 * Return: See ieee80211_beacon_get_tim().
3612 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3613 struct ieee80211_vif *vif)
3615 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3619 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3620 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3622 * The csa counter should be updated after each beacon transmission.
3623 * This function is called implicitly when
3624 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3625 * beacon frames are generated by the device, the driver should call this
3626 * function after each beacon transmission to sync mac80211's csa counters.
3628 * Return: new csa counter value
3630 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3633 * ieee80211_csa_finish - notify mac80211 about channel switch
3634 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3636 * After a channel switch announcement was scheduled and the counter in this
3637 * announcement hits 1, this function must be called by the driver to
3638 * notify mac80211 that the channel can be changed.
3640 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3643 * ieee80211_csa_is_complete - find out if counters reached 1
3644 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3646 * This function returns whether the channel switch counters reached zero.
3648 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3652 * ieee80211_proberesp_get - retrieve a Probe Response template
3653 * @hw: pointer obtained from ieee80211_alloc_hw().
3654 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3656 * Creates a Probe Response template which can, for example, be uploaded to
3657 * hardware. The destination address should be set by the caller.
3659 * Can only be called in AP mode.
3661 * Return: The Probe Response template. %NULL on error.
3663 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3664 struct ieee80211_vif *vif);
3667 * ieee80211_pspoll_get - retrieve a PS Poll template
3668 * @hw: pointer obtained from ieee80211_alloc_hw().
3669 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3671 * Creates a PS Poll a template which can, for example, uploaded to
3672 * hardware. The template must be updated after association so that correct
3673 * AID, BSSID and MAC address is used.
3675 * Note: Caller (or hardware) is responsible for setting the
3676 * &IEEE80211_FCTL_PM bit.
3678 * Return: The PS Poll template. %NULL on error.
3680 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3681 struct ieee80211_vif *vif);
3684 * ieee80211_nullfunc_get - retrieve a nullfunc template
3685 * @hw: pointer obtained from ieee80211_alloc_hw().
3686 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3688 * Creates a Nullfunc template which can, for example, uploaded to
3689 * hardware. The template must be updated after association so that correct
3690 * BSSID and address is used.
3692 * Note: Caller (or hardware) is responsible for setting the
3693 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3695 * Return: The nullfunc template. %NULL on error.
3697 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3698 struct ieee80211_vif *vif);
3701 * ieee80211_probereq_get - retrieve a Probe Request template
3702 * @hw: pointer obtained from ieee80211_alloc_hw().
3703 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3704 * @ssid: SSID buffer
3705 * @ssid_len: length of SSID
3706 * @tailroom: tailroom to reserve at end of SKB for IEs
3708 * Creates a Probe Request template which can, for example, be uploaded to
3711 * Return: The Probe Request template. %NULL on error.
3713 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3714 struct ieee80211_vif *vif,
3715 const u8 *ssid, size_t ssid_len,
3719 * ieee80211_rts_get - RTS 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 RTS.
3723 * @frame_len: the frame length (in octets).
3724 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3725 * @rts: The buffer where to store the RTS frame.
3727 * If the RTS 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 RTS frame from the 802.11 code. The low-level is responsible
3730 * for calling this function before and RTS frame is needed.
3732 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3733 const void *frame, size_t frame_len,
3734 const struct ieee80211_tx_info *frame_txctl,
3735 struct ieee80211_rts *rts);
3738 * ieee80211_rts_duration - Get the duration field for an RTS frame
3739 * @hw: pointer obtained from ieee80211_alloc_hw().
3740 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3741 * @frame_len: the length of the frame that is going to be protected by the RTS.
3742 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3744 * If the RTS is generated in firmware, but the host system must provide
3745 * the duration field, the low-level driver uses this function to receive
3746 * the duration field value in little-endian byteorder.
3748 * Return: The duration.
3750 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3751 struct ieee80211_vif *vif, size_t frame_len,
3752 const struct ieee80211_tx_info *frame_txctl);
3755 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3756 * @hw: pointer obtained from ieee80211_alloc_hw().
3757 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3758 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3759 * @frame_len: the frame length (in octets).
3760 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3761 * @cts: The buffer where to store the CTS-to-self frame.
3763 * If the CTS-to-self frames are generated by the host system (i.e., not in
3764 * hardware/firmware), the low-level driver uses this function to receive
3765 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3766 * for calling this function before and CTS-to-self frame is needed.
3768 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3769 struct ieee80211_vif *vif,
3770 const void *frame, size_t frame_len,
3771 const struct ieee80211_tx_info *frame_txctl,
3772 struct ieee80211_cts *cts);
3775 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3776 * @hw: pointer obtained from ieee80211_alloc_hw().
3777 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3778 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3779 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3781 * If the CTS-to-self is generated in firmware, but the host system must provide
3782 * the duration field, the low-level driver uses this function to receive
3783 * the duration field value in little-endian byteorder.
3785 * Return: The duration.
3787 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3788 struct ieee80211_vif *vif,
3790 const struct ieee80211_tx_info *frame_txctl);
3793 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3794 * @hw: pointer obtained from ieee80211_alloc_hw().
3795 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3796 * @band: the band to calculate the frame duration on
3797 * @frame_len: the length of the frame.
3798 * @rate: the rate at which the frame is going to be transmitted.
3800 * Calculate the duration field of some generic frame, given its
3801 * length and transmission rate (in 100kbps).
3803 * Return: The duration.
3805 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3806 struct ieee80211_vif *vif,
3807 enum ieee80211_band band,
3809 struct ieee80211_rate *rate);
3812 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3813 * @hw: pointer as obtained from ieee80211_alloc_hw().
3814 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3816 * Function for accessing buffered broadcast and multicast frames. If
3817 * hardware/firmware does not implement buffering of broadcast/multicast
3818 * frames when power saving is used, 802.11 code buffers them in the host
3819 * memory. The low-level driver uses this function to fetch next buffered
3820 * frame. In most cases, this is used when generating beacon frame.
3822 * Return: A pointer to the next buffered skb or NULL if no more buffered
3823 * frames are available.
3825 * Note: buffered frames are returned only after DTIM beacon frame was
3826 * generated with ieee80211_beacon_get() and the low-level driver must thus
3827 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3828 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3829 * does not need to check for DTIM beacons separately and should be able to
3830 * use common code for all beacons.
3833 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3836 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3838 * This function returns the TKIP phase 1 key for the given IV32.
3840 * @keyconf: the parameter passed with the set key
3841 * @iv32: IV32 to get the P1K for
3842 * @p1k: a buffer to which the key will be written, as 5 u16 values
3844 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3845 u32 iv32, u16 *p1k);
3848 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3850 * This function returns the TKIP phase 1 key for the IV32 taken
3851 * from the given packet.
3853 * @keyconf: the parameter passed with the set key
3854 * @skb: the packet to take the IV32 value from that will be encrypted
3856 * @p1k: a buffer to which the key will be written, as 5 u16 values
3858 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3859 struct sk_buff *skb, u16 *p1k)
3861 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3862 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3863 u32 iv32 = get_unaligned_le32(&data[4]);
3865 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3869 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3871 * This function returns the TKIP phase 1 key for the given IV32
3872 * and transmitter address.
3874 * @keyconf: the parameter passed with the set key
3875 * @ta: TA that will be used with the key
3876 * @iv32: IV32 to get the P1K for
3877 * @p1k: a buffer to which the key will be written, as 5 u16 values
3879 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3880 const u8 *ta, u32 iv32, u16 *p1k);
3883 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3885 * This function computes the TKIP RC4 key for the IV values
3888 * @keyconf: the parameter passed with the set key
3889 * @skb: the packet to take the IV32/IV16 values from that will be
3890 * encrypted with this key
3891 * @p2k: a buffer to which the key will be written, 16 bytes
3893 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3894 struct sk_buff *skb, u8 *p2k);
3897 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3899 * This function computes the two AES-CMAC sub-keys, based on the
3900 * previously installed master key.
3902 * @keyconf: the parameter passed with the set key
3903 * @k1: a buffer to be filled with the 1st sub-key
3904 * @k2: a buffer to be filled with the 2nd sub-key
3906 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3910 * struct ieee80211_key_seq - key sequence counter
3912 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3913 * @ccmp: PN data, most significant byte first (big endian,
3914 * reverse order than in packet)
3915 * @aes_cmac: PN data, most significant byte first (big endian,
3916 * reverse order than in packet)
3918 struct ieee80211_key_seq {
3934 * ieee80211_get_key_tx_seq - get key TX sequence counter
3936 * @keyconf: the parameter passed with the set key
3937 * @seq: buffer to receive the sequence data
3939 * This function allows a driver to retrieve the current TX IV/PN
3940 * for the given key. It must not be called if IV generation is
3941 * offloaded to the device.
3943 * Note that this function may only be called when no TX processing
3944 * can be done concurrently, for example when queues are stopped
3945 * and the stop has been synchronized.
3947 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3948 struct ieee80211_key_seq *seq);
3951 * ieee80211_get_key_rx_seq - get 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: buffer to receive the sequence data
3959 * This function allows a driver to retrieve the current RX IV/PNs
3960 * for the given key. It must not be called if IV checking is done
3961 * by the device and not by mac80211.
3963 * Note that this function may only be called when no RX processing
3964 * can be done concurrently.
3966 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3967 int tid, struct ieee80211_key_seq *seq);
3970 * ieee80211_set_key_tx_seq - set key TX sequence counter
3972 * @keyconf: the parameter passed with the set key
3973 * @seq: new sequence data
3975 * This function allows a driver to set the current TX IV/PNs for the
3976 * given key. This is useful when resuming from WoWLAN sleep and the
3977 * device may have transmitted frames using the PTK, e.g. replies to
3980 * Note that this function may only be called when no TX processing
3981 * can be done concurrently.
3983 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3984 struct ieee80211_key_seq *seq);
3987 * ieee80211_set_key_rx_seq - set key RX sequence counter
3989 * @keyconf: the parameter passed with the set key
3990 * @tid: The TID, or -1 for the management frame value (CCMP only);
3991 * the value on TID 0 is also used for non-QoS frames. For
3992 * CMAC, only TID 0 is valid.
3993 * @seq: new sequence data
3995 * This function allows a driver to set the current RX IV/PNs for the
3996 * given key. This is useful when resuming from WoWLAN sleep and GTK
3997 * rekey may have been done while suspended. It should not be called
3998 * if IV checking is done by the device and not by mac80211.
4000 * Note that this function may only be called when no RX processing
4001 * can be done concurrently.
4003 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4004 int tid, struct ieee80211_key_seq *seq);
4007 * ieee80211_remove_key - remove the given key
4008 * @keyconf: the parameter passed with the set key
4010 * Remove the given key. If the key was uploaded to the hardware at the
4011 * time this function is called, it is not deleted in the hardware but
4012 * instead assumed to have been removed already.
4014 * Note that due to locking considerations this function can (currently)
4015 * only be called during key iteration (ieee80211_iter_keys().)
4017 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4020 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4021 * @vif: the virtual interface to add the key on
4022 * @keyconf: new key data
4024 * When GTK rekeying was done while the system was suspended, (a) new
4025 * key(s) will be available. These will be needed by mac80211 for proper
4026 * RX processing, so this function allows setting them.
4028 * The function returns the newly allocated key structure, which will
4029 * have similar contents to the passed key configuration but point to
4030 * mac80211-owned memory. In case of errors, the function returns an
4031 * ERR_PTR(), use IS_ERR() etc.
4033 * Note that this function assumes the key isn't added to hardware
4034 * acceleration, so no TX will be done with the key. Since it's a GTK
4035 * on managed (station) networks, this is true anyway. If the driver
4036 * calls this function from the resume callback and subsequently uses
4037 * the return code 1 to reconfigure the device, this key will be part
4038 * of the reconfiguration.
4040 * Note that the driver should also call ieee80211_set_key_rx_seq()
4041 * for the new key for each TID to set up sequence counters properly.
4043 * IMPORTANT: If this replaces a key that is present in the hardware,
4044 * then it will attempt to remove it during this call. In many cases
4045 * this isn't what you want, so call ieee80211_remove_key() first for
4046 * the key that's being replaced.
4048 struct ieee80211_key_conf *
4049 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4050 struct ieee80211_key_conf *keyconf);
4053 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4054 * @vif: virtual interface the rekeying was done on
4055 * @bssid: The BSSID of the AP, for checking association
4056 * @replay_ctr: the new replay counter after GTK rekeying
4057 * @gfp: allocation flags
4059 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4060 const u8 *replay_ctr, gfp_t gfp);
4063 * ieee80211_wake_queue - wake specific queue
4064 * @hw: pointer as obtained from ieee80211_alloc_hw().
4065 * @queue: queue number (counted from zero).
4067 * Drivers should use this function instead of netif_wake_queue.
4069 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4072 * ieee80211_stop_queue - stop specific queue
4073 * @hw: pointer as obtained from ieee80211_alloc_hw().
4074 * @queue: queue number (counted from zero).
4076 * Drivers should use this function instead of netif_stop_queue.
4078 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4081 * ieee80211_queue_stopped - test status of the queue
4082 * @hw: pointer as obtained from ieee80211_alloc_hw().
4083 * @queue: queue number (counted from zero).
4085 * Drivers should use this function instead of netif_stop_queue.
4087 * Return: %true if the queue is stopped. %false otherwise.
4090 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4093 * ieee80211_stop_queues - stop all queues
4094 * @hw: pointer as obtained from ieee80211_alloc_hw().
4096 * Drivers should use this function instead of netif_stop_queue.
4098 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4101 * ieee80211_wake_queues - wake all queues
4102 * @hw: pointer as obtained from ieee80211_alloc_hw().
4104 * Drivers should use this function instead of netif_wake_queue.
4106 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4109 * ieee80211_scan_completed - completed hardware scan
4111 * When hardware scan offload is used (i.e. the hw_scan() callback is
4112 * assigned) this function needs to be called by the driver to notify
4113 * mac80211 that the scan finished. This function can be called from
4114 * any context, including hardirq context.
4116 * @hw: the hardware that finished the scan
4117 * @aborted: set to true if scan was aborted
4119 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4122 * ieee80211_sched_scan_results - got results from scheduled scan
4124 * When a scheduled scan is running, this function needs to be called by the
4125 * driver whenever there are new scan results available.
4127 * @hw: the hardware that is performing scheduled scans
4129 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4132 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4134 * When a scheduled scan is running, this function can be called by
4135 * the driver if it needs to stop the scan to perform another task.
4136 * Usual scenarios are drivers that cannot continue the scheduled scan
4137 * while associating, for instance.
4139 * @hw: the hardware that is performing scheduled scans
4141 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4144 * enum ieee80211_interface_iteration_flags - interface iteration flags
4145 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4146 * been added to the driver; However, note that during hardware
4147 * reconfiguration (after restart_hw) it will iterate over a new
4148 * interface and over all the existing interfaces even if they
4149 * haven't been re-added to the driver yet.
4150 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4151 * interfaces, even if they haven't been re-added to the driver yet.
4153 enum ieee80211_interface_iteration_flags {
4154 IEEE80211_IFACE_ITER_NORMAL = 0,
4155 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4159 * ieee80211_iterate_active_interfaces - iterate active interfaces
4161 * This function iterates over the interfaces associated with a given
4162 * hardware that are currently active and calls the callback for them.
4163 * This function allows the iterator function to sleep, when the iterator
4164 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4166 * Does not iterate over a new interface during add_interface().
4168 * @hw: the hardware struct of which the interfaces should be iterated over
4169 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4170 * @iterator: the iterator function to call
4171 * @data: first argument of the iterator function
4173 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
4175 void (*iterator)(void *data, u8 *mac,
4176 struct ieee80211_vif *vif),
4180 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4182 * This function iterates over the interfaces associated with a given
4183 * hardware that are currently active and calls the callback for them.
4184 * This function requires the iterator callback function to be atomic,
4185 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4186 * Does not iterate over a new interface during add_interface().
4188 * @hw: the hardware struct of which the interfaces should be iterated over
4189 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4190 * @iterator: the iterator function to call, cannot sleep
4191 * @data: first argument of the iterator function
4193 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4195 void (*iterator)(void *data,
4197 struct ieee80211_vif *vif),
4201 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4203 * This function iterates over the interfaces associated with a given
4204 * hardware that are currently active and calls the callback for them.
4205 * This version can only be used while holding the RTNL.
4207 * @hw: the hardware struct of which the interfaces should be iterated over
4208 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4209 * @iterator: the iterator function to call, cannot sleep
4210 * @data: first argument of the iterator function
4212 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4214 void (*iterator)(void *data,
4216 struct ieee80211_vif *vif),
4220 * ieee80211_iterate_stations_atomic - iterate stations
4222 * This function iterates over all stations associated with a given
4223 * hardware that are currently uploaded to the driver and calls the callback
4224 * function for them.
4225 * This function requires the iterator callback function to be atomic,
4227 * @hw: the hardware struct of which the interfaces should be iterated over
4228 * @iterator: the iterator function to call, cannot sleep
4229 * @data: first argument of the iterator function
4231 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4232 void (*iterator)(void *data,
4233 struct ieee80211_sta *sta),
4236 * ieee80211_queue_work - add work onto the mac80211 workqueue
4238 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4239 * This helper ensures drivers are not queueing work when they should not be.
4241 * @hw: the hardware struct for the interface we are adding work for
4242 * @work: the work we want to add onto the mac80211 workqueue
4244 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4247 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4249 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4252 * @hw: the hardware struct for the interface we are adding work for
4253 * @dwork: delayable work to queue onto the mac80211 workqueue
4254 * @delay: number of jiffies to wait before queueing
4256 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4257 struct delayed_work *dwork,
4258 unsigned long delay);
4261 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4262 * @sta: the station for which to start a BA session
4263 * @tid: the TID to BA on.
4264 * @timeout: session timeout value (in TUs)
4266 * Return: success if addBA request was sent, failure otherwise
4268 * Although mac80211/low level driver/user space application can estimate
4269 * the need to start aggregation on a certain RA/TID, the session level
4270 * will be managed by the mac80211.
4272 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4276 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4277 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4278 * @ra: receiver address of the BA session recipient.
4279 * @tid: the TID to BA on.
4281 * This function must be called by low level driver once it has
4282 * finished with preparations for the BA session. It can be called
4285 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4289 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4290 * @sta: the station whose BA session to stop
4291 * @tid: the TID to stop BA.
4293 * Return: negative error if the TID is invalid, or no aggregation active
4295 * Although mac80211/low level driver/user space application can estimate
4296 * the need to stop aggregation on a certain RA/TID, the session level
4297 * will be managed by the mac80211.
4299 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4302 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4303 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4304 * @ra: receiver address of the BA session recipient.
4305 * @tid: the desired TID to BA on.
4307 * This function must be called by low level driver once it has
4308 * finished with preparations for the BA session tear down. It
4309 * can be called from any context.
4311 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4315 * ieee80211_find_sta - find a station
4317 * @vif: virtual interface to look for station on
4318 * @addr: station's address
4320 * Return: The station, if found. %NULL otherwise.
4322 * Note: This function must be called under RCU lock and the
4323 * resulting pointer is only valid under RCU lock as well.
4325 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4329 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4331 * @hw: pointer as obtained from ieee80211_alloc_hw()
4332 * @addr: remote station's address
4333 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4335 * Return: The station, if found. %NULL otherwise.
4337 * Note: This function must be called under RCU lock and the
4338 * resulting pointer is only valid under RCU lock as well.
4340 * NOTE: You may pass NULL for localaddr, but then you will just get
4341 * the first STA that matches the remote address 'addr'.
4342 * We can have multiple STA associated with multiple
4343 * logical stations (e.g. consider a station connecting to another
4344 * BSSID on the same AP hardware without disconnecting first).
4345 * In this case, the result of this method with localaddr NULL
4348 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4350 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4352 const u8 *localaddr);
4355 * ieee80211_sta_block_awake - block station from waking up
4357 * @pubsta: the station
4358 * @block: whether to block or unblock
4360 * Some devices require that all frames that are on the queues
4361 * for a specific station that went to sleep are flushed before
4362 * a poll response or frames after the station woke up can be
4363 * delivered to that it. Note that such frames must be rejected
4364 * by the driver as filtered, with the appropriate status flag.
4366 * This function allows implementing this mode in a race-free
4369 * To do this, a driver must keep track of the number of frames
4370 * still enqueued for a specific station. If this number is not
4371 * zero when the station goes to sleep, the driver must call
4372 * this function to force mac80211 to consider the station to
4373 * be asleep regardless of the station's actual state. Once the
4374 * number of outstanding frames reaches zero, the driver must
4375 * call this function again to unblock the station. That will
4376 * cause mac80211 to be able to send ps-poll responses, and if
4377 * the station queried in the meantime then frames will also
4378 * be sent out as a result of this. Additionally, the driver
4379 * will be notified that the station woke up some time after
4380 * it is unblocked, regardless of whether the station actually
4381 * woke up while blocked or not.
4383 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4384 struct ieee80211_sta *pubsta, bool block);
4387 * ieee80211_sta_eosp - notify mac80211 about end of SP
4388 * @pubsta: the station
4390 * When a device transmits frames in a way that it can't tell
4391 * mac80211 in the TX status about the EOSP, it must clear the
4392 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4393 * This applies for PS-Poll as well as uAPSD.
4395 * Note that just like with _tx_status() and _rx() drivers must
4396 * not mix calls to irqsafe/non-irqsafe versions, this function
4397 * must not be mixed with those either. Use the all irqsafe, or
4398 * all non-irqsafe, don't mix!
4400 * NB: the _irqsafe version of this function doesn't exist, no
4401 * driver needs it right now. Don't call this function if
4402 * you'd need the _irqsafe version, look at the git history
4403 * and restore the _irqsafe version!
4405 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4408 * ieee80211_iter_keys - iterate keys programmed into the device
4409 * @hw: pointer obtained from ieee80211_alloc_hw()
4410 * @vif: virtual interface to iterate, may be %NULL for all
4411 * @iter: iterator function that will be called for each key
4412 * @iter_data: custom data to pass to the iterator function
4414 * This function can be used to iterate all the keys known to
4415 * mac80211, even those that weren't previously programmed into
4416 * the device. This is intended for use in WoWLAN if the device
4417 * needs reprogramming of the keys during suspend. Note that due
4418 * to locking reasons, it is also only safe to call this at few
4419 * spots since it must hold the RTNL and be able to sleep.
4421 * The order in which the keys are iterated matches the order
4422 * in which they were originally installed and handed to the
4425 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4426 struct ieee80211_vif *vif,
4427 void (*iter)(struct ieee80211_hw *hw,
4428 struct ieee80211_vif *vif,
4429 struct ieee80211_sta *sta,
4430 struct ieee80211_key_conf *key,
4435 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4436 * @hw: pointre obtained from ieee80211_alloc_hw().
4437 * @iter: iterator function
4438 * @iter_data: data passed to iterator function
4440 * Iterate all active channel contexts. This function is atomic and
4441 * doesn't acquire any locks internally that might be held in other
4442 * places while calling into the driver.
4444 * The iterator will not find a context that's being added (during
4445 * the driver callback to add it) but will find it while it's being
4448 * Note that during hardware restart, all contexts that existed
4449 * before the restart are considered already present so will be
4450 * found while iterating, whether they've been re-added already
4453 void ieee80211_iter_chan_contexts_atomic(
4454 struct ieee80211_hw *hw,
4455 void (*iter)(struct ieee80211_hw *hw,
4456 struct ieee80211_chanctx_conf *chanctx_conf,
4461 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4462 * @hw: pointer obtained from ieee80211_alloc_hw().
4463 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4465 * Creates a Probe Request template which can, for example, be uploaded to
4466 * hardware. The template is filled with bssid, ssid and supported rate
4467 * information. This function must only be called from within the
4468 * .bss_info_changed callback function and only in managed mode. The function
4469 * is only useful when the interface is associated, otherwise it will return
4472 * Return: The Probe Request template. %NULL on error.
4474 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4475 struct ieee80211_vif *vif);
4478 * ieee80211_beacon_loss - inform hardware does not receive beacons
4480 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4482 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4483 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4484 * hardware is not receiving beacons with this function.
4486 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4489 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4491 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4493 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4494 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4495 * needs to inform if the connection to the AP has been lost.
4496 * The function may also be called if the connection needs to be terminated
4497 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4499 * This function will cause immediate change to disassociated state,
4500 * without connection recovery attempts.
4502 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4505 * ieee80211_resume_disconnect - disconnect from AP after resume
4507 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4509 * Instructs mac80211 to disconnect from the AP after resume.
4510 * Drivers can use this after WoWLAN if they know that the
4511 * connection cannot be kept up, for example because keys were
4512 * used while the device was asleep but the replay counters or
4513 * similar cannot be retrieved from the device during resume.
4515 * Note that due to implementation issues, if the driver uses
4516 * the reconfiguration functionality during resume the interface
4517 * will still be added as associated first during resume and then
4518 * disconnect normally later.
4520 * This function can only be called from the resume callback and
4521 * the driver must not be holding any of its own locks while it
4522 * calls this function, or at least not any locks it needs in the
4523 * key configuration paths (if it supports HW crypto).
4525 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4528 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4529 * rssi threshold triggered
4531 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4532 * @rssi_event: the RSSI trigger event type
4533 * @gfp: context flags
4535 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4536 * monitoring is configured with an rssi threshold, the driver will inform
4537 * whenever the rssi level reaches the threshold.
4539 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4540 enum nl80211_cqm_rssi_threshold_event rssi_event,
4544 * ieee80211_radar_detected - inform that a radar was detected
4546 * @hw: pointer as obtained from ieee80211_alloc_hw()
4548 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4551 * ieee80211_chswitch_done - Complete channel switch process
4552 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4553 * @success: make the channel switch successful or not
4555 * Complete the channel switch post-process: set the new operational channel
4556 * and wake up the suspended queues.
4558 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4561 * ieee80211_request_smps - request SM PS transition
4562 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4563 * @smps_mode: new SM PS mode
4565 * This allows the driver to request an SM PS transition in managed
4566 * mode. This is useful when the driver has more information than
4567 * the stack about possible interference, for example by bluetooth.
4569 void ieee80211_request_smps(struct ieee80211_vif *vif,
4570 enum ieee80211_smps_mode smps_mode);
4573 * ieee80211_ready_on_channel - notification of remain-on-channel start
4574 * @hw: pointer as obtained from ieee80211_alloc_hw()
4576 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4579 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4580 * @hw: pointer as obtained from ieee80211_alloc_hw()
4582 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4585 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4587 * in order not to harm the system performance and user experience, the device
4588 * may request not to allow any rx ba session and tear down existing rx ba
4589 * sessions based on system constraints such as periodic BT activity that needs
4590 * to limit wlan activity (eg.sco or a2dp)."
4591 * in such cases, the intention is to limit the duration of the rx ppdu and
4592 * therefore prevent the peer device to use a-mpdu aggregation.
4594 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4595 * @ba_rx_bitmap: Bit map of open rx ba per tid
4596 * @addr: & to bssid mac address
4598 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4602 * ieee80211_send_bar - send a BlockAckReq frame
4604 * can be used to flush pending frames from the peer's aggregation reorder
4607 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4608 * @ra: the peer's destination address
4609 * @tid: the TID of the aggregation session
4610 * @ssn: the new starting sequence number for the receiver
4612 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4615 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
4617 * Some device drivers may offload part of the Rx aggregation flow including
4618 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4621 * Create structures responsible for reordering so device drivers may call here
4622 * when they complete AddBa negotiation.
4624 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4625 * @addr: station mac address
4628 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
4629 const u8 *addr, u16 tid);
4632 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
4634 * Some device drivers may offload part of the Rx aggregation flow including
4635 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4638 * Destroy structures responsible for reordering so device drivers may call here
4639 * when they complete DelBa negotiation.
4641 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4642 * @addr: station mac address
4645 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
4646 const u8 *addr, u16 tid);
4648 /* Rate control API */
4651 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4653 * @hw: The hardware the algorithm is invoked for.
4654 * @sband: The band this frame is being transmitted on.
4655 * @bss_conf: the current BSS configuration
4656 * @skb: the skb that will be transmitted, the control information in it needs
4658 * @reported_rate: The rate control algorithm can fill this in to indicate
4659 * which rate should be reported to userspace as the current rate and
4660 * used for rate calculations in the mesh network.
4661 * @rts: whether RTS will be used for this frame because it is longer than the
4663 * @short_preamble: whether mac80211 will request short-preamble transmission
4664 * if the selected rate supports it
4665 * @max_rate_idx: user-requested maximum (legacy) rate
4666 * (deprecated; this will be removed once drivers get updated to use
4668 * @rate_idx_mask: user-requested (legacy) rate mask
4669 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4670 * @bss: whether this frame is sent out in AP or IBSS mode
4672 struct ieee80211_tx_rate_control {
4673 struct ieee80211_hw *hw;
4674 struct ieee80211_supported_band *sband;
4675 struct ieee80211_bss_conf *bss_conf;
4676 struct sk_buff *skb;
4677 struct ieee80211_tx_rate reported_rate;
4678 bool rts, short_preamble;
4681 u8 *rate_idx_mcs_mask;
4685 struct rate_control_ops {
4687 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4688 void (*free)(void *priv);
4690 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4691 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4692 struct cfg80211_chan_def *chandef,
4693 struct ieee80211_sta *sta, void *priv_sta);
4694 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4695 struct cfg80211_chan_def *chandef,
4696 struct ieee80211_sta *sta, void *priv_sta,
4698 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4701 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4702 struct ieee80211_sta *sta, void *priv_sta,
4703 struct sk_buff *skb);
4704 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4705 struct ieee80211_tx_rate_control *txrc);
4707 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4708 struct dentry *dir);
4709 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4711 u32 (*get_expected_throughput)(void *priv_sta);
4714 static inline int rate_supported(struct ieee80211_sta *sta,
4715 enum ieee80211_band band,
4718 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4722 * rate_control_send_low - helper for drivers for management/no-ack frames
4724 * Rate control algorithms that agree to use the lowest rate to
4725 * send management frames and NO_ACK data with the respective hw
4726 * retries should use this in the beginning of their mac80211 get_rate
4727 * callback. If true is returned the rate control can simply return.
4728 * If false is returned we guarantee that sta and sta and priv_sta is
4731 * Rate control algorithms wishing to do more intelligent selection of
4732 * rate for multicast/broadcast frames may choose to not use this.
4734 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4735 * that this may be null.
4736 * @priv_sta: private rate control structure. This may be null.
4737 * @txrc: rate control information we sholud populate for mac80211.
4739 bool rate_control_send_low(struct ieee80211_sta *sta,
4741 struct ieee80211_tx_rate_control *txrc);
4745 rate_lowest_index(struct ieee80211_supported_band *sband,
4746 struct ieee80211_sta *sta)
4750 for (i = 0; i < sband->n_bitrates; i++)
4751 if (rate_supported(sta, sband->band, i))
4754 /* warn when we cannot find a rate. */
4757 /* and return 0 (the lowest index) */
4762 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4763 struct ieee80211_sta *sta)
4767 for (i = 0; i < sband->n_bitrates; i++)
4768 if (rate_supported(sta, sband->band, i))
4774 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4776 * When not doing a rate control probe to test rates, rate control should pass
4777 * its rate selection to mac80211. If the driver supports receiving a station
4778 * rate table, it will use it to ensure that frames are always sent based on
4779 * the most recent rate control module decision.
4781 * @hw: pointer as obtained from ieee80211_alloc_hw()
4782 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4783 * @rates: new tx rate set to be used for this station.
4785 int rate_control_set_rates(struct ieee80211_hw *hw,
4786 struct ieee80211_sta *pubsta,
4787 struct ieee80211_sta_rates *rates);
4789 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4790 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4793 conf_is_ht20(struct ieee80211_conf *conf)
4795 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4799 conf_is_ht40_minus(struct ieee80211_conf *conf)
4801 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4802 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4806 conf_is_ht40_plus(struct ieee80211_conf *conf)
4808 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4809 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4813 conf_is_ht40(struct ieee80211_conf *conf)
4815 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4819 conf_is_ht(struct ieee80211_conf *conf)
4821 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
4822 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
4823 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
4826 static inline enum nl80211_iftype
4827 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4831 case NL80211_IFTYPE_STATION:
4832 return NL80211_IFTYPE_P2P_CLIENT;
4833 case NL80211_IFTYPE_AP:
4834 return NL80211_IFTYPE_P2P_GO;
4842 static inline enum nl80211_iftype
4843 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4845 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4848 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4850 int rssi_max_thold);
4852 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4855 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4857 * @vif: the specified virtual interface
4859 * Note: This function assumes that the given vif is valid.
4861 * Return: The average RSSI value for the requested interface, or 0 if not
4864 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4867 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4868 * @vif: virtual interface
4869 * @wakeup: wakeup reason(s)
4870 * @gfp: allocation flags
4872 * See cfg80211_report_wowlan_wakeup().
4874 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4875 struct cfg80211_wowlan_wakeup *wakeup,
4879 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4880 * @hw: pointer as obtained from ieee80211_alloc_hw()
4881 * @vif: virtual interface
4882 * @skb: frame to be sent from within the driver
4883 * @band: the band to transmit on
4884 * @sta: optional pointer to get the station to send the frame to
4886 * Note: must be called under RCU lock
4888 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4889 struct ieee80211_vif *vif, struct sk_buff *skb,
4890 int band, struct ieee80211_sta **sta);
4893 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4895 * @next_tsf: TSF timestamp of the next absent state change
4896 * @has_next_tsf: next absent state change event pending
4898 * @absent: descriptor bitmask, set if GO is currently absent
4902 * @count: count fields from the NoA descriptors
4903 * @desc: adjusted data from the NoA
4905 struct ieee80211_noa_data {
4911 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
4916 } desc[IEEE80211_P2P_NOA_DESC_MAX];
4920 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4923 * @data: NoA tracking data
4924 * @tsf: current TSF timestamp
4926 * Return: number of successfully parsed descriptors
4928 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
4929 struct ieee80211_noa_data *data, u32 tsf);
4932 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4934 * @data: NoA tracking data
4935 * @tsf: current TSF timestamp
4937 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
4940 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
4941 * @vif: virtual interface
4942 * @peer: the peer's destination address
4943 * @oper: the requested TDLS operation
4944 * @reason_code: reason code for the operation, valid for TDLS teardown
4945 * @gfp: allocation flags
4947 * See cfg80211_tdls_oper_request().
4949 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
4950 enum nl80211_tdls_operation oper,
4951 u16 reason_code, gfp_t gfp);
4954 * ieee80211_ie_split - split an IE buffer according to ordering
4956 * @ies: the IE buffer
4957 * @ielen: the length of the IE buffer
4958 * @ids: an array with element IDs that are allowed before
4960 * @n_ids: the size of the element ID array
4961 * @offset: offset where to start splitting in the buffer
4963 * This function splits an IE buffer by updating the @offset
4964 * variable to point to the location where the buffer should be
4967 * It assumes that the given IE buffer is well-formed, this
4968 * has to be guaranteed by the caller!
4970 * It also assumes that the IEs in the buffer are ordered
4971 * correctly, if not the result of using this function will not
4972 * be ordered correctly either, i.e. it does no reordering.
4974 * The function returns the offset where the next part of the
4975 * buffer starts, which may be @ielen if the entire (remainder)
4976 * of the buffer should be used.
4978 size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
4979 const u8 *ids, int n_ids, size_t offset);
4980 #endif /* MAC80211_H */