2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
72 * DOC: mac80211 workqueue
74 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
75 * The workqueue is a single threaded workqueue and can only be accessed by
76 * helpers for sanity checking. Drivers must ensure all work added onto the
77 * mac80211 workqueue should be cancelled on the driver stop() callback.
79 * mac80211 will flushed the workqueue upon interface removal and during
82 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
89 * enum ieee80211_max_queues - maximum number of queues
91 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
92 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
94 enum ieee80211_max_queues
{
95 IEEE80211_MAX_QUEUES
= 16,
96 IEEE80211_MAX_QUEUE_MAP
= BIT(IEEE80211_MAX_QUEUES
) - 1,
99 #define IEEE80211_INVAL_HW_QUEUE 0xff
102 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
103 * @IEEE80211_AC_VO: voice
104 * @IEEE80211_AC_VI: video
105 * @IEEE80211_AC_BE: best effort
106 * @IEEE80211_AC_BK: background
108 enum ieee80211_ac_numbers
{
114 #define IEEE80211_NUM_ACS 4
117 * struct ieee80211_tx_queue_params - transmit queue configuration
119 * The information provided in this structure is required for QoS
120 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
122 * @aifs: arbitration interframe space [0..255]
123 * @cw_min: minimum contention window [a value of the form
124 * 2^n-1 in the range 1..32767]
125 * @cw_max: maximum contention window [like @cw_min]
126 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
127 * @acm: is mandatory admission control required for the access category
128 * @uapsd: is U-APSD mode enabled for the queue
130 struct ieee80211_tx_queue_params
{
139 struct ieee80211_low_level_stats
{
140 unsigned int dot11ACKFailureCount
;
141 unsigned int dot11RTSFailureCount
;
142 unsigned int dot11FCSErrorCount
;
143 unsigned int dot11RTSSuccessCount
;
147 * enum ieee80211_chanctx_change - change flag for channel context
148 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
150 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
151 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
152 * this is used only with channel switching with CSA
153 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
155 enum ieee80211_chanctx_change
{
156 IEEE80211_CHANCTX_CHANGE_WIDTH
= BIT(0),
157 IEEE80211_CHANCTX_CHANGE_RX_CHAINS
= BIT(1),
158 IEEE80211_CHANCTX_CHANGE_RADAR
= BIT(2),
159 IEEE80211_CHANCTX_CHANGE_CHANNEL
= BIT(3),
160 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH
= BIT(4),
164 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
166 * This is the driver-visible part. The ieee80211_chanctx
167 * that contains it is visible in mac80211 only.
169 * @def: the channel definition
170 * @min_def: the minimum channel definition currently required.
171 * @rx_chains_static: The number of RX chains that must always be
172 * active on the channel to receive MIMO transmissions
173 * @rx_chains_dynamic: The number of RX chains that must be enabled
174 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
175 * this will always be >= @rx_chains_static.
176 * @radar_enabled: whether radar detection is enabled on this channel.
177 * @drv_priv: data area for driver use, will always be aligned to
178 * sizeof(void *), size is determined in hw information.
180 struct ieee80211_chanctx_conf
{
181 struct cfg80211_chan_def def
;
182 struct cfg80211_chan_def min_def
;
184 u8 rx_chains_static
, rx_chains_dynamic
;
188 u8 drv_priv
[0] __aligned(sizeof(void *));
192 * enum ieee80211_bss_change - BSS change notification flags
194 * These flags are used with the bss_info_changed() callback
195 * to indicate which BSS parameter changed.
197 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
198 * also implies a change in the AID.
199 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
200 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
201 * @BSS_CHANGED_ERP_SLOT: slot timing changed
202 * @BSS_CHANGED_HT: 802.11n parameters changed
203 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
204 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
205 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
206 * reason (IBSS and managed mode)
207 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
208 * new beacon (beaconing modes)
209 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
210 * enabled/disabled (beaconing modes)
211 * @BSS_CHANGED_CQM: Connection quality monitor config changed
212 * @BSS_CHANGED_IBSS: IBSS join status changed
213 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
214 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
215 * that it is only ever disabled for station mode.
216 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
217 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
218 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
219 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
220 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
221 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
222 * changed (currently only in P2P client mode, GO mode will be later)
223 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
224 * currently dtim_period only is under consideration.
225 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
226 * note that this is only called when it changes after the channel
227 * context had been assigned.
229 enum ieee80211_bss_change
{
230 BSS_CHANGED_ASSOC
= 1<<0,
231 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
232 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
233 BSS_CHANGED_ERP_SLOT
= 1<<3,
234 BSS_CHANGED_HT
= 1<<4,
235 BSS_CHANGED_BASIC_RATES
= 1<<5,
236 BSS_CHANGED_BEACON_INT
= 1<<6,
237 BSS_CHANGED_BSSID
= 1<<7,
238 BSS_CHANGED_BEACON
= 1<<8,
239 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
240 BSS_CHANGED_CQM
= 1<<10,
241 BSS_CHANGED_IBSS
= 1<<11,
242 BSS_CHANGED_ARP_FILTER
= 1<<12,
243 BSS_CHANGED_QOS
= 1<<13,
244 BSS_CHANGED_IDLE
= 1<<14,
245 BSS_CHANGED_SSID
= 1<<15,
246 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
247 BSS_CHANGED_PS
= 1<<17,
248 BSS_CHANGED_TXPOWER
= 1<<18,
249 BSS_CHANGED_P2P_PS
= 1<<19,
250 BSS_CHANGED_BEACON_INFO
= 1<<20,
251 BSS_CHANGED_BANDWIDTH
= 1<<21,
253 /* when adding here, make sure to change ieee80211_reconfig */
257 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
258 * of addresses for an interface increase beyond this value, hardware ARP
259 * filtering will be disabled.
261 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
264 * enum ieee80211_rssi_event - RSSI threshold event
265 * An indicator for when RSSI goes below/above a certain threshold.
266 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
267 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
269 enum ieee80211_rssi_event
{
275 * struct ieee80211_bss_conf - holds the BSS's changing parameters
277 * This structure keeps information about a BSS (and an association
278 * to that BSS) that can change during the lifetime of the BSS.
280 * @assoc: association status
281 * @ibss_joined: indicates whether this station is part of an IBSS
283 * @ibss_creator: indicates if a new IBSS network is being created
284 * @aid: association ID number, valid only when @assoc is true
285 * @use_cts_prot: use CTS protection
286 * @use_short_preamble: use 802.11b short preamble;
287 * if the hardware cannot handle this it must set the
288 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
289 * @use_short_slot: use short slot time (only relevant for ERP);
290 * if the hardware cannot handle this it must set the
291 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
292 * @dtim_period: num of beacons before the next DTIM, for beaconing,
293 * valid in station mode only if after the driver was notified
294 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
295 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
296 * as it may have been received during scanning long ago). If the
297 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
298 * only come from a beacon, but might not become valid until after
299 * association when a beacon is received (which is notified with the
300 * %BSS_CHANGED_DTIM flag.)
301 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
302 * the driver/device can use this to calculate synchronisation
304 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
305 * is requested, see @sync_tsf/@sync_device_ts.
306 * @beacon_int: beacon interval
307 * @assoc_capability: capabilities taken from assoc resp
308 * @basic_rates: bitmap of basic rates, each bit stands for an
309 * index into the rate table configured by the driver in
311 * @beacon_rate: associated AP's beacon TX rate
312 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
313 * @bssid: The BSSID for this BSS
314 * @enable_beacon: whether beaconing should be enabled or not
315 * @chandef: Channel definition for this BSS -- the hardware might be
316 * configured a higher bandwidth than this BSS uses, for example.
317 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
318 * This field is only valid when the channel type is one of the HT types.
319 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
321 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
322 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
323 * may filter ARP queries targeted for other addresses than listed here.
324 * The driver must allow ARP queries targeted for all address listed here
325 * to pass through. An empty list implies no ARP queries need to pass.
326 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
327 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
328 * array size), it's up to the driver what to do in that case.
329 * @qos: This is a QoS-enabled BSS.
330 * @idle: This interface is idle. There's also a global idle flag in the
331 * hardware config which may be more appropriate depending on what
332 * your driver/device needs to do.
333 * @ps: power-save mode (STA only). This flag is NOT affected by
334 * offchannel/dynamic_ps operations.
335 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
336 * @ssid_len: Length of SSID given in @ssid.
337 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
338 * @txpower: TX power in dBm
339 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
341 struct ieee80211_bss_conf
{
343 /* association related data */
344 bool assoc
, ibss_joined
;
347 /* erp related data */
349 bool use_short_preamble
;
354 u16 assoc_capability
;
359 struct ieee80211_rate
*beacon_rate
;
360 int mcast_rate
[IEEE80211_NUM_BANDS
];
361 u16 ht_operation_mode
;
364 struct cfg80211_chan_def chandef
;
365 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
370 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
374 struct ieee80211_p2p_noa_attr p2p_noa_attr
;
378 * enum mac80211_tx_info_flags - flags to describe transmission information/status
380 * These flags are used with the @flags member of &ieee80211_tx_info.
382 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
383 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
384 * number to this frame, taking care of not overwriting the fragment
385 * number and increasing the sequence number only when the
386 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
387 * assign sequence numbers to QoS-data frames but cannot do so correctly
388 * for non-QoS-data and management frames because beacons need them from
389 * that counter as well and mac80211 cannot guarantee proper sequencing.
390 * If this flag is set, the driver should instruct the hardware to
391 * assign a sequence number to the frame or assign one itself. Cf. IEEE
392 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
393 * beacons and always be clear for frames without a sequence number field.
394 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
395 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
397 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
398 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
399 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
400 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
401 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
402 * because the destination STA was in powersave mode. Note that to
403 * avoid race conditions, the filter must be set by the hardware or
404 * firmware upon receiving a frame that indicates that the station
405 * went to sleep (must be done on device to filter frames already on
406 * the queue) and may only be unset after mac80211 gives the OK for
407 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
408 * since only then is it guaranteed that no more frames are in the
410 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
411 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
412 * is for the whole aggregation.
413 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
414 * so consider using block ack request (BAR).
415 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
416 * set by rate control algorithms to indicate probe rate, will
417 * be cleared for fragmented frames (except on the last fragment)
418 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
419 * that a frame can be transmitted while the queues are stopped for
420 * off-channel operation.
421 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
422 * used to indicate that a pending frame requires TX processing before
423 * it can be sent out.
424 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
425 * used to indicate that a frame was already retried due to PS
426 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
427 * used to indicate frame should not be encrypted
428 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
429 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
430 * be sent although the station is in powersave mode.
431 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
432 * transmit function after the current frame, this can be used
433 * by drivers to kick the DMA queue only if unset or when the
435 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
436 * after TX status because the destination was asleep, it must not
437 * be modified again (no seqno assignment, crypto, etc.)
438 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
439 * code for connection establishment, this indicates that its status
440 * should kick the MLME state machine.
441 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
442 * MLME command (internal to mac80211 to figure out whether to send TX
443 * status to user space)
444 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
445 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
446 * frame and selects the maximum number of streams that it can use.
447 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
448 * the off-channel channel when a remain-on-channel offload is done
449 * in hardware -- normal packets still flow and are expected to be
450 * handled properly by the device.
451 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
452 * testing. It will be sent out with incorrect Michael MIC key to allow
453 * TKIP countermeasures to be tested.
454 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
455 * This flag is actually used for management frame especially for P2P
456 * frames not being sent at CCK rate in 2GHz band.
457 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
458 * when its status is reported the service period ends. For frames in
459 * an SP that mac80211 transmits, it is already set; for driver frames
460 * the driver may set this flag. It is also used to do the same for
462 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
463 * This flag is used to send nullfunc frame at minimum rate when
464 * the nullfunc is used for connection monitoring purpose.
465 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
466 * would be fragmented by size (this is optional, only used for
467 * monitor injection).
468 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
469 * frame (PS-Poll or uAPSD).
471 * Note: If you have to add new flags to the enumeration, then don't
472 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
474 enum mac80211_tx_info_flags
{
475 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
476 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
477 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
478 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
479 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
480 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
481 IEEE80211_TX_CTL_AMPDU
= BIT(6),
482 IEEE80211_TX_CTL_INJECTED
= BIT(7),
483 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
484 IEEE80211_TX_STAT_ACK
= BIT(9),
485 IEEE80211_TX_STAT_AMPDU
= BIT(10),
486 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
487 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
488 IEEE80211_TX_INTFL_OFFCHAN_TX_OK
= BIT(13),
489 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
490 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
491 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
492 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
493 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
494 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
495 IEEE80211_TX_INTFL_MLME_CONN_TX
= BIT(20),
496 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
497 IEEE80211_TX_CTL_LDPC
= BIT(22),
498 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
499 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
500 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
501 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
502 IEEE80211_TX_STATUS_EOSP
= BIT(28),
503 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
504 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
505 IEEE80211_TX_CTL_PS_RESPONSE
= BIT(31),
508 #define IEEE80211_TX_CTL_STBC_SHIFT 23
511 * enum mac80211_tx_control_flags - flags to describe transmit control
513 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
514 * protocol frame (e.g. EAP)
516 * These flags are used in tx_info->control.flags.
518 enum mac80211_tx_control_flags
{
519 IEEE80211_TX_CTRL_PORT_CTRL_PROTO
= BIT(0),
523 * This definition is used as a mask to clear all temporary flags, which are
524 * set by the tx handlers for each transmission attempt by the mac80211 stack.
526 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
527 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
528 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
529 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
530 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
531 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
532 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
533 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
536 * enum mac80211_rate_control_flags - per-rate flags set by the
537 * Rate Control algorithm.
539 * These flags are set by the Rate control algorithm for each rate during tx,
540 * in the @flags member of struct ieee80211_tx_rate.
542 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
543 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
544 * This is set if the current BSS requires ERP protection.
545 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
546 * @IEEE80211_TX_RC_MCS: HT rate.
547 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
548 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
549 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
551 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
552 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
553 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
554 * (80+80 isn't supported yet)
555 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
556 * adjacent 20 MHz channels, if the current channel type is
557 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
558 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
560 enum mac80211_rate_control_flags
{
561 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
562 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
563 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
565 /* rate index is an HT/VHT MCS instead of an index */
566 IEEE80211_TX_RC_MCS
= BIT(3),
567 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
568 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
569 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
570 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
571 IEEE80211_TX_RC_VHT_MCS
= BIT(8),
572 IEEE80211_TX_RC_80_MHZ_WIDTH
= BIT(9),
573 IEEE80211_TX_RC_160_MHZ_WIDTH
= BIT(10),
577 /* there are 40 bytes if you don't need the rateset to be kept */
578 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
580 /* if you do need the rateset, then you have less space */
581 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
583 /* maximum number of rate stages */
584 #define IEEE80211_TX_MAX_RATES 4
586 /* maximum number of rate table entries */
587 #define IEEE80211_TX_RATE_TABLE_SIZE 4
590 * struct ieee80211_tx_rate - rate selection/status
592 * @idx: rate index to attempt to send with
593 * @flags: rate control flags (&enum mac80211_rate_control_flags)
594 * @count: number of tries in this rate before going to the next rate
596 * A value of -1 for @idx indicates an invalid rate and, if used
597 * in an array of retry rates, that no more rates should be tried.
599 * When used for transmit status reporting, the driver should
600 * always report the rate along with the flags it used.
602 * &struct ieee80211_tx_info contains an array of these structs
603 * in the control information, and it will be filled by the rate
604 * control algorithm according to what should be sent. For example,
605 * if this array contains, in the format { <idx>, <count> } the
607 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
608 * then this means that the frame should be transmitted
609 * up to twice at rate 3, up to twice at rate 2, and up to four
610 * times at rate 1 if it doesn't get acknowledged. Say it gets
611 * acknowledged by the peer after the fifth attempt, the status
612 * information should then contain
613 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
614 * since it was transmitted twice at rate 3, twice at rate 2
615 * and once at rate 1 after which we received an acknowledgement.
617 struct ieee80211_tx_rate
{
623 #define IEEE80211_MAX_TX_RETRY 31
625 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate
*rate
,
629 WARN_ON((nss
- 1) & ~0x7);
630 rate
->idx
= ((nss
- 1) << 4) | mcs
;
634 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate
*rate
)
636 return rate
->idx
& 0xF;
640 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate
*rate
)
642 return (rate
->idx
>> 4) + 1;
646 * struct ieee80211_tx_info - skb transmit information
648 * This structure is placed in skb->cb for three uses:
649 * (1) mac80211 TX control - mac80211 tells the driver what to do
650 * (2) driver internal use (if applicable)
651 * (3) TX status information - driver tells mac80211 what happened
653 * @flags: transmit info flags, defined above
654 * @band: the band to transmit on (use for checking for races)
655 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
656 * @ack_frame_id: internal frame ID for TX status, used internally
657 * @control: union for control data
658 * @status: union for status data
659 * @driver_data: array of driver_data pointers
660 * @ampdu_ack_len: number of acked aggregated frames.
661 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
662 * @ampdu_len: number of aggregated frames.
663 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
664 * @ack_signal: signal strength of the ACK frame
666 struct ieee80211_tx_info
{
667 /* common information */
680 struct ieee80211_tx_rate rates
[
681 IEEE80211_TX_MAX_RATES
];
689 /* only needed before rate control */
690 unsigned long jiffies
;
692 /* NB: vif can be NULL for injected frames */
693 struct ieee80211_vif
*vif
;
694 struct ieee80211_key_conf
*hw_key
;
699 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
707 struct ieee80211_tx_rate driver_rates
[
708 IEEE80211_TX_MAX_RATES
];
711 void *rate_driver_data
[
712 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
715 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
720 * struct ieee80211_sched_scan_ies - scheduled scan IEs
722 * This structure is used to pass the appropriate IEs to be used in scheduled
723 * scans for all bands. It contains both the IEs passed from the userspace
724 * and the ones generated by mac80211.
726 * @ie: array with the IEs for each supported band
727 * @len: array with the total length of the IEs for each band
729 struct ieee80211_sched_scan_ies
{
730 u8
*ie
[IEEE80211_NUM_BANDS
];
731 size_t len
[IEEE80211_NUM_BANDS
];
734 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
736 return (struct ieee80211_tx_info
*)skb
->cb
;
739 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
741 return (struct ieee80211_rx_status
*)skb
->cb
;
745 * ieee80211_tx_info_clear_status - clear TX status
747 * @info: The &struct ieee80211_tx_info to be cleared.
749 * When the driver passes an skb back to mac80211, it must report
750 * a number of things in TX status. This function clears everything
751 * in the TX status but the rate control information (it does clear
752 * the count since you need to fill that in anyway).
754 * NOTE: You can only use this function if you do NOT use
755 * info->driver_data! Use info->rate_driver_data
756 * instead if you need only the less space that allows.
759 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
763 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
764 offsetof(struct ieee80211_tx_info
, control
.rates
));
765 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
766 offsetof(struct ieee80211_tx_info
, driver_rates
));
767 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
768 /* clear the rate counts */
769 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
770 info
->status
.rates
[i
].count
= 0;
773 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
774 memset(&info
->status
.ampdu_ack_len
, 0,
775 sizeof(struct ieee80211_tx_info
) -
776 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
781 * enum mac80211_rx_flags - receive flags
783 * These flags are used with the @flag member of &struct ieee80211_rx_status.
784 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
785 * Use together with %RX_FLAG_MMIC_STRIPPED.
786 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
787 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
788 * verification has been done by the hardware.
789 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
790 * If this flag is set, the stack cannot do any replay detection
791 * hence the driver or hardware will have to do that.
792 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
794 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
796 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
797 * field) is valid and contains the time the first symbol of the MPDU
798 * was received. This is useful in monitor mode and for proper IBSS
800 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
801 * field) is valid and contains the time the last symbol of the MPDU
802 * (including FCS) was received.
803 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
804 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
805 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
806 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
807 * @RX_FLAG_SHORT_GI: Short guard interval was used
808 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
809 * Valid only for data frames (mainly A-MPDU)
810 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
811 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
812 * to hw.radiotap_mcs_details to advertise that fact
813 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
814 * number (@ampdu_reference) must be populated and be a distinct number for
816 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
817 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
818 * monitoring purposes only
819 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
820 * subframes of a single A-MPDU
821 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
822 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
824 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
825 * is stored in the @ampdu_delimiter_crc field)
826 * @RX_FLAG_LDPC: LDPC was used
827 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
828 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
829 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
830 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
831 * subframes instead of a one huge frame for performance reasons.
832 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
833 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
834 * the 3rd (last) one must not have this flag set. The flag is used to
835 * deal with retransmission/duplication recovery properly since A-MSDU
836 * subframes share the same sequence number. Reported subframes can be
837 * either regular MSDU or singly A-MSDUs. Subframes must not be
838 * interleaved with other frames.
840 enum mac80211_rx_flags
{
841 RX_FLAG_MMIC_ERROR
= BIT(0),
842 RX_FLAG_DECRYPTED
= BIT(1),
843 RX_FLAG_MMIC_STRIPPED
= BIT(3),
844 RX_FLAG_IV_STRIPPED
= BIT(4),
845 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
846 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
847 RX_FLAG_MACTIME_START
= BIT(7),
848 RX_FLAG_SHORTPRE
= BIT(8),
850 RX_FLAG_40MHZ
= BIT(10),
851 RX_FLAG_SHORT_GI
= BIT(11),
852 RX_FLAG_NO_SIGNAL_VAL
= BIT(12),
853 RX_FLAG_HT_GF
= BIT(13),
854 RX_FLAG_AMPDU_DETAILS
= BIT(14),
855 RX_FLAG_AMPDU_REPORT_ZEROLEN
= BIT(15),
856 RX_FLAG_AMPDU_IS_ZEROLEN
= BIT(16),
857 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(17),
858 RX_FLAG_AMPDU_IS_LAST
= BIT(18),
859 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(19),
860 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(20),
861 RX_FLAG_MACTIME_END
= BIT(21),
862 RX_FLAG_VHT
= BIT(22),
863 RX_FLAG_LDPC
= BIT(23),
864 RX_FLAG_STBC_MASK
= BIT(26) | BIT(27),
865 RX_FLAG_10MHZ
= BIT(28),
866 RX_FLAG_5MHZ
= BIT(29),
867 RX_FLAG_AMSDU_MORE
= BIT(30),
870 #define RX_FLAG_STBC_SHIFT 26
873 * enum mac80211_rx_vht_flags - receive VHT flags
875 * These flags are used with the @vht_flag member of
876 * &struct ieee80211_rx_status.
877 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
878 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
879 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
881 enum mac80211_rx_vht_flags
{
882 RX_VHT_FLAG_80MHZ
= BIT(0),
883 RX_VHT_FLAG_80P80MHZ
= BIT(1),
884 RX_VHT_FLAG_160MHZ
= BIT(2),
888 * struct ieee80211_rx_status - receive status
890 * The low-level driver should provide this information (the subset
891 * supported by hardware) to the 802.11 code with each received
892 * frame, in the skb's control buffer (cb).
894 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
895 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
896 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
897 * it but can store it and pass it back to the driver for synchronisation
898 * @band: the active band when this frame was received
899 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
900 * @signal: signal strength when receiving this frame, either in dBm, in dB or
901 * unspecified depending on the hardware capabilities flags
902 * @IEEE80211_HW_SIGNAL_*
903 * @chains: bitmask of receive chains for which separate signal strength
904 * values were filled.
905 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
906 * support dB or unspecified units)
907 * @antenna: antenna used
908 * @rate_idx: index of data rate into band's supported rates or MCS index if
909 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
910 * @vht_nss: number of streams (VHT only)
912 * @vht_flag: %RX_VHT_FLAG_*
913 * @rx_flags: internal RX flags for mac80211
914 * @ampdu_reference: A-MPDU reference number, must be a different value for
915 * each A-MPDU but the same for each subframe within one A-MPDU
916 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
918 struct ieee80211_rx_status
{
920 u32 device_timestamp
;
932 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
933 u8 ampdu_delimiter_crc
;
937 * enum ieee80211_conf_flags - configuration flags
939 * Flags to define PHY configuration options
941 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
942 * to determine for example whether to calculate timestamps for packets
943 * or not, do not use instead of filter flags!
944 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
945 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
946 * meaning that the hardware still wakes up for beacons, is able to
947 * transmit frames and receive the possible acknowledgment frames.
948 * Not to be confused with hardware specific wakeup/sleep states,
949 * driver is responsible for that. See the section "Powersave support"
951 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
952 * the driver should be prepared to handle configuration requests but
953 * may turn the device off as much as possible. Typically, this flag will
954 * be set when an interface is set UP but not associated or scanning, but
955 * it can also be unset in that case when monitor interfaces are active.
956 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
959 enum ieee80211_conf_flags
{
960 IEEE80211_CONF_MONITOR
= (1<<0),
961 IEEE80211_CONF_PS
= (1<<1),
962 IEEE80211_CONF_IDLE
= (1<<2),
963 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
968 * enum ieee80211_conf_changed - denotes which configuration changed
970 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
971 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
972 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
973 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
974 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
975 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
976 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
977 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
978 * Note that this is only valid if channel contexts are not used,
979 * otherwise each channel context has the number of chains listed.
981 enum ieee80211_conf_changed
{
982 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
983 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
984 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
985 IEEE80211_CONF_CHANGE_PS
= BIT(4),
986 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
987 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
988 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
989 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
993 * enum ieee80211_smps_mode - spatial multiplexing power save mode
995 * @IEEE80211_SMPS_AUTOMATIC: automatic
996 * @IEEE80211_SMPS_OFF: off
997 * @IEEE80211_SMPS_STATIC: static
998 * @IEEE80211_SMPS_DYNAMIC: dynamic
999 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1001 enum ieee80211_smps_mode
{
1002 IEEE80211_SMPS_AUTOMATIC
,
1004 IEEE80211_SMPS_STATIC
,
1005 IEEE80211_SMPS_DYNAMIC
,
1008 IEEE80211_SMPS_NUM_MODES
,
1012 * struct ieee80211_conf - configuration of the device
1014 * This struct indicates how the driver shall configure the hardware.
1016 * @flags: configuration flags defined above
1018 * @listen_interval: listen interval in units of beacon interval
1019 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1020 * before checking the beacon for a TIM bit (managed mode only); this
1021 * value will be only achievable between DTIM frames, the hardware
1022 * needs to check for the multicast traffic bit in DTIM beacons.
1023 * This variable is valid only when the CONF_PS flag is set.
1024 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1025 * in power saving. Power saving will not be enabled until a beacon
1026 * has been received and the DTIM period is known.
1027 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1028 * powersave documentation below. This variable is valid only when
1029 * the CONF_PS flag is set.
1031 * @power_level: requested transmit power (in dBm), backward compatibility
1032 * value only that is set to the minimum of all interfaces
1034 * @chandef: the channel definition to tune to
1035 * @radar_enabled: whether radar detection is enabled
1037 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1038 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1039 * but actually means the number of transmissions not the number of retries
1040 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1041 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1042 * number of transmissions not the number of retries
1044 * @smps_mode: spatial multiplexing powersave mode; note that
1045 * %IEEE80211_SMPS_STATIC is used when the device is not
1046 * configured for an HT channel.
1047 * Note that this is only valid if channel contexts are not used,
1048 * otherwise each channel context has the number of chains listed.
1050 struct ieee80211_conf
{
1052 int power_level
, dynamic_ps_timeout
;
1053 int max_sleep_period
;
1055 u16 listen_interval
;
1058 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
1060 struct cfg80211_chan_def chandef
;
1062 enum ieee80211_smps_mode smps_mode
;
1066 * struct ieee80211_channel_switch - holds the channel switch data
1068 * The information provided in this structure is required for channel switch
1071 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1072 * Function (TSF) timer when the frame containing the channel switch
1073 * announcement was received. This is simply the rx.mactime parameter
1074 * the driver passed into mac80211.
1075 * @block_tx: Indicates whether transmission must be blocked before the
1076 * scheduled channel switch, as indicated by the AP.
1077 * @chandef: the new channel to switch to
1078 * @count: the number of TBTT's until the channel switch event
1080 struct ieee80211_channel_switch
{
1083 struct cfg80211_chan_def chandef
;
1088 * enum ieee80211_vif_flags - virtual interface flags
1090 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1091 * on this virtual interface to avoid unnecessary CPU wakeups
1092 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1093 * monitoring on this virtual interface -- i.e. it can monitor
1094 * connection quality related parameters, such as the RSSI level and
1095 * provide notifications if configured trigger levels are reached.
1097 enum ieee80211_vif_flags
{
1098 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
1099 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
1103 * struct ieee80211_vif - per-interface data
1105 * Data in this structure is continually present for driver
1106 * use during the life of a virtual interface.
1108 * @type: type of this virtual interface
1109 * @bss_conf: BSS configuration for this interface, either our own
1110 * or the BSS we're associated to
1111 * @addr: address of this interface
1112 * @p2p: indicates whether this AP or STA interface is a p2p
1113 * interface, i.e. a GO or p2p-sta respectively
1114 * @csa_active: marks whether a channel switch is going on
1115 * @driver_flags: flags/capabilities the driver has for this interface,
1116 * these need to be set (or cleared) when the interface is added
1117 * or, if supported by the driver, the interface type is changed
1118 * at runtime, mac80211 will never touch this field
1119 * @hw_queue: hardware queue for each AC
1120 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1121 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1122 * when it is not assigned. This pointer is RCU-protected due to the TX
1123 * path needing to access it; even though the netdev carrier will always
1124 * be off when it is %NULL there can still be races and packets could be
1125 * processed after it switches back to %NULL.
1126 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1127 * interface debug files. Note that it will be NULL for the virtual
1128 * monitor interface (if that is requested.)
1129 * @drv_priv: data area for driver use, will always be aligned to
1132 struct ieee80211_vif
{
1133 enum nl80211_iftype type
;
1134 struct ieee80211_bss_conf bss_conf
;
1140 u8 hw_queue
[IEEE80211_NUM_ACS
];
1142 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1146 #ifdef CONFIG_MAC80211_DEBUGFS
1147 struct dentry
*debugfs_dir
;
1151 u8 drv_priv
[0] __aligned(sizeof(void *));
1154 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1156 #ifdef CONFIG_MAC80211_MESH
1157 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1163 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1164 * @wdev: the wdev to get the vif for
1166 * This can be used by mac80211 drivers with direct cfg80211 APIs
1167 * (like the vendor commands) that get a wdev.
1169 * Note that this function may return %NULL if the given wdev isn't
1170 * associated with a vif that the driver knows about (e.g. monitor
1171 * or AP_VLAN interfaces.)
1173 struct ieee80211_vif
*wdev_to_ieee80211_vif(struct wireless_dev
*wdev
);
1176 * enum ieee80211_key_flags - key flags
1178 * These flags are used for communication about keys between the driver
1179 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1181 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1182 * driver to indicate that it requires IV generation for this
1184 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1185 * the driver for a TKIP key if it requires Michael MIC
1186 * generation in software.
1187 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1188 * that the key is pairwise rather then a shared key.
1189 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1190 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1191 * be done in software.
1192 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1193 * if space should be prepared for the IV, but the IV
1194 * itself should not be generated. Do not set together with
1195 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1196 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1197 * management frames. The flag can help drivers that have a hardware
1198 * crypto implementation that doesn't deal with management frames
1199 * properly by allowing them to not upload the keys to hardware and
1200 * fall back to software crypto. Note that this flag deals only with
1201 * RX, if your crypto engine can't deal with TX you can also set the
1202 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1204 enum ieee80211_key_flags
{
1205 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
1206 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
1207 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
1208 IEEE80211_KEY_FLAG_SW_MGMT_TX
= 1<<4,
1209 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= 1<<5,
1210 IEEE80211_KEY_FLAG_RX_MGMT
= 1<<6,
1214 * struct ieee80211_key_conf - key information
1216 * This key information is given by mac80211 to the driver by
1217 * the set_key() callback in &struct ieee80211_ops.
1219 * @hw_key_idx: To be set by the driver, this is the key index the driver
1220 * wants to be given when a frame is transmitted and needs to be
1221 * encrypted in hardware.
1222 * @cipher: The key's cipher suite selector.
1223 * @flags: key flags, see &enum ieee80211_key_flags.
1224 * @keyidx: the key index (0-3)
1225 * @keylen: key material length
1226 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1228 * - Temporal Encryption Key (128 bits)
1229 * - Temporal Authenticator Tx MIC Key (64 bits)
1230 * - Temporal Authenticator Rx MIC Key (64 bits)
1231 * @icv_len: The ICV length for this key type
1232 * @iv_len: The IV length for this key type
1234 struct ieee80211_key_conf
{
1246 * struct ieee80211_cipher_scheme - cipher scheme
1248 * This structure contains a cipher scheme information defining
1249 * the secure packet crypto handling.
1251 * @cipher: a cipher suite selector
1252 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1253 * @hdr_len: a length of a security header used the cipher
1254 * @pn_len: a length of a packet number in the security header
1255 * @pn_off: an offset of pn from the beginning of the security header
1256 * @key_idx_off: an offset of key index byte in the security header
1257 * @key_idx_mask: a bit mask of key_idx bits
1258 * @key_idx_shift: a bit shift needed to get key_idx
1259 * key_idx value calculation:
1260 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1261 * @mic_len: a mic length in bytes
1263 struct ieee80211_cipher_scheme
{
1276 * enum set_key_cmd - key command
1278 * Used with the set_key() callback in &struct ieee80211_ops, this
1279 * indicates whether a key is being removed or added.
1281 * @SET_KEY: a key is set
1282 * @DISABLE_KEY: a key must be disabled
1285 SET_KEY
, DISABLE_KEY
,
1289 * enum ieee80211_sta_state - station state
1291 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1292 * this is a special state for add/remove transitions
1293 * @IEEE80211_STA_NONE: station exists without special state
1294 * @IEEE80211_STA_AUTH: station is authenticated
1295 * @IEEE80211_STA_ASSOC: station is associated
1296 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1298 enum ieee80211_sta_state
{
1299 /* NOTE: These need to be ordered correctly! */
1300 IEEE80211_STA_NOTEXIST
,
1303 IEEE80211_STA_ASSOC
,
1304 IEEE80211_STA_AUTHORIZED
,
1308 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1309 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1310 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1311 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1312 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1313 * (including 80+80 MHz)
1315 * Implementation note: 20 must be zero to be initialized
1316 * correctly, the values must be sorted.
1318 enum ieee80211_sta_rx_bandwidth
{
1319 IEEE80211_STA_RX_BW_20
= 0,
1320 IEEE80211_STA_RX_BW_40
,
1321 IEEE80211_STA_RX_BW_80
,
1322 IEEE80211_STA_RX_BW_160
,
1326 * struct ieee80211_sta_rates - station rate selection table
1328 * @rcu_head: RCU head used for freeing the table on update
1329 * @rate: transmit rates/flags to be used by default.
1330 * Overriding entries per-packet is possible by using cb tx control.
1332 struct ieee80211_sta_rates
{
1333 struct rcu_head rcu_head
;
1340 } rate
[IEEE80211_TX_RATE_TABLE_SIZE
];
1344 * struct ieee80211_sta - station table entry
1346 * A station table entry represents a station we are possibly
1347 * communicating with. Since stations are RCU-managed in
1348 * mac80211, any ieee80211_sta pointer you get access to must
1349 * either be protected by rcu_read_lock() explicitly or implicitly,
1350 * or you must take good care to not use such a pointer after a
1351 * call to your sta_remove callback that removed it.
1353 * @addr: MAC address
1354 * @aid: AID we assigned to the station if we're an AP
1355 * @supp_rates: Bitmap of supported rates (per band)
1356 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1357 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1358 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1359 * @drv_priv: data area for driver use, will always be aligned to
1360 * sizeof(void *), size is determined in hw information.
1361 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1362 * if wme is supported.
1363 * @max_sp: max Service Period. Only valid if wme is supported.
1364 * @bandwidth: current bandwidth the station can receive with
1365 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1366 * station can receive at the moment, changed by operating mode
1367 * notifications and capabilities. The value is only valid after
1368 * the station moves to associated state.
1369 * @smps_mode: current SMPS mode (off, static or dynamic)
1370 * @rates: rate control selection table
1372 struct ieee80211_sta
{
1373 u32 supp_rates
[IEEE80211_NUM_BANDS
];
1376 struct ieee80211_sta_ht_cap ht_cap
;
1377 struct ieee80211_sta_vht_cap vht_cap
;
1382 enum ieee80211_sta_rx_bandwidth bandwidth
;
1383 enum ieee80211_smps_mode smps_mode
;
1384 struct ieee80211_sta_rates __rcu
*rates
;
1387 u8 drv_priv
[0] __aligned(sizeof(void *));
1391 * enum sta_notify_cmd - sta notify command
1393 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1394 * indicates if an associated station made a power state transition.
1396 * @STA_NOTIFY_SLEEP: a station is now sleeping
1397 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1399 enum sta_notify_cmd
{
1400 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1404 * struct ieee80211_tx_control - TX control data
1406 * @sta: station table entry, this sta pointer may be NULL and
1407 * it is not allowed to copy the pointer, due to RCU.
1409 struct ieee80211_tx_control
{
1410 struct ieee80211_sta
*sta
;
1414 * enum ieee80211_hw_flags - hardware flags
1416 * These flags are used to indicate hardware capabilities to
1417 * the stack. Generally, flags here should have their meaning
1418 * done in a way that the simplest hardware doesn't need setting
1419 * any particular flags. There are some exceptions to this rule,
1420 * however, so you are advised to review these flags carefully.
1422 * @IEEE80211_HW_HAS_RATE_CONTROL:
1423 * The hardware or firmware includes rate control, and cannot be
1424 * controlled by the stack. As such, no rate control algorithm
1425 * should be instantiated, and the TX rate reported to userspace
1426 * will be taken from the TX status instead of the rate control
1428 * Note that this requires that the driver implement a number of
1429 * callbacks so it has the correct information, it needs to have
1430 * the @set_rts_threshold callback and must look at the BSS config
1431 * @use_cts_prot for G/N protection, @use_short_slot for slot
1432 * timing in 2.4 GHz and @use_short_preamble for preambles for
1435 * @IEEE80211_HW_RX_INCLUDES_FCS:
1436 * Indicates that received frames passed to the stack include
1437 * the FCS at the end.
1439 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1440 * Some wireless LAN chipsets buffer broadcast/multicast frames
1441 * for power saving stations in the hardware/firmware and others
1442 * rely on the host system for such buffering. This option is used
1443 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1444 * multicast frames when there are power saving stations so that
1445 * the driver can fetch them with ieee80211_get_buffered_bc().
1447 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1448 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1450 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1451 * Hardware is not capable of receiving frames with short preamble on
1454 * @IEEE80211_HW_SIGNAL_UNSPEC:
1455 * Hardware can provide signal values but we don't know its units. We
1456 * expect values between 0 and @max_signal.
1457 * If possible please provide dB or dBm instead.
1459 * @IEEE80211_HW_SIGNAL_DBM:
1460 * Hardware gives signal values in dBm, decibel difference from
1461 * one milliwatt. This is the preferred method since it is standardized
1462 * between different devices. @max_signal does not need to be set.
1464 * @IEEE80211_HW_SPECTRUM_MGMT:
1465 * Hardware supports spectrum management defined in 802.11h
1466 * Measurement, Channel Switch, Quieting, TPC
1468 * @IEEE80211_HW_AMPDU_AGGREGATION:
1469 * Hardware supports 11n A-MPDU aggregation.
1471 * @IEEE80211_HW_SUPPORTS_PS:
1472 * Hardware has power save support (i.e. can go to sleep).
1474 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1475 * Hardware requires nullfunc frame handling in stack, implies
1476 * stack support for dynamic PS.
1478 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1479 * Hardware has support for dynamic PS.
1481 * @IEEE80211_HW_MFP_CAPABLE:
1482 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1484 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1485 * Hardware supports static spatial multiplexing powersave,
1486 * ie. can turn off all but one chain even on HT connections
1487 * that should be using more chains.
1489 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1490 * Hardware supports dynamic spatial multiplexing powersave,
1491 * ie. can turn off all but one chain and then wake the rest
1492 * up as required after, for example, rts/cts handshake.
1494 * @IEEE80211_HW_SUPPORTS_UAPSD:
1495 * Hardware supports Unscheduled Automatic Power Save Delivery
1496 * (U-APSD) in managed mode. The mode is configured with
1497 * conf_tx() operation.
1499 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1500 * Hardware can provide ack status reports of Tx frames to
1503 * @IEEE80211_HW_CONNECTION_MONITOR:
1504 * The hardware performs its own connection monitoring, including
1505 * periodic keep-alives to the AP and probing the AP on beacon loss.
1507 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1508 * This device needs to get data from beacon before association (i.e.
1511 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1512 * per-station GTKs as used by IBSS RSN or during fast transition. If
1513 * the device doesn't support per-station GTKs, but can be asked not
1514 * to decrypt group addressed frames, then IBSS RSN support is still
1515 * possible but software crypto will be used. Advertise the wiphy flag
1516 * only in that case.
1518 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1519 * autonomously manages the PS status of connected stations. When
1520 * this flag is set mac80211 will not trigger PS mode for connected
1521 * stations based on the PM bit of incoming frames.
1522 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1523 * the PS mode of connected stations.
1525 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1526 * setup strictly in HW. mac80211 should not attempt to do this in
1529 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1530 * a virtual monitor interface when monitor interfaces are the only
1531 * active interfaces.
1533 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1534 * queue mapping in order to use different queues (not just one per AC)
1535 * for different virtual interfaces. See the doc section on HW queue
1536 * control for more details.
1538 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1539 * selection table provided by the rate control algorithm.
1541 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1542 * P2P Interface. This will be honoured even if more than one interface
1545 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1546 * only, to allow getting TBTT of a DTIM beacon.
1548 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1549 * and can cope with CCK rates in an aggregation session (e.g. by not
1550 * using aggregation for such frames.)
1552 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1553 * for a single active channel while using channel contexts. When support
1554 * is not enabled the default action is to disconnect when getting the
1557 enum ieee80211_hw_flags
{
1558 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1559 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1560 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1561 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1562 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1563 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1564 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1565 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC
= 1<<7,
1566 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1567 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1568 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1569 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1570 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1571 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1572 IEEE80211_HW_WANT_MONITOR_VIF
= 1<<14,
1573 IEEE80211_HW_SUPPORTS_STATIC_SMPS
= 1<<15,
1574 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS
= 1<<16,
1575 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1576 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1577 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1578 IEEE80211_HW_QUEUE_CONTROL
= 1<<20,
1579 IEEE80211_HW_SUPPORTS_PER_STA_GTK
= 1<<21,
1580 IEEE80211_HW_AP_LINK_PS
= 1<<22,
1581 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
= 1<<23,
1582 IEEE80211_HW_SUPPORTS_RC_TABLE
= 1<<24,
1583 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
= 1<<25,
1584 IEEE80211_HW_TIMING_BEACON_ONLY
= 1<<26,
1585 IEEE80211_HW_SUPPORTS_HT_CCK_RATES
= 1<<27,
1586 IEEE80211_HW_CHANCTX_STA_CSA
= 1<<28,
1590 * struct ieee80211_hw - hardware information and state
1592 * This structure contains the configuration and hardware
1593 * information for an 802.11 PHY.
1595 * @wiphy: This points to the &struct wiphy allocated for this
1596 * 802.11 PHY. You must fill in the @perm_addr and @dev
1597 * members of this structure using SET_IEEE80211_DEV()
1598 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1599 * bands (with channels, bitrates) are registered here.
1601 * @conf: &struct ieee80211_conf, device configuration, don't use.
1603 * @priv: pointer to private area that was allocated for driver use
1604 * along with this structure.
1606 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1608 * @extra_tx_headroom: headroom to reserve in each transmit skb
1609 * for use by the driver (e.g. for transmit headers.)
1611 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1612 * Can be used by drivers to add extra IEs.
1614 * @max_signal: Maximum value for signal (rssi) in RX information, used
1615 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1617 * @max_listen_interval: max listen interval in units of beacon interval
1620 * @queues: number of available hardware transmit queues for
1621 * data packets. WMM/QoS requires at least four, these
1622 * queues need to have configurable access parameters.
1624 * @rate_control_algorithm: rate control algorithm for this hardware.
1625 * If unset (NULL), the default algorithm will be used. Must be
1626 * set before calling ieee80211_register_hw().
1628 * @vif_data_size: size (in bytes) of the drv_priv data area
1629 * within &struct ieee80211_vif.
1630 * @sta_data_size: size (in bytes) of the drv_priv data area
1631 * within &struct ieee80211_sta.
1632 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1633 * within &struct ieee80211_chanctx_conf.
1635 * @max_rates: maximum number of alternate rate retry stages the hw
1637 * @max_report_rates: maximum number of alternate rate retry stages
1638 * the hw can report back.
1639 * @max_rate_tries: maximum number of tries for each stage
1641 * @max_rx_aggregation_subframes: maximum buffer size (number of
1642 * sub-frames) to be used for A-MPDU block ack receiver
1644 * This is only relevant if the device has restrictions on the
1645 * number of subframes, if it relies on mac80211 to do reordering
1646 * it shouldn't be set.
1648 * @max_tx_aggregation_subframes: maximum number of subframes in an
1649 * aggregate an HT driver will transmit, used by the peer as a
1650 * hint to size its reorder buffer.
1652 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1653 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1655 * @radiotap_mcs_details: lists which MCS information can the HW
1656 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1657 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1658 * adding _BW is supported today.
1660 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1661 * the default is _GI | _BANDWIDTH.
1662 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1664 * @netdev_features: netdev features to be set in each netdev created
1665 * from this HW. Note only HW checksum features are currently
1666 * compatible with mac80211. Other feature bits will be rejected.
1668 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1669 * for each access category if it is uAPSD trigger-enabled and delivery-
1670 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1671 * Each bit corresponds to different AC. Value '1' in specific bit means
1672 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1675 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1676 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1677 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1679 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1680 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1683 struct ieee80211_hw
{
1684 struct ieee80211_conf conf
;
1685 struct wiphy
*wiphy
;
1686 const char *rate_control_algorithm
;
1689 unsigned int extra_tx_headroom
;
1690 unsigned int extra_beacon_tailroom
;
1693 int chanctx_data_size
;
1695 u16 max_listen_interval
;
1698 u8 max_report_rates
;
1700 u8 max_rx_aggregation_subframes
;
1701 u8 max_tx_aggregation_subframes
;
1702 u8 offchannel_tx_hw_queue
;
1703 u8 radiotap_mcs_details
;
1704 u16 radiotap_vht_details
;
1705 netdev_features_t netdev_features
;
1707 u8 uapsd_max_sp_len
;
1708 u8 n_cipher_schemes
;
1709 const struct ieee80211_cipher_scheme
*cipher_schemes
;
1713 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1715 * @wiphy: the &struct wiphy which we want to query
1717 * mac80211 drivers can use this to get to their respective
1718 * &struct ieee80211_hw. Drivers wishing to get to their own private
1719 * structure can then access it via hw->priv. Note that mac802111 drivers should
1720 * not use wiphy_priv() to try to get their private driver structure as this
1721 * is already used internally by mac80211.
1723 * Return: The mac80211 driver hw struct of @wiphy.
1725 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1728 * SET_IEEE80211_DEV - set device for 802.11 hardware
1730 * @hw: the &struct ieee80211_hw to set the device for
1731 * @dev: the &struct device of this 802.11 device
1733 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1735 set_wiphy_dev(hw
->wiphy
, dev
);
1739 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1741 * @hw: the &struct ieee80211_hw to set the MAC address for
1742 * @addr: the address to set
1744 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1746 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1749 static inline struct ieee80211_rate
*
1750 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1751 const struct ieee80211_tx_info
*c
)
1753 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
1755 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1758 static inline struct ieee80211_rate
*
1759 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1760 const struct ieee80211_tx_info
*c
)
1762 if (c
->control
.rts_cts_rate_idx
< 0)
1764 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1767 static inline struct ieee80211_rate
*
1768 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1769 const struct ieee80211_tx_info
*c
, int idx
)
1771 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1773 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1777 * ieee80211_free_txskb - free TX skb
1781 * Free a transmit skb. Use this funtion when some failure
1782 * to transmit happened and thus status cannot be reported.
1784 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1787 * DOC: Hardware crypto acceleration
1789 * mac80211 is capable of taking advantage of many hardware
1790 * acceleration designs for encryption and decryption operations.
1792 * The set_key() callback in the &struct ieee80211_ops for a given
1793 * device is called to enable hardware acceleration of encryption and
1794 * decryption. The callback takes a @sta parameter that will be NULL
1795 * for default keys or keys used for transmission only, or point to
1796 * the station information for the peer for individual keys.
1797 * Multiple transmission keys with the same key index may be used when
1798 * VLANs are configured for an access point.
1800 * When transmitting, the TX control data will use the @hw_key_idx
1801 * selected by the driver by modifying the &struct ieee80211_key_conf
1802 * pointed to by the @key parameter to the set_key() function.
1804 * The set_key() call for the %SET_KEY command should return 0 if
1805 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1806 * added; if you return 0 then hw_key_idx must be assigned to the
1807 * hardware key index, you are free to use the full u8 range.
1809 * When the cmd is %DISABLE_KEY then it must succeed.
1811 * Note that it is permissible to not decrypt a frame even if a key
1812 * for it has been uploaded to hardware, the stack will not make any
1813 * decision based on whether a key has been uploaded or not but rather
1814 * based on the receive flags.
1816 * The &struct ieee80211_key_conf structure pointed to by the @key
1817 * parameter is guaranteed to be valid until another call to set_key()
1818 * removes it, but it can only be used as a cookie to differentiate
1821 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1822 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1824 * The update_tkip_key() call updates the driver with the new phase 1 key.
1825 * This happens every time the iv16 wraps around (every 65536 packets). The
1826 * set_key() call will happen only once for each key (unless the AP did
1827 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1828 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1829 * handler is software decryption with wrap around of iv16.
1831 * The set_default_unicast_key() call updates the default WEP key index
1832 * configured to the hardware for WEP encryption type. This is required
1833 * for devices that support offload of data packets (e.g. ARP responses).
1837 * DOC: Powersave support
1839 * mac80211 has support for various powersave implementations.
1841 * First, it can support hardware that handles all powersaving by itself,
1842 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1843 * flag. In that case, it will be told about the desired powersave mode
1844 * with the %IEEE80211_CONF_PS flag depending on the association status.
1845 * The hardware must take care of sending nullfunc frames when necessary,
1846 * i.e. when entering and leaving powersave mode. The hardware is required
1847 * to look at the AID in beacons and signal to the AP that it woke up when
1848 * it finds traffic directed to it.
1850 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1851 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1852 * with hardware wakeup and sleep states. Driver is responsible for waking
1853 * up the hardware before issuing commands to the hardware and putting it
1854 * back to sleep at appropriate times.
1856 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1857 * buffered multicast/broadcast frames after the beacon. Also it must be
1858 * possible to send frames and receive the acknowledment frame.
1860 * Other hardware designs cannot send nullfunc frames by themselves and also
1861 * need software support for parsing the TIM bitmap. This is also supported
1862 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1863 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1864 * required to pass up beacons. The hardware is still required to handle
1865 * waking up for multicast traffic; if it cannot the driver must handle that
1866 * as best as it can, mac80211 is too slow to do that.
1868 * Dynamic powersave is an extension to normal powersave in which the
1869 * hardware stays awake for a user-specified period of time after sending a
1870 * frame so that reply frames need not be buffered and therefore delayed to
1871 * the next wakeup. It's compromise of getting good enough latency when
1872 * there's data traffic and still saving significantly power in idle
1875 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1876 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1877 * flag and mac80211 will handle everything automatically. Additionally,
1878 * hardware having support for the dynamic PS feature may set the
1879 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1880 * dynamic PS mode itself. The driver needs to look at the
1881 * @dynamic_ps_timeout hardware configuration value and use it that value
1882 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1883 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1884 * enabled whenever user has enabled powersave.
1886 * Driver informs U-APSD client support by enabling
1887 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1888 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1889 * Nullfunc frames and stay awake until the service period has ended. To
1890 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1891 * from that AC are transmitted with powersave enabled.
1893 * Note: U-APSD client mode is not yet supported with
1894 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1898 * DOC: Beacon filter support
1900 * Some hardware have beacon filter support to reduce host cpu wakeups
1901 * which will reduce system power consumption. It usually works so that
1902 * the firmware creates a checksum of the beacon but omits all constantly
1903 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1904 * beacon is forwarded to the host, otherwise it will be just dropped. That
1905 * way the host will only receive beacons where some relevant information
1906 * (for example ERP protection or WMM settings) have changed.
1908 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1909 * interface capability. The driver needs to enable beacon filter support
1910 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1911 * power save is enabled, the stack will not check for beacon loss and the
1912 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1914 * The time (or number of beacons missed) until the firmware notifies the
1915 * driver of a beacon loss event (which in turn causes the driver to call
1916 * ieee80211_beacon_loss()) should be configurable and will be controlled
1917 * by mac80211 and the roaming algorithm in the future.
1919 * Since there may be constantly changing information elements that nothing
1920 * in the software stack cares about, we will, in the future, have mac80211
1921 * tell the driver which information elements are interesting in the sense
1922 * that we want to see changes in them. This will include
1923 * - a list of information element IDs
1924 * - a list of OUIs for the vendor information element
1926 * Ideally, the hardware would filter out any beacons without changes in the
1927 * requested elements, but if it cannot support that it may, at the expense
1928 * of some efficiency, filter out only a subset. For example, if the device
1929 * doesn't support checking for OUIs it should pass up all changes in all
1930 * vendor information elements.
1932 * Note that change, for the sake of simplification, also includes information
1933 * elements appearing or disappearing from the beacon.
1935 * Some hardware supports an "ignore list" instead, just make sure nothing
1936 * that was requested is on the ignore list, and include commonly changing
1937 * information element IDs in the ignore list, for example 11 (BSS load) and
1938 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1939 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1940 * it could also include some currently unused IDs.
1943 * In addition to these capabilities, hardware should support notifying the
1944 * host of changes in the beacon RSSI. This is relevant to implement roaming
1945 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1946 * the received data packets). This can consist in notifying the host when
1947 * the RSSI changes significantly or when it drops below or rises above
1948 * configurable thresholds. In the future these thresholds will also be
1949 * configured by mac80211 (which gets them from userspace) to implement
1950 * them as the roaming algorithm requires.
1952 * If the hardware cannot implement this, the driver should ask it to
1953 * periodically pass beacon frames to the host so that software can do the
1954 * signal strength threshold checking.
1958 * DOC: Spatial multiplexing power save
1960 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1961 * power in an 802.11n implementation. For details on the mechanism
1962 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1963 * "11.2.3 SM power save".
1965 * The mac80211 implementation is capable of sending action frames
1966 * to update the AP about the station's SMPS mode, and will instruct
1967 * the driver to enter the specific mode. It will also announce the
1968 * requested SMPS mode during the association handshake. Hardware
1969 * support for this feature is required, and can be indicated by
1972 * The default mode will be "automatic", which nl80211/cfg80211
1973 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1974 * turned off otherwise.
1976 * To support this feature, the driver must set the appropriate
1977 * hardware support flags, and handle the SMPS flag to the config()
1978 * operation. It will then with this mechanism be instructed to
1979 * enter the requested SMPS mode while associated to an HT AP.
1983 * DOC: Frame filtering
1985 * mac80211 requires to see many management frames for proper
1986 * operation, and users may want to see many more frames when
1987 * in monitor mode. However, for best CPU usage and power consumption,
1988 * having as few frames as possible percolate through the stack is
1989 * desirable. Hence, the hardware should filter as much as possible.
1991 * To achieve this, mac80211 uses filter flags (see below) to tell
1992 * the driver's configure_filter() function which frames should be
1993 * passed to mac80211 and which should be filtered out.
1995 * Before configure_filter() is invoked, the prepare_multicast()
1996 * callback is invoked with the parameters @mc_count and @mc_list
1997 * for the combined multicast address list of all virtual interfaces.
1998 * It's use is optional, and it returns a u64 that is passed to
1999 * configure_filter(). Additionally, configure_filter() has the
2000 * arguments @changed_flags telling which flags were changed and
2001 * @total_flags with the new flag states.
2003 * If your device has no multicast address filters your driver will
2004 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2005 * parameter to see whether multicast frames should be accepted
2008 * All unsupported flags in @total_flags must be cleared.
2009 * Hardware does not support a flag if it is incapable of _passing_
2010 * the frame to the stack. Otherwise the driver must ignore
2011 * the flag, but not clear it.
2012 * You must _only_ clear the flag (announce no support for the
2013 * flag to mac80211) if you are not able to pass the packet type
2014 * to the stack (so the hardware always filters it).
2015 * So for example, you should clear @FIF_CONTROL, if your hardware
2016 * always filters control frames. If your hardware always passes
2017 * control frames to the kernel and is incapable of filtering them,
2018 * you do _not_ clear the @FIF_CONTROL flag.
2019 * This rule applies to all other FIF flags as well.
2023 * DOC: AP support for powersaving clients
2025 * In order to implement AP and P2P GO modes, mac80211 has support for
2026 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2027 * There currently is no support for sAPSD.
2029 * There is one assumption that mac80211 makes, namely that a client
2030 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2031 * Both are supported, and both can be used by the same client, but
2032 * they can't be used concurrently by the same client. This simplifies
2035 * The first thing to keep in mind is that there is a flag for complete
2036 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2037 * mac80211 expects the driver to handle most of the state machine for
2038 * powersaving clients and will ignore the PM bit in incoming frames.
2039 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2040 * stations' powersave transitions. In this mode, mac80211 also doesn't
2041 * handle PS-Poll/uAPSD.
2043 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2044 * PM bit in incoming frames for client powersave transitions. When a
2045 * station goes to sleep, we will stop transmitting to it. There is,
2046 * however, a race condition: a station might go to sleep while there is
2047 * data buffered on hardware queues. If the device has support for this
2048 * it will reject frames, and the driver should give the frames back to
2049 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2050 * cause mac80211 to retry the frame when the station wakes up. The
2051 * driver is also notified of powersave transitions by calling its
2052 * @sta_notify callback.
2054 * When the station is asleep, it has three choices: it can wake up,
2055 * it can PS-Poll, or it can possibly start a uAPSD service period.
2056 * Waking up is implemented by simply transmitting all buffered (and
2057 * filtered) frames to the station. This is the easiest case. When
2058 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2059 * will inform the driver of this with the @allow_buffered_frames
2060 * callback; this callback is optional. mac80211 will then transmit
2061 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2062 * on each frame. The last frame in the service period (or the only
2063 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2064 * indicate that it ends the service period; as this frame must have
2065 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2066 * When TX status is reported for this frame, the service period is
2067 * marked has having ended and a new one can be started by the peer.
2069 * Additionally, non-bufferable MMPDUs can also be transmitted by
2070 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2072 * Another race condition can happen on some devices like iwlwifi
2073 * when there are frames queued for the station and it wakes up
2074 * or polls; the frames that are already queued could end up being
2075 * transmitted first instead, causing reordering and/or wrong
2076 * processing of the EOSP. The cause is that allowing frames to be
2077 * transmitted to a certain station is out-of-band communication to
2078 * the device. To allow this problem to be solved, the driver can
2079 * call ieee80211_sta_block_awake() if frames are buffered when it
2080 * is notified that the station went to sleep. When all these frames
2081 * have been filtered (see above), it must call the function again
2082 * to indicate that the station is no longer blocked.
2084 * If the driver buffers frames in the driver for aggregation in any
2085 * way, it must use the ieee80211_sta_set_buffered() call when it is
2086 * notified of the station going to sleep to inform mac80211 of any
2087 * TIDs that have frames buffered. Note that when a station wakes up
2088 * this information is reset (hence the requirement to call it when
2089 * informed of the station going to sleep). Then, when a service
2090 * period starts for any reason, @release_buffered_frames is called
2091 * with the number of frames to be released and which TIDs they are
2092 * to come from. In this case, the driver is responsible for setting
2093 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2094 * to help the @more_data paramter is passed to tell the driver if
2095 * there is more data on other TIDs -- the TIDs to release frames
2096 * from are ignored since mac80211 doesn't know how many frames the
2097 * buffers for those TIDs contain.
2099 * If the driver also implement GO mode, where absence periods may
2100 * shorten service periods (or abort PS-Poll responses), it must
2101 * filter those response frames except in the case of frames that
2102 * are buffered in the driver -- those must remain buffered to avoid
2103 * reordering. Because it is possible that no frames are released
2104 * in this case, the driver must call ieee80211_sta_eosp()
2105 * to indicate to mac80211 that the service period ended anyway.
2107 * Finally, if frames from multiple TIDs are released from mac80211
2108 * but the driver might reorder them, it must clear & set the flags
2109 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2110 * and also take care of the EOSP and MORE_DATA bits in the frame.
2111 * The driver may also use ieee80211_sta_eosp() in this case.
2113 * Note that if the driver ever buffers frames other than QoS-data
2114 * frames, it must take care to never send a non-QoS-data frame as
2115 * the last frame in a service period, adding a QoS-nulldata frame
2116 * after a non-QoS-data frame if needed.
2120 * DOC: HW queue control
2122 * Before HW queue control was introduced, mac80211 only had a single static
2123 * assignment of per-interface AC software queues to hardware queues. This
2124 * was problematic for a few reasons:
2125 * 1) off-channel transmissions might get stuck behind other frames
2126 * 2) multiple virtual interfaces couldn't be handled correctly
2127 * 3) after-DTIM frames could get stuck behind other frames
2129 * To solve this, hardware typically uses multiple different queues for all
2130 * the different usages, and this needs to be propagated into mac80211 so it
2131 * won't have the same problem with the software queues.
2133 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2134 * flag that tells it that the driver implements its own queue control. To do
2135 * so, the driver will set up the various queues in each &struct ieee80211_vif
2136 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2137 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2138 * if necessary will queue the frame on the right software queue that mirrors
2139 * the hardware queue.
2140 * Additionally, the driver has to then use these HW queue IDs for the queue
2141 * management functions (ieee80211_stop_queue() et al.)
2143 * The driver is free to set up the queue mappings as needed, multiple virtual
2144 * interfaces may map to the same hardware queues if needed. The setup has to
2145 * happen during add_interface or change_interface callbacks. For example, a
2146 * driver supporting station+station and station+AP modes might decide to have
2147 * 10 hardware queues to handle different scenarios:
2149 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2150 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2151 * after-DTIM queue for AP: 8
2152 * off-channel queue: 9
2154 * It would then set up the hardware like this:
2155 * hw.offchannel_tx_hw_queue = 9
2157 * and the first virtual interface that is added as follows:
2158 * vif.hw_queue[IEEE80211_AC_VO] = 0
2159 * vif.hw_queue[IEEE80211_AC_VI] = 1
2160 * vif.hw_queue[IEEE80211_AC_BE] = 2
2161 * vif.hw_queue[IEEE80211_AC_BK] = 3
2162 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2163 * and the second virtual interface with 4-7.
2165 * If queue 6 gets full, for example, mac80211 would only stop the second
2166 * virtual interface's BE queue since virtual interface queues are per AC.
2168 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2169 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2170 * queue could potentially be shared since mac80211 will look at cab_queue when
2171 * a queue is stopped/woken even if the interface is not in AP mode.
2175 * enum ieee80211_filter_flags - hardware filter flags
2177 * These flags determine what the filter in hardware should be
2178 * programmed to let through and what should not be passed to the
2179 * stack. It is always safe to pass more frames than requested,
2180 * but this has negative impact on power consumption.
2182 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2183 * think of the BSS as your network segment and then this corresponds
2184 * to the regular ethernet device promiscuous mode.
2186 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2187 * by the user or if the hardware is not capable of filtering by
2188 * multicast address.
2190 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2191 * %RX_FLAG_FAILED_FCS_CRC for them)
2193 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2194 * the %RX_FLAG_FAILED_PLCP_CRC for them
2196 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2197 * to the hardware that it should not filter beacons or probe responses
2198 * by BSSID. Filtering them can greatly reduce the amount of processing
2199 * mac80211 needs to do and the amount of CPU wakeups, so you should
2200 * honour this flag if possible.
2202 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2203 * is not set then only those addressed to this station.
2205 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2207 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2208 * those addressed to this station.
2210 * @FIF_PROBE_REQ: pass probe request frames
2212 enum ieee80211_filter_flags
{
2213 FIF_PROMISC_IN_BSS
= 1<<0,
2214 FIF_ALLMULTI
= 1<<1,
2216 FIF_PLCPFAIL
= 1<<3,
2217 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
2219 FIF_OTHER_BSS
= 1<<6,
2221 FIF_PROBE_REQ
= 1<<8,
2225 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2227 * These flags are used with the ampdu_action() callback in
2228 * &struct ieee80211_ops to indicate which action is needed.
2230 * Note that drivers MUST be able to deal with a TX aggregation
2231 * session being stopped even before they OK'ed starting it by
2232 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2233 * might receive the addBA frame and send a delBA right away!
2235 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2236 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2237 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2238 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2239 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2240 * queued packets, now unaggregated. After all packets are transmitted the
2241 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2242 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2243 * called when the station is removed. There's no need or reason to call
2244 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2245 * session is gone and removes the station.
2246 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2247 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2248 * now the connection is dropped and the station will be removed. Drivers
2249 * should clean up and drop remaining packets when this is called.
2251 enum ieee80211_ampdu_mlme_action
{
2252 IEEE80211_AMPDU_RX_START
,
2253 IEEE80211_AMPDU_RX_STOP
,
2254 IEEE80211_AMPDU_TX_START
,
2255 IEEE80211_AMPDU_TX_STOP_CONT
,
2256 IEEE80211_AMPDU_TX_STOP_FLUSH
,
2257 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
,
2258 IEEE80211_AMPDU_TX_OPERATIONAL
,
2262 * enum ieee80211_frame_release_type - frame release reason
2263 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2264 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2265 * frame received on trigger-enabled AC
2267 enum ieee80211_frame_release_type
{
2268 IEEE80211_FRAME_RELEASE_PSPOLL
,
2269 IEEE80211_FRAME_RELEASE_UAPSD
,
2273 * enum ieee80211_rate_control_changed - flags to indicate what changed
2275 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2276 * to this station changed. The actual bandwidth is in the station
2277 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2278 * flag changes, for HT and VHT the bandwidth field changes.
2279 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2280 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2281 * changed (in IBSS mode) due to discovering more information about
2283 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2286 enum ieee80211_rate_control_changed
{
2287 IEEE80211_RC_BW_CHANGED
= BIT(0),
2288 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
2289 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
2290 IEEE80211_RC_NSS_CHANGED
= BIT(3),
2294 * enum ieee80211_roc_type - remain on channel type
2296 * With the support for multi channel contexts and multi channel operations,
2297 * remain on channel operations might be limited/deferred/aborted by other
2298 * flows/operations which have higher priority (and vise versa).
2299 * Specifying the ROC type can be used by devices to prioritize the ROC
2300 * operations compared to other operations/flows.
2302 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2303 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2304 * for sending managment frames offchannel.
2306 enum ieee80211_roc_type
{
2307 IEEE80211_ROC_TYPE_NORMAL
= 0,
2308 IEEE80211_ROC_TYPE_MGMT_TX
,
2312 * struct ieee80211_ops - callbacks from mac80211 to the driver
2314 * This structure contains various callbacks that the driver may
2315 * handle or, in some cases, must handle, for example to configure
2316 * the hardware to a new channel or to transmit a frame.
2318 * @tx: Handler that 802.11 module calls for each transmitted frame.
2319 * skb contains the buffer starting from the IEEE 802.11 header.
2320 * The low-level driver should send the frame out based on
2321 * configuration in the TX control data. This handler should,
2322 * preferably, never fail and stop queues appropriately.
2325 * @start: Called before the first netdevice attached to the hardware
2326 * is enabled. This should turn on the hardware and must turn on
2327 * frame reception (for possibly enabled monitor interfaces.)
2328 * Returns negative error codes, these may be seen in userspace,
2330 * When the device is started it should not have a MAC address
2331 * to avoid acknowledging frames before a non-monitor device
2333 * Must be implemented and can sleep.
2335 * @stop: Called after last netdevice attached to the hardware
2336 * is disabled. This should turn off the hardware (at least
2337 * it must turn off frame reception.)
2338 * May be called right after add_interface if that rejects
2339 * an interface. If you added any work onto the mac80211 workqueue
2340 * you should ensure to cancel it on this callback.
2341 * Must be implemented and can sleep.
2343 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2344 * stop transmitting and doing any other configuration, and then
2345 * ask the device to suspend. This is only invoked when WoWLAN is
2346 * configured, otherwise the device is deconfigured completely and
2347 * reconfigured at resume time.
2348 * The driver may also impose special conditions under which it
2349 * wants to use the "normal" suspend (deconfigure), say if it only
2350 * supports WoWLAN when the device is associated. In this case, it
2351 * must return 1 from this function.
2353 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2354 * now resuming its operation, after this the device must be fully
2355 * functional again. If this returns an error, the only way out is
2356 * to also unregister the device. If it returns 1, then mac80211
2357 * will also go through the regular complete restart on resume.
2359 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2360 * modified. The reason is that device_set_wakeup_enable() is
2361 * supposed to be called when the configuration changes, not only
2364 * @add_interface: Called when a netdevice attached to the hardware is
2365 * enabled. Because it is not called for monitor mode devices, @start
2366 * and @stop must be implemented.
2367 * The driver should perform any initialization it needs before
2368 * the device can be enabled. The initial configuration for the
2369 * interface is given in the conf parameter.
2370 * The callback may refuse to add an interface by returning a
2371 * negative error code (which will be seen in userspace.)
2372 * Must be implemented and can sleep.
2374 * @change_interface: Called when a netdevice changes type. This callback
2375 * is optional, but only if it is supported can interface types be
2376 * switched while the interface is UP. The callback may sleep.
2377 * Note that while an interface is being switched, it will not be
2378 * found by the interface iteration callbacks.
2380 * @remove_interface: Notifies a driver that an interface is going down.
2381 * The @stop callback is called after this if it is the last interface
2382 * and no monitor interfaces are present.
2383 * When all interfaces are removed, the MAC address in the hardware
2384 * must be cleared so the device no longer acknowledges packets,
2385 * the mac_addr member of the conf structure is, however, set to the
2386 * MAC address of the device going away.
2387 * Hence, this callback must be implemented. It can sleep.
2389 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2390 * function to change hardware configuration, e.g., channel.
2391 * This function should never fail but returns a negative error code
2392 * if it does. The callback can sleep.
2394 * @bss_info_changed: Handler for configuration requests related to BSS
2395 * parameters that may vary during BSS's lifespan, and may affect low
2396 * level driver (e.g. assoc/disassoc status, erp parameters).
2397 * This function should not be used if no BSS has been set, unless
2398 * for association indication. The @changed parameter indicates which
2399 * of the bss parameters has changed when a call is made. The callback
2402 * @prepare_multicast: Prepare for multicast filter configuration.
2403 * This callback is optional, and its return value is passed
2404 * to configure_filter(). This callback must be atomic.
2406 * @configure_filter: Configure the device's RX filter.
2407 * See the section "Frame filtering" for more information.
2408 * This callback must be implemented and can sleep.
2410 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2411 * must be set or cleared for a given STA. Must be atomic.
2413 * @set_key: See the section "Hardware crypto acceleration"
2414 * This callback is only called between add_interface and
2415 * remove_interface calls, i.e. while the given virtual interface
2417 * Returns a negative error code if the key can't be added.
2418 * The callback can sleep.
2420 * @update_tkip_key: See the section "Hardware crypto acceleration"
2421 * This callback will be called in the context of Rx. Called for drivers
2422 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2423 * The callback must be atomic.
2425 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2426 * host is suspended, it can assign this callback to retrieve the data
2427 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2428 * After rekeying was done it should (for example during resume) notify
2429 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2431 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2432 * WEP when the device sends data packets autonomously, e.g. for ARP
2433 * offloading. The index can be 0-3, or -1 for unsetting it.
2435 * @hw_scan: Ask the hardware to service the scan request, no need to start
2436 * the scan state machine in stack. The scan must honour the channel
2437 * configuration done by the regulatory agent in the wiphy's
2438 * registered bands. The hardware (or the driver) needs to make sure
2439 * that power save is disabled.
2440 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2441 * entire IEs after the SSID, so that drivers need not look at these
2442 * at all but just send them after the SSID -- mac80211 includes the
2443 * (extended) supported rates and HT information (where applicable).
2444 * When the scan finishes, ieee80211_scan_completed() must be called;
2445 * note that it also must be called when the scan cannot finish due to
2446 * any error unless this callback returned a negative error code.
2447 * The callback can sleep.
2449 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2450 * The driver should ask the hardware to cancel the scan (if possible),
2451 * but the scan will be completed only after the driver will call
2452 * ieee80211_scan_completed().
2453 * This callback is needed for wowlan, to prevent enqueueing a new
2454 * scan_work after the low-level driver was already suspended.
2455 * The callback can sleep.
2457 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2458 * specific intervals. The driver must call the
2459 * ieee80211_sched_scan_results() function whenever it finds results.
2460 * This process will continue until sched_scan_stop is called.
2462 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2463 * In this case, ieee80211_sched_scan_stopped() must not be called.
2465 * @sw_scan_start: Notifier function that is called just before a software scan
2466 * is started. Can be NULL, if the driver doesn't need this notification.
2467 * The callback can sleep.
2469 * @sw_scan_complete: Notifier function that is called just after a
2470 * software scan finished. Can be NULL, if the driver doesn't need
2471 * this notification.
2472 * The callback can sleep.
2474 * @get_stats: Return low-level statistics.
2475 * Returns zero if statistics are available.
2476 * The callback can sleep.
2478 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2479 * callback should be provided to read the TKIP transmit IVs (both IV32
2480 * and IV16) for the given key from hardware.
2481 * The callback must be atomic.
2483 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2484 * if the device does fragmentation by itself; if this callback is
2485 * implemented then the stack will not do fragmentation.
2486 * The callback can sleep.
2488 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2489 * The callback can sleep.
2491 * @sta_add: Notifies low level driver about addition of an associated station,
2492 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2494 * @sta_remove: Notifies low level driver about removal of an associated
2495 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2496 * returns it isn't safe to use the pointer, not even RCU protected;
2497 * no RCU grace period is guaranteed between returning here and freeing
2498 * the station. See @sta_pre_rcu_remove if needed.
2499 * This callback can sleep.
2501 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2502 * when a station is added to mac80211's station list. This callback
2503 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2504 * conditional. This callback can sleep.
2506 * @sta_remove_debugfs: Remove the debugfs files which were added using
2507 * @sta_add_debugfs. This callback can sleep.
2509 * @sta_notify: Notifies low level driver about power state transition of an
2510 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2511 * in AP mode, this callback will not be called when the flag
2512 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2514 * @sta_state: Notifies low level driver about state transition of a
2515 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2516 * This callback is mutually exclusive with @sta_add/@sta_remove.
2517 * It must not fail for down transitions but may fail for transitions
2518 * up the list of states. Also note that after the callback returns it
2519 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2520 * period is guaranteed between returning here and freeing the station.
2521 * See @sta_pre_rcu_remove if needed.
2522 * The callback can sleep.
2524 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2525 * synchronisation. This is useful if a driver needs to have station
2526 * pointers protected using RCU, it can then use this call to clear
2527 * the pointers instead of waiting for an RCU grace period to elapse
2529 * The callback can sleep.
2531 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2532 * used to transmit to the station. The changes are advertised with bits
2533 * from &enum ieee80211_rate_control_changed and the values are reflected
2534 * in the station data. This callback should only be used when the driver
2535 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2536 * otherwise the rate control algorithm is notified directly.
2539 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2540 * bursting) for a hardware TX queue.
2541 * Returns a negative error code on failure.
2542 * The callback can sleep.
2544 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2545 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2546 * required function.
2547 * The callback can sleep.
2549 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2550 * Currently, this is only used for IBSS mode debugging. Is not a
2551 * required function.
2552 * The callback can sleep.
2554 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2555 * with other STAs in the IBSS. This is only used in IBSS mode. This
2556 * function is optional if the firmware/hardware takes full care of
2557 * TSF synchronization.
2558 * The callback can sleep.
2560 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2561 * This is needed only for IBSS mode and the result of this function is
2562 * used to determine whether to reply to Probe Requests.
2563 * Returns non-zero if this device sent the last beacon.
2564 * The callback can sleep.
2566 * @ampdu_action: Perform a certain A-MPDU action
2567 * The RA/TID combination determines the destination and TID we want
2568 * the ampdu action to be performed for. The action is defined through
2569 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2570 * is the first frame we expect to perform the action on. Notice
2571 * that TX/RX_STOP can pass NULL for this parameter.
2572 * The @buf_size parameter is only valid when the action is set to
2573 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2574 * buffer size (number of subframes) for this session -- the driver
2575 * may neither send aggregates containing more subframes than this
2576 * nor send aggregates in a way that lost frames would exceed the
2577 * buffer size. If just limiting the aggregate size, this would be
2578 * possible with a buf_size of 8:
2580 * - RX: 2....7 (lost frame #1)
2582 * which is invalid since #1 was now re-transmitted well past the
2583 * buffer size of 8. Correct ways to retransmit #1 would be:
2584 * - TX: 1 or 18 or 81
2585 * Even "189" would be wrong since 1 could be lost again.
2587 * Returns a negative error code on failure.
2588 * The callback can sleep.
2590 * @get_survey: Return per-channel survey information
2592 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2593 * need to set wiphy->rfkill_poll to %true before registration,
2594 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2595 * The callback can sleep.
2597 * @set_coverage_class: Set slot time for given coverage class as specified
2598 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2599 * accordingly. This callback is not required and may sleep.
2601 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2602 * be %NULL. The callback can sleep.
2603 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2605 * @flush: Flush all pending frames from the hardware queue, making sure
2606 * that the hardware queues are empty. The @queues parameter is a bitmap
2607 * of queues to flush, which is useful if different virtual interfaces
2608 * use different hardware queues; it may also indicate all queues.
2609 * If the parameter @drop is set to %true, pending frames may be dropped.
2610 * The callback can sleep.
2612 * @channel_switch: Drivers that need (or want) to offload the channel
2613 * switch operation for CSAs received from the AP may implement this
2614 * callback. They must then call ieee80211_chswitch_done() to indicate
2615 * completion of the channel switch.
2617 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2618 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2619 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2620 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2622 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2624 * @remain_on_channel: Starts an off-channel period on the given channel, must
2625 * call back to ieee80211_ready_on_channel() when on that channel. Note
2626 * that normal channel traffic is not stopped as this is intended for hw
2627 * offload. Frames to transmit on the off-channel channel are transmitted
2628 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2629 * duration (which will always be non-zero) expires, the driver must call
2630 * ieee80211_remain_on_channel_expired().
2631 * Note that this callback may be called while the device is in IDLE and
2632 * must be accepted in this case.
2633 * This callback may sleep.
2634 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2635 * aborted before it expires. This callback may sleep.
2637 * @set_ringparam: Set tx and rx ring sizes.
2639 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2641 * @tx_frames_pending: Check if there is any pending frame in the hardware
2642 * queues before entering power save.
2644 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2645 * when transmitting a frame. Currently only legacy rates are handled.
2646 * The callback can sleep.
2647 * @rssi_callback: Notify driver when the average RSSI goes above/below
2648 * thresholds that were registered previously. The callback can sleep.
2650 * @release_buffered_frames: Release buffered frames according to the given
2651 * parameters. In the case where the driver buffers some frames for
2652 * sleeping stations mac80211 will use this callback to tell the driver
2653 * to release some frames, either for PS-poll or uAPSD.
2654 * Note that if the @more_data paramter is %false the driver must check
2655 * if there are more frames on the given TIDs, and if there are more than
2656 * the frames being released then it must still set the more-data bit in
2657 * the frame. If the @more_data parameter is %true, then of course the
2658 * more-data bit must always be set.
2659 * The @tids parameter tells the driver which TIDs to release frames
2660 * from, for PS-poll it will always have only a single bit set.
2661 * In the case this is used for a PS-poll initiated release, the
2662 * @num_frames parameter will always be 1 so code can be shared. In
2663 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2664 * on the TX status (and must report TX status) so that the PS-poll
2665 * period is properly ended. This is used to avoid sending multiple
2666 * responses for a retried PS-poll frame.
2667 * In the case this is used for uAPSD, the @num_frames parameter may be
2668 * bigger than one, but the driver may send fewer frames (it must send
2669 * at least one, however). In this case it is also responsible for
2670 * setting the EOSP flag in the QoS header of the frames. Also, when the
2671 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2672 * on the last frame in the SP. Alternatively, it may call the function
2673 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2674 * This callback must be atomic.
2675 * @allow_buffered_frames: Prepare device to allow the given number of frames
2676 * to go out to the given station. The frames will be sent by mac80211
2677 * via the usual TX path after this call. The TX information for frames
2678 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2679 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2680 * frames from multiple TIDs are released and the driver might reorder
2681 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2682 * on the last frame and clear it on all others and also handle the EOSP
2683 * bit in the QoS header correctly. Alternatively, it can also call the
2684 * ieee80211_sta_eosp() function.
2685 * The @tids parameter is a bitmap and tells the driver which TIDs the
2686 * frames will be on; it will at most have two bits set.
2687 * This callback must be atomic.
2689 * @get_et_sset_count: Ethtool API to get string-set count.
2691 * @get_et_stats: Ethtool API to get a set of u64 stats.
2693 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2694 * and perhaps other supported types of ethtool data-sets.
2696 * @get_rssi: Get current signal strength in dBm, the function is optional
2699 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2700 * before associated. In multi-channel scenarios, a virtual interface is
2701 * bound to a channel before it is associated, but as it isn't associated
2702 * yet it need not necessarily be given airtime, in particular since any
2703 * transmission to a P2P GO needs to be synchronized against the GO's
2704 * powersave state. mac80211 will call this function before transmitting a
2705 * management frame prior to having successfully associated to allow the
2706 * driver to give it channel time for the transmission, to get a response
2707 * and to be able to synchronize with the GO.
2708 * The callback will be called before each transmission and upon return
2709 * mac80211 will transmit the frame right away.
2710 * The callback is optional and can (should!) sleep.
2712 * @add_chanctx: Notifies device driver about new channel context creation.
2713 * @remove_chanctx: Notifies device driver about channel context destruction.
2714 * @change_chanctx: Notifies device driver about channel context changes that
2715 * may happen when combining different virtual interfaces on the same
2716 * channel context with different settings
2717 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2718 * to vif. Possible use is for hw queue remapping.
2719 * @unassign_vif_chanctx: Notifies device driver about channel context being
2721 * @start_ap: Start operation on the AP interface, this is called after all the
2722 * information in bss_conf is set and beacon can be retrieved. A channel
2723 * context is bound before this is called. Note that if the driver uses
2724 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2725 * just "paused" for scanning/ROC, which is indicated by the beacon being
2726 * disabled/enabled via @bss_info_changed.
2727 * @stop_ap: Stop operation on the AP interface.
2729 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2730 * reconfiguration has completed. This can help the driver implement the
2731 * reconfiguration step. Also called when reconfiguring because the
2732 * driver's resume function returned 1, as this is just like an "inline"
2733 * hardware restart. This callback may sleep.
2735 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2736 * Currently, this is only called for managed or P2P client interfaces.
2737 * This callback is optional; it must not sleep.
2739 * @channel_switch_beacon: Starts a channel switch to a new channel.
2740 * Beacons are modified to include CSA or ECSA IEs before calling this
2741 * function. The corresponding count fields in these IEs must be
2742 * decremented, and when they reach 1 the driver must call
2743 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2744 * get the csa counter decremented by mac80211, but must check if it is
2745 * 1 using ieee80211_csa_is_complete() after the beacon has been
2746 * transmitted and then call ieee80211_csa_finish().
2747 * If the CSA count starts as zero or 1, this function will not be called,
2748 * since there won't be any time to beacon before the switch anyway.
2750 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2751 * information in bss_conf is set up and the beacon can be retrieved. A
2752 * channel context is bound before this is called.
2753 * @leave_ibss: Leave the IBSS again.
2755 struct ieee80211_ops
{
2756 void (*tx
)(struct ieee80211_hw
*hw
,
2757 struct ieee80211_tx_control
*control
,
2758 struct sk_buff
*skb
);
2759 int (*start
)(struct ieee80211_hw
*hw
);
2760 void (*stop
)(struct ieee80211_hw
*hw
);
2762 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
2763 int (*resume
)(struct ieee80211_hw
*hw
);
2764 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
2766 int (*add_interface
)(struct ieee80211_hw
*hw
,
2767 struct ieee80211_vif
*vif
);
2768 int (*change_interface
)(struct ieee80211_hw
*hw
,
2769 struct ieee80211_vif
*vif
,
2770 enum nl80211_iftype new_type
, bool p2p
);
2771 void (*remove_interface
)(struct ieee80211_hw
*hw
,
2772 struct ieee80211_vif
*vif
);
2773 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
2774 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
2775 struct ieee80211_vif
*vif
,
2776 struct ieee80211_bss_conf
*info
,
2779 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2780 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2782 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
2783 struct netdev_hw_addr_list
*mc_list
);
2784 void (*configure_filter
)(struct ieee80211_hw
*hw
,
2785 unsigned int changed_flags
,
2786 unsigned int *total_flags
,
2788 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
2790 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
2791 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
2792 struct ieee80211_key_conf
*key
);
2793 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
2794 struct ieee80211_vif
*vif
,
2795 struct ieee80211_key_conf
*conf
,
2796 struct ieee80211_sta
*sta
,
2797 u32 iv32
, u16
*phase1key
);
2798 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
2799 struct ieee80211_vif
*vif
,
2800 struct cfg80211_gtk_rekey_data
*data
);
2801 void (*set_default_unicast_key
)(struct ieee80211_hw
*hw
,
2802 struct ieee80211_vif
*vif
, int idx
);
2803 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2804 struct cfg80211_scan_request
*req
);
2805 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
2806 struct ieee80211_vif
*vif
);
2807 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
2808 struct ieee80211_vif
*vif
,
2809 struct cfg80211_sched_scan_request
*req
,
2810 struct ieee80211_sched_scan_ies
*ies
);
2811 int (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
2812 struct ieee80211_vif
*vif
);
2813 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
2814 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
2815 int (*get_stats
)(struct ieee80211_hw
*hw
,
2816 struct ieee80211_low_level_stats
*stats
);
2817 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
2818 u32
*iv32
, u16
*iv16
);
2819 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2820 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2821 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2822 struct ieee80211_sta
*sta
);
2823 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2824 struct ieee80211_sta
*sta
);
2825 #ifdef CONFIG_MAC80211_DEBUGFS
2826 void (*sta_add_debugfs
)(struct ieee80211_hw
*hw
,
2827 struct ieee80211_vif
*vif
,
2828 struct ieee80211_sta
*sta
,
2829 struct dentry
*dir
);
2830 void (*sta_remove_debugfs
)(struct ieee80211_hw
*hw
,
2831 struct ieee80211_vif
*vif
,
2832 struct ieee80211_sta
*sta
,
2833 struct dentry
*dir
);
2835 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2836 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
2837 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2838 struct ieee80211_sta
*sta
,
2839 enum ieee80211_sta_state old_state
,
2840 enum ieee80211_sta_state new_state
);
2841 void (*sta_pre_rcu_remove
)(struct ieee80211_hw
*hw
,
2842 struct ieee80211_vif
*vif
,
2843 struct ieee80211_sta
*sta
);
2844 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
2845 struct ieee80211_vif
*vif
,
2846 struct ieee80211_sta
*sta
,
2848 int (*conf_tx
)(struct ieee80211_hw
*hw
,
2849 struct ieee80211_vif
*vif
, u16 ac
,
2850 const struct ieee80211_tx_queue_params
*params
);
2851 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2852 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2854 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2855 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
2856 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
2857 struct ieee80211_vif
*vif
,
2858 enum ieee80211_ampdu_mlme_action action
,
2859 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
,
2861 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
2862 struct survey_info
*survey
);
2863 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
2864 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, u8 coverage_class
);
2865 #ifdef CONFIG_NL80211_TESTMODE
2866 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2867 void *data
, int len
);
2868 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
2869 struct netlink_callback
*cb
,
2870 void *data
, int len
);
2872 void (*flush
)(struct ieee80211_hw
*hw
, u32 queues
, bool drop
);
2873 void (*channel_switch
)(struct ieee80211_hw
*hw
,
2874 struct ieee80211_channel_switch
*ch_switch
);
2875 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
2876 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
2878 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
2879 struct ieee80211_vif
*vif
,
2880 struct ieee80211_channel
*chan
,
2882 enum ieee80211_roc_type type
);
2883 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
2884 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
2885 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
2886 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
2887 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
2888 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2889 const struct cfg80211_bitrate_mask
*mask
);
2890 void (*rssi_callback
)(struct ieee80211_hw
*hw
,
2891 struct ieee80211_vif
*vif
,
2892 enum ieee80211_rssi_event rssi_event
);
2894 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
2895 struct ieee80211_sta
*sta
,
2896 u16 tids
, int num_frames
,
2897 enum ieee80211_frame_release_type reason
,
2899 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
2900 struct ieee80211_sta
*sta
,
2901 u16 tids
, int num_frames
,
2902 enum ieee80211_frame_release_type reason
,
2905 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
2906 struct ieee80211_vif
*vif
, int sset
);
2907 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
2908 struct ieee80211_vif
*vif
,
2909 struct ethtool_stats
*stats
, u64
*data
);
2910 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
2911 struct ieee80211_vif
*vif
,
2912 u32 sset
, u8
*data
);
2913 int (*get_rssi
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2914 struct ieee80211_sta
*sta
, s8
*rssi_dbm
);
2916 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
2917 struct ieee80211_vif
*vif
);
2919 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
2920 struct ieee80211_chanctx_conf
*ctx
);
2921 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
2922 struct ieee80211_chanctx_conf
*ctx
);
2923 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
2924 struct ieee80211_chanctx_conf
*ctx
,
2926 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
2927 struct ieee80211_vif
*vif
,
2928 struct ieee80211_chanctx_conf
*ctx
);
2929 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
2930 struct ieee80211_vif
*vif
,
2931 struct ieee80211_chanctx_conf
*ctx
);
2933 void (*restart_complete
)(struct ieee80211_hw
*hw
);
2935 #if IS_ENABLED(CONFIG_IPV6)
2936 void (*ipv6_addr_change
)(struct ieee80211_hw
*hw
,
2937 struct ieee80211_vif
*vif
,
2938 struct inet6_dev
*idev
);
2940 void (*channel_switch_beacon
)(struct ieee80211_hw
*hw
,
2941 struct ieee80211_vif
*vif
,
2942 struct cfg80211_chan_def
*chandef
);
2944 int (*join_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2945 void (*leave_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2949 * ieee80211_alloc_hw - Allocate a new hardware device
2951 * This must be called once for each hardware device. The returned pointer
2952 * must be used to refer to this device when calling other functions.
2953 * mac80211 allocates a private data area for the driver pointed to by
2954 * @priv in &struct ieee80211_hw, the size of this area is given as
2957 * @priv_data_len: length of private data
2958 * @ops: callbacks for this device
2960 * Return: A pointer to the new hardware device, or %NULL on error.
2962 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
2963 const struct ieee80211_ops
*ops
);
2966 * ieee80211_register_hw - Register hardware device
2968 * You must call this function before any other functions in
2969 * mac80211. Note that before a hardware can be registered, you
2970 * need to fill the contained wiphy's information.
2972 * @hw: the device to register as returned by ieee80211_alloc_hw()
2974 * Return: 0 on success. An error code otherwise.
2976 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
2979 * struct ieee80211_tpt_blink - throughput blink description
2980 * @throughput: throughput in Kbit/sec
2981 * @blink_time: blink time in milliseconds
2982 * (full cycle, ie. one off + one on period)
2984 struct ieee80211_tpt_blink
{
2990 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2991 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2992 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2993 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2994 * interface is connected in some way, including being an AP
2996 enum ieee80211_tpt_led_trigger_flags
{
2997 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
2998 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
2999 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
3002 #ifdef CONFIG_MAC80211_LEDS
3003 char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
3004 char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
3005 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
3006 char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
3007 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
,
3009 const struct ieee80211_tpt_blink
*blink_table
,
3010 unsigned int blink_table_len
);
3013 * ieee80211_get_tx_led_name - get name of TX LED
3015 * mac80211 creates a transmit LED trigger for each wireless hardware
3016 * that can be used to drive LEDs if your driver registers a LED device.
3017 * This function returns the name (or %NULL if not configured for LEDs)
3018 * of the trigger so you can automatically link the LED device.
3020 * @hw: the hardware to get the LED trigger name for
3022 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3024 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
3026 #ifdef CONFIG_MAC80211_LEDS
3027 return __ieee80211_get_tx_led_name(hw
);
3034 * ieee80211_get_rx_led_name - get name of RX LED
3036 * mac80211 creates a receive LED trigger for each wireless hardware
3037 * that can be used to drive LEDs if your driver registers a LED device.
3038 * This function returns the name (or %NULL if not configured for LEDs)
3039 * of the trigger so you can automatically link the LED device.
3041 * @hw: the hardware to get the LED trigger name for
3043 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3045 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
3047 #ifdef CONFIG_MAC80211_LEDS
3048 return __ieee80211_get_rx_led_name(hw
);
3055 * ieee80211_get_assoc_led_name - get name of association LED
3057 * mac80211 creates a association LED trigger for each wireless hardware
3058 * that can be used to drive LEDs if your driver registers a LED device.
3059 * This function returns the name (or %NULL if not configured for LEDs)
3060 * of the trigger so you can automatically link the LED device.
3062 * @hw: the hardware to get the LED trigger name for
3064 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3066 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
3068 #ifdef CONFIG_MAC80211_LEDS
3069 return __ieee80211_get_assoc_led_name(hw
);
3076 * ieee80211_get_radio_led_name - get name of radio LED
3078 * mac80211 creates a radio change LED trigger for each wireless hardware
3079 * that can be used to drive LEDs if your driver registers a LED device.
3080 * This function returns the name (or %NULL if not configured for LEDs)
3081 * of the trigger so you can automatically link the LED device.
3083 * @hw: the hardware to get the LED trigger name for
3085 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3087 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
3089 #ifdef CONFIG_MAC80211_LEDS
3090 return __ieee80211_get_radio_led_name(hw
);
3097 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3098 * @hw: the hardware to create the trigger for
3099 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3100 * @blink_table: the blink table -- needs to be ordered by throughput
3101 * @blink_table_len: size of the blink table
3103 * Return: %NULL (in case of error, or if no LED triggers are
3104 * configured) or the name of the new trigger.
3106 * Note: This function must be called before ieee80211_register_hw().
3108 static inline char *
3109 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
3110 const struct ieee80211_tpt_blink
*blink_table
,
3111 unsigned int blink_table_len
)
3113 #ifdef CONFIG_MAC80211_LEDS
3114 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
3122 * ieee80211_unregister_hw - Unregister a hardware device
3124 * This function instructs mac80211 to free allocated resources
3125 * and unregister netdevices from the networking subsystem.
3127 * @hw: the hardware to unregister
3129 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
3132 * ieee80211_free_hw - free hardware descriptor
3134 * This function frees everything that was allocated, including the
3135 * private data for the driver. You must call ieee80211_unregister_hw()
3136 * before calling this function.
3138 * @hw: the hardware to free
3140 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
3143 * ieee80211_restart_hw - restart hardware completely
3145 * Call this function when the hardware was restarted for some reason
3146 * (hardware error, ...) and the driver is unable to restore its state
3147 * by itself. mac80211 assumes that at this point the driver/hardware
3148 * is completely uninitialised and stopped, it starts the process by
3149 * calling the ->start() operation. The driver will need to reset all
3150 * internal state that it has prior to calling this function.
3152 * @hw: the hardware to restart
3154 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
3157 * ieee80211_napi_add - initialize mac80211 NAPI context
3158 * @hw: the hardware to initialize the NAPI context on
3159 * @napi: the NAPI context to initialize
3160 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3161 * driver doesn't use NAPI
3162 * @poll: poll function
3163 * @weight: default weight
3165 * See also netif_napi_add().
3167 void ieee80211_napi_add(struct ieee80211_hw
*hw
, struct napi_struct
*napi
,
3168 struct net_device
*napi_dev
,
3169 int (*poll
)(struct napi_struct
*, int),
3173 * ieee80211_rx - receive frame
3175 * Use this function to hand received frames to mac80211. The receive
3176 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3177 * paged @skb is used, the driver is recommended to put the ieee80211
3178 * header of the frame on the linear part of the @skb to avoid memory
3179 * allocation and/or memcpy by the stack.
3181 * This function may not be called in IRQ context. Calls to this function
3182 * for a single hardware must be synchronized against each other. Calls to
3183 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3184 * mixed for a single hardware. Must not run concurrently with
3185 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3187 * In process context use instead ieee80211_rx_ni().
3189 * @hw: the hardware this frame came in on
3190 * @skb: the buffer to receive, owned by mac80211 after this call
3192 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
3195 * ieee80211_rx_irqsafe - receive frame
3197 * Like ieee80211_rx() but can be called in IRQ context
3198 * (internally defers to a tasklet.)
3200 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3201 * be mixed for a single hardware.Must not run concurrently with
3202 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3204 * @hw: the hardware this frame came in on
3205 * @skb: the buffer to receive, owned by mac80211 after this call
3207 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
3210 * ieee80211_rx_ni - receive frame (in process context)
3212 * Like ieee80211_rx() but can be called in process context
3213 * (internally disables bottom halves).
3215 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3216 * not be mixed for a single hardware. Must not run concurrently with
3217 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3219 * @hw: the hardware this frame came in on
3220 * @skb: the buffer to receive, owned by mac80211 after this call
3222 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
3223 struct sk_buff
*skb
)
3226 ieee80211_rx(hw
, skb
);
3231 * ieee80211_sta_ps_transition - PS transition for connected sta
3233 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3234 * flag set, use this function to inform mac80211 about a connected station
3235 * entering/leaving PS mode.
3237 * This function may not be called in IRQ context or with softirqs enabled.
3239 * Calls to this function for a single hardware must be synchronized against
3242 * @sta: currently connected sta
3243 * @start: start or stop PS
3245 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3247 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
3250 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3251 * (in process context)
3253 * Like ieee80211_sta_ps_transition() but can be called in process context
3254 * (internally disables bottom halves). Concurrent call restriction still
3257 * @sta: currently connected sta
3258 * @start: start or stop PS
3260 * Return: Like ieee80211_sta_ps_transition().
3262 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
3268 ret
= ieee80211_sta_ps_transition(sta
, start
);
3275 * The TX headroom reserved by mac80211 for its own tx_status functions.
3276 * This is enough for the radiotap header.
3278 #define IEEE80211_TX_STATUS_HEADROOM 14
3281 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3282 * @sta: &struct ieee80211_sta pointer for the sleeping station
3283 * @tid: the TID that has buffered frames
3284 * @buffered: indicates whether or not frames are buffered for this TID
3286 * If a driver buffers frames for a powersave station instead of passing
3287 * them back to mac80211 for retransmission, the station may still need
3288 * to be told that there are buffered frames via the TIM bit.
3290 * This function informs mac80211 whether or not there are frames that are
3291 * buffered in the driver for a given TID; mac80211 can then use this data
3292 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3293 * call! Beware of the locking!)
3295 * If all frames are released to the station (due to PS-poll or uAPSD)
3296 * then the driver needs to inform mac80211 that there no longer are
3297 * frames buffered. However, when the station wakes up mac80211 assumes
3298 * that all buffered frames will be transmitted and clears this data,
3299 * drivers need to make sure they inform mac80211 about all buffered
3300 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3302 * Note that technically mac80211 only needs to know this per AC, not per
3303 * TID, but since driver buffering will inevitably happen per TID (since
3304 * it is related to aggregation) it is easier to make mac80211 map the
3305 * TID to the AC as required instead of keeping track in all drivers that
3308 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
3309 u8 tid
, bool buffered
);
3312 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3314 * Call this function in a driver with per-packet rate selection support
3315 * to combine the rate info in the packet tx info with the most recent
3316 * rate selection table for the station entry.
3318 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3319 * @sta: the receiver station to which this packet is sent.
3320 * @skb: the frame to be transmitted.
3321 * @dest: buffer for extracted rate/retry information
3322 * @max_rates: maximum number of rates to fetch
3324 void ieee80211_get_tx_rates(struct ieee80211_vif
*vif
,
3325 struct ieee80211_sta
*sta
,
3326 struct sk_buff
*skb
,
3327 struct ieee80211_tx_rate
*dest
,
3331 * ieee80211_tx_status - transmit status callback
3333 * Call this function for all transmitted frames after they have been
3334 * transmitted. It is permissible to not call this function for
3335 * multicast frames but this can affect statistics.
3337 * This function may not be called in IRQ context. Calls to this function
3338 * for a single hardware must be synchronized against each other. Calls
3339 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3340 * may not be mixed for a single hardware. Must not run concurrently with
3341 * ieee80211_rx() or ieee80211_rx_ni().
3343 * @hw: the hardware the frame was transmitted by
3344 * @skb: the frame that was transmitted, owned by mac80211 after this call
3346 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
3347 struct sk_buff
*skb
);
3350 * ieee80211_tx_status_ni - transmit status callback (in process context)
3352 * Like ieee80211_tx_status() but can be called in process context.
3354 * Calls to this function, ieee80211_tx_status() and
3355 * ieee80211_tx_status_irqsafe() may not be mixed
3356 * for a single hardware.
3358 * @hw: the hardware the frame was transmitted by
3359 * @skb: the frame that was transmitted, owned by mac80211 after this call
3361 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
3362 struct sk_buff
*skb
)
3365 ieee80211_tx_status(hw
, skb
);
3370 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3372 * Like ieee80211_tx_status() but can be called in IRQ context
3373 * (internally defers to a tasklet.)
3375 * Calls to this function, ieee80211_tx_status() and
3376 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3378 * @hw: the hardware the frame was transmitted by
3379 * @skb: the frame that was transmitted, owned by mac80211 after this call
3381 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
3382 struct sk_buff
*skb
);
3385 * ieee80211_report_low_ack - report non-responding station
3387 * When operating in AP-mode, call this function to report a non-responding
3390 * @sta: the non-responding connected sta
3391 * @num_packets: number of packets sent to @sta without a response
3393 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
3396 * ieee80211_beacon_get_tim - beacon generation function
3397 * @hw: pointer obtained from ieee80211_alloc_hw().
3398 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3399 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3400 * Set to 0 if invalid (in non-AP modes).
3401 * @tim_length: pointer to variable that will receive the TIM IE length,
3402 * (including the ID and length bytes!).
3403 * Set to 0 if invalid (in non-AP modes).
3405 * If the driver implements beaconing modes, it must use this function to
3406 * obtain the beacon frame/template.
3408 * If the beacon frames are generated by the host system (i.e., not in
3409 * hardware/firmware), the driver uses this function to get each beacon
3410 * frame from mac80211 -- it is responsible for calling this function
3411 * before the beacon is needed (e.g. based on hardware interrupt).
3413 * If the beacon frames are generated by the device, then the driver
3414 * must use the returned beacon as the template and change the TIM IE
3415 * according to the current DTIM parameters/TIM bitmap.
3417 * The driver is responsible for freeing the returned skb.
3419 * Return: The beacon template. %NULL on error.
3421 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
3422 struct ieee80211_vif
*vif
,
3423 u16
*tim_offset
, u16
*tim_length
);
3426 * ieee80211_beacon_get - beacon generation function
3427 * @hw: pointer obtained from ieee80211_alloc_hw().
3428 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3430 * See ieee80211_beacon_get_tim().
3432 * Return: See ieee80211_beacon_get_tim().
3434 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
3435 struct ieee80211_vif
*vif
)
3437 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
3441 * ieee80211_csa_finish - notify mac80211 about channel switch
3442 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3444 * After a channel switch announcement was scheduled and the counter in this
3445 * announcement hits 1, this function must be called by the driver to
3446 * notify mac80211 that the channel can be changed.
3448 void ieee80211_csa_finish(struct ieee80211_vif
*vif
);
3451 * ieee80211_csa_is_complete - find out if counters reached 1
3452 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3454 * This function returns whether the channel switch counters reached zero.
3456 bool ieee80211_csa_is_complete(struct ieee80211_vif
*vif
);
3460 * ieee80211_proberesp_get - retrieve a Probe Response template
3461 * @hw: pointer obtained from ieee80211_alloc_hw().
3462 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3464 * Creates a Probe Response template which can, for example, be uploaded to
3465 * hardware. The destination address should be set by the caller.
3467 * Can only be called in AP mode.
3469 * Return: The Probe Response template. %NULL on error.
3471 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
3472 struct ieee80211_vif
*vif
);
3475 * ieee80211_pspoll_get - retrieve a PS Poll template
3476 * @hw: pointer obtained from ieee80211_alloc_hw().
3477 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3479 * Creates a PS Poll a template which can, for example, uploaded to
3480 * hardware. The template must be updated after association so that correct
3481 * AID, BSSID and MAC address is used.
3483 * Note: Caller (or hardware) is responsible for setting the
3484 * &IEEE80211_FCTL_PM bit.
3486 * Return: The PS Poll template. %NULL on error.
3488 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
3489 struct ieee80211_vif
*vif
);
3492 * ieee80211_nullfunc_get - retrieve a nullfunc template
3493 * @hw: pointer obtained from ieee80211_alloc_hw().
3494 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3496 * Creates a Nullfunc template which can, for example, uploaded to
3497 * hardware. The template must be updated after association so that correct
3498 * BSSID and address is used.
3500 * Note: Caller (or hardware) is responsible for setting the
3501 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3503 * Return: The nullfunc template. %NULL on error.
3505 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
3506 struct ieee80211_vif
*vif
);
3509 * ieee80211_probereq_get - retrieve a Probe Request template
3510 * @hw: pointer obtained from ieee80211_alloc_hw().
3511 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3512 * @ssid: SSID buffer
3513 * @ssid_len: length of SSID
3514 * @tailroom: tailroom to reserve at end of SKB for IEs
3516 * Creates a Probe Request template which can, for example, be uploaded to
3519 * Return: The Probe Request template. %NULL on error.
3521 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
3522 struct ieee80211_vif
*vif
,
3523 const u8
*ssid
, size_t ssid_len
,
3527 * ieee80211_rts_get - RTS frame generation function
3528 * @hw: pointer obtained from ieee80211_alloc_hw().
3529 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3530 * @frame: pointer to the frame that is going to be protected by the RTS.
3531 * @frame_len: the frame length (in octets).
3532 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3533 * @rts: The buffer where to store the RTS frame.
3535 * If the RTS frames are generated by the host system (i.e., not in
3536 * hardware/firmware), the low-level driver uses this function to receive
3537 * the next RTS frame from the 802.11 code. The low-level is responsible
3538 * for calling this function before and RTS frame is needed.
3540 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3541 const void *frame
, size_t frame_len
,
3542 const struct ieee80211_tx_info
*frame_txctl
,
3543 struct ieee80211_rts
*rts
);
3546 * ieee80211_rts_duration - Get the duration field for an RTS frame
3547 * @hw: pointer obtained from ieee80211_alloc_hw().
3548 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3549 * @frame_len: the length of the frame that is going to be protected by the RTS.
3550 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3552 * If the RTS is generated in firmware, but the host system must provide
3553 * the duration field, the low-level driver uses this function to receive
3554 * the duration field value in little-endian byteorder.
3556 * Return: The duration.
3558 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
3559 struct ieee80211_vif
*vif
, size_t frame_len
,
3560 const struct ieee80211_tx_info
*frame_txctl
);
3563 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3564 * @hw: pointer obtained from ieee80211_alloc_hw().
3565 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3566 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3567 * @frame_len: the frame length (in octets).
3568 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3569 * @cts: The buffer where to store the CTS-to-self frame.
3571 * If the CTS-to-self frames are generated by the host system (i.e., not in
3572 * hardware/firmware), the low-level driver uses this function to receive
3573 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3574 * for calling this function before and CTS-to-self frame is needed.
3576 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
3577 struct ieee80211_vif
*vif
,
3578 const void *frame
, size_t frame_len
,
3579 const struct ieee80211_tx_info
*frame_txctl
,
3580 struct ieee80211_cts
*cts
);
3583 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3584 * @hw: pointer obtained from ieee80211_alloc_hw().
3585 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3586 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3587 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3589 * If the CTS-to-self is generated in firmware, but the host system must provide
3590 * the duration field, the low-level driver uses this function to receive
3591 * the duration field value in little-endian byteorder.
3593 * Return: The duration.
3595 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
3596 struct ieee80211_vif
*vif
,
3598 const struct ieee80211_tx_info
*frame_txctl
);
3601 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3602 * @hw: pointer obtained from ieee80211_alloc_hw().
3603 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3604 * @band: the band to calculate the frame duration on
3605 * @frame_len: the length of the frame.
3606 * @rate: the rate at which the frame is going to be transmitted.
3608 * Calculate the duration field of some generic frame, given its
3609 * length and transmission rate (in 100kbps).
3611 * Return: The duration.
3613 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
3614 struct ieee80211_vif
*vif
,
3615 enum ieee80211_band band
,
3617 struct ieee80211_rate
*rate
);
3620 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3621 * @hw: pointer as obtained from ieee80211_alloc_hw().
3622 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3624 * Function for accessing buffered broadcast and multicast frames. If
3625 * hardware/firmware does not implement buffering of broadcast/multicast
3626 * frames when power saving is used, 802.11 code buffers them in the host
3627 * memory. The low-level driver uses this function to fetch next buffered
3628 * frame. In most cases, this is used when generating beacon frame.
3630 * Return: A pointer to the next buffered skb or NULL if no more buffered
3631 * frames are available.
3633 * Note: buffered frames are returned only after DTIM beacon frame was
3634 * generated with ieee80211_beacon_get() and the low-level driver must thus
3635 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3636 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3637 * does not need to check for DTIM beacons separately and should be able to
3638 * use common code for all beacons.
3641 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3644 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3646 * This function returns the TKIP phase 1 key for the given IV32.
3648 * @keyconf: the parameter passed with the set key
3649 * @iv32: IV32 to get the P1K for
3650 * @p1k: a buffer to which the key will be written, as 5 u16 values
3652 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
3653 u32 iv32
, u16
*p1k
);
3656 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3658 * This function returns the TKIP phase 1 key for the IV32 taken
3659 * from the given packet.
3661 * @keyconf: the parameter passed with the set key
3662 * @skb: the packet to take the IV32 value from that will be encrypted
3664 * @p1k: a buffer to which the key will be written, as 5 u16 values
3666 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
3667 struct sk_buff
*skb
, u16
*p1k
)
3669 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
3670 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
3671 u32 iv32
= get_unaligned_le32(&data
[4]);
3673 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
3677 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3679 * This function returns the TKIP phase 1 key for the given IV32
3680 * and transmitter address.
3682 * @keyconf: the parameter passed with the set key
3683 * @ta: TA that will be used with the key
3684 * @iv32: IV32 to get the P1K for
3685 * @p1k: a buffer to which the key will be written, as 5 u16 values
3687 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
3688 const u8
*ta
, u32 iv32
, u16
*p1k
);
3691 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3693 * This function computes the TKIP RC4 key for the IV values
3696 * @keyconf: the parameter passed with the set key
3697 * @skb: the packet to take the IV32/IV16 values from that will be
3698 * encrypted with this key
3699 * @p2k: a buffer to which the key will be written, 16 bytes
3701 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
3702 struct sk_buff
*skb
, u8
*p2k
);
3705 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3707 * This function computes the two AES-CMAC sub-keys, based on the
3708 * previously installed master key.
3710 * @keyconf: the parameter passed with the set key
3711 * @k1: a buffer to be filled with the 1st sub-key
3712 * @k2: a buffer to be filled with the 2nd sub-key
3714 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf
*keyconf
,
3718 * struct ieee80211_key_seq - key sequence counter
3720 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3721 * @ccmp: PN data, most significant byte first (big endian,
3722 * reverse order than in packet)
3723 * @aes_cmac: PN data, most significant byte first (big endian,
3724 * reverse order than in packet)
3726 struct ieee80211_key_seq
{
3742 * ieee80211_get_key_tx_seq - get key TX sequence counter
3744 * @keyconf: the parameter passed with the set key
3745 * @seq: buffer to receive the sequence data
3747 * This function allows a driver to retrieve the current TX IV/PN
3748 * for the given key. It must not be called if IV generation is
3749 * offloaded to the device.
3751 * Note that this function may only be called when no TX processing
3752 * can be done concurrently, for example when queues are stopped
3753 * and the stop has been synchronized.
3755 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
3756 struct ieee80211_key_seq
*seq
);
3759 * ieee80211_get_key_rx_seq - get key RX sequence counter
3761 * @keyconf: the parameter passed with the set key
3762 * @tid: The TID, or -1 for the management frame value (CCMP only);
3763 * the value on TID 0 is also used for non-QoS frames. For
3764 * CMAC, only TID 0 is valid.
3765 * @seq: buffer to receive the sequence data
3767 * This function allows a driver to retrieve the current RX IV/PNs
3768 * for the given key. It must not be called if IV checking is done
3769 * by the device and not by mac80211.
3771 * Note that this function may only be called when no RX processing
3772 * can be done concurrently.
3774 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
3775 int tid
, struct ieee80211_key_seq
*seq
);
3778 * ieee80211_set_key_tx_seq - set key TX sequence counter
3780 * @keyconf: the parameter passed with the set key
3781 * @seq: new sequence data
3783 * This function allows a driver to set the current TX IV/PNs for the
3784 * given key. This is useful when resuming from WoWLAN sleep and the
3785 * device may have transmitted frames using the PTK, e.g. replies to
3788 * Note that this function may only be called when no TX processing
3789 * can be done concurrently.
3791 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
3792 struct ieee80211_key_seq
*seq
);
3795 * ieee80211_set_key_rx_seq - set key RX sequence counter
3797 * @keyconf: the parameter passed with the set key
3798 * @tid: The TID, or -1 for the management frame value (CCMP only);
3799 * the value on TID 0 is also used for non-QoS frames. For
3800 * CMAC, only TID 0 is valid.
3801 * @seq: new sequence data
3803 * This function allows a driver to set the current RX IV/PNs for the
3804 * given key. This is useful when resuming from WoWLAN sleep and GTK
3805 * rekey may have been done while suspended. It should not be called
3806 * if IV checking is done by the device and not by mac80211.
3808 * Note that this function may only be called when no RX processing
3809 * can be done concurrently.
3811 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
3812 int tid
, struct ieee80211_key_seq
*seq
);
3815 * ieee80211_remove_key - remove the given key
3816 * @keyconf: the parameter passed with the set key
3818 * Remove the given key. If the key was uploaded to the hardware at the
3819 * time this function is called, it is not deleted in the hardware but
3820 * instead assumed to have been removed already.
3822 * Note that due to locking considerations this function can (currently)
3823 * only be called during key iteration (ieee80211_iter_keys().)
3825 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
);
3828 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3829 * @vif: the virtual interface to add the key on
3830 * @keyconf: new key data
3832 * When GTK rekeying was done while the system was suspended, (a) new
3833 * key(s) will be available. These will be needed by mac80211 for proper
3834 * RX processing, so this function allows setting them.
3836 * The function returns the newly allocated key structure, which will
3837 * have similar contents to the passed key configuration but point to
3838 * mac80211-owned memory. In case of errors, the function returns an
3839 * ERR_PTR(), use IS_ERR() etc.
3841 * Note that this function assumes the key isn't added to hardware
3842 * acceleration, so no TX will be done with the key. Since it's a GTK
3843 * on managed (station) networks, this is true anyway. If the driver
3844 * calls this function from the resume callback and subsequently uses
3845 * the return code 1 to reconfigure the device, this key will be part
3846 * of the reconfiguration.
3848 * Note that the driver should also call ieee80211_set_key_rx_seq()
3849 * for the new key for each TID to set up sequence counters properly.
3851 * IMPORTANT: If this replaces a key that is present in the hardware,
3852 * then it will attempt to remove it during this call. In many cases
3853 * this isn't what you want, so call ieee80211_remove_key() first for
3854 * the key that's being replaced.
3856 struct ieee80211_key_conf
*
3857 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
3858 struct ieee80211_key_conf
*keyconf
);
3861 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3862 * @vif: virtual interface the rekeying was done on
3863 * @bssid: The BSSID of the AP, for checking association
3864 * @replay_ctr: the new replay counter after GTK rekeying
3865 * @gfp: allocation flags
3867 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
3868 const u8
*replay_ctr
, gfp_t gfp
);
3871 * ieee80211_wake_queue - wake specific queue
3872 * @hw: pointer as obtained from ieee80211_alloc_hw().
3873 * @queue: queue number (counted from zero).
3875 * Drivers should use this function instead of netif_wake_queue.
3877 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
3880 * ieee80211_stop_queue - stop specific queue
3881 * @hw: pointer as obtained from ieee80211_alloc_hw().
3882 * @queue: queue number (counted from zero).
3884 * Drivers should use this function instead of netif_stop_queue.
3886 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
3889 * ieee80211_queue_stopped - test status of the queue
3890 * @hw: pointer as obtained from ieee80211_alloc_hw().
3891 * @queue: queue number (counted from zero).
3893 * Drivers should use this function instead of netif_stop_queue.
3895 * Return: %true if the queue is stopped. %false otherwise.
3898 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
3901 * ieee80211_stop_queues - stop all queues
3902 * @hw: pointer as obtained from ieee80211_alloc_hw().
3904 * Drivers should use this function instead of netif_stop_queue.
3906 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
3909 * ieee80211_wake_queues - wake all queues
3910 * @hw: pointer as obtained from ieee80211_alloc_hw().
3912 * Drivers should use this function instead of netif_wake_queue.
3914 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
3917 * ieee80211_scan_completed - completed hardware scan
3919 * When hardware scan offload is used (i.e. the hw_scan() callback is
3920 * assigned) this function needs to be called by the driver to notify
3921 * mac80211 that the scan finished. This function can be called from
3922 * any context, including hardirq context.
3924 * @hw: the hardware that finished the scan
3925 * @aborted: set to true if scan was aborted
3927 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
3930 * ieee80211_sched_scan_results - got results from scheduled scan
3932 * When a scheduled scan is running, this function needs to be called by the
3933 * driver whenever there are new scan results available.
3935 * @hw: the hardware that is performing scheduled scans
3937 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
3940 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3942 * When a scheduled scan is running, this function can be called by
3943 * the driver if it needs to stop the scan to perform another task.
3944 * Usual scenarios are drivers that cannot continue the scheduled scan
3945 * while associating, for instance.
3947 * @hw: the hardware that is performing scheduled scans
3949 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
3952 * enum ieee80211_interface_iteration_flags - interface iteration flags
3953 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3954 * been added to the driver; However, note that during hardware
3955 * reconfiguration (after restart_hw) it will iterate over a new
3956 * interface and over all the existing interfaces even if they
3957 * haven't been re-added to the driver yet.
3958 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3959 * interfaces, even if they haven't been re-added to the driver yet.
3961 enum ieee80211_interface_iteration_flags
{
3962 IEEE80211_IFACE_ITER_NORMAL
= 0,
3963 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
3967 * ieee80211_iterate_active_interfaces - iterate active interfaces
3969 * This function iterates over the interfaces associated with a given
3970 * hardware that are currently active and calls the callback for them.
3971 * This function allows the iterator function to sleep, when the iterator
3972 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3974 * Does not iterate over a new interface during add_interface().
3976 * @hw: the hardware struct of which the interfaces should be iterated over
3977 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3978 * @iterator: the iterator function to call
3979 * @data: first argument of the iterator function
3981 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
3983 void (*iterator
)(void *data
, u8
*mac
,
3984 struct ieee80211_vif
*vif
),
3988 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3990 * This function iterates over the interfaces associated with a given
3991 * hardware that are currently active and calls the callback for them.
3992 * This function requires the iterator callback function to be atomic,
3993 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3994 * Does not iterate over a new interface during add_interface().
3996 * @hw: the hardware struct of which the interfaces should be iterated over
3997 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3998 * @iterator: the iterator function to call, cannot sleep
3999 * @data: first argument of the iterator function
4001 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
4003 void (*iterator
)(void *data
,
4005 struct ieee80211_vif
*vif
),
4009 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4011 * This function iterates over the interfaces associated with a given
4012 * hardware that are currently active and calls the callback for them.
4013 * This version can only be used while holding the RTNL.
4015 * @hw: the hardware struct of which the interfaces should be iterated over
4016 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4017 * @iterator: the iterator function to call, cannot sleep
4018 * @data: first argument of the iterator function
4020 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw
*hw
,
4022 void (*iterator
)(void *data
,
4024 struct ieee80211_vif
*vif
),
4028 * ieee80211_queue_work - add work onto the mac80211 workqueue
4030 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4031 * This helper ensures drivers are not queueing work when they should not be.
4033 * @hw: the hardware struct for the interface we are adding work for
4034 * @work: the work we want to add onto the mac80211 workqueue
4036 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
4039 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4041 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4044 * @hw: the hardware struct for the interface we are adding work for
4045 * @dwork: delayable work to queue onto the mac80211 workqueue
4046 * @delay: number of jiffies to wait before queueing
4048 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
4049 struct delayed_work
*dwork
,
4050 unsigned long delay
);
4053 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4054 * @sta: the station for which to start a BA session
4055 * @tid: the TID to BA on.
4056 * @timeout: session timeout value (in TUs)
4058 * Return: success if addBA request was sent, failure otherwise
4060 * Although mac80211/low level driver/user space application can estimate
4061 * the need to start aggregation on a certain RA/TID, the session level
4062 * will be managed by the mac80211.
4064 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
4068 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4069 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4070 * @ra: receiver address of the BA session recipient.
4071 * @tid: the TID to BA on.
4073 * This function must be called by low level driver once it has
4074 * finished with preparations for the BA session. It can be called
4077 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
4081 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4082 * @sta: the station whose BA session to stop
4083 * @tid: the TID to stop BA.
4085 * Return: negative error if the TID is invalid, or no aggregation active
4087 * Although mac80211/low level driver/user space application can estimate
4088 * the need to stop aggregation on a certain RA/TID, the session level
4089 * will be managed by the mac80211.
4091 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
4094 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4095 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4096 * @ra: receiver address of the BA session recipient.
4097 * @tid: the desired TID to BA on.
4099 * This function must be called by low level driver once it has
4100 * finished with preparations for the BA session tear down. It
4101 * can be called from any context.
4103 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
4107 * ieee80211_find_sta - find a station
4109 * @vif: virtual interface to look for station on
4110 * @addr: station's address
4112 * Return: The station, if found. %NULL otherwise.
4114 * Note: This function must be called under RCU lock and the
4115 * resulting pointer is only valid under RCU lock as well.
4117 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
4121 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4123 * @hw: pointer as obtained from ieee80211_alloc_hw()
4124 * @addr: remote station's address
4125 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4127 * Return: The station, if found. %NULL otherwise.
4129 * Note: This function must be called under RCU lock and the
4130 * resulting pointer is only valid under RCU lock as well.
4132 * NOTE: You may pass NULL for localaddr, but then you will just get
4133 * the first STA that matches the remote address 'addr'.
4134 * We can have multiple STA associated with multiple
4135 * logical stations (e.g. consider a station connecting to another
4136 * BSSID on the same AP hardware without disconnecting first).
4137 * In this case, the result of this method with localaddr NULL
4140 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4142 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
4144 const u8
*localaddr
);
4147 * ieee80211_sta_block_awake - block station from waking up
4149 * @pubsta: the station
4150 * @block: whether to block or unblock
4152 * Some devices require that all frames that are on the queues
4153 * for a specific station that went to sleep are flushed before
4154 * a poll response or frames after the station woke up can be
4155 * delivered to that it. Note that such frames must be rejected
4156 * by the driver as filtered, with the appropriate status flag.
4158 * This function allows implementing this mode in a race-free
4161 * To do this, a driver must keep track of the number of frames
4162 * still enqueued for a specific station. If this number is not
4163 * zero when the station goes to sleep, the driver must call
4164 * this function to force mac80211 to consider the station to
4165 * be asleep regardless of the station's actual state. Once the
4166 * number of outstanding frames reaches zero, the driver must
4167 * call this function again to unblock the station. That will
4168 * cause mac80211 to be able to send ps-poll responses, and if
4169 * the station queried in the meantime then frames will also
4170 * be sent out as a result of this. Additionally, the driver
4171 * will be notified that the station woke up some time after
4172 * it is unblocked, regardless of whether the station actually
4173 * woke up while blocked or not.
4175 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
4176 struct ieee80211_sta
*pubsta
, bool block
);
4179 * ieee80211_sta_eosp - notify mac80211 about end of SP
4180 * @pubsta: the station
4182 * When a device transmits frames in a way that it can't tell
4183 * mac80211 in the TX status about the EOSP, it must clear the
4184 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4185 * This applies for PS-Poll as well as uAPSD.
4187 * Note that just like with _tx_status() and _rx() drivers must
4188 * not mix calls to irqsafe/non-irqsafe versions, this function
4189 * must not be mixed with those either. Use the all irqsafe, or
4190 * all non-irqsafe, don't mix!
4192 * NB: the _irqsafe version of this function doesn't exist, no
4193 * driver needs it right now. Don't call this function if
4194 * you'd need the _irqsafe version, look at the git history
4195 * and restore the _irqsafe version!
4197 void ieee80211_sta_eosp(struct ieee80211_sta
*pubsta
);
4200 * ieee80211_iter_keys - iterate keys programmed into the device
4201 * @hw: pointer obtained from ieee80211_alloc_hw()
4202 * @vif: virtual interface to iterate, may be %NULL for all
4203 * @iter: iterator function that will be called for each key
4204 * @iter_data: custom data to pass to the iterator function
4206 * This function can be used to iterate all the keys known to
4207 * mac80211, even those that weren't previously programmed into
4208 * the device. This is intended for use in WoWLAN if the device
4209 * needs reprogramming of the keys during suspend. Note that due
4210 * to locking reasons, it is also only safe to call this at few
4211 * spots since it must hold the RTNL and be able to sleep.
4213 * The order in which the keys are iterated matches the order
4214 * in which they were originally installed and handed to the
4217 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
4218 struct ieee80211_vif
*vif
,
4219 void (*iter
)(struct ieee80211_hw
*hw
,
4220 struct ieee80211_vif
*vif
,
4221 struct ieee80211_sta
*sta
,
4222 struct ieee80211_key_conf
*key
,
4227 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4228 * @hw: pointre obtained from ieee80211_alloc_hw().
4229 * @iter: iterator function
4230 * @iter_data: data passed to iterator function
4232 * Iterate all active channel contexts. This function is atomic and
4233 * doesn't acquire any locks internally that might be held in other
4234 * places while calling into the driver.
4236 * The iterator will not find a context that's being added (during
4237 * the driver callback to add it) but will find it while it's being
4240 * Note that during hardware restart, all contexts that existed
4241 * before the restart are considered already present so will be
4242 * found while iterating, whether they've been re-added already
4245 void ieee80211_iter_chan_contexts_atomic(
4246 struct ieee80211_hw
*hw
,
4247 void (*iter
)(struct ieee80211_hw
*hw
,
4248 struct ieee80211_chanctx_conf
*chanctx_conf
,
4253 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4254 * @hw: pointer obtained from ieee80211_alloc_hw().
4255 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4257 * Creates a Probe Request template which can, for example, be uploaded to
4258 * hardware. The template is filled with bssid, ssid and supported rate
4259 * information. This function must only be called from within the
4260 * .bss_info_changed callback function and only in managed mode. The function
4261 * is only useful when the interface is associated, otherwise it will return
4264 * Return: The Probe Request template. %NULL on error.
4266 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
4267 struct ieee80211_vif
*vif
);
4270 * ieee80211_beacon_loss - inform hardware does not receive beacons
4272 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4274 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4275 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4276 * hardware is not receiving beacons with this function.
4278 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
4281 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4283 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4285 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4286 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4287 * needs to inform if the connection to the AP has been lost.
4288 * The function may also be called if the connection needs to be terminated
4289 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4291 * This function will cause immediate change to disassociated state,
4292 * without connection recovery attempts.
4294 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
4297 * ieee80211_resume_disconnect - disconnect from AP after resume
4299 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4301 * Instructs mac80211 to disconnect from the AP after resume.
4302 * Drivers can use this after WoWLAN if they know that the
4303 * connection cannot be kept up, for example because keys were
4304 * used while the device was asleep but the replay counters or
4305 * similar cannot be retrieved from the device during resume.
4307 * Note that due to implementation issues, if the driver uses
4308 * the reconfiguration functionality during resume the interface
4309 * will still be added as associated first during resume and then
4310 * disconnect normally later.
4312 * This function can only be called from the resume callback and
4313 * the driver must not be holding any of its own locks while it
4314 * calls this function, or at least not any locks it needs in the
4315 * key configuration paths (if it supports HW crypto).
4317 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
4320 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4321 * rssi threshold triggered
4323 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4324 * @rssi_event: the RSSI trigger event type
4325 * @gfp: context flags
4327 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4328 * monitoring is configured with an rssi threshold, the driver will inform
4329 * whenever the rssi level reaches the threshold.
4331 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
4332 enum nl80211_cqm_rssi_threshold_event rssi_event
,
4336 * ieee80211_radar_detected - inform that a radar was detected
4338 * @hw: pointer as obtained from ieee80211_alloc_hw()
4340 void ieee80211_radar_detected(struct ieee80211_hw
*hw
);
4343 * ieee80211_chswitch_done - Complete channel switch process
4344 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4345 * @success: make the channel switch successful or not
4347 * Complete the channel switch post-process: set the new operational channel
4348 * and wake up the suspended queues.
4350 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
4353 * ieee80211_request_smps - request SM PS transition
4354 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4355 * @smps_mode: new SM PS mode
4357 * This allows the driver to request an SM PS transition in managed
4358 * mode. This is useful when the driver has more information than
4359 * the stack about possible interference, for example by bluetooth.
4361 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
4362 enum ieee80211_smps_mode smps_mode
);
4365 * ieee80211_ready_on_channel - notification of remain-on-channel start
4366 * @hw: pointer as obtained from ieee80211_alloc_hw()
4368 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
4371 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4372 * @hw: pointer as obtained from ieee80211_alloc_hw()
4374 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
4377 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4379 * in order not to harm the system performance and user experience, the device
4380 * may request not to allow any rx ba session and tear down existing rx ba
4381 * sessions based on system constraints such as periodic BT activity that needs
4382 * to limit wlan activity (eg.sco or a2dp)."
4383 * in such cases, the intention is to limit the duration of the rx ppdu and
4384 * therefore prevent the peer device to use a-mpdu aggregation.
4386 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4387 * @ba_rx_bitmap: Bit map of open rx ba per tid
4388 * @addr: & to bssid mac address
4390 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
4394 * ieee80211_send_bar - send a BlockAckReq frame
4396 * can be used to flush pending frames from the peer's aggregation reorder
4399 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4400 * @ra: the peer's destination address
4401 * @tid: the TID of the aggregation session
4402 * @ssn: the new starting sequence number for the receiver
4404 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
4406 /* Rate control API */
4409 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4411 * @hw: The hardware the algorithm is invoked for.
4412 * @sband: The band this frame is being transmitted on.
4413 * @bss_conf: the current BSS configuration
4414 * @skb: the skb that will be transmitted, the control information in it needs
4416 * @reported_rate: The rate control algorithm can fill this in to indicate
4417 * which rate should be reported to userspace as the current rate and
4418 * used for rate calculations in the mesh network.
4419 * @rts: whether RTS will be used for this frame because it is longer than the
4421 * @short_preamble: whether mac80211 will request short-preamble transmission
4422 * if the selected rate supports it
4423 * @max_rate_idx: user-requested maximum (legacy) rate
4424 * (deprecated; this will be removed once drivers get updated to use
4426 * @rate_idx_mask: user-requested (legacy) rate mask
4427 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4428 * @bss: whether this frame is sent out in AP or IBSS mode
4430 struct ieee80211_tx_rate_control
{
4431 struct ieee80211_hw
*hw
;
4432 struct ieee80211_supported_band
*sband
;
4433 struct ieee80211_bss_conf
*bss_conf
;
4434 struct sk_buff
*skb
;
4435 struct ieee80211_tx_rate reported_rate
;
4436 bool rts
, short_preamble
;
4439 u8
*rate_idx_mcs_mask
;
4443 struct rate_control_ops
{
4445 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
4446 void (*free
)(void *priv
);
4448 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
4449 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
4450 struct cfg80211_chan_def
*chandef
,
4451 struct ieee80211_sta
*sta
, void *priv_sta
);
4452 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
4453 struct cfg80211_chan_def
*chandef
,
4454 struct ieee80211_sta
*sta
, void *priv_sta
,
4456 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
4459 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
4460 struct ieee80211_sta
*sta
, void *priv_sta
,
4461 struct sk_buff
*skb
);
4462 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
4463 struct ieee80211_tx_rate_control
*txrc
);
4465 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
4466 struct dentry
*dir
);
4467 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
4470 static inline int rate_supported(struct ieee80211_sta
*sta
,
4471 enum ieee80211_band band
,
4474 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
4478 * rate_control_send_low - helper for drivers for management/no-ack frames
4480 * Rate control algorithms that agree to use the lowest rate to
4481 * send management frames and NO_ACK data with the respective hw
4482 * retries should use this in the beginning of their mac80211 get_rate
4483 * callback. If true is returned the rate control can simply return.
4484 * If false is returned we guarantee that sta and sta and priv_sta is
4487 * Rate control algorithms wishing to do more intelligent selection of
4488 * rate for multicast/broadcast frames may choose to not use this.
4490 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4491 * that this may be null.
4492 * @priv_sta: private rate control structure. This may be null.
4493 * @txrc: rate control information we sholud populate for mac80211.
4495 bool rate_control_send_low(struct ieee80211_sta
*sta
,
4497 struct ieee80211_tx_rate_control
*txrc
);
4501 rate_lowest_index(struct ieee80211_supported_band
*sband
,
4502 struct ieee80211_sta
*sta
)
4506 for (i
= 0; i
< sband
->n_bitrates
; i
++)
4507 if (rate_supported(sta
, sband
->band
, i
))
4510 /* warn when we cannot find a rate. */
4513 /* and return 0 (the lowest index) */
4518 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
4519 struct ieee80211_sta
*sta
)
4523 for (i
= 0; i
< sband
->n_bitrates
; i
++)
4524 if (rate_supported(sta
, sband
->band
, i
))
4530 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4532 * When not doing a rate control probe to test rates, rate control should pass
4533 * its rate selection to mac80211. If the driver supports receiving a station
4534 * rate table, it will use it to ensure that frames are always sent based on
4535 * the most recent rate control module decision.
4537 * @hw: pointer as obtained from ieee80211_alloc_hw()
4538 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4539 * @rates: new tx rate set to be used for this station.
4541 int rate_control_set_rates(struct ieee80211_hw
*hw
,
4542 struct ieee80211_sta
*pubsta
,
4543 struct ieee80211_sta_rates
*rates
);
4545 int ieee80211_rate_control_register(const struct rate_control_ops
*ops
);
4546 void ieee80211_rate_control_unregister(const struct rate_control_ops
*ops
);
4549 conf_is_ht20(struct ieee80211_conf
*conf
)
4551 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_20
;
4555 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
4557 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
4558 conf
->chandef
.center_freq1
< conf
->chandef
.chan
->center_freq
;
4562 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
4564 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
4565 conf
->chandef
.center_freq1
> conf
->chandef
.chan
->center_freq
;
4569 conf_is_ht40(struct ieee80211_conf
*conf
)
4571 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
;
4575 conf_is_ht(struct ieee80211_conf
*conf
)
4577 return conf
->chandef
.width
!= NL80211_CHAN_WIDTH_20_NOHT
;
4580 static inline enum nl80211_iftype
4581 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
4585 case NL80211_IFTYPE_STATION
:
4586 return NL80211_IFTYPE_P2P_CLIENT
;
4587 case NL80211_IFTYPE_AP
:
4588 return NL80211_IFTYPE_P2P_GO
;
4596 static inline enum nl80211_iftype
4597 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
4599 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
4602 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
4604 int rssi_max_thold
);
4606 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
4609 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4611 * @vif: the specified virtual interface
4613 * Note: This function assumes that the given vif is valid.
4615 * Return: The average RSSI value for the requested interface, or 0 if not
4618 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
4621 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4622 * @vif: virtual interface
4623 * @wakeup: wakeup reason(s)
4624 * @gfp: allocation flags
4626 * See cfg80211_report_wowlan_wakeup().
4628 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif
*vif
,
4629 struct cfg80211_wowlan_wakeup
*wakeup
,
4633 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4634 * @hw: pointer as obtained from ieee80211_alloc_hw()
4635 * @vif: virtual interface
4636 * @skb: frame to be sent from within the driver
4637 * @band: the band to transmit on
4638 * @sta: optional pointer to get the station to send the frame to
4640 * Note: must be called under RCU lock
4642 bool ieee80211_tx_prepare_skb(struct ieee80211_hw
*hw
,
4643 struct ieee80211_vif
*vif
, struct sk_buff
*skb
,
4644 int band
, struct ieee80211_sta
**sta
);
4647 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4649 * @next_tsf: TSF timestamp of the next absent state change
4650 * @has_next_tsf: next absent state change event pending
4652 * @absent: descriptor bitmask, set if GO is currently absent
4656 * @count: count fields from the NoA descriptors
4657 * @desc: adjusted data from the NoA
4659 struct ieee80211_noa_data
{
4665 u8 count
[IEEE80211_P2P_NOA_DESC_MAX
];
4670 } desc
[IEEE80211_P2P_NOA_DESC_MAX
];
4674 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4677 * @data: NoA tracking data
4678 * @tsf: current TSF timestamp
4680 * Return: number of successfully parsed descriptors
4682 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr
*attr
,
4683 struct ieee80211_noa_data
*data
, u32 tsf
);
4686 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4688 * @data: NoA tracking data
4689 * @tsf: current TSF timestamp
4691 void ieee80211_update_p2p_noa(struct ieee80211_noa_data
*data
, u32 tsf
);
4693 #endif /* MAC80211_H */