2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
17 #include <linux/bug.h>
18 #include <linux/kernel.h>
19 #include <linux/if_ether.h>
20 #include <linux/skbuff.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
23 #include <asm/unaligned.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
73 * DOC: mac80211 workqueue
75 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
76 * The workqueue is a single threaded workqueue and can only be accessed by
77 * helpers for sanity checking. Drivers must ensure all work added onto the
78 * mac80211 workqueue should be cancelled on the driver stop() callback.
80 * mac80211 will flushed the workqueue upon interface removal and during
83 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
90 * enum ieee80211_max_queues - maximum number of queues
92 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
93 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
95 enum ieee80211_max_queues
{
96 IEEE80211_MAX_QUEUES
= 16,
97 IEEE80211_MAX_QUEUE_MAP
= BIT(IEEE80211_MAX_QUEUES
) - 1,
100 #define IEEE80211_INVAL_HW_QUEUE 0xff
103 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
104 * @IEEE80211_AC_VO: voice
105 * @IEEE80211_AC_VI: video
106 * @IEEE80211_AC_BE: best effort
107 * @IEEE80211_AC_BK: background
109 enum ieee80211_ac_numbers
{
115 #define IEEE80211_NUM_ACS 4
118 * struct ieee80211_tx_queue_params - transmit queue configuration
120 * The information provided in this structure is required for QoS
121 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
123 * @aifs: arbitration interframe space [0..255]
124 * @cw_min: minimum contention window [a value of the form
125 * 2^n-1 in the range 1..32767]
126 * @cw_max: maximum contention window [like @cw_min]
127 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
128 * @acm: is mandatory admission control required for the access category
129 * @uapsd: is U-APSD mode enabled for the queue
131 struct ieee80211_tx_queue_params
{
140 struct ieee80211_low_level_stats
{
141 unsigned int dot11ACKFailureCount
;
142 unsigned int dot11RTSFailureCount
;
143 unsigned int dot11FCSErrorCount
;
144 unsigned int dot11RTSSuccessCount
;
148 * enum ieee80211_chanctx_change - change flag for channel context
149 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
150 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
152 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
153 * this is used only with channel switching with CSA
154 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
156 enum ieee80211_chanctx_change
{
157 IEEE80211_CHANCTX_CHANGE_WIDTH
= BIT(0),
158 IEEE80211_CHANCTX_CHANGE_RX_CHAINS
= BIT(1),
159 IEEE80211_CHANCTX_CHANGE_RADAR
= BIT(2),
160 IEEE80211_CHANCTX_CHANGE_CHANNEL
= BIT(3),
161 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH
= BIT(4),
165 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
167 * This is the driver-visible part. The ieee80211_chanctx
168 * that contains it is visible in mac80211 only.
170 * @def: the channel definition
171 * @min_def: the minimum channel definition currently required.
172 * @rx_chains_static: The number of RX chains that must always be
173 * active on the channel to receive MIMO transmissions
174 * @rx_chains_dynamic: The number of RX chains that must be enabled
175 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
176 * this will always be >= @rx_chains_static.
177 * @radar_enabled: whether radar detection is enabled on this channel.
178 * @drv_priv: data area for driver use, will always be aligned to
179 * sizeof(void *), size is determined in hw information.
181 struct ieee80211_chanctx_conf
{
182 struct cfg80211_chan_def def
;
183 struct cfg80211_chan_def min_def
;
185 u8 rx_chains_static
, rx_chains_dynamic
;
189 u8 drv_priv
[0] __aligned(sizeof(void *));
193 * enum ieee80211_chanctx_switch_mode - channel context switch mode
194 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
195 * exist (and will continue to exist), but the virtual interface
196 * needs to be switched from one to the other.
197 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
198 * to exist with this call, the new context doesn't exist but
199 * will be active after this call, the virtual interface switches
200 * from the old to the new (note that the driver may of course
201 * implement this as an on-the-fly chandef switch of the existing
202 * hardware context, but the mac80211 pointer for the old context
203 * will cease to exist and only the new one will later be used
204 * for changes/removal.)
206 enum ieee80211_chanctx_switch_mode
{
207 CHANCTX_SWMODE_REASSIGN_VIF
,
208 CHANCTX_SWMODE_SWAP_CONTEXTS
,
212 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
214 * This is structure is used to pass information about a vif that
215 * needs to switch from one chanctx to another. The
216 * &ieee80211_chanctx_switch_mode defines how the switch should be
219 * @vif: the vif that should be switched from old_ctx to new_ctx
220 * @old_ctx: the old context to which the vif was assigned
221 * @new_ctx: the new context to which the vif must be assigned
223 struct ieee80211_vif_chanctx_switch
{
224 struct ieee80211_vif
*vif
;
225 struct ieee80211_chanctx_conf
*old_ctx
;
226 struct ieee80211_chanctx_conf
*new_ctx
;
230 * enum ieee80211_bss_change - BSS change notification flags
232 * These flags are used with the bss_info_changed() callback
233 * to indicate which BSS parameter changed.
235 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
236 * also implies a change in the AID.
237 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
238 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
239 * @BSS_CHANGED_ERP_SLOT: slot timing changed
240 * @BSS_CHANGED_HT: 802.11n parameters changed
241 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
242 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
243 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
244 * reason (IBSS and managed mode)
245 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
246 * new beacon (beaconing modes)
247 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
248 * enabled/disabled (beaconing modes)
249 * @BSS_CHANGED_CQM: Connection quality monitor config changed
250 * @BSS_CHANGED_IBSS: IBSS join status changed
251 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
252 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
253 * that it is only ever disabled for station mode.
254 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
255 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
256 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
257 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
258 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
259 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
260 * changed (currently only in P2P client mode, GO mode will be later)
261 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
262 * currently dtim_period only is under consideration.
263 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
264 * note that this is only called when it changes after the channel
265 * context had been assigned.
267 enum ieee80211_bss_change
{
268 BSS_CHANGED_ASSOC
= 1<<0,
269 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
270 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
271 BSS_CHANGED_ERP_SLOT
= 1<<3,
272 BSS_CHANGED_HT
= 1<<4,
273 BSS_CHANGED_BASIC_RATES
= 1<<5,
274 BSS_CHANGED_BEACON_INT
= 1<<6,
275 BSS_CHANGED_BSSID
= 1<<7,
276 BSS_CHANGED_BEACON
= 1<<8,
277 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
278 BSS_CHANGED_CQM
= 1<<10,
279 BSS_CHANGED_IBSS
= 1<<11,
280 BSS_CHANGED_ARP_FILTER
= 1<<12,
281 BSS_CHANGED_QOS
= 1<<13,
282 BSS_CHANGED_IDLE
= 1<<14,
283 BSS_CHANGED_SSID
= 1<<15,
284 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
285 BSS_CHANGED_PS
= 1<<17,
286 BSS_CHANGED_TXPOWER
= 1<<18,
287 BSS_CHANGED_P2P_PS
= 1<<19,
288 BSS_CHANGED_BEACON_INFO
= 1<<20,
289 BSS_CHANGED_BANDWIDTH
= 1<<21,
291 /* when adding here, make sure to change ieee80211_reconfig */
295 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
296 * of addresses for an interface increase beyond this value, hardware ARP
297 * filtering will be disabled.
299 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
302 * enum ieee80211_rssi_event - RSSI threshold event
303 * An indicator for when RSSI goes below/above a certain threshold.
304 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
305 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
307 enum ieee80211_rssi_event
{
313 * struct ieee80211_bss_conf - holds the BSS's changing parameters
315 * This structure keeps information about a BSS (and an association
316 * to that BSS) that can change during the lifetime of the BSS.
318 * @assoc: association status
319 * @ibss_joined: indicates whether this station is part of an IBSS
321 * @ibss_creator: indicates if a new IBSS network is being created
322 * @aid: association ID number, valid only when @assoc is true
323 * @use_cts_prot: use CTS protection
324 * @use_short_preamble: use 802.11b short preamble;
325 * if the hardware cannot handle this it must set the
326 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
327 * @use_short_slot: use short slot time (only relevant for ERP);
328 * if the hardware cannot handle this it must set the
329 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
330 * @dtim_period: num of beacons before the next DTIM, for beaconing,
331 * valid in station mode only if after the driver was notified
332 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
333 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
334 * as it may have been received during scanning long ago). If the
335 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
336 * only come from a beacon, but might not become valid until after
337 * association when a beacon is received (which is notified with the
338 * %BSS_CHANGED_DTIM flag.)
339 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
340 * the driver/device can use this to calculate synchronisation
342 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
343 * is requested, see @sync_tsf/@sync_device_ts.
344 * @beacon_int: beacon interval
345 * @assoc_capability: capabilities taken from assoc resp
346 * @basic_rates: bitmap of basic rates, each bit stands for an
347 * index into the rate table configured by the driver in
349 * @beacon_rate: associated AP's beacon TX rate
350 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
351 * @bssid: The BSSID for this BSS
352 * @enable_beacon: whether beaconing should be enabled or not
353 * @chandef: Channel definition for this BSS -- the hardware might be
354 * configured a higher bandwidth than this BSS uses, for example.
355 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
356 * This field is only valid when the channel type is one of the HT types.
357 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
359 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
360 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
361 * may filter ARP queries targeted for other addresses than listed here.
362 * The driver must allow ARP queries targeted for all address listed here
363 * to pass through. An empty list implies no ARP queries need to pass.
364 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
365 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
366 * array size), it's up to the driver what to do in that case.
367 * @qos: This is a QoS-enabled BSS.
368 * @idle: This interface is idle. There's also a global idle flag in the
369 * hardware config which may be more appropriate depending on what
370 * your driver/device needs to do.
371 * @ps: power-save mode (STA only). This flag is NOT affected by
372 * offchannel/dynamic_ps operations.
373 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
374 * @ssid_len: Length of SSID given in @ssid.
375 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
376 * @txpower: TX power in dBm
377 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
379 struct ieee80211_bss_conf
{
381 /* association related data */
382 bool assoc
, ibss_joined
;
385 /* erp related data */
387 bool use_short_preamble
;
392 u16 assoc_capability
;
397 struct ieee80211_rate
*beacon_rate
;
398 int mcast_rate
[IEEE80211_NUM_BANDS
];
399 u16 ht_operation_mode
;
402 struct cfg80211_chan_def chandef
;
403 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
408 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
412 struct ieee80211_p2p_noa_attr p2p_noa_attr
;
416 * enum mac80211_tx_info_flags - flags to describe transmission information/status
418 * These flags are used with the @flags member of &ieee80211_tx_info.
420 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
421 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
422 * number to this frame, taking care of not overwriting the fragment
423 * number and increasing the sequence number only when the
424 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
425 * assign sequence numbers to QoS-data frames but cannot do so correctly
426 * for non-QoS-data and management frames because beacons need them from
427 * that counter as well and mac80211 cannot guarantee proper sequencing.
428 * If this flag is set, the driver should instruct the hardware to
429 * assign a sequence number to the frame or assign one itself. Cf. IEEE
430 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
431 * beacons and always be clear for frames without a sequence number field.
432 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
433 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
435 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
436 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
437 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
438 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
439 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
440 * because the destination STA was in powersave mode. Note that to
441 * avoid race conditions, the filter must be set by the hardware or
442 * firmware upon receiving a frame that indicates that the station
443 * went to sleep (must be done on device to filter frames already on
444 * the queue) and may only be unset after mac80211 gives the OK for
445 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
446 * since only then is it guaranteed that no more frames are in the
448 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
449 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
450 * is for the whole aggregation.
451 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
452 * so consider using block ack request (BAR).
453 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
454 * set by rate control algorithms to indicate probe rate, will
455 * be cleared for fragmented frames (except on the last fragment)
456 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
457 * that a frame can be transmitted while the queues are stopped for
458 * off-channel operation.
459 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
460 * used to indicate that a pending frame requires TX processing before
461 * it can be sent out.
462 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
463 * used to indicate that a frame was already retried due to PS
464 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
465 * used to indicate frame should not be encrypted
466 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
467 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
468 * be sent although the station is in powersave mode.
469 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
470 * transmit function after the current frame, this can be used
471 * by drivers to kick the DMA queue only if unset or when the
473 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
474 * after TX status because the destination was asleep, it must not
475 * be modified again (no seqno assignment, crypto, etc.)
476 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
477 * code for connection establishment, this indicates that its status
478 * should kick the MLME state machine.
479 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
480 * MLME command (internal to mac80211 to figure out whether to send TX
481 * status to user space)
482 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
483 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
484 * frame and selects the maximum number of streams that it can use.
485 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
486 * the off-channel channel when a remain-on-channel offload is done
487 * in hardware -- normal packets still flow and are expected to be
488 * handled properly by the device.
489 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
490 * testing. It will be sent out with incorrect Michael MIC key to allow
491 * TKIP countermeasures to be tested.
492 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
493 * This flag is actually used for management frame especially for P2P
494 * frames not being sent at CCK rate in 2GHz band.
495 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
496 * when its status is reported the service period ends. For frames in
497 * an SP that mac80211 transmits, it is already set; for driver frames
498 * the driver may set this flag. It is also used to do the same for
500 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
501 * This flag is used to send nullfunc frame at minimum rate when
502 * the nullfunc is used for connection monitoring purpose.
503 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
504 * would be fragmented by size (this is optional, only used for
505 * monitor injection).
506 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
507 * frame (PS-Poll or uAPSD).
509 * Note: If you have to add new flags to the enumeration, then don't
510 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
512 enum mac80211_tx_info_flags
{
513 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
514 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
515 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
516 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
517 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
518 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
519 IEEE80211_TX_CTL_AMPDU
= BIT(6),
520 IEEE80211_TX_CTL_INJECTED
= BIT(7),
521 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
522 IEEE80211_TX_STAT_ACK
= BIT(9),
523 IEEE80211_TX_STAT_AMPDU
= BIT(10),
524 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
525 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
526 IEEE80211_TX_INTFL_OFFCHAN_TX_OK
= BIT(13),
527 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
528 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
529 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
530 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
531 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
532 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
533 IEEE80211_TX_INTFL_MLME_CONN_TX
= BIT(20),
534 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
535 IEEE80211_TX_CTL_LDPC
= BIT(22),
536 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
537 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
538 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
539 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
540 IEEE80211_TX_STATUS_EOSP
= BIT(28),
541 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
542 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
543 IEEE80211_TX_CTL_PS_RESPONSE
= BIT(31),
546 #define IEEE80211_TX_CTL_STBC_SHIFT 23
549 * enum mac80211_tx_control_flags - flags to describe transmit control
551 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
552 * protocol frame (e.g. EAP)
554 * These flags are used in tx_info->control.flags.
556 enum mac80211_tx_control_flags
{
557 IEEE80211_TX_CTRL_PORT_CTRL_PROTO
= BIT(0),
561 * This definition is used as a mask to clear all temporary flags, which are
562 * set by the tx handlers for each transmission attempt by the mac80211 stack.
564 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
565 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
566 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
567 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
568 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
569 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
570 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
571 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
574 * enum mac80211_rate_control_flags - per-rate flags set by the
575 * Rate Control algorithm.
577 * These flags are set by the Rate control algorithm for each rate during tx,
578 * in the @flags member of struct ieee80211_tx_rate.
580 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
581 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
582 * This is set if the current BSS requires ERP protection.
583 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
584 * @IEEE80211_TX_RC_MCS: HT rate.
585 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
586 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
587 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
589 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
590 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
591 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
592 * (80+80 isn't supported yet)
593 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
594 * adjacent 20 MHz channels, if the current channel type is
595 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
596 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
598 enum mac80211_rate_control_flags
{
599 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
600 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
601 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
603 /* rate index is an HT/VHT MCS instead of an index */
604 IEEE80211_TX_RC_MCS
= BIT(3),
605 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
606 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
607 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
608 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
609 IEEE80211_TX_RC_VHT_MCS
= BIT(8),
610 IEEE80211_TX_RC_80_MHZ_WIDTH
= BIT(9),
611 IEEE80211_TX_RC_160_MHZ_WIDTH
= BIT(10),
615 /* there are 40 bytes if you don't need the rateset to be kept */
616 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
618 /* if you do need the rateset, then you have less space */
619 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
621 /* maximum number of rate stages */
622 #define IEEE80211_TX_MAX_RATES 4
624 /* maximum number of rate table entries */
625 #define IEEE80211_TX_RATE_TABLE_SIZE 4
628 * struct ieee80211_tx_rate - rate selection/status
630 * @idx: rate index to attempt to send with
631 * @flags: rate control flags (&enum mac80211_rate_control_flags)
632 * @count: number of tries in this rate before going to the next rate
634 * A value of -1 for @idx indicates an invalid rate and, if used
635 * in an array of retry rates, that no more rates should be tried.
637 * When used for transmit status reporting, the driver should
638 * always report the rate along with the flags it used.
640 * &struct ieee80211_tx_info contains an array of these structs
641 * in the control information, and it will be filled by the rate
642 * control algorithm according to what should be sent. For example,
643 * if this array contains, in the format { <idx>, <count> } the
645 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
646 * then this means that the frame should be transmitted
647 * up to twice at rate 3, up to twice at rate 2, and up to four
648 * times at rate 1 if it doesn't get acknowledged. Say it gets
649 * acknowledged by the peer after the fifth attempt, the status
650 * information should then contain
651 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
652 * since it was transmitted twice at rate 3, twice at rate 2
653 * and once at rate 1 after which we received an acknowledgement.
655 struct ieee80211_tx_rate
{
661 #define IEEE80211_MAX_TX_RETRY 31
663 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate
*rate
,
667 WARN_ON((nss
- 1) & ~0x7);
668 rate
->idx
= ((nss
- 1) << 4) | mcs
;
672 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate
*rate
)
674 return rate
->idx
& 0xF;
678 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate
*rate
)
680 return (rate
->idx
>> 4) + 1;
684 * struct ieee80211_tx_info - skb transmit information
686 * This structure is placed in skb->cb for three uses:
687 * (1) mac80211 TX control - mac80211 tells the driver what to do
688 * (2) driver internal use (if applicable)
689 * (3) TX status information - driver tells mac80211 what happened
691 * @flags: transmit info flags, defined above
692 * @band: the band to transmit on (use for checking for races)
693 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
694 * @ack_frame_id: internal frame ID for TX status, used internally
695 * @control: union for control data
696 * @status: union for status data
697 * @driver_data: array of driver_data pointers
698 * @ampdu_ack_len: number of acked aggregated frames.
699 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
700 * @ampdu_len: number of aggregated frames.
701 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
702 * @ack_signal: signal strength of the ACK frame
704 struct ieee80211_tx_info
{
705 /* common information */
718 struct ieee80211_tx_rate rates
[
719 IEEE80211_TX_MAX_RATES
];
727 /* only needed before rate control */
728 unsigned long jiffies
;
730 /* NB: vif can be NULL for injected frames */
731 struct ieee80211_vif
*vif
;
732 struct ieee80211_key_conf
*hw_key
;
737 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
743 void *status_driver_data
[19 / sizeof(void *)];
746 struct ieee80211_tx_rate driver_rates
[
747 IEEE80211_TX_MAX_RATES
];
750 void *rate_driver_data
[
751 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
754 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
759 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
761 * This structure is used to point to different blocks of IEs in HW scan
762 * and scheduled scan. These blocks contain the IEs passed by userspace
763 * and the ones generated by mac80211.
765 * @ies: pointers to band specific IEs.
766 * @len: lengths of band_specific IEs.
767 * @common_ies: IEs for all bands (especially vendor specific ones)
768 * @common_ie_len: length of the common_ies
770 struct ieee80211_scan_ies
{
771 const u8
*ies
[IEEE80211_NUM_BANDS
];
772 size_t len
[IEEE80211_NUM_BANDS
];
773 const u8
*common_ies
;
774 size_t common_ie_len
;
778 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
780 return (struct ieee80211_tx_info
*)skb
->cb
;
783 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
785 return (struct ieee80211_rx_status
*)skb
->cb
;
789 * ieee80211_tx_info_clear_status - clear TX status
791 * @info: The &struct ieee80211_tx_info to be cleared.
793 * When the driver passes an skb back to mac80211, it must report
794 * a number of things in TX status. This function clears everything
795 * in the TX status but the rate control information (it does clear
796 * the count since you need to fill that in anyway).
798 * NOTE: You can only use this function if you do NOT use
799 * info->driver_data! Use info->rate_driver_data
800 * instead if you need only the less space that allows.
803 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
807 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
808 offsetof(struct ieee80211_tx_info
, control
.rates
));
809 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
810 offsetof(struct ieee80211_tx_info
, driver_rates
));
811 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
812 /* clear the rate counts */
813 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
814 info
->status
.rates
[i
].count
= 0;
817 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
818 memset(&info
->status
.ampdu_ack_len
, 0,
819 sizeof(struct ieee80211_tx_info
) -
820 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
825 * enum mac80211_rx_flags - receive flags
827 * These flags are used with the @flag member of &struct ieee80211_rx_status.
828 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
829 * Use together with %RX_FLAG_MMIC_STRIPPED.
830 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
831 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
832 * verification has been done by the hardware.
833 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
834 * If this flag is set, the stack cannot do any replay detection
835 * hence the driver or hardware will have to do that.
836 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
838 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
840 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
841 * field) is valid and contains the time the first symbol of the MPDU
842 * was received. This is useful in monitor mode and for proper IBSS
844 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
845 * field) is valid and contains the time the last symbol of the MPDU
846 * (including FCS) was received.
847 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
848 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
849 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
850 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
851 * @RX_FLAG_SHORT_GI: Short guard interval was used
852 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
853 * Valid only for data frames (mainly A-MPDU)
854 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
855 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
856 * to hw.radiotap_mcs_details to advertise that fact
857 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
858 * number (@ampdu_reference) must be populated and be a distinct number for
860 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
861 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
862 * monitoring purposes only
863 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
864 * subframes of a single A-MPDU
865 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
866 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
868 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
869 * is stored in the @ampdu_delimiter_crc field)
870 * @RX_FLAG_LDPC: LDPC was used
871 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
872 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
873 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
874 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
875 * subframes instead of a one huge frame for performance reasons.
876 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
877 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
878 * the 3rd (last) one must not have this flag set. The flag is used to
879 * deal with retransmission/duplication recovery properly since A-MSDU
880 * subframes share the same sequence number. Reported subframes can be
881 * either regular MSDU or singly A-MSDUs. Subframes must not be
882 * interleaved with other frames.
884 enum mac80211_rx_flags
{
885 RX_FLAG_MMIC_ERROR
= BIT(0),
886 RX_FLAG_DECRYPTED
= BIT(1),
887 RX_FLAG_MMIC_STRIPPED
= BIT(3),
888 RX_FLAG_IV_STRIPPED
= BIT(4),
889 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
890 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
891 RX_FLAG_MACTIME_START
= BIT(7),
892 RX_FLAG_SHORTPRE
= BIT(8),
894 RX_FLAG_40MHZ
= BIT(10),
895 RX_FLAG_SHORT_GI
= BIT(11),
896 RX_FLAG_NO_SIGNAL_VAL
= BIT(12),
897 RX_FLAG_HT_GF
= BIT(13),
898 RX_FLAG_AMPDU_DETAILS
= BIT(14),
899 RX_FLAG_AMPDU_REPORT_ZEROLEN
= BIT(15),
900 RX_FLAG_AMPDU_IS_ZEROLEN
= BIT(16),
901 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(17),
902 RX_FLAG_AMPDU_IS_LAST
= BIT(18),
903 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(19),
904 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(20),
905 RX_FLAG_MACTIME_END
= BIT(21),
906 RX_FLAG_VHT
= BIT(22),
907 RX_FLAG_LDPC
= BIT(23),
908 RX_FLAG_STBC_MASK
= BIT(26) | BIT(27),
909 RX_FLAG_10MHZ
= BIT(28),
910 RX_FLAG_5MHZ
= BIT(29),
911 RX_FLAG_AMSDU_MORE
= BIT(30),
914 #define RX_FLAG_STBC_SHIFT 26
917 * enum mac80211_rx_vht_flags - receive VHT flags
919 * These flags are used with the @vht_flag member of
920 * &struct ieee80211_rx_status.
921 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
922 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
923 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
924 * @RX_VHT_FLAG_BF: packet was beamformed
926 enum mac80211_rx_vht_flags
{
927 RX_VHT_FLAG_80MHZ
= BIT(0),
928 RX_VHT_FLAG_80P80MHZ
= BIT(1),
929 RX_VHT_FLAG_160MHZ
= BIT(2),
930 RX_VHT_FLAG_BF
= BIT(3),
934 * struct ieee80211_rx_status - receive status
936 * The low-level driver should provide this information (the subset
937 * supported by hardware) to the 802.11 code with each received
938 * frame, in the skb's control buffer (cb).
940 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
941 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
942 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
943 * it but can store it and pass it back to the driver for synchronisation
944 * @band: the active band when this frame was received
945 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
946 * @signal: signal strength when receiving this frame, either in dBm, in dB or
947 * unspecified depending on the hardware capabilities flags
948 * @IEEE80211_HW_SIGNAL_*
949 * @chains: bitmask of receive chains for which separate signal strength
950 * values were filled.
951 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
952 * support dB or unspecified units)
953 * @antenna: antenna used
954 * @rate_idx: index of data rate into band's supported rates or MCS index if
955 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
956 * @vht_nss: number of streams (VHT only)
958 * @vht_flag: %RX_VHT_FLAG_*
959 * @rx_flags: internal RX flags for mac80211
960 * @ampdu_reference: A-MPDU reference number, must be a different value for
961 * each A-MPDU but the same for each subframe within one A-MPDU
962 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
964 struct ieee80211_rx_status
{
966 u32 device_timestamp
;
978 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
979 u8 ampdu_delimiter_crc
;
983 * enum ieee80211_conf_flags - configuration flags
985 * Flags to define PHY configuration options
987 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
988 * to determine for example whether to calculate timestamps for packets
989 * or not, do not use instead of filter flags!
990 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
991 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
992 * meaning that the hardware still wakes up for beacons, is able to
993 * transmit frames and receive the possible acknowledgment frames.
994 * Not to be confused with hardware specific wakeup/sleep states,
995 * driver is responsible for that. See the section "Powersave support"
997 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
998 * the driver should be prepared to handle configuration requests but
999 * may turn the device off as much as possible. Typically, this flag will
1000 * be set when an interface is set UP but not associated or scanning, but
1001 * it can also be unset in that case when monitor interfaces are active.
1002 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1003 * operating channel.
1005 enum ieee80211_conf_flags
{
1006 IEEE80211_CONF_MONITOR
= (1<<0),
1007 IEEE80211_CONF_PS
= (1<<1),
1008 IEEE80211_CONF_IDLE
= (1<<2),
1009 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
1014 * enum ieee80211_conf_changed - denotes which configuration changed
1016 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1017 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1018 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1019 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1020 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1021 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1022 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1023 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1024 * Note that this is only valid if channel contexts are not used,
1025 * otherwise each channel context has the number of chains listed.
1027 enum ieee80211_conf_changed
{
1028 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
1029 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
1030 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
1031 IEEE80211_CONF_CHANGE_PS
= BIT(4),
1032 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
1033 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
1034 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
1035 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
1039 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1041 * @IEEE80211_SMPS_AUTOMATIC: automatic
1042 * @IEEE80211_SMPS_OFF: off
1043 * @IEEE80211_SMPS_STATIC: static
1044 * @IEEE80211_SMPS_DYNAMIC: dynamic
1045 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1047 enum ieee80211_smps_mode
{
1048 IEEE80211_SMPS_AUTOMATIC
,
1050 IEEE80211_SMPS_STATIC
,
1051 IEEE80211_SMPS_DYNAMIC
,
1054 IEEE80211_SMPS_NUM_MODES
,
1058 * struct ieee80211_conf - configuration of the device
1060 * This struct indicates how the driver shall configure the hardware.
1062 * @flags: configuration flags defined above
1064 * @listen_interval: listen interval in units of beacon interval
1065 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1066 * before checking the beacon for a TIM bit (managed mode only); this
1067 * value will be only achievable between DTIM frames, the hardware
1068 * needs to check for the multicast traffic bit in DTIM beacons.
1069 * This variable is valid only when the CONF_PS flag is set.
1070 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1071 * in power saving. Power saving will not be enabled until a beacon
1072 * has been received and the DTIM period is known.
1073 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1074 * powersave documentation below. This variable is valid only when
1075 * the CONF_PS flag is set.
1077 * @power_level: requested transmit power (in dBm), backward compatibility
1078 * value only that is set to the minimum of all interfaces
1080 * @chandef: the channel definition to tune to
1081 * @radar_enabled: whether radar detection is enabled
1083 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1084 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1085 * but actually means the number of transmissions not the number of retries
1086 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1087 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1088 * number of transmissions not the number of retries
1090 * @smps_mode: spatial multiplexing powersave mode; note that
1091 * %IEEE80211_SMPS_STATIC is used when the device is not
1092 * configured for an HT channel.
1093 * Note that this is only valid if channel contexts are not used,
1094 * otherwise each channel context has the number of chains listed.
1096 struct ieee80211_conf
{
1098 int power_level
, dynamic_ps_timeout
;
1099 int max_sleep_period
;
1101 u16 listen_interval
;
1104 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
1106 struct cfg80211_chan_def chandef
;
1108 enum ieee80211_smps_mode smps_mode
;
1112 * struct ieee80211_channel_switch - holds the channel switch data
1114 * The information provided in this structure is required for channel switch
1117 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1118 * Function (TSF) timer when the frame containing the channel switch
1119 * announcement was received. This is simply the rx.mactime parameter
1120 * the driver passed into mac80211.
1121 * @device_timestamp: arbitrary timestamp for the device, this is the
1122 * rx.device_timestamp parameter the driver passed to mac80211.
1123 * @block_tx: Indicates whether transmission must be blocked before the
1124 * scheduled channel switch, as indicated by the AP.
1125 * @chandef: the new channel to switch to
1126 * @count: the number of TBTT's until the channel switch event
1128 struct ieee80211_channel_switch
{
1130 u32 device_timestamp
;
1132 struct cfg80211_chan_def chandef
;
1137 * enum ieee80211_vif_flags - virtual interface flags
1139 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1140 * on this virtual interface to avoid unnecessary CPU wakeups
1141 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1142 * monitoring on this virtual interface -- i.e. it can monitor
1143 * connection quality related parameters, such as the RSSI level and
1144 * provide notifications if configured trigger levels are reached.
1146 enum ieee80211_vif_flags
{
1147 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
1148 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
1152 * struct ieee80211_vif - per-interface data
1154 * Data in this structure is continually present for driver
1155 * use during the life of a virtual interface.
1157 * @type: type of this virtual interface
1158 * @bss_conf: BSS configuration for this interface, either our own
1159 * or the BSS we're associated to
1160 * @addr: address of this interface
1161 * @p2p: indicates whether this AP or STA interface is a p2p
1162 * interface, i.e. a GO or p2p-sta respectively
1163 * @csa_active: marks whether a channel switch is going on. Internally it is
1164 * write-protected by sdata_lock and local->mtx so holding either is fine
1166 * @driver_flags: flags/capabilities the driver has for this interface,
1167 * these need to be set (or cleared) when the interface is added
1168 * or, if supported by the driver, the interface type is changed
1169 * at runtime, mac80211 will never touch this field
1170 * @hw_queue: hardware queue for each AC
1171 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1172 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1173 * when it is not assigned. This pointer is RCU-protected due to the TX
1174 * path needing to access it; even though the netdev carrier will always
1175 * be off when it is %NULL there can still be races and packets could be
1176 * processed after it switches back to %NULL.
1177 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1178 * interface debug files. Note that it will be NULL for the virtual
1179 * monitor interface (if that is requested.)
1180 * @drv_priv: data area for driver use, will always be aligned to
1183 struct ieee80211_vif
{
1184 enum nl80211_iftype type
;
1185 struct ieee80211_bss_conf bss_conf
;
1191 u8 hw_queue
[IEEE80211_NUM_ACS
];
1193 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1197 #ifdef CONFIG_MAC80211_DEBUGFS
1198 struct dentry
*debugfs_dir
;
1202 u8 drv_priv
[0] __aligned(sizeof(void *));
1205 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1207 #ifdef CONFIG_MAC80211_MESH
1208 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1214 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1215 * @wdev: the wdev to get the vif for
1217 * This can be used by mac80211 drivers with direct cfg80211 APIs
1218 * (like the vendor commands) that get a wdev.
1220 * Note that this function may return %NULL if the given wdev isn't
1221 * associated with a vif that the driver knows about (e.g. monitor
1222 * or AP_VLAN interfaces.)
1224 struct ieee80211_vif
*wdev_to_ieee80211_vif(struct wireless_dev
*wdev
);
1227 * enum ieee80211_key_flags - key flags
1229 * These flags are used for communication about keys between the driver
1230 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1232 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1233 * driver to indicate that it requires IV generation for this
1234 * particular key. Setting this flag does not necessarily mean that SKBs
1235 * will have sufficient tailroom for ICV or MIC.
1236 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1237 * the driver for a TKIP key if it requires Michael MIC
1238 * generation in software.
1239 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1240 * that the key is pairwise rather then a shared key.
1241 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1242 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1243 * be done in software.
1244 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1245 * if space should be prepared for the IV, but the IV
1246 * itself should not be generated. Do not set together with
1247 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1248 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1250 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1251 * management frames. The flag can help drivers that have a hardware
1252 * crypto implementation that doesn't deal with management frames
1253 * properly by allowing them to not upload the keys to hardware and
1254 * fall back to software crypto. Note that this flag deals only with
1255 * RX, if your crypto engine can't deal with TX you can also set the
1256 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1257 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1258 * driver for a CCMP key to indicate that is requires IV generation
1259 * only for managment frames (MFP).
1261 enum ieee80211_key_flags
{
1262 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT
= BIT(0),
1263 IEEE80211_KEY_FLAG_GENERATE_IV
= BIT(1),
1264 IEEE80211_KEY_FLAG_GENERATE_MMIC
= BIT(2),
1265 IEEE80211_KEY_FLAG_PAIRWISE
= BIT(3),
1266 IEEE80211_KEY_FLAG_SW_MGMT_TX
= BIT(4),
1267 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= BIT(5),
1268 IEEE80211_KEY_FLAG_RX_MGMT
= BIT(6),
1272 * struct ieee80211_key_conf - key information
1274 * This key information is given by mac80211 to the driver by
1275 * the set_key() callback in &struct ieee80211_ops.
1277 * @hw_key_idx: To be set by the driver, this is the key index the driver
1278 * wants to be given when a frame is transmitted and needs to be
1279 * encrypted in hardware.
1280 * @cipher: The key's cipher suite selector.
1281 * @flags: key flags, see &enum ieee80211_key_flags.
1282 * @keyidx: the key index (0-3)
1283 * @keylen: key material length
1284 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1286 * - Temporal Encryption Key (128 bits)
1287 * - Temporal Authenticator Tx MIC Key (64 bits)
1288 * - Temporal Authenticator Rx MIC Key (64 bits)
1289 * @icv_len: The ICV length for this key type
1290 * @iv_len: The IV length for this key type
1292 struct ieee80211_key_conf
{
1304 * struct ieee80211_cipher_scheme - cipher scheme
1306 * This structure contains a cipher scheme information defining
1307 * the secure packet crypto handling.
1309 * @cipher: a cipher suite selector
1310 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1311 * @hdr_len: a length of a security header used the cipher
1312 * @pn_len: a length of a packet number in the security header
1313 * @pn_off: an offset of pn from the beginning of the security header
1314 * @key_idx_off: an offset of key index byte in the security header
1315 * @key_idx_mask: a bit mask of key_idx bits
1316 * @key_idx_shift: a bit shift needed to get key_idx
1317 * key_idx value calculation:
1318 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1319 * @mic_len: a mic length in bytes
1321 struct ieee80211_cipher_scheme
{
1334 * enum set_key_cmd - key command
1336 * Used with the set_key() callback in &struct ieee80211_ops, this
1337 * indicates whether a key is being removed or added.
1339 * @SET_KEY: a key is set
1340 * @DISABLE_KEY: a key must be disabled
1343 SET_KEY
, DISABLE_KEY
,
1347 * enum ieee80211_sta_state - station state
1349 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1350 * this is a special state for add/remove transitions
1351 * @IEEE80211_STA_NONE: station exists without special state
1352 * @IEEE80211_STA_AUTH: station is authenticated
1353 * @IEEE80211_STA_ASSOC: station is associated
1354 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1356 enum ieee80211_sta_state
{
1357 /* NOTE: These need to be ordered correctly! */
1358 IEEE80211_STA_NOTEXIST
,
1361 IEEE80211_STA_ASSOC
,
1362 IEEE80211_STA_AUTHORIZED
,
1366 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1367 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1368 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1369 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1370 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1371 * (including 80+80 MHz)
1373 * Implementation note: 20 must be zero to be initialized
1374 * correctly, the values must be sorted.
1376 enum ieee80211_sta_rx_bandwidth
{
1377 IEEE80211_STA_RX_BW_20
= 0,
1378 IEEE80211_STA_RX_BW_40
,
1379 IEEE80211_STA_RX_BW_80
,
1380 IEEE80211_STA_RX_BW_160
,
1384 * struct ieee80211_sta_rates - station rate selection table
1386 * @rcu_head: RCU head used for freeing the table on update
1387 * @rate: transmit rates/flags to be used by default.
1388 * Overriding entries per-packet is possible by using cb tx control.
1390 struct ieee80211_sta_rates
{
1391 struct rcu_head rcu_head
;
1398 } rate
[IEEE80211_TX_RATE_TABLE_SIZE
];
1402 * struct ieee80211_sta - station table entry
1404 * A station table entry represents a station we are possibly
1405 * communicating with. Since stations are RCU-managed in
1406 * mac80211, any ieee80211_sta pointer you get access to must
1407 * either be protected by rcu_read_lock() explicitly or implicitly,
1408 * or you must take good care to not use such a pointer after a
1409 * call to your sta_remove callback that removed it.
1411 * @addr: MAC address
1412 * @aid: AID we assigned to the station if we're an AP
1413 * @supp_rates: Bitmap of supported rates (per band)
1414 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1415 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1416 * @wme: indicates whether the STA supports QoS/WME.
1417 * @drv_priv: data area for driver use, will always be aligned to
1418 * sizeof(void *), size is determined in hw information.
1419 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1420 * if wme is supported.
1421 * @max_sp: max Service Period. Only valid if wme is supported.
1422 * @bandwidth: current bandwidth the station can receive with
1423 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1424 * station can receive at the moment, changed by operating mode
1425 * notifications and capabilities. The value is only valid after
1426 * the station moves to associated state.
1427 * @smps_mode: current SMPS mode (off, static or dynamic)
1428 * @rates: rate control selection table
1429 * @tdls: indicates whether the STA is a TDLS peer
1430 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1431 * valid if the STA is a TDLS peer in the first place.
1433 struct ieee80211_sta
{
1434 u32 supp_rates
[IEEE80211_NUM_BANDS
];
1437 struct ieee80211_sta_ht_cap ht_cap
;
1438 struct ieee80211_sta_vht_cap vht_cap
;
1443 enum ieee80211_sta_rx_bandwidth bandwidth
;
1444 enum ieee80211_smps_mode smps_mode
;
1445 struct ieee80211_sta_rates __rcu
*rates
;
1447 bool tdls_initiator
;
1450 u8 drv_priv
[0] __aligned(sizeof(void *));
1454 * enum sta_notify_cmd - sta notify command
1456 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1457 * indicates if an associated station made a power state transition.
1459 * @STA_NOTIFY_SLEEP: a station is now sleeping
1460 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1462 enum sta_notify_cmd
{
1463 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1467 * struct ieee80211_tx_control - TX control data
1469 * @sta: station table entry, this sta pointer may be NULL and
1470 * it is not allowed to copy the pointer, due to RCU.
1472 struct ieee80211_tx_control
{
1473 struct ieee80211_sta
*sta
;
1477 * enum ieee80211_hw_flags - hardware flags
1479 * These flags are used to indicate hardware capabilities to
1480 * the stack. Generally, flags here should have their meaning
1481 * done in a way that the simplest hardware doesn't need setting
1482 * any particular flags. There are some exceptions to this rule,
1483 * however, so you are advised to review these flags carefully.
1485 * @IEEE80211_HW_HAS_RATE_CONTROL:
1486 * The hardware or firmware includes rate control, and cannot be
1487 * controlled by the stack. As such, no rate control algorithm
1488 * should be instantiated, and the TX rate reported to userspace
1489 * will be taken from the TX status instead of the rate control
1491 * Note that this requires that the driver implement a number of
1492 * callbacks so it has the correct information, it needs to have
1493 * the @set_rts_threshold callback and must look at the BSS config
1494 * @use_cts_prot for G/N protection, @use_short_slot for slot
1495 * timing in 2.4 GHz and @use_short_preamble for preambles for
1498 * @IEEE80211_HW_RX_INCLUDES_FCS:
1499 * Indicates that received frames passed to the stack include
1500 * the FCS at the end.
1502 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1503 * Some wireless LAN chipsets buffer broadcast/multicast frames
1504 * for power saving stations in the hardware/firmware and others
1505 * rely on the host system for such buffering. This option is used
1506 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1507 * multicast frames when there are power saving stations so that
1508 * the driver can fetch them with ieee80211_get_buffered_bc().
1510 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1511 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1513 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1514 * Hardware is not capable of receiving frames with short preamble on
1517 * @IEEE80211_HW_SIGNAL_UNSPEC:
1518 * Hardware can provide signal values but we don't know its units. We
1519 * expect values between 0 and @max_signal.
1520 * If possible please provide dB or dBm instead.
1522 * @IEEE80211_HW_SIGNAL_DBM:
1523 * Hardware gives signal values in dBm, decibel difference from
1524 * one milliwatt. This is the preferred method since it is standardized
1525 * between different devices. @max_signal does not need to be set.
1527 * @IEEE80211_HW_SPECTRUM_MGMT:
1528 * Hardware supports spectrum management defined in 802.11h
1529 * Measurement, Channel Switch, Quieting, TPC
1531 * @IEEE80211_HW_AMPDU_AGGREGATION:
1532 * Hardware supports 11n A-MPDU aggregation.
1534 * @IEEE80211_HW_SUPPORTS_PS:
1535 * Hardware has power save support (i.e. can go to sleep).
1537 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1538 * Hardware requires nullfunc frame handling in stack, implies
1539 * stack support for dynamic PS.
1541 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1542 * Hardware has support for dynamic PS.
1544 * @IEEE80211_HW_MFP_CAPABLE:
1545 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1547 * @IEEE80211_HW_SUPPORTS_UAPSD:
1548 * Hardware supports Unscheduled Automatic Power Save Delivery
1549 * (U-APSD) in managed mode. The mode is configured with
1550 * conf_tx() operation.
1552 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1553 * Hardware can provide ack status reports of Tx frames to
1556 * @IEEE80211_HW_CONNECTION_MONITOR:
1557 * The hardware performs its own connection monitoring, including
1558 * periodic keep-alives to the AP and probing the AP on beacon loss.
1560 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1561 * This device needs to get data from beacon before association (i.e.
1564 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1565 * per-station GTKs as used by IBSS RSN or during fast transition. If
1566 * the device doesn't support per-station GTKs, but can be asked not
1567 * to decrypt group addressed frames, then IBSS RSN support is still
1568 * possible but software crypto will be used. Advertise the wiphy flag
1569 * only in that case.
1571 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1572 * autonomously manages the PS status of connected stations. When
1573 * this flag is set mac80211 will not trigger PS mode for connected
1574 * stations based on the PM bit of incoming frames.
1575 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1576 * the PS mode of connected stations.
1578 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1579 * setup strictly in HW. mac80211 should not attempt to do this in
1582 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1583 * a virtual monitor interface when monitor interfaces are the only
1584 * active interfaces.
1586 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1587 * be created. It is expected user-space will create vifs as
1588 * desired (and thus have them named as desired).
1590 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1591 * queue mapping in order to use different queues (not just one per AC)
1592 * for different virtual interfaces. See the doc section on HW queue
1593 * control for more details.
1595 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1596 * selection table provided by the rate control algorithm.
1598 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1599 * P2P Interface. This will be honoured even if more than one interface
1602 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1603 * only, to allow getting TBTT of a DTIM beacon.
1605 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1606 * and can cope with CCK rates in an aggregation session (e.g. by not
1607 * using aggregation for such frames.)
1609 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1610 * for a single active channel while using channel contexts. When support
1611 * is not enabled the default action is to disconnect when getting the
1614 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1615 * or tailroom of TX skbs without copying them first.
1617 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1618 * in one command, mac80211 doesn't have to run separate scans per band.
1620 enum ieee80211_hw_flags
{
1621 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1622 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1623 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1624 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1625 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1626 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1627 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1628 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC
= 1<<7,
1629 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1630 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1631 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1632 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1633 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1634 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1635 IEEE80211_HW_WANT_MONITOR_VIF
= 1<<14,
1636 IEEE80211_HW_NO_AUTO_VIF
= 1<<15,
1638 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1639 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1640 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1641 IEEE80211_HW_QUEUE_CONTROL
= 1<<20,
1642 IEEE80211_HW_SUPPORTS_PER_STA_GTK
= 1<<21,
1643 IEEE80211_HW_AP_LINK_PS
= 1<<22,
1644 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
= 1<<23,
1645 IEEE80211_HW_SUPPORTS_RC_TABLE
= 1<<24,
1646 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
= 1<<25,
1647 IEEE80211_HW_TIMING_BEACON_ONLY
= 1<<26,
1648 IEEE80211_HW_SUPPORTS_HT_CCK_RATES
= 1<<27,
1649 IEEE80211_HW_CHANCTX_STA_CSA
= 1<<28,
1650 IEEE80211_HW_SUPPORTS_CLONED_SKBS
= 1<<29,
1651 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS
= 1<<30,
1655 * struct ieee80211_hw - hardware information and state
1657 * This structure contains the configuration and hardware
1658 * information for an 802.11 PHY.
1660 * @wiphy: This points to the &struct wiphy allocated for this
1661 * 802.11 PHY. You must fill in the @perm_addr and @dev
1662 * members of this structure using SET_IEEE80211_DEV()
1663 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1664 * bands (with channels, bitrates) are registered here.
1666 * @conf: &struct ieee80211_conf, device configuration, don't use.
1668 * @priv: pointer to private area that was allocated for driver use
1669 * along with this structure.
1671 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1673 * @extra_tx_headroom: headroom to reserve in each transmit skb
1674 * for use by the driver (e.g. for transmit headers.)
1676 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1677 * Can be used by drivers to add extra IEs.
1679 * @max_signal: Maximum value for signal (rssi) in RX information, used
1680 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1682 * @max_listen_interval: max listen interval in units of beacon interval
1685 * @queues: number of available hardware transmit queues for
1686 * data packets. WMM/QoS requires at least four, these
1687 * queues need to have configurable access parameters.
1689 * @rate_control_algorithm: rate control algorithm for this hardware.
1690 * If unset (NULL), the default algorithm will be used. Must be
1691 * set before calling ieee80211_register_hw().
1693 * @vif_data_size: size (in bytes) of the drv_priv data area
1694 * within &struct ieee80211_vif.
1695 * @sta_data_size: size (in bytes) of the drv_priv data area
1696 * within &struct ieee80211_sta.
1697 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1698 * within &struct ieee80211_chanctx_conf.
1700 * @max_rates: maximum number of alternate rate retry stages the hw
1702 * @max_report_rates: maximum number of alternate rate retry stages
1703 * the hw can report back.
1704 * @max_rate_tries: maximum number of tries for each stage
1706 * @max_rx_aggregation_subframes: maximum buffer size (number of
1707 * sub-frames) to be used for A-MPDU block ack receiver
1709 * This is only relevant if the device has restrictions on the
1710 * number of subframes, if it relies on mac80211 to do reordering
1711 * it shouldn't be set.
1713 * @max_tx_aggregation_subframes: maximum number of subframes in an
1714 * aggregate an HT driver will transmit, used by the peer as a
1715 * hint to size its reorder buffer.
1717 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1718 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1720 * @radiotap_mcs_details: lists which MCS information can the HW
1721 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1722 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1723 * adding _BW is supported today.
1725 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1726 * the default is _GI | _BANDWIDTH.
1727 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1729 * @netdev_features: netdev features to be set in each netdev created
1730 * from this HW. Note only HW checksum features are currently
1731 * compatible with mac80211. Other feature bits will be rejected.
1733 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1734 * for each access category if it is uAPSD trigger-enabled and delivery-
1735 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1736 * Each bit corresponds to different AC. Value '1' in specific bit means
1737 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1740 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1741 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1742 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1744 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1745 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1748 struct ieee80211_hw
{
1749 struct ieee80211_conf conf
;
1750 struct wiphy
*wiphy
;
1751 const char *rate_control_algorithm
;
1754 unsigned int extra_tx_headroom
;
1755 unsigned int extra_beacon_tailroom
;
1758 int chanctx_data_size
;
1760 u16 max_listen_interval
;
1763 u8 max_report_rates
;
1765 u8 max_rx_aggregation_subframes
;
1766 u8 max_tx_aggregation_subframes
;
1767 u8 offchannel_tx_hw_queue
;
1768 u8 radiotap_mcs_details
;
1769 u16 radiotap_vht_details
;
1770 netdev_features_t netdev_features
;
1772 u8 uapsd_max_sp_len
;
1773 u8 n_cipher_schemes
;
1774 const struct ieee80211_cipher_scheme
*cipher_schemes
;
1778 * struct ieee80211_scan_request - hw scan request
1780 * @ies: pointers different parts of IEs (in req.ie)
1781 * @req: cfg80211 request.
1783 struct ieee80211_scan_request
{
1784 struct ieee80211_scan_ies ies
;
1787 struct cfg80211_scan_request req
;
1791 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1793 * @wiphy: the &struct wiphy which we want to query
1795 * mac80211 drivers can use this to get to their respective
1796 * &struct ieee80211_hw. Drivers wishing to get to their own private
1797 * structure can then access it via hw->priv. Note that mac802111 drivers should
1798 * not use wiphy_priv() to try to get their private driver structure as this
1799 * is already used internally by mac80211.
1801 * Return: The mac80211 driver hw struct of @wiphy.
1803 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1806 * SET_IEEE80211_DEV - set device for 802.11 hardware
1808 * @hw: the &struct ieee80211_hw to set the device for
1809 * @dev: the &struct device of this 802.11 device
1811 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1813 set_wiphy_dev(hw
->wiphy
, dev
);
1817 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1819 * @hw: the &struct ieee80211_hw to set the MAC address for
1820 * @addr: the address to set
1822 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1824 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1827 static inline struct ieee80211_rate
*
1828 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1829 const struct ieee80211_tx_info
*c
)
1831 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
1833 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1836 static inline struct ieee80211_rate
*
1837 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1838 const struct ieee80211_tx_info
*c
)
1840 if (c
->control
.rts_cts_rate_idx
< 0)
1842 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1845 static inline struct ieee80211_rate
*
1846 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1847 const struct ieee80211_tx_info
*c
, int idx
)
1849 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1851 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1855 * ieee80211_free_txskb - free TX skb
1859 * Free a transmit skb. Use this funtion when some failure
1860 * to transmit happened and thus status cannot be reported.
1862 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1865 * DOC: Hardware crypto acceleration
1867 * mac80211 is capable of taking advantage of many hardware
1868 * acceleration designs for encryption and decryption operations.
1870 * The set_key() callback in the &struct ieee80211_ops for a given
1871 * device is called to enable hardware acceleration of encryption and
1872 * decryption. The callback takes a @sta parameter that will be NULL
1873 * for default keys or keys used for transmission only, or point to
1874 * the station information for the peer for individual keys.
1875 * Multiple transmission keys with the same key index may be used when
1876 * VLANs are configured for an access point.
1878 * When transmitting, the TX control data will use the @hw_key_idx
1879 * selected by the driver by modifying the &struct ieee80211_key_conf
1880 * pointed to by the @key parameter to the set_key() function.
1882 * The set_key() call for the %SET_KEY command should return 0 if
1883 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1884 * added; if you return 0 then hw_key_idx must be assigned to the
1885 * hardware key index, you are free to use the full u8 range.
1887 * When the cmd is %DISABLE_KEY then it must succeed.
1889 * Note that it is permissible to not decrypt a frame even if a key
1890 * for it has been uploaded to hardware, the stack will not make any
1891 * decision based on whether a key has been uploaded or not but rather
1892 * based on the receive flags.
1894 * The &struct ieee80211_key_conf structure pointed to by the @key
1895 * parameter is guaranteed to be valid until another call to set_key()
1896 * removes it, but it can only be used as a cookie to differentiate
1899 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1900 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1902 * The update_tkip_key() call updates the driver with the new phase 1 key.
1903 * This happens every time the iv16 wraps around (every 65536 packets). The
1904 * set_key() call will happen only once for each key (unless the AP did
1905 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1906 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1907 * handler is software decryption with wrap around of iv16.
1909 * The set_default_unicast_key() call updates the default WEP key index
1910 * configured to the hardware for WEP encryption type. This is required
1911 * for devices that support offload of data packets (e.g. ARP responses).
1915 * DOC: Powersave support
1917 * mac80211 has support for various powersave implementations.
1919 * First, it can support hardware that handles all powersaving by itself,
1920 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1921 * flag. In that case, it will be told about the desired powersave mode
1922 * with the %IEEE80211_CONF_PS flag depending on the association status.
1923 * The hardware must take care of sending nullfunc frames when necessary,
1924 * i.e. when entering and leaving powersave mode. The hardware is required
1925 * to look at the AID in beacons and signal to the AP that it woke up when
1926 * it finds traffic directed to it.
1928 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1929 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1930 * with hardware wakeup and sleep states. Driver is responsible for waking
1931 * up the hardware before issuing commands to the hardware and putting it
1932 * back to sleep at appropriate times.
1934 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1935 * buffered multicast/broadcast frames after the beacon. Also it must be
1936 * possible to send frames and receive the acknowledment frame.
1938 * Other hardware designs cannot send nullfunc frames by themselves and also
1939 * need software support for parsing the TIM bitmap. This is also supported
1940 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1941 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1942 * required to pass up beacons. The hardware is still required to handle
1943 * waking up for multicast traffic; if it cannot the driver must handle that
1944 * as best as it can, mac80211 is too slow to do that.
1946 * Dynamic powersave is an extension to normal powersave in which the
1947 * hardware stays awake for a user-specified period of time after sending a
1948 * frame so that reply frames need not be buffered and therefore delayed to
1949 * the next wakeup. It's compromise of getting good enough latency when
1950 * there's data traffic and still saving significantly power in idle
1953 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1954 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1955 * flag and mac80211 will handle everything automatically. Additionally,
1956 * hardware having support for the dynamic PS feature may set the
1957 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1958 * dynamic PS mode itself. The driver needs to look at the
1959 * @dynamic_ps_timeout hardware configuration value and use it that value
1960 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1961 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1962 * enabled whenever user has enabled powersave.
1964 * Driver informs U-APSD client support by enabling
1965 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1966 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
1967 * Nullfunc frames and stay awake until the service period has ended. To
1968 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1969 * from that AC are transmitted with powersave enabled.
1971 * Note: U-APSD client mode is not yet supported with
1972 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1976 * DOC: Beacon filter support
1978 * Some hardware have beacon filter support to reduce host cpu wakeups
1979 * which will reduce system power consumption. It usually works so that
1980 * the firmware creates a checksum of the beacon but omits all constantly
1981 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1982 * beacon is forwarded to the host, otherwise it will be just dropped. That
1983 * way the host will only receive beacons where some relevant information
1984 * (for example ERP protection or WMM settings) have changed.
1986 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1987 * interface capability. The driver needs to enable beacon filter support
1988 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1989 * power save is enabled, the stack will not check for beacon loss and the
1990 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1992 * The time (or number of beacons missed) until the firmware notifies the
1993 * driver of a beacon loss event (which in turn causes the driver to call
1994 * ieee80211_beacon_loss()) should be configurable and will be controlled
1995 * by mac80211 and the roaming algorithm in the future.
1997 * Since there may be constantly changing information elements that nothing
1998 * in the software stack cares about, we will, in the future, have mac80211
1999 * tell the driver which information elements are interesting in the sense
2000 * that we want to see changes in them. This will include
2001 * - a list of information element IDs
2002 * - a list of OUIs for the vendor information element
2004 * Ideally, the hardware would filter out any beacons without changes in the
2005 * requested elements, but if it cannot support that it may, at the expense
2006 * of some efficiency, filter out only a subset. For example, if the device
2007 * doesn't support checking for OUIs it should pass up all changes in all
2008 * vendor information elements.
2010 * Note that change, for the sake of simplification, also includes information
2011 * elements appearing or disappearing from the beacon.
2013 * Some hardware supports an "ignore list" instead, just make sure nothing
2014 * that was requested is on the ignore list, and include commonly changing
2015 * information element IDs in the ignore list, for example 11 (BSS load) and
2016 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2017 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2018 * it could also include some currently unused IDs.
2021 * In addition to these capabilities, hardware should support notifying the
2022 * host of changes in the beacon RSSI. This is relevant to implement roaming
2023 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2024 * the received data packets). This can consist in notifying the host when
2025 * the RSSI changes significantly or when it drops below or rises above
2026 * configurable thresholds. In the future these thresholds will also be
2027 * configured by mac80211 (which gets them from userspace) to implement
2028 * them as the roaming algorithm requires.
2030 * If the hardware cannot implement this, the driver should ask it to
2031 * periodically pass beacon frames to the host so that software can do the
2032 * signal strength threshold checking.
2036 * DOC: Spatial multiplexing power save
2038 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2039 * power in an 802.11n implementation. For details on the mechanism
2040 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2041 * "11.2.3 SM power save".
2043 * The mac80211 implementation is capable of sending action frames
2044 * to update the AP about the station's SMPS mode, and will instruct
2045 * the driver to enter the specific mode. It will also announce the
2046 * requested SMPS mode during the association handshake. Hardware
2047 * support for this feature is required, and can be indicated by
2050 * The default mode will be "automatic", which nl80211/cfg80211
2051 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2052 * turned off otherwise.
2054 * To support this feature, the driver must set the appropriate
2055 * hardware support flags, and handle the SMPS flag to the config()
2056 * operation. It will then with this mechanism be instructed to
2057 * enter the requested SMPS mode while associated to an HT AP.
2061 * DOC: Frame filtering
2063 * mac80211 requires to see many management frames for proper
2064 * operation, and users may want to see many more frames when
2065 * in monitor mode. However, for best CPU usage and power consumption,
2066 * having as few frames as possible percolate through the stack is
2067 * desirable. Hence, the hardware should filter as much as possible.
2069 * To achieve this, mac80211 uses filter flags (see below) to tell
2070 * the driver's configure_filter() function which frames should be
2071 * passed to mac80211 and which should be filtered out.
2073 * Before configure_filter() is invoked, the prepare_multicast()
2074 * callback is invoked with the parameters @mc_count and @mc_list
2075 * for the combined multicast address list of all virtual interfaces.
2076 * It's use is optional, and it returns a u64 that is passed to
2077 * configure_filter(). Additionally, configure_filter() has the
2078 * arguments @changed_flags telling which flags were changed and
2079 * @total_flags with the new flag states.
2081 * If your device has no multicast address filters your driver will
2082 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2083 * parameter to see whether multicast frames should be accepted
2086 * All unsupported flags in @total_flags must be cleared.
2087 * Hardware does not support a flag if it is incapable of _passing_
2088 * the frame to the stack. Otherwise the driver must ignore
2089 * the flag, but not clear it.
2090 * You must _only_ clear the flag (announce no support for the
2091 * flag to mac80211) if you are not able to pass the packet type
2092 * to the stack (so the hardware always filters it).
2093 * So for example, you should clear @FIF_CONTROL, if your hardware
2094 * always filters control frames. If your hardware always passes
2095 * control frames to the kernel and is incapable of filtering them,
2096 * you do _not_ clear the @FIF_CONTROL flag.
2097 * This rule applies to all other FIF flags as well.
2101 * DOC: AP support for powersaving clients
2103 * In order to implement AP and P2P GO modes, mac80211 has support for
2104 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2105 * There currently is no support for sAPSD.
2107 * There is one assumption that mac80211 makes, namely that a client
2108 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2109 * Both are supported, and both can be used by the same client, but
2110 * they can't be used concurrently by the same client. This simplifies
2113 * The first thing to keep in mind is that there is a flag for complete
2114 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2115 * mac80211 expects the driver to handle most of the state machine for
2116 * powersaving clients and will ignore the PM bit in incoming frames.
2117 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2118 * stations' powersave transitions. In this mode, mac80211 also doesn't
2119 * handle PS-Poll/uAPSD.
2121 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2122 * PM bit in incoming frames for client powersave transitions. When a
2123 * station goes to sleep, we will stop transmitting to it. There is,
2124 * however, a race condition: a station might go to sleep while there is
2125 * data buffered on hardware queues. If the device has support for this
2126 * it will reject frames, and the driver should give the frames back to
2127 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2128 * cause mac80211 to retry the frame when the station wakes up. The
2129 * driver is also notified of powersave transitions by calling its
2130 * @sta_notify callback.
2132 * When the station is asleep, it has three choices: it can wake up,
2133 * it can PS-Poll, or it can possibly start a uAPSD service period.
2134 * Waking up is implemented by simply transmitting all buffered (and
2135 * filtered) frames to the station. This is the easiest case. When
2136 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2137 * will inform the driver of this with the @allow_buffered_frames
2138 * callback; this callback is optional. mac80211 will then transmit
2139 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2140 * on each frame. The last frame in the service period (or the only
2141 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2142 * indicate that it ends the service period; as this frame must have
2143 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2144 * When TX status is reported for this frame, the service period is
2145 * marked has having ended and a new one can be started by the peer.
2147 * Additionally, non-bufferable MMPDUs can also be transmitted by
2148 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2150 * Another race condition can happen on some devices like iwlwifi
2151 * when there are frames queued for the station and it wakes up
2152 * or polls; the frames that are already queued could end up being
2153 * transmitted first instead, causing reordering and/or wrong
2154 * processing of the EOSP. The cause is that allowing frames to be
2155 * transmitted to a certain station is out-of-band communication to
2156 * the device. To allow this problem to be solved, the driver can
2157 * call ieee80211_sta_block_awake() if frames are buffered when it
2158 * is notified that the station went to sleep. When all these frames
2159 * have been filtered (see above), it must call the function again
2160 * to indicate that the station is no longer blocked.
2162 * If the driver buffers frames in the driver for aggregation in any
2163 * way, it must use the ieee80211_sta_set_buffered() call when it is
2164 * notified of the station going to sleep to inform mac80211 of any
2165 * TIDs that have frames buffered. Note that when a station wakes up
2166 * this information is reset (hence the requirement to call it when
2167 * informed of the station going to sleep). Then, when a service
2168 * period starts for any reason, @release_buffered_frames is called
2169 * with the number of frames to be released and which TIDs they are
2170 * to come from. In this case, the driver is responsible for setting
2171 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2172 * to help the @more_data parameter is passed to tell the driver if
2173 * there is more data on other TIDs -- the TIDs to release frames
2174 * from are ignored since mac80211 doesn't know how many frames the
2175 * buffers for those TIDs contain.
2177 * If the driver also implement GO mode, where absence periods may
2178 * shorten service periods (or abort PS-Poll responses), it must
2179 * filter those response frames except in the case of frames that
2180 * are buffered in the driver -- those must remain buffered to avoid
2181 * reordering. Because it is possible that no frames are released
2182 * in this case, the driver must call ieee80211_sta_eosp()
2183 * to indicate to mac80211 that the service period ended anyway.
2185 * Finally, if frames from multiple TIDs are released from mac80211
2186 * but the driver might reorder them, it must clear & set the flags
2187 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2188 * and also take care of the EOSP and MORE_DATA bits in the frame.
2189 * The driver may also use ieee80211_sta_eosp() in this case.
2191 * Note that if the driver ever buffers frames other than QoS-data
2192 * frames, it must take care to never send a non-QoS-data frame as
2193 * the last frame in a service period, adding a QoS-nulldata frame
2194 * after a non-QoS-data frame if needed.
2198 * DOC: HW queue control
2200 * Before HW queue control was introduced, mac80211 only had a single static
2201 * assignment of per-interface AC software queues to hardware queues. This
2202 * was problematic for a few reasons:
2203 * 1) off-channel transmissions might get stuck behind other frames
2204 * 2) multiple virtual interfaces couldn't be handled correctly
2205 * 3) after-DTIM frames could get stuck behind other frames
2207 * To solve this, hardware typically uses multiple different queues for all
2208 * the different usages, and this needs to be propagated into mac80211 so it
2209 * won't have the same problem with the software queues.
2211 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2212 * flag that tells it that the driver implements its own queue control. To do
2213 * so, the driver will set up the various queues in each &struct ieee80211_vif
2214 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2215 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2216 * if necessary will queue the frame on the right software queue that mirrors
2217 * the hardware queue.
2218 * Additionally, the driver has to then use these HW queue IDs for the queue
2219 * management functions (ieee80211_stop_queue() et al.)
2221 * The driver is free to set up the queue mappings as needed, multiple virtual
2222 * interfaces may map to the same hardware queues if needed. The setup has to
2223 * happen during add_interface or change_interface callbacks. For example, a
2224 * driver supporting station+station and station+AP modes might decide to have
2225 * 10 hardware queues to handle different scenarios:
2227 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2228 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2229 * after-DTIM queue for AP: 8
2230 * off-channel queue: 9
2232 * It would then set up the hardware like this:
2233 * hw.offchannel_tx_hw_queue = 9
2235 * and the first virtual interface that is added as follows:
2236 * vif.hw_queue[IEEE80211_AC_VO] = 0
2237 * vif.hw_queue[IEEE80211_AC_VI] = 1
2238 * vif.hw_queue[IEEE80211_AC_BE] = 2
2239 * vif.hw_queue[IEEE80211_AC_BK] = 3
2240 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2241 * and the second virtual interface with 4-7.
2243 * If queue 6 gets full, for example, mac80211 would only stop the second
2244 * virtual interface's BE queue since virtual interface queues are per AC.
2246 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2247 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2248 * queue could potentially be shared since mac80211 will look at cab_queue when
2249 * a queue is stopped/woken even if the interface is not in AP mode.
2253 * enum ieee80211_filter_flags - hardware filter flags
2255 * These flags determine what the filter in hardware should be
2256 * programmed to let through and what should not be passed to the
2257 * stack. It is always safe to pass more frames than requested,
2258 * but this has negative impact on power consumption.
2260 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2261 * think of the BSS as your network segment and then this corresponds
2262 * to the regular ethernet device promiscuous mode.
2264 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2265 * by the user or if the hardware is not capable of filtering by
2266 * multicast address.
2268 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2269 * %RX_FLAG_FAILED_FCS_CRC for them)
2271 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2272 * the %RX_FLAG_FAILED_PLCP_CRC for them
2274 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2275 * to the hardware that it should not filter beacons or probe responses
2276 * by BSSID. Filtering them can greatly reduce the amount of processing
2277 * mac80211 needs to do and the amount of CPU wakeups, so you should
2278 * honour this flag if possible.
2280 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2281 * is not set then only those addressed to this station.
2283 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2285 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2286 * those addressed to this station.
2288 * @FIF_PROBE_REQ: pass probe request frames
2290 enum ieee80211_filter_flags
{
2291 FIF_PROMISC_IN_BSS
= 1<<0,
2292 FIF_ALLMULTI
= 1<<1,
2294 FIF_PLCPFAIL
= 1<<3,
2295 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
2297 FIF_OTHER_BSS
= 1<<6,
2299 FIF_PROBE_REQ
= 1<<8,
2303 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2305 * These flags are used with the ampdu_action() callback in
2306 * &struct ieee80211_ops to indicate which action is needed.
2308 * Note that drivers MUST be able to deal with a TX aggregation
2309 * session being stopped even before they OK'ed starting it by
2310 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2311 * might receive the addBA frame and send a delBA right away!
2313 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2314 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2315 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2316 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2317 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2318 * queued packets, now unaggregated. After all packets are transmitted the
2319 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2320 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2321 * called when the station is removed. There's no need or reason to call
2322 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2323 * session is gone and removes the station.
2324 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2325 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2326 * now the connection is dropped and the station will be removed. Drivers
2327 * should clean up and drop remaining packets when this is called.
2329 enum ieee80211_ampdu_mlme_action
{
2330 IEEE80211_AMPDU_RX_START
,
2331 IEEE80211_AMPDU_RX_STOP
,
2332 IEEE80211_AMPDU_TX_START
,
2333 IEEE80211_AMPDU_TX_STOP_CONT
,
2334 IEEE80211_AMPDU_TX_STOP_FLUSH
,
2335 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
,
2336 IEEE80211_AMPDU_TX_OPERATIONAL
,
2340 * enum ieee80211_frame_release_type - frame release reason
2341 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2342 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2343 * frame received on trigger-enabled AC
2345 enum ieee80211_frame_release_type
{
2346 IEEE80211_FRAME_RELEASE_PSPOLL
,
2347 IEEE80211_FRAME_RELEASE_UAPSD
,
2351 * enum ieee80211_rate_control_changed - flags to indicate what changed
2353 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2354 * to this station changed. The actual bandwidth is in the station
2355 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2356 * flag changes, for HT and VHT the bandwidth field changes.
2357 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2358 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2359 * changed (in IBSS mode) due to discovering more information about
2361 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2364 enum ieee80211_rate_control_changed
{
2365 IEEE80211_RC_BW_CHANGED
= BIT(0),
2366 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
2367 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
2368 IEEE80211_RC_NSS_CHANGED
= BIT(3),
2372 * enum ieee80211_roc_type - remain on channel type
2374 * With the support for multi channel contexts and multi channel operations,
2375 * remain on channel operations might be limited/deferred/aborted by other
2376 * flows/operations which have higher priority (and vise versa).
2377 * Specifying the ROC type can be used by devices to prioritize the ROC
2378 * operations compared to other operations/flows.
2380 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2381 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2382 * for sending managment frames offchannel.
2384 enum ieee80211_roc_type
{
2385 IEEE80211_ROC_TYPE_NORMAL
= 0,
2386 IEEE80211_ROC_TYPE_MGMT_TX
,
2390 * struct ieee80211_ops - callbacks from mac80211 to the driver
2392 * This structure contains various callbacks that the driver may
2393 * handle or, in some cases, must handle, for example to configure
2394 * the hardware to a new channel or to transmit a frame.
2396 * @tx: Handler that 802.11 module calls for each transmitted frame.
2397 * skb contains the buffer starting from the IEEE 802.11 header.
2398 * The low-level driver should send the frame out based on
2399 * configuration in the TX control data. This handler should,
2400 * preferably, never fail and stop queues appropriately.
2403 * @start: Called before the first netdevice attached to the hardware
2404 * is enabled. This should turn on the hardware and must turn on
2405 * frame reception (for possibly enabled monitor interfaces.)
2406 * Returns negative error codes, these may be seen in userspace,
2408 * When the device is started it should not have a MAC address
2409 * to avoid acknowledging frames before a non-monitor device
2411 * Must be implemented and can sleep.
2413 * @stop: Called after last netdevice attached to the hardware
2414 * is disabled. This should turn off the hardware (at least
2415 * it must turn off frame reception.)
2416 * May be called right after add_interface if that rejects
2417 * an interface. If you added any work onto the mac80211 workqueue
2418 * you should ensure to cancel it on this callback.
2419 * Must be implemented and can sleep.
2421 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2422 * stop transmitting and doing any other configuration, and then
2423 * ask the device to suspend. This is only invoked when WoWLAN is
2424 * configured, otherwise the device is deconfigured completely and
2425 * reconfigured at resume time.
2426 * The driver may also impose special conditions under which it
2427 * wants to use the "normal" suspend (deconfigure), say if it only
2428 * supports WoWLAN when the device is associated. In this case, it
2429 * must return 1 from this function.
2431 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2432 * now resuming its operation, after this the device must be fully
2433 * functional again. If this returns an error, the only way out is
2434 * to also unregister the device. If it returns 1, then mac80211
2435 * will also go through the regular complete restart on resume.
2437 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2438 * modified. The reason is that device_set_wakeup_enable() is
2439 * supposed to be called when the configuration changes, not only
2442 * @add_interface: Called when a netdevice attached to the hardware is
2443 * enabled. Because it is not called for monitor mode devices, @start
2444 * and @stop must be implemented.
2445 * The driver should perform any initialization it needs before
2446 * the device can be enabled. The initial configuration for the
2447 * interface is given in the conf parameter.
2448 * The callback may refuse to add an interface by returning a
2449 * negative error code (which will be seen in userspace.)
2450 * Must be implemented and can sleep.
2452 * @change_interface: Called when a netdevice changes type. This callback
2453 * is optional, but only if it is supported can interface types be
2454 * switched while the interface is UP. The callback may sleep.
2455 * Note that while an interface is being switched, it will not be
2456 * found by the interface iteration callbacks.
2458 * @remove_interface: Notifies a driver that an interface is going down.
2459 * The @stop callback is called after this if it is the last interface
2460 * and no monitor interfaces are present.
2461 * When all interfaces are removed, the MAC address in the hardware
2462 * must be cleared so the device no longer acknowledges packets,
2463 * the mac_addr member of the conf structure is, however, set to the
2464 * MAC address of the device going away.
2465 * Hence, this callback must be implemented. It can sleep.
2467 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2468 * function to change hardware configuration, e.g., channel.
2469 * This function should never fail but returns a negative error code
2470 * if it does. The callback can sleep.
2472 * @bss_info_changed: Handler for configuration requests related to BSS
2473 * parameters that may vary during BSS's lifespan, and may affect low
2474 * level driver (e.g. assoc/disassoc status, erp parameters).
2475 * This function should not be used if no BSS has been set, unless
2476 * for association indication. The @changed parameter indicates which
2477 * of the bss parameters has changed when a call is made. The callback
2480 * @prepare_multicast: Prepare for multicast filter configuration.
2481 * This callback is optional, and its return value is passed
2482 * to configure_filter(). This callback must be atomic.
2484 * @configure_filter: Configure the device's RX filter.
2485 * See the section "Frame filtering" for more information.
2486 * This callback must be implemented and can sleep.
2488 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2489 * must be set or cleared for a given STA. Must be atomic.
2491 * @set_key: See the section "Hardware crypto acceleration"
2492 * This callback is only called between add_interface and
2493 * remove_interface calls, i.e. while the given virtual interface
2495 * Returns a negative error code if the key can't be added.
2496 * The callback can sleep.
2498 * @update_tkip_key: See the section "Hardware crypto acceleration"
2499 * This callback will be called in the context of Rx. Called for drivers
2500 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2501 * The callback must be atomic.
2503 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2504 * host is suspended, it can assign this callback to retrieve the data
2505 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2506 * After rekeying was done it should (for example during resume) notify
2507 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2509 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2510 * WEP when the device sends data packets autonomously, e.g. for ARP
2511 * offloading. The index can be 0-3, or -1 for unsetting it.
2513 * @hw_scan: Ask the hardware to service the scan request, no need to start
2514 * the scan state machine in stack. The scan must honour the channel
2515 * configuration done by the regulatory agent in the wiphy's
2516 * registered bands. The hardware (or the driver) needs to make sure
2517 * that power save is disabled.
2518 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2519 * entire IEs after the SSID, so that drivers need not look at these
2520 * at all but just send them after the SSID -- mac80211 includes the
2521 * (extended) supported rates and HT information (where applicable).
2522 * When the scan finishes, ieee80211_scan_completed() must be called;
2523 * note that it also must be called when the scan cannot finish due to
2524 * any error unless this callback returned a negative error code.
2525 * The callback can sleep.
2527 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2528 * The driver should ask the hardware to cancel the scan (if possible),
2529 * but the scan will be completed only after the driver will call
2530 * ieee80211_scan_completed().
2531 * This callback is needed for wowlan, to prevent enqueueing a new
2532 * scan_work after the low-level driver was already suspended.
2533 * The callback can sleep.
2535 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2536 * specific intervals. The driver must call the
2537 * ieee80211_sched_scan_results() function whenever it finds results.
2538 * This process will continue until sched_scan_stop is called.
2540 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2541 * In this case, ieee80211_sched_scan_stopped() must not be called.
2543 * @sw_scan_start: Notifier function that is called just before a software scan
2544 * is started. Can be NULL, if the driver doesn't need this notification.
2545 * The callback can sleep.
2547 * @sw_scan_complete: Notifier function that is called just after a
2548 * software scan finished. Can be NULL, if the driver doesn't need
2549 * this notification.
2550 * The callback can sleep.
2552 * @get_stats: Return low-level statistics.
2553 * Returns zero if statistics are available.
2554 * The callback can sleep.
2556 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2557 * callback should be provided to read the TKIP transmit IVs (both IV32
2558 * and IV16) for the given key from hardware.
2559 * The callback must be atomic.
2561 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2562 * if the device does fragmentation by itself; if this callback is
2563 * implemented then the stack will not do fragmentation.
2564 * The callback can sleep.
2566 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2567 * The callback can sleep.
2569 * @sta_add: Notifies low level driver about addition of an associated station,
2570 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2572 * @sta_remove: Notifies low level driver about removal of an associated
2573 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2574 * returns it isn't safe to use the pointer, not even RCU protected;
2575 * no RCU grace period is guaranteed between returning here and freeing
2576 * the station. See @sta_pre_rcu_remove if needed.
2577 * This callback can sleep.
2579 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2580 * when a station is added to mac80211's station list. This callback
2581 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2582 * conditional. This callback can sleep.
2584 * @sta_remove_debugfs: Remove the debugfs files which were added using
2585 * @sta_add_debugfs. This callback can sleep.
2587 * @sta_notify: Notifies low level driver about power state transition of an
2588 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2589 * in AP mode, this callback will not be called when the flag
2590 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2592 * @sta_state: Notifies low level driver about state transition of a
2593 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2594 * This callback is mutually exclusive with @sta_add/@sta_remove.
2595 * It must not fail for down transitions but may fail for transitions
2596 * up the list of states. Also note that after the callback returns it
2597 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2598 * period is guaranteed between returning here and freeing the station.
2599 * See @sta_pre_rcu_remove if needed.
2600 * The callback can sleep.
2602 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2603 * synchronisation. This is useful if a driver needs to have station
2604 * pointers protected using RCU, it can then use this call to clear
2605 * the pointers instead of waiting for an RCU grace period to elapse
2607 * The callback can sleep.
2609 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2610 * used to transmit to the station. The changes are advertised with bits
2611 * from &enum ieee80211_rate_control_changed and the values are reflected
2612 * in the station data. This callback should only be used when the driver
2613 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2614 * otherwise the rate control algorithm is notified directly.
2617 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2618 * bursting) for a hardware TX queue.
2619 * Returns a negative error code on failure.
2620 * The callback can sleep.
2622 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2623 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2624 * required function.
2625 * The callback can sleep.
2627 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2628 * Currently, this is only used for IBSS mode debugging. Is not a
2629 * required function.
2630 * The callback can sleep.
2632 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2633 * with other STAs in the IBSS. This is only used in IBSS mode. This
2634 * function is optional if the firmware/hardware takes full care of
2635 * TSF synchronization.
2636 * The callback can sleep.
2638 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2639 * This is needed only for IBSS mode and the result of this function is
2640 * used to determine whether to reply to Probe Requests.
2641 * Returns non-zero if this device sent the last beacon.
2642 * The callback can sleep.
2644 * @ampdu_action: Perform a certain A-MPDU action
2645 * The RA/TID combination determines the destination and TID we want
2646 * the ampdu action to be performed for. The action is defined through
2647 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2648 * is the first frame we expect to perform the action on. Notice
2649 * that TX/RX_STOP can pass NULL for this parameter.
2650 * The @buf_size parameter is only valid when the action is set to
2651 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2652 * buffer size (number of subframes) for this session -- the driver
2653 * may neither send aggregates containing more subframes than this
2654 * nor send aggregates in a way that lost frames would exceed the
2655 * buffer size. If just limiting the aggregate size, this would be
2656 * possible with a buf_size of 8:
2658 * - RX: 2....7 (lost frame #1)
2660 * which is invalid since #1 was now re-transmitted well past the
2661 * buffer size of 8. Correct ways to retransmit #1 would be:
2662 * - TX: 1 or 18 or 81
2663 * Even "189" would be wrong since 1 could be lost again.
2665 * Returns a negative error code on failure.
2666 * The callback can sleep.
2668 * @get_survey: Return per-channel survey information
2670 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2671 * need to set wiphy->rfkill_poll to %true before registration,
2672 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2673 * The callback can sleep.
2675 * @set_coverage_class: Set slot time for given coverage class as specified
2676 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2677 * accordingly; coverage class equals to -1 to enable ACK timeout
2678 * estimation algorithm (dynack). To disable dynack set valid value for
2679 * coverage class. This callback is not required and may sleep.
2681 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2682 * be %NULL. The callback can sleep.
2683 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2685 * @flush: Flush all pending frames from the hardware queue, making sure
2686 * that the hardware queues are empty. The @queues parameter is a bitmap
2687 * of queues to flush, which is useful if different virtual interfaces
2688 * use different hardware queues; it may also indicate all queues.
2689 * If the parameter @drop is set to %true, pending frames may be dropped.
2690 * Note that vif can be NULL.
2691 * The callback can sleep.
2693 * @channel_switch: Drivers that need (or want) to offload the channel
2694 * switch operation for CSAs received from the AP may implement this
2695 * callback. They must then call ieee80211_chswitch_done() to indicate
2696 * completion of the channel switch.
2698 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2699 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2700 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2701 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2703 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2705 * @remain_on_channel: Starts an off-channel period on the given channel, must
2706 * call back to ieee80211_ready_on_channel() when on that channel. Note
2707 * that normal channel traffic is not stopped as this is intended for hw
2708 * offload. Frames to transmit on the off-channel channel are transmitted
2709 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2710 * duration (which will always be non-zero) expires, the driver must call
2711 * ieee80211_remain_on_channel_expired().
2712 * Note that this callback may be called while the device is in IDLE and
2713 * must be accepted in this case.
2714 * This callback may sleep.
2715 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2716 * aborted before it expires. This callback may sleep.
2718 * @set_ringparam: Set tx and rx ring sizes.
2720 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2722 * @tx_frames_pending: Check if there is any pending frame in the hardware
2723 * queues before entering power save.
2725 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2726 * when transmitting a frame. Currently only legacy rates are handled.
2727 * The callback can sleep.
2728 * @rssi_callback: Notify driver when the average RSSI goes above/below
2729 * thresholds that were registered previously. The callback can sleep.
2731 * @release_buffered_frames: Release buffered frames according to the given
2732 * parameters. In the case where the driver buffers some frames for
2733 * sleeping stations mac80211 will use this callback to tell the driver
2734 * to release some frames, either for PS-poll or uAPSD.
2735 * Note that if the @more_data parameter is %false the driver must check
2736 * if there are more frames on the given TIDs, and if there are more than
2737 * the frames being released then it must still set the more-data bit in
2738 * the frame. If the @more_data parameter is %true, then of course the
2739 * more-data bit must always be set.
2740 * The @tids parameter tells the driver which TIDs to release frames
2741 * from, for PS-poll it will always have only a single bit set.
2742 * In the case this is used for a PS-poll initiated release, the
2743 * @num_frames parameter will always be 1 so code can be shared. In
2744 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2745 * on the TX status (and must report TX status) so that the PS-poll
2746 * period is properly ended. This is used to avoid sending multiple
2747 * responses for a retried PS-poll frame.
2748 * In the case this is used for uAPSD, the @num_frames parameter may be
2749 * bigger than one, but the driver may send fewer frames (it must send
2750 * at least one, however). In this case it is also responsible for
2751 * setting the EOSP flag in the QoS header of the frames. Also, when the
2752 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2753 * on the last frame in the SP. Alternatively, it may call the function
2754 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2755 * This callback must be atomic.
2756 * @allow_buffered_frames: Prepare device to allow the given number of frames
2757 * to go out to the given station. The frames will be sent by mac80211
2758 * via the usual TX path after this call. The TX information for frames
2759 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2760 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2761 * frames from multiple TIDs are released and the driver might reorder
2762 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2763 * on the last frame and clear it on all others and also handle the EOSP
2764 * bit in the QoS header correctly. Alternatively, it can also call the
2765 * ieee80211_sta_eosp() function.
2766 * The @tids parameter is a bitmap and tells the driver which TIDs the
2767 * frames will be on; it will at most have two bits set.
2768 * This callback must be atomic.
2770 * @get_et_sset_count: Ethtool API to get string-set count.
2772 * @get_et_stats: Ethtool API to get a set of u64 stats.
2774 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2775 * and perhaps other supported types of ethtool data-sets.
2777 * @get_rssi: Get current signal strength in dBm, the function is optional
2780 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2781 * before associated. In multi-channel scenarios, a virtual interface is
2782 * bound to a channel before it is associated, but as it isn't associated
2783 * yet it need not necessarily be given airtime, in particular since any
2784 * transmission to a P2P GO needs to be synchronized against the GO's
2785 * powersave state. mac80211 will call this function before transmitting a
2786 * management frame prior to having successfully associated to allow the
2787 * driver to give it channel time for the transmission, to get a response
2788 * and to be able to synchronize with the GO.
2789 * The callback will be called before each transmission and upon return
2790 * mac80211 will transmit the frame right away.
2791 * The callback is optional and can (should!) sleep.
2793 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2794 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2795 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2796 * setup-response is a direct packet not buffered by the AP.
2797 * mac80211 will call this function just before the transmission of a TDLS
2798 * discovery-request. The recommended period of protection is at least
2799 * 2 * (DTIM period).
2800 * The callback is optional and can sleep.
2802 * @add_chanctx: Notifies device driver about new channel context creation.
2803 * @remove_chanctx: Notifies device driver about channel context destruction.
2804 * @change_chanctx: Notifies device driver about channel context changes that
2805 * may happen when combining different virtual interfaces on the same
2806 * channel context with different settings
2807 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2808 * to vif. Possible use is for hw queue remapping.
2809 * @unassign_vif_chanctx: Notifies device driver about channel context being
2811 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2812 * another, as specified in the list of
2813 * @ieee80211_vif_chanctx_switch passed to the driver, according
2814 * to the mode defined in &ieee80211_chanctx_switch_mode.
2816 * @start_ap: Start operation on the AP interface, this is called after all the
2817 * information in bss_conf is set and beacon can be retrieved. A channel
2818 * context is bound before this is called. Note that if the driver uses
2819 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2820 * just "paused" for scanning/ROC, which is indicated by the beacon being
2821 * disabled/enabled via @bss_info_changed.
2822 * @stop_ap: Stop operation on the AP interface.
2824 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2825 * reconfiguration has completed. This can help the driver implement the
2826 * reconfiguration step. Also called when reconfiguring because the
2827 * driver's resume function returned 1, as this is just like an "inline"
2828 * hardware restart. This callback may sleep.
2830 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2831 * Currently, this is only called for managed or P2P client interfaces.
2832 * This callback is optional; it must not sleep.
2834 * @channel_switch_beacon: Starts a channel switch to a new channel.
2835 * Beacons are modified to include CSA or ECSA IEs before calling this
2836 * function. The corresponding count fields in these IEs must be
2837 * decremented, and when they reach 1 the driver must call
2838 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2839 * get the csa counter decremented by mac80211, but must check if it is
2840 * 1 using ieee80211_csa_is_complete() after the beacon has been
2841 * transmitted and then call ieee80211_csa_finish().
2842 * If the CSA count starts as zero or 1, this function will not be called,
2843 * since there won't be any time to beacon before the switch anyway.
2844 * @pre_channel_switch: This is an optional callback that is called
2845 * before a channel switch procedure is started (ie. when a STA
2846 * gets a CSA or an userspace initiated channel-switch), allowing
2847 * the driver to prepare for the channel switch.
2848 * @post_channel_switch: This is an optional callback that is called
2849 * after a channel switch procedure is completed, allowing the
2850 * driver to go back to a normal configuration.
2852 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2853 * information in bss_conf is set up and the beacon can be retrieved. A
2854 * channel context is bound before this is called.
2855 * @leave_ibss: Leave the IBSS again.
2857 * @get_expected_throughput: extract the expected throughput towards the
2858 * specified station. The returned value is expressed in Kbps. It returns 0
2859 * if the RC algorithm does not have proper data to provide.
2861 * @get_txpower: get current maximum tx power (in dBm) based on configuration
2862 * and hardware limits.
2864 struct ieee80211_ops
{
2865 void (*tx
)(struct ieee80211_hw
*hw
,
2866 struct ieee80211_tx_control
*control
,
2867 struct sk_buff
*skb
);
2868 int (*start
)(struct ieee80211_hw
*hw
);
2869 void (*stop
)(struct ieee80211_hw
*hw
);
2871 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
2872 int (*resume
)(struct ieee80211_hw
*hw
);
2873 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
2875 int (*add_interface
)(struct ieee80211_hw
*hw
,
2876 struct ieee80211_vif
*vif
);
2877 int (*change_interface
)(struct ieee80211_hw
*hw
,
2878 struct ieee80211_vif
*vif
,
2879 enum nl80211_iftype new_type
, bool p2p
);
2880 void (*remove_interface
)(struct ieee80211_hw
*hw
,
2881 struct ieee80211_vif
*vif
);
2882 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
2883 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
2884 struct ieee80211_vif
*vif
,
2885 struct ieee80211_bss_conf
*info
,
2888 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2889 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2891 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
2892 struct netdev_hw_addr_list
*mc_list
);
2893 void (*configure_filter
)(struct ieee80211_hw
*hw
,
2894 unsigned int changed_flags
,
2895 unsigned int *total_flags
,
2897 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
2899 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
2900 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
2901 struct ieee80211_key_conf
*key
);
2902 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
2903 struct ieee80211_vif
*vif
,
2904 struct ieee80211_key_conf
*conf
,
2905 struct ieee80211_sta
*sta
,
2906 u32 iv32
, u16
*phase1key
);
2907 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
2908 struct ieee80211_vif
*vif
,
2909 struct cfg80211_gtk_rekey_data
*data
);
2910 void (*set_default_unicast_key
)(struct ieee80211_hw
*hw
,
2911 struct ieee80211_vif
*vif
, int idx
);
2912 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2913 struct ieee80211_scan_request
*req
);
2914 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
2915 struct ieee80211_vif
*vif
);
2916 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
2917 struct ieee80211_vif
*vif
,
2918 struct cfg80211_sched_scan_request
*req
,
2919 struct ieee80211_scan_ies
*ies
);
2920 int (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
2921 struct ieee80211_vif
*vif
);
2922 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
2923 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
2924 int (*get_stats
)(struct ieee80211_hw
*hw
,
2925 struct ieee80211_low_level_stats
*stats
);
2926 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
2927 u32
*iv32
, u16
*iv16
);
2928 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2929 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2930 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2931 struct ieee80211_sta
*sta
);
2932 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2933 struct ieee80211_sta
*sta
);
2934 #ifdef CONFIG_MAC80211_DEBUGFS
2935 void (*sta_add_debugfs
)(struct ieee80211_hw
*hw
,
2936 struct ieee80211_vif
*vif
,
2937 struct ieee80211_sta
*sta
,
2938 struct dentry
*dir
);
2939 void (*sta_remove_debugfs
)(struct ieee80211_hw
*hw
,
2940 struct ieee80211_vif
*vif
,
2941 struct ieee80211_sta
*sta
,
2942 struct dentry
*dir
);
2944 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2945 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
2946 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2947 struct ieee80211_sta
*sta
,
2948 enum ieee80211_sta_state old_state
,
2949 enum ieee80211_sta_state new_state
);
2950 void (*sta_pre_rcu_remove
)(struct ieee80211_hw
*hw
,
2951 struct ieee80211_vif
*vif
,
2952 struct ieee80211_sta
*sta
);
2953 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
2954 struct ieee80211_vif
*vif
,
2955 struct ieee80211_sta
*sta
,
2957 int (*conf_tx
)(struct ieee80211_hw
*hw
,
2958 struct ieee80211_vif
*vif
, u16 ac
,
2959 const struct ieee80211_tx_queue_params
*params
);
2960 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2961 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2963 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2964 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
2965 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
2966 struct ieee80211_vif
*vif
,
2967 enum ieee80211_ampdu_mlme_action action
,
2968 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
,
2970 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
2971 struct survey_info
*survey
);
2972 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
2973 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, s16 coverage_class
);
2974 #ifdef CONFIG_NL80211_TESTMODE
2975 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2976 void *data
, int len
);
2977 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
2978 struct netlink_callback
*cb
,
2979 void *data
, int len
);
2981 void (*flush
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2982 u32 queues
, bool drop
);
2983 void (*channel_switch
)(struct ieee80211_hw
*hw
,
2984 struct ieee80211_vif
*vif
,
2985 struct ieee80211_channel_switch
*ch_switch
);
2986 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
2987 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
2989 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
2990 struct ieee80211_vif
*vif
,
2991 struct ieee80211_channel
*chan
,
2993 enum ieee80211_roc_type type
);
2994 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
2995 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
2996 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
2997 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
2998 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
2999 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3000 const struct cfg80211_bitrate_mask
*mask
);
3001 void (*rssi_callback
)(struct ieee80211_hw
*hw
,
3002 struct ieee80211_vif
*vif
,
3003 enum ieee80211_rssi_event rssi_event
);
3005 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
3006 struct ieee80211_sta
*sta
,
3007 u16 tids
, int num_frames
,
3008 enum ieee80211_frame_release_type reason
,
3010 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
3011 struct ieee80211_sta
*sta
,
3012 u16 tids
, int num_frames
,
3013 enum ieee80211_frame_release_type reason
,
3016 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
3017 struct ieee80211_vif
*vif
, int sset
);
3018 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
3019 struct ieee80211_vif
*vif
,
3020 struct ethtool_stats
*stats
, u64
*data
);
3021 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
3022 struct ieee80211_vif
*vif
,
3023 u32 sset
, u8
*data
);
3024 int (*get_rssi
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3025 struct ieee80211_sta
*sta
, s8
*rssi_dbm
);
3027 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
3028 struct ieee80211_vif
*vif
);
3030 void (*mgd_protect_tdls_discover
)(struct ieee80211_hw
*hw
,
3031 struct ieee80211_vif
*vif
);
3033 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
3034 struct ieee80211_chanctx_conf
*ctx
);
3035 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
3036 struct ieee80211_chanctx_conf
*ctx
);
3037 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
3038 struct ieee80211_chanctx_conf
*ctx
,
3040 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3041 struct ieee80211_vif
*vif
,
3042 struct ieee80211_chanctx_conf
*ctx
);
3043 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3044 struct ieee80211_vif
*vif
,
3045 struct ieee80211_chanctx_conf
*ctx
);
3046 int (*switch_vif_chanctx
)(struct ieee80211_hw
*hw
,
3047 struct ieee80211_vif_chanctx_switch
*vifs
,
3049 enum ieee80211_chanctx_switch_mode mode
);
3051 void (*restart_complete
)(struct ieee80211_hw
*hw
);
3053 #if IS_ENABLED(CONFIG_IPV6)
3054 void (*ipv6_addr_change
)(struct ieee80211_hw
*hw
,
3055 struct ieee80211_vif
*vif
,
3056 struct inet6_dev
*idev
);
3058 void (*channel_switch_beacon
)(struct ieee80211_hw
*hw
,
3059 struct ieee80211_vif
*vif
,
3060 struct cfg80211_chan_def
*chandef
);
3061 int (*pre_channel_switch
)(struct ieee80211_hw
*hw
,
3062 struct ieee80211_vif
*vif
,
3063 struct ieee80211_channel_switch
*ch_switch
);
3065 int (*post_channel_switch
)(struct ieee80211_hw
*hw
,
3066 struct ieee80211_vif
*vif
);
3068 int (*join_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3069 void (*leave_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3070 u32 (*get_expected_throughput
)(struct ieee80211_sta
*sta
);
3071 int (*get_txpower
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3076 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3078 * This must be called once for each hardware device. The returned pointer
3079 * must be used to refer to this device when calling other functions.
3080 * mac80211 allocates a private data area for the driver pointed to by
3081 * @priv in &struct ieee80211_hw, the size of this area is given as
3084 * @priv_data_len: length of private data
3085 * @ops: callbacks for this device
3086 * @requested_name: Requested name for this device.
3087 * NULL is valid value, and means use the default naming (phy%d)
3089 * Return: A pointer to the new hardware device, or %NULL on error.
3091 struct ieee80211_hw
*ieee80211_alloc_hw_nm(size_t priv_data_len
,
3092 const struct ieee80211_ops
*ops
,
3093 const char *requested_name
);
3096 * ieee80211_alloc_hw - Allocate a new hardware device
3098 * This must be called once for each hardware device. The returned pointer
3099 * must be used to refer to this device when calling other functions.
3100 * mac80211 allocates a private data area for the driver pointed to by
3101 * @priv in &struct ieee80211_hw, the size of this area is given as
3104 * @priv_data_len: length of private data
3105 * @ops: callbacks for this device
3107 * Return: A pointer to the new hardware device, or %NULL on error.
3110 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
3111 const struct ieee80211_ops
*ops
)
3113 return ieee80211_alloc_hw_nm(priv_data_len
, ops
, NULL
);
3117 * ieee80211_register_hw - Register hardware device
3119 * You must call this function before any other functions in
3120 * mac80211. Note that before a hardware can be registered, you
3121 * need to fill the contained wiphy's information.
3123 * @hw: the device to register as returned by ieee80211_alloc_hw()
3125 * Return: 0 on success. An error code otherwise.
3127 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
3130 * struct ieee80211_tpt_blink - throughput blink description
3131 * @throughput: throughput in Kbit/sec
3132 * @blink_time: blink time in milliseconds
3133 * (full cycle, ie. one off + one on period)
3135 struct ieee80211_tpt_blink
{
3141 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3142 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3143 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3144 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3145 * interface is connected in some way, including being an AP
3147 enum ieee80211_tpt_led_trigger_flags
{
3148 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
3149 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
3150 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
3153 #ifdef CONFIG_MAC80211_LEDS
3154 char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
3155 char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
3156 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
3157 char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
3158 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
,
3160 const struct ieee80211_tpt_blink
*blink_table
,
3161 unsigned int blink_table_len
);
3164 * ieee80211_get_tx_led_name - get name of TX LED
3166 * mac80211 creates a transmit LED trigger for each wireless hardware
3167 * that can be used to drive LEDs if your driver registers a LED device.
3168 * This function returns the name (or %NULL if not configured for LEDs)
3169 * of the trigger so you can automatically link the LED device.
3171 * @hw: the hardware to get the LED trigger name for
3173 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3175 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
3177 #ifdef CONFIG_MAC80211_LEDS
3178 return __ieee80211_get_tx_led_name(hw
);
3185 * ieee80211_get_rx_led_name - get name of RX LED
3187 * mac80211 creates a receive LED trigger for each wireless hardware
3188 * that can be used to drive LEDs if your driver registers a LED device.
3189 * This function returns the name (or %NULL if not configured for LEDs)
3190 * of the trigger so you can automatically link the LED device.
3192 * @hw: the hardware to get the LED trigger name for
3194 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3196 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
3198 #ifdef CONFIG_MAC80211_LEDS
3199 return __ieee80211_get_rx_led_name(hw
);
3206 * ieee80211_get_assoc_led_name - get name of association LED
3208 * mac80211 creates a association LED trigger for each wireless hardware
3209 * that can be used to drive LEDs if your driver registers a LED device.
3210 * This function returns the name (or %NULL if not configured for LEDs)
3211 * of the trigger so you can automatically link the LED device.
3213 * @hw: the hardware to get the LED trigger name for
3215 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3217 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
3219 #ifdef CONFIG_MAC80211_LEDS
3220 return __ieee80211_get_assoc_led_name(hw
);
3227 * ieee80211_get_radio_led_name - get name of radio LED
3229 * mac80211 creates a radio change LED trigger for each wireless hardware
3230 * that can be used to drive LEDs if your driver registers a LED device.
3231 * This function returns the name (or %NULL if not configured for LEDs)
3232 * of the trigger so you can automatically link the LED device.
3234 * @hw: the hardware to get the LED trigger name for
3236 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3238 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
3240 #ifdef CONFIG_MAC80211_LEDS
3241 return __ieee80211_get_radio_led_name(hw
);
3248 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3249 * @hw: the hardware to create the trigger for
3250 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3251 * @blink_table: the blink table -- needs to be ordered by throughput
3252 * @blink_table_len: size of the blink table
3254 * Return: %NULL (in case of error, or if no LED triggers are
3255 * configured) or the name of the new trigger.
3257 * Note: This function must be called before ieee80211_register_hw().
3259 static inline char *
3260 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
3261 const struct ieee80211_tpt_blink
*blink_table
,
3262 unsigned int blink_table_len
)
3264 #ifdef CONFIG_MAC80211_LEDS
3265 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
3273 * ieee80211_unregister_hw - Unregister a hardware device
3275 * This function instructs mac80211 to free allocated resources
3276 * and unregister netdevices from the networking subsystem.
3278 * @hw: the hardware to unregister
3280 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
3283 * ieee80211_free_hw - free hardware descriptor
3285 * This function frees everything that was allocated, including the
3286 * private data for the driver. You must call ieee80211_unregister_hw()
3287 * before calling this function.
3289 * @hw: the hardware to free
3291 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
3294 * ieee80211_restart_hw - restart hardware completely
3296 * Call this function when the hardware was restarted for some reason
3297 * (hardware error, ...) and the driver is unable to restore its state
3298 * by itself. mac80211 assumes that at this point the driver/hardware
3299 * is completely uninitialised and stopped, it starts the process by
3300 * calling the ->start() operation. The driver will need to reset all
3301 * internal state that it has prior to calling this function.
3303 * @hw: the hardware to restart
3305 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
3308 * ieee80211_napi_add - initialize mac80211 NAPI context
3309 * @hw: the hardware to initialize the NAPI context on
3310 * @napi: the NAPI context to initialize
3311 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3312 * driver doesn't use NAPI
3313 * @poll: poll function
3314 * @weight: default weight
3316 * See also netif_napi_add().
3318 void ieee80211_napi_add(struct ieee80211_hw
*hw
, struct napi_struct
*napi
,
3319 struct net_device
*napi_dev
,
3320 int (*poll
)(struct napi_struct
*, int),
3324 * ieee80211_rx - receive frame
3326 * Use this function to hand received frames to mac80211. The receive
3327 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3328 * paged @skb is used, the driver is recommended to put the ieee80211
3329 * header of the frame on the linear part of the @skb to avoid memory
3330 * allocation and/or memcpy by the stack.
3332 * This function may not be called in IRQ context. Calls to this function
3333 * for a single hardware must be synchronized against each other. Calls to
3334 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3335 * mixed for a single hardware. Must not run concurrently with
3336 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3338 * In process context use instead ieee80211_rx_ni().
3340 * @hw: the hardware this frame came in on
3341 * @skb: the buffer to receive, owned by mac80211 after this call
3343 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
3346 * ieee80211_rx_irqsafe - receive frame
3348 * Like ieee80211_rx() but can be called in IRQ context
3349 * (internally defers to a tasklet.)
3351 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3352 * be mixed for a single hardware.Must not run concurrently with
3353 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3355 * @hw: the hardware this frame came in on
3356 * @skb: the buffer to receive, owned by mac80211 after this call
3358 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
3361 * ieee80211_rx_ni - receive frame (in process context)
3363 * Like ieee80211_rx() but can be called in process context
3364 * (internally disables bottom halves).
3366 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3367 * not be mixed for a single hardware. Must not run concurrently with
3368 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3370 * @hw: the hardware this frame came in on
3371 * @skb: the buffer to receive, owned by mac80211 after this call
3373 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
3374 struct sk_buff
*skb
)
3377 ieee80211_rx(hw
, skb
);
3382 * ieee80211_sta_ps_transition - PS transition for connected sta
3384 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3385 * flag set, use this function to inform mac80211 about a connected station
3386 * entering/leaving PS mode.
3388 * This function may not be called in IRQ context or with softirqs enabled.
3390 * Calls to this function for a single hardware must be synchronized against
3393 * @sta: currently connected sta
3394 * @start: start or stop PS
3396 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3398 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
3401 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3402 * (in process context)
3404 * Like ieee80211_sta_ps_transition() but can be called in process context
3405 * (internally disables bottom halves). Concurrent call restriction still
3408 * @sta: currently connected sta
3409 * @start: start or stop PS
3411 * Return: Like ieee80211_sta_ps_transition().
3413 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
3419 ret
= ieee80211_sta_ps_transition(sta
, start
);
3426 * The TX headroom reserved by mac80211 for its own tx_status functions.
3427 * This is enough for the radiotap header.
3429 #define IEEE80211_TX_STATUS_HEADROOM 14
3432 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3433 * @sta: &struct ieee80211_sta pointer for the sleeping station
3434 * @tid: the TID that has buffered frames
3435 * @buffered: indicates whether or not frames are buffered for this TID
3437 * If a driver buffers frames for a powersave station instead of passing
3438 * them back to mac80211 for retransmission, the station may still need
3439 * to be told that there are buffered frames via the TIM bit.
3441 * This function informs mac80211 whether or not there are frames that are
3442 * buffered in the driver for a given TID; mac80211 can then use this data
3443 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3444 * call! Beware of the locking!)
3446 * If all frames are released to the station (due to PS-poll or uAPSD)
3447 * then the driver needs to inform mac80211 that there no longer are
3448 * frames buffered. However, when the station wakes up mac80211 assumes
3449 * that all buffered frames will be transmitted and clears this data,
3450 * drivers need to make sure they inform mac80211 about all buffered
3451 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3453 * Note that technically mac80211 only needs to know this per AC, not per
3454 * TID, but since driver buffering will inevitably happen per TID (since
3455 * it is related to aggregation) it is easier to make mac80211 map the
3456 * TID to the AC as required instead of keeping track in all drivers that
3459 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
3460 u8 tid
, bool buffered
);
3463 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3465 * Call this function in a driver with per-packet rate selection support
3466 * to combine the rate info in the packet tx info with the most recent
3467 * rate selection table for the station entry.
3469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3470 * @sta: the receiver station to which this packet is sent.
3471 * @skb: the frame to be transmitted.
3472 * @dest: buffer for extracted rate/retry information
3473 * @max_rates: maximum number of rates to fetch
3475 void ieee80211_get_tx_rates(struct ieee80211_vif
*vif
,
3476 struct ieee80211_sta
*sta
,
3477 struct sk_buff
*skb
,
3478 struct ieee80211_tx_rate
*dest
,
3482 * ieee80211_tx_status - transmit status callback
3484 * Call this function for all transmitted frames after they have been
3485 * transmitted. It is permissible to not call this function for
3486 * multicast frames but this can affect statistics.
3488 * This function may not be called in IRQ context. Calls to this function
3489 * for a single hardware must be synchronized against each other. Calls
3490 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3491 * may not be mixed for a single hardware. Must not run concurrently with
3492 * ieee80211_rx() or ieee80211_rx_ni().
3494 * @hw: the hardware the frame was transmitted by
3495 * @skb: the frame that was transmitted, owned by mac80211 after this call
3497 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
3498 struct sk_buff
*skb
);
3501 * ieee80211_tx_status_ni - transmit status callback (in process context)
3503 * Like ieee80211_tx_status() but can be called in process context.
3505 * Calls to this function, ieee80211_tx_status() and
3506 * ieee80211_tx_status_irqsafe() may not be mixed
3507 * for a single hardware.
3509 * @hw: the hardware the frame was transmitted by
3510 * @skb: the frame that was transmitted, owned by mac80211 after this call
3512 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
3513 struct sk_buff
*skb
)
3516 ieee80211_tx_status(hw
, skb
);
3521 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3523 * Like ieee80211_tx_status() but can be called in IRQ context
3524 * (internally defers to a tasklet.)
3526 * Calls to this function, ieee80211_tx_status() and
3527 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3529 * @hw: the hardware the frame was transmitted by
3530 * @skb: the frame that was transmitted, owned by mac80211 after this call
3532 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
3533 struct sk_buff
*skb
);
3536 * ieee80211_report_low_ack - report non-responding station
3538 * When operating in AP-mode, call this function to report a non-responding
3541 * @sta: the non-responding connected sta
3542 * @num_packets: number of packets sent to @sta without a response
3544 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
3546 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3549 * struct ieee80211_mutable_offsets - mutable beacon offsets
3550 * @tim_offset: position of TIM element
3551 * @tim_length: size of TIM element
3552 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3553 * to CSA counters. This array can contain zero values which
3554 * should be ignored.
3556 struct ieee80211_mutable_offsets
{
3560 u16 csa_counter_offs
[IEEE80211_MAX_CSA_COUNTERS_NUM
];
3564 * ieee80211_beacon_get_template - beacon template generation function
3565 * @hw: pointer obtained from ieee80211_alloc_hw().
3566 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3567 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3568 * receive the offsets that may be updated by the driver.
3570 * If the driver implements beaconing modes, it must use this function to
3571 * obtain the beacon template.
3573 * This function should be used if the beacon frames are generated by the
3574 * device, and then the driver must use the returned beacon as the template
3575 * The driver or the device are responsible to update the DTIM and, when
3576 * applicable, the CSA count.
3578 * The driver is responsible for freeing the returned skb.
3580 * Return: The beacon template. %NULL on error.
3583 ieee80211_beacon_get_template(struct ieee80211_hw
*hw
,
3584 struct ieee80211_vif
*vif
,
3585 struct ieee80211_mutable_offsets
*offs
);
3588 * ieee80211_beacon_get_tim - beacon generation function
3589 * @hw: pointer obtained from ieee80211_alloc_hw().
3590 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3591 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3592 * Set to 0 if invalid (in non-AP modes).
3593 * @tim_length: pointer to variable that will receive the TIM IE length,
3594 * (including the ID and length bytes!).
3595 * Set to 0 if invalid (in non-AP modes).
3597 * If the driver implements beaconing modes, it must use this function to
3598 * obtain the beacon frame.
3600 * If the beacon frames are generated by the host system (i.e., not in
3601 * hardware/firmware), the driver uses this function to get each beacon
3602 * frame from mac80211 -- it is responsible for calling this function exactly
3603 * once before the beacon is needed (e.g. based on hardware interrupt).
3605 * The driver is responsible for freeing the returned skb.
3607 * Return: The beacon template. %NULL on error.
3609 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
3610 struct ieee80211_vif
*vif
,
3611 u16
*tim_offset
, u16
*tim_length
);
3614 * ieee80211_beacon_get - beacon generation function
3615 * @hw: pointer obtained from ieee80211_alloc_hw().
3616 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3618 * See ieee80211_beacon_get_tim().
3620 * Return: See ieee80211_beacon_get_tim().
3622 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
3623 struct ieee80211_vif
*vif
)
3625 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
3629 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3630 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3632 * The csa counter should be updated after each beacon transmission.
3633 * This function is called implicitly when
3634 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3635 * beacon frames are generated by the device, the driver should call this
3636 * function after each beacon transmission to sync mac80211's csa counters.
3638 * Return: new csa counter value
3640 u8
ieee80211_csa_update_counter(struct ieee80211_vif
*vif
);
3643 * ieee80211_csa_finish - notify mac80211 about channel switch
3644 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3646 * After a channel switch announcement was scheduled and the counter in this
3647 * announcement hits 1, this function must be called by the driver to
3648 * notify mac80211 that the channel can be changed.
3650 void ieee80211_csa_finish(struct ieee80211_vif
*vif
);
3653 * ieee80211_csa_is_complete - find out if counters reached 1
3654 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3656 * This function returns whether the channel switch counters reached zero.
3658 bool ieee80211_csa_is_complete(struct ieee80211_vif
*vif
);
3662 * ieee80211_proberesp_get - retrieve a Probe Response template
3663 * @hw: pointer obtained from ieee80211_alloc_hw().
3664 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3666 * Creates a Probe Response template which can, for example, be uploaded to
3667 * hardware. The destination address should be set by the caller.
3669 * Can only be called in AP mode.
3671 * Return: The Probe Response template. %NULL on error.
3673 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
3674 struct ieee80211_vif
*vif
);
3677 * ieee80211_pspoll_get - retrieve a PS Poll template
3678 * @hw: pointer obtained from ieee80211_alloc_hw().
3679 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3681 * Creates a PS Poll a template which can, for example, uploaded to
3682 * hardware. The template must be updated after association so that correct
3683 * AID, BSSID and MAC address is used.
3685 * Note: Caller (or hardware) is responsible for setting the
3686 * &IEEE80211_FCTL_PM bit.
3688 * Return: The PS Poll template. %NULL on error.
3690 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
3691 struct ieee80211_vif
*vif
);
3694 * ieee80211_nullfunc_get - retrieve a nullfunc template
3695 * @hw: pointer obtained from ieee80211_alloc_hw().
3696 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3698 * Creates a Nullfunc template which can, for example, uploaded to
3699 * hardware. The template must be updated after association so that correct
3700 * BSSID and address is used.
3702 * Note: Caller (or hardware) is responsible for setting the
3703 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3705 * Return: The nullfunc template. %NULL on error.
3707 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
3708 struct ieee80211_vif
*vif
);
3711 * ieee80211_probereq_get - retrieve a Probe Request template
3712 * @hw: pointer obtained from ieee80211_alloc_hw().
3713 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3714 * @ssid: SSID buffer
3715 * @ssid_len: length of SSID
3716 * @tailroom: tailroom to reserve at end of SKB for IEs
3718 * Creates a Probe Request template which can, for example, be uploaded to
3721 * Return: The Probe Request template. %NULL on error.
3723 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
3724 struct ieee80211_vif
*vif
,
3725 const u8
*ssid
, size_t ssid_len
,
3729 * ieee80211_rts_get - RTS frame generation function
3730 * @hw: pointer obtained from ieee80211_alloc_hw().
3731 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3732 * @frame: pointer to the frame that is going to be protected by the RTS.
3733 * @frame_len: the frame length (in octets).
3734 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3735 * @rts: The buffer where to store the RTS frame.
3737 * If the RTS frames are generated by the host system (i.e., not in
3738 * hardware/firmware), the low-level driver uses this function to receive
3739 * the next RTS frame from the 802.11 code. The low-level is responsible
3740 * for calling this function before and RTS frame is needed.
3742 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3743 const void *frame
, size_t frame_len
,
3744 const struct ieee80211_tx_info
*frame_txctl
,
3745 struct ieee80211_rts
*rts
);
3748 * ieee80211_rts_duration - Get the duration field for an RTS frame
3749 * @hw: pointer obtained from ieee80211_alloc_hw().
3750 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3751 * @frame_len: the length of the frame that is going to be protected by the RTS.
3752 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3754 * If the RTS is generated in firmware, but the host system must provide
3755 * the duration field, the low-level driver uses this function to receive
3756 * the duration field value in little-endian byteorder.
3758 * Return: The duration.
3760 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
3761 struct ieee80211_vif
*vif
, size_t frame_len
,
3762 const struct ieee80211_tx_info
*frame_txctl
);
3765 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3766 * @hw: pointer obtained from ieee80211_alloc_hw().
3767 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3768 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3769 * @frame_len: the frame length (in octets).
3770 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3771 * @cts: The buffer where to store the CTS-to-self frame.
3773 * If the CTS-to-self frames are generated by the host system (i.e., not in
3774 * hardware/firmware), the low-level driver uses this function to receive
3775 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3776 * for calling this function before and CTS-to-self frame is needed.
3778 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
3779 struct ieee80211_vif
*vif
,
3780 const void *frame
, size_t frame_len
,
3781 const struct ieee80211_tx_info
*frame_txctl
,
3782 struct ieee80211_cts
*cts
);
3785 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3786 * @hw: pointer obtained from ieee80211_alloc_hw().
3787 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3788 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3789 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3791 * If the CTS-to-self is generated in firmware, but the host system must provide
3792 * the duration field, the low-level driver uses this function to receive
3793 * the duration field value in little-endian byteorder.
3795 * Return: The duration.
3797 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
3798 struct ieee80211_vif
*vif
,
3800 const struct ieee80211_tx_info
*frame_txctl
);
3803 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3804 * @hw: pointer obtained from ieee80211_alloc_hw().
3805 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3806 * @band: the band to calculate the frame duration on
3807 * @frame_len: the length of the frame.
3808 * @rate: the rate at which the frame is going to be transmitted.
3810 * Calculate the duration field of some generic frame, given its
3811 * length and transmission rate (in 100kbps).
3813 * Return: The duration.
3815 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
3816 struct ieee80211_vif
*vif
,
3817 enum ieee80211_band band
,
3819 struct ieee80211_rate
*rate
);
3822 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3823 * @hw: pointer as obtained from ieee80211_alloc_hw().
3824 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3826 * Function for accessing buffered broadcast and multicast frames. If
3827 * hardware/firmware does not implement buffering of broadcast/multicast
3828 * frames when power saving is used, 802.11 code buffers them in the host
3829 * memory. The low-level driver uses this function to fetch next buffered
3830 * frame. In most cases, this is used when generating beacon frame.
3832 * Return: A pointer to the next buffered skb or NULL if no more buffered
3833 * frames are available.
3835 * Note: buffered frames are returned only after DTIM beacon frame was
3836 * generated with ieee80211_beacon_get() and the low-level driver must thus
3837 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3838 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3839 * does not need to check for DTIM beacons separately and should be able to
3840 * use common code for all beacons.
3843 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3846 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3848 * This function returns the TKIP phase 1 key for the given IV32.
3850 * @keyconf: the parameter passed with the set key
3851 * @iv32: IV32 to get the P1K for
3852 * @p1k: a buffer to which the key will be written, as 5 u16 values
3854 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
3855 u32 iv32
, u16
*p1k
);
3858 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3860 * This function returns the TKIP phase 1 key for the IV32 taken
3861 * from the given packet.
3863 * @keyconf: the parameter passed with the set key
3864 * @skb: the packet to take the IV32 value from that will be encrypted
3866 * @p1k: a buffer to which the key will be written, as 5 u16 values
3868 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
3869 struct sk_buff
*skb
, u16
*p1k
)
3871 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
3872 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
3873 u32 iv32
= get_unaligned_le32(&data
[4]);
3875 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
3879 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3881 * This function returns the TKIP phase 1 key for the given IV32
3882 * and transmitter address.
3884 * @keyconf: the parameter passed with the set key
3885 * @ta: TA that will be used with the key
3886 * @iv32: IV32 to get the P1K for
3887 * @p1k: a buffer to which the key will be written, as 5 u16 values
3889 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
3890 const u8
*ta
, u32 iv32
, u16
*p1k
);
3893 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3895 * This function computes the TKIP RC4 key for the IV values
3898 * @keyconf: the parameter passed with the set key
3899 * @skb: the packet to take the IV32/IV16 values from that will be
3900 * encrypted with this key
3901 * @p2k: a buffer to which the key will be written, 16 bytes
3903 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
3904 struct sk_buff
*skb
, u8
*p2k
);
3907 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3909 * This function computes the two AES-CMAC sub-keys, based on the
3910 * previously installed master key.
3912 * @keyconf: the parameter passed with the set key
3913 * @k1: a buffer to be filled with the 1st sub-key
3914 * @k2: a buffer to be filled with the 2nd sub-key
3916 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf
*keyconf
,
3920 * struct ieee80211_key_seq - key sequence counter
3922 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3923 * @ccmp: PN data, most significant byte first (big endian,
3924 * reverse order than in packet)
3925 * @aes_cmac: PN data, most significant byte first (big endian,
3926 * reverse order than in packet)
3928 struct ieee80211_key_seq
{
3944 * ieee80211_get_key_tx_seq - get key TX sequence counter
3946 * @keyconf: the parameter passed with the set key
3947 * @seq: buffer to receive the sequence data
3949 * This function allows a driver to retrieve the current TX IV/PN
3950 * for the given key. It must not be called if IV generation is
3951 * offloaded to the device.
3953 * Note that this function may only be called when no TX processing
3954 * can be done concurrently, for example when queues are stopped
3955 * and the stop has been synchronized.
3957 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
3958 struct ieee80211_key_seq
*seq
);
3961 * ieee80211_get_key_rx_seq - get key RX sequence counter
3963 * @keyconf: the parameter passed with the set key
3964 * @tid: The TID, or -1 for the management frame value (CCMP only);
3965 * the value on TID 0 is also used for non-QoS frames. For
3966 * CMAC, only TID 0 is valid.
3967 * @seq: buffer to receive the sequence data
3969 * This function allows a driver to retrieve the current RX IV/PNs
3970 * for the given key. It must not be called if IV checking is done
3971 * by the device and not by mac80211.
3973 * Note that this function may only be called when no RX processing
3974 * can be done concurrently.
3976 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
3977 int tid
, struct ieee80211_key_seq
*seq
);
3980 * ieee80211_set_key_tx_seq - set key TX sequence counter
3982 * @keyconf: the parameter passed with the set key
3983 * @seq: new sequence data
3985 * This function allows a driver to set the current TX IV/PNs for the
3986 * given key. This is useful when resuming from WoWLAN sleep and the
3987 * device may have transmitted frames using the PTK, e.g. replies to
3990 * Note that this function may only be called when no TX processing
3991 * can be done concurrently.
3993 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
3994 struct ieee80211_key_seq
*seq
);
3997 * ieee80211_set_key_rx_seq - set key RX sequence counter
3999 * @keyconf: the parameter passed with the set key
4000 * @tid: The TID, or -1 for the management frame value (CCMP only);
4001 * the value on TID 0 is also used for non-QoS frames. For
4002 * CMAC, only TID 0 is valid.
4003 * @seq: new sequence data
4005 * This function allows a driver to set the current RX IV/PNs for the
4006 * given key. This is useful when resuming from WoWLAN sleep and GTK
4007 * rekey may have been done while suspended. It should not be called
4008 * if IV checking is done by the device and not by mac80211.
4010 * Note that this function may only be called when no RX processing
4011 * can be done concurrently.
4013 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
4014 int tid
, struct ieee80211_key_seq
*seq
);
4017 * ieee80211_remove_key - remove the given key
4018 * @keyconf: the parameter passed with the set key
4020 * Remove the given key. If the key was uploaded to the hardware at the
4021 * time this function is called, it is not deleted in the hardware but
4022 * instead assumed to have been removed already.
4024 * Note that due to locking considerations this function can (currently)
4025 * only be called during key iteration (ieee80211_iter_keys().)
4027 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
);
4030 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4031 * @vif: the virtual interface to add the key on
4032 * @keyconf: new key data
4034 * When GTK rekeying was done while the system was suspended, (a) new
4035 * key(s) will be available. These will be needed by mac80211 for proper
4036 * RX processing, so this function allows setting them.
4038 * The function returns the newly allocated key structure, which will
4039 * have similar contents to the passed key configuration but point to
4040 * mac80211-owned memory. In case of errors, the function returns an
4041 * ERR_PTR(), use IS_ERR() etc.
4043 * Note that this function assumes the key isn't added to hardware
4044 * acceleration, so no TX will be done with the key. Since it's a GTK
4045 * on managed (station) networks, this is true anyway. If the driver
4046 * calls this function from the resume callback and subsequently uses
4047 * the return code 1 to reconfigure the device, this key will be part
4048 * of the reconfiguration.
4050 * Note that the driver should also call ieee80211_set_key_rx_seq()
4051 * for the new key for each TID to set up sequence counters properly.
4053 * IMPORTANT: If this replaces a key that is present in the hardware,
4054 * then it will attempt to remove it during this call. In many cases
4055 * this isn't what you want, so call ieee80211_remove_key() first for
4056 * the key that's being replaced.
4058 struct ieee80211_key_conf
*
4059 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
4060 struct ieee80211_key_conf
*keyconf
);
4063 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4064 * @vif: virtual interface the rekeying was done on
4065 * @bssid: The BSSID of the AP, for checking association
4066 * @replay_ctr: the new replay counter after GTK rekeying
4067 * @gfp: allocation flags
4069 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
4070 const u8
*replay_ctr
, gfp_t gfp
);
4073 * ieee80211_wake_queue - wake specific queue
4074 * @hw: pointer as obtained from ieee80211_alloc_hw().
4075 * @queue: queue number (counted from zero).
4077 * Drivers should use this function instead of netif_wake_queue.
4079 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
4082 * ieee80211_stop_queue - stop specific queue
4083 * @hw: pointer as obtained from ieee80211_alloc_hw().
4084 * @queue: queue number (counted from zero).
4086 * Drivers should use this function instead of netif_stop_queue.
4088 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
4091 * ieee80211_queue_stopped - test status of the queue
4092 * @hw: pointer as obtained from ieee80211_alloc_hw().
4093 * @queue: queue number (counted from zero).
4095 * Drivers should use this function instead of netif_stop_queue.
4097 * Return: %true if the queue is stopped. %false otherwise.
4100 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
4103 * ieee80211_stop_queues - stop all queues
4104 * @hw: pointer as obtained from ieee80211_alloc_hw().
4106 * Drivers should use this function instead of netif_stop_queue.
4108 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
4111 * ieee80211_wake_queues - wake all queues
4112 * @hw: pointer as obtained from ieee80211_alloc_hw().
4114 * Drivers should use this function instead of netif_wake_queue.
4116 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
4119 * ieee80211_scan_completed - completed hardware scan
4121 * When hardware scan offload is used (i.e. the hw_scan() callback is
4122 * assigned) this function needs to be called by the driver to notify
4123 * mac80211 that the scan finished. This function can be called from
4124 * any context, including hardirq context.
4126 * @hw: the hardware that finished the scan
4127 * @aborted: set to true if scan was aborted
4129 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
4132 * ieee80211_sched_scan_results - got results from scheduled scan
4134 * When a scheduled scan is running, this function needs to be called by the
4135 * driver whenever there are new scan results available.
4137 * @hw: the hardware that is performing scheduled scans
4139 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
4142 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4144 * When a scheduled scan is running, this function can be called by
4145 * the driver if it needs to stop the scan to perform another task.
4146 * Usual scenarios are drivers that cannot continue the scheduled scan
4147 * while associating, for instance.
4149 * @hw: the hardware that is performing scheduled scans
4151 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
4154 * enum ieee80211_interface_iteration_flags - interface iteration flags
4155 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4156 * been added to the driver; However, note that during hardware
4157 * reconfiguration (after restart_hw) it will iterate over a new
4158 * interface and over all the existing interfaces even if they
4159 * haven't been re-added to the driver yet.
4160 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4161 * interfaces, even if they haven't been re-added to the driver yet.
4163 enum ieee80211_interface_iteration_flags
{
4164 IEEE80211_IFACE_ITER_NORMAL
= 0,
4165 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
4169 * ieee80211_iterate_active_interfaces - iterate active interfaces
4171 * This function iterates over the interfaces associated with a given
4172 * hardware that are currently active and calls the callback for them.
4173 * This function allows the iterator function to sleep, when the iterator
4174 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4176 * Does not iterate over a new interface during add_interface().
4178 * @hw: the hardware struct of which the interfaces should be iterated over
4179 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4180 * @iterator: the iterator function to call
4181 * @data: first argument of the iterator function
4183 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
4185 void (*iterator
)(void *data
, u8
*mac
,
4186 struct ieee80211_vif
*vif
),
4190 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4192 * This function iterates over the interfaces associated with a given
4193 * hardware that are currently active and calls the callback for them.
4194 * This function requires the iterator callback function to be atomic,
4195 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4196 * Does not iterate over a new interface during add_interface().
4198 * @hw: the hardware struct of which the interfaces should be iterated over
4199 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4200 * @iterator: the iterator function to call, cannot sleep
4201 * @data: first argument of the iterator function
4203 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
4205 void (*iterator
)(void *data
,
4207 struct ieee80211_vif
*vif
),
4211 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4213 * This function iterates over the interfaces associated with a given
4214 * hardware that are currently active and calls the callback for them.
4215 * This version can only be used while holding the RTNL.
4217 * @hw: the hardware struct of which the interfaces should be iterated over
4218 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4219 * @iterator: the iterator function to call, cannot sleep
4220 * @data: first argument of the iterator function
4222 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw
*hw
,
4224 void (*iterator
)(void *data
,
4226 struct ieee80211_vif
*vif
),
4230 * ieee80211_iterate_stations_atomic - iterate stations
4232 * This function iterates over all stations associated with a given
4233 * hardware that are currently uploaded to the driver and calls the callback
4234 * function for them.
4235 * This function requires the iterator callback function to be atomic,
4237 * @hw: the hardware struct of which the interfaces should be iterated over
4238 * @iterator: the iterator function to call, cannot sleep
4239 * @data: first argument of the iterator function
4241 void ieee80211_iterate_stations_atomic(struct ieee80211_hw
*hw
,
4242 void (*iterator
)(void *data
,
4243 struct ieee80211_sta
*sta
),
4246 * ieee80211_queue_work - add work onto the mac80211 workqueue
4248 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4249 * This helper ensures drivers are not queueing work when they should not be.
4251 * @hw: the hardware struct for the interface we are adding work for
4252 * @work: the work we want to add onto the mac80211 workqueue
4254 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
4257 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4259 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4262 * @hw: the hardware struct for the interface we are adding work for
4263 * @dwork: delayable work to queue onto the mac80211 workqueue
4264 * @delay: number of jiffies to wait before queueing
4266 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
4267 struct delayed_work
*dwork
,
4268 unsigned long delay
);
4271 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4272 * @sta: the station for which to start a BA session
4273 * @tid: the TID to BA on.
4274 * @timeout: session timeout value (in TUs)
4276 * Return: success if addBA request was sent, failure otherwise
4278 * Although mac80211/low level driver/user space application can estimate
4279 * the need to start aggregation on a certain RA/TID, the session level
4280 * will be managed by the mac80211.
4282 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
4286 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4287 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4288 * @ra: receiver address of the BA session recipient.
4289 * @tid: the TID to BA on.
4291 * This function must be called by low level driver once it has
4292 * finished with preparations for the BA session. It can be called
4295 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
4299 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4300 * @sta: the station whose BA session to stop
4301 * @tid: the TID to stop BA.
4303 * Return: negative error if the TID is invalid, or no aggregation active
4305 * Although mac80211/low level driver/user space application can estimate
4306 * the need to stop aggregation on a certain RA/TID, the session level
4307 * will be managed by the mac80211.
4309 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
4312 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4313 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4314 * @ra: receiver address of the BA session recipient.
4315 * @tid: the desired TID to BA on.
4317 * This function must be called by low level driver once it has
4318 * finished with preparations for the BA session tear down. It
4319 * can be called from any context.
4321 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
4325 * ieee80211_find_sta - find a station
4327 * @vif: virtual interface to look for station on
4328 * @addr: station's address
4330 * Return: The station, if found. %NULL otherwise.
4332 * Note: This function must be called under RCU lock and the
4333 * resulting pointer is only valid under RCU lock as well.
4335 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
4339 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4341 * @hw: pointer as obtained from ieee80211_alloc_hw()
4342 * @addr: remote station's address
4343 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4345 * Return: The station, if found. %NULL otherwise.
4347 * Note: This function must be called under RCU lock and the
4348 * resulting pointer is only valid under RCU lock as well.
4350 * NOTE: You may pass NULL for localaddr, but then you will just get
4351 * the first STA that matches the remote address 'addr'.
4352 * We can have multiple STA associated with multiple
4353 * logical stations (e.g. consider a station connecting to another
4354 * BSSID on the same AP hardware without disconnecting first).
4355 * In this case, the result of this method with localaddr NULL
4358 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4360 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
4362 const u8
*localaddr
);
4365 * ieee80211_sta_block_awake - block station from waking up
4367 * @pubsta: the station
4368 * @block: whether to block or unblock
4370 * Some devices require that all frames that are on the queues
4371 * for a specific station that went to sleep are flushed before
4372 * a poll response or frames after the station woke up can be
4373 * delivered to that it. Note that such frames must be rejected
4374 * by the driver as filtered, with the appropriate status flag.
4376 * This function allows implementing this mode in a race-free
4379 * To do this, a driver must keep track of the number of frames
4380 * still enqueued for a specific station. If this number is not
4381 * zero when the station goes to sleep, the driver must call
4382 * this function to force mac80211 to consider the station to
4383 * be asleep regardless of the station's actual state. Once the
4384 * number of outstanding frames reaches zero, the driver must
4385 * call this function again to unblock the station. That will
4386 * cause mac80211 to be able to send ps-poll responses, and if
4387 * the station queried in the meantime then frames will also
4388 * be sent out as a result of this. Additionally, the driver
4389 * will be notified that the station woke up some time after
4390 * it is unblocked, regardless of whether the station actually
4391 * woke up while blocked or not.
4393 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
4394 struct ieee80211_sta
*pubsta
, bool block
);
4397 * ieee80211_sta_eosp - notify mac80211 about end of SP
4398 * @pubsta: the station
4400 * When a device transmits frames in a way that it can't tell
4401 * mac80211 in the TX status about the EOSP, it must clear the
4402 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4403 * This applies for PS-Poll as well as uAPSD.
4405 * Note that just like with _tx_status() and _rx() drivers must
4406 * not mix calls to irqsafe/non-irqsafe versions, this function
4407 * must not be mixed with those either. Use the all irqsafe, or
4408 * all non-irqsafe, don't mix!
4410 * NB: the _irqsafe version of this function doesn't exist, no
4411 * driver needs it right now. Don't call this function if
4412 * you'd need the _irqsafe version, look at the git history
4413 * and restore the _irqsafe version!
4415 void ieee80211_sta_eosp(struct ieee80211_sta
*pubsta
);
4418 * ieee80211_iter_keys - iterate keys programmed into the device
4419 * @hw: pointer obtained from ieee80211_alloc_hw()
4420 * @vif: virtual interface to iterate, may be %NULL for all
4421 * @iter: iterator function that will be called for each key
4422 * @iter_data: custom data to pass to the iterator function
4424 * This function can be used to iterate all the keys known to
4425 * mac80211, even those that weren't previously programmed into
4426 * the device. This is intended for use in WoWLAN if the device
4427 * needs reprogramming of the keys during suspend. Note that due
4428 * to locking reasons, it is also only safe to call this at few
4429 * spots since it must hold the RTNL and be able to sleep.
4431 * The order in which the keys are iterated matches the order
4432 * in which they were originally installed and handed to the
4435 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
4436 struct ieee80211_vif
*vif
,
4437 void (*iter
)(struct ieee80211_hw
*hw
,
4438 struct ieee80211_vif
*vif
,
4439 struct ieee80211_sta
*sta
,
4440 struct ieee80211_key_conf
*key
,
4445 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4446 * @hw: pointre obtained from ieee80211_alloc_hw().
4447 * @iter: iterator function
4448 * @iter_data: data passed to iterator function
4450 * Iterate all active channel contexts. This function is atomic and
4451 * doesn't acquire any locks internally that might be held in other
4452 * places while calling into the driver.
4454 * The iterator will not find a context that's being added (during
4455 * the driver callback to add it) but will find it while it's being
4458 * Note that during hardware restart, all contexts that existed
4459 * before the restart are considered already present so will be
4460 * found while iterating, whether they've been re-added already
4463 void ieee80211_iter_chan_contexts_atomic(
4464 struct ieee80211_hw
*hw
,
4465 void (*iter
)(struct ieee80211_hw
*hw
,
4466 struct ieee80211_chanctx_conf
*chanctx_conf
,
4471 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4472 * @hw: pointer obtained from ieee80211_alloc_hw().
4473 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4475 * Creates a Probe Request template which can, for example, be uploaded to
4476 * hardware. The template is filled with bssid, ssid and supported rate
4477 * information. This function must only be called from within the
4478 * .bss_info_changed callback function and only in managed mode. The function
4479 * is only useful when the interface is associated, otherwise it will return
4482 * Return: The Probe Request template. %NULL on error.
4484 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
4485 struct ieee80211_vif
*vif
);
4488 * ieee80211_beacon_loss - inform hardware does not receive beacons
4490 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4492 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4493 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4494 * hardware is not receiving beacons with this function.
4496 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
4499 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4501 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4503 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4504 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4505 * needs to inform if the connection to the AP has been lost.
4506 * The function may also be called if the connection needs to be terminated
4507 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4509 * This function will cause immediate change to disassociated state,
4510 * without connection recovery attempts.
4512 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
4515 * ieee80211_resume_disconnect - disconnect from AP after resume
4517 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4519 * Instructs mac80211 to disconnect from the AP after resume.
4520 * Drivers can use this after WoWLAN if they know that the
4521 * connection cannot be kept up, for example because keys were
4522 * used while the device was asleep but the replay counters or
4523 * similar cannot be retrieved from the device during resume.
4525 * Note that due to implementation issues, if the driver uses
4526 * the reconfiguration functionality during resume the interface
4527 * will still be added as associated first during resume and then
4528 * disconnect normally later.
4530 * This function can only be called from the resume callback and
4531 * the driver must not be holding any of its own locks while it
4532 * calls this function, or at least not any locks it needs in the
4533 * key configuration paths (if it supports HW crypto).
4535 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
4538 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4539 * rssi threshold triggered
4541 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4542 * @rssi_event: the RSSI trigger event type
4543 * @gfp: context flags
4545 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4546 * monitoring is configured with an rssi threshold, the driver will inform
4547 * whenever the rssi level reaches the threshold.
4549 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
4550 enum nl80211_cqm_rssi_threshold_event rssi_event
,
4554 * ieee80211_radar_detected - inform that a radar was detected
4556 * @hw: pointer as obtained from ieee80211_alloc_hw()
4558 void ieee80211_radar_detected(struct ieee80211_hw
*hw
);
4561 * ieee80211_chswitch_done - Complete channel switch process
4562 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4563 * @success: make the channel switch successful or not
4565 * Complete the channel switch post-process: set the new operational channel
4566 * and wake up the suspended queues.
4568 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
4571 * ieee80211_request_smps - request SM PS transition
4572 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4573 * @smps_mode: new SM PS mode
4575 * This allows the driver to request an SM PS transition in managed
4576 * mode. This is useful when the driver has more information than
4577 * the stack about possible interference, for example by bluetooth.
4579 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
4580 enum ieee80211_smps_mode smps_mode
);
4583 * ieee80211_ready_on_channel - notification of remain-on-channel start
4584 * @hw: pointer as obtained from ieee80211_alloc_hw()
4586 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
4589 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4590 * @hw: pointer as obtained from ieee80211_alloc_hw()
4592 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
4595 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4597 * in order not to harm the system performance and user experience, the device
4598 * may request not to allow any rx ba session and tear down existing rx ba
4599 * sessions based on system constraints such as periodic BT activity that needs
4600 * to limit wlan activity (eg.sco or a2dp)."
4601 * in such cases, the intention is to limit the duration of the rx ppdu and
4602 * therefore prevent the peer device to use a-mpdu aggregation.
4604 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4605 * @ba_rx_bitmap: Bit map of open rx ba per tid
4606 * @addr: & to bssid mac address
4608 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
4612 * ieee80211_send_bar - send a BlockAckReq frame
4614 * can be used to flush pending frames from the peer's aggregation reorder
4617 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4618 * @ra: the peer's destination address
4619 * @tid: the TID of the aggregation session
4620 * @ssn: the new starting sequence number for the receiver
4622 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
4625 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
4627 * Some device drivers may offload part of the Rx aggregation flow including
4628 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4631 * Create structures responsible for reordering so device drivers may call here
4632 * when they complete AddBa negotiation.
4634 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4635 * @addr: station mac address
4638 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif
*vif
,
4639 const u8
*addr
, u16 tid
);
4642 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
4644 * Some device drivers may offload part of the Rx aggregation flow including
4645 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
4648 * Destroy structures responsible for reordering so device drivers may call here
4649 * when they complete DelBa negotiation.
4651 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4652 * @addr: station mac address
4655 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif
*vif
,
4656 const u8
*addr
, u16 tid
);
4658 /* Rate control API */
4661 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4663 * @hw: The hardware the algorithm is invoked for.
4664 * @sband: The band this frame is being transmitted on.
4665 * @bss_conf: the current BSS configuration
4666 * @skb: the skb that will be transmitted, the control information in it needs
4668 * @reported_rate: The rate control algorithm can fill this in to indicate
4669 * which rate should be reported to userspace as the current rate and
4670 * used for rate calculations in the mesh network.
4671 * @rts: whether RTS will be used for this frame because it is longer than the
4673 * @short_preamble: whether mac80211 will request short-preamble transmission
4674 * if the selected rate supports it
4675 * @max_rate_idx: user-requested maximum (legacy) rate
4676 * (deprecated; this will be removed once drivers get updated to use
4678 * @rate_idx_mask: user-requested (legacy) rate mask
4679 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4680 * @bss: whether this frame is sent out in AP or IBSS mode
4682 struct ieee80211_tx_rate_control
{
4683 struct ieee80211_hw
*hw
;
4684 struct ieee80211_supported_band
*sband
;
4685 struct ieee80211_bss_conf
*bss_conf
;
4686 struct sk_buff
*skb
;
4687 struct ieee80211_tx_rate reported_rate
;
4688 bool rts
, short_preamble
;
4691 u8
*rate_idx_mcs_mask
;
4695 struct rate_control_ops
{
4697 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
4698 void (*free
)(void *priv
);
4700 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
4701 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
4702 struct cfg80211_chan_def
*chandef
,
4703 struct ieee80211_sta
*sta
, void *priv_sta
);
4704 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
4705 struct cfg80211_chan_def
*chandef
,
4706 struct ieee80211_sta
*sta
, void *priv_sta
,
4708 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
4711 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
4712 struct ieee80211_sta
*sta
, void *priv_sta
,
4713 struct sk_buff
*skb
);
4714 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
4715 struct ieee80211_tx_rate_control
*txrc
);
4717 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
4718 struct dentry
*dir
);
4719 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
4721 u32 (*get_expected_throughput
)(void *priv_sta
);
4724 static inline int rate_supported(struct ieee80211_sta
*sta
,
4725 enum ieee80211_band band
,
4728 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
4732 * rate_control_send_low - helper for drivers for management/no-ack frames
4734 * Rate control algorithms that agree to use the lowest rate to
4735 * send management frames and NO_ACK data with the respective hw
4736 * retries should use this in the beginning of their mac80211 get_rate
4737 * callback. If true is returned the rate control can simply return.
4738 * If false is returned we guarantee that sta and sta and priv_sta is
4741 * Rate control algorithms wishing to do more intelligent selection of
4742 * rate for multicast/broadcast frames may choose to not use this.
4744 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4745 * that this may be null.
4746 * @priv_sta: private rate control structure. This may be null.
4747 * @txrc: rate control information we sholud populate for mac80211.
4749 bool rate_control_send_low(struct ieee80211_sta
*sta
,
4751 struct ieee80211_tx_rate_control
*txrc
);
4755 rate_lowest_index(struct ieee80211_supported_band
*sband
,
4756 struct ieee80211_sta
*sta
)
4760 for (i
= 0; i
< sband
->n_bitrates
; i
++)
4761 if (rate_supported(sta
, sband
->band
, i
))
4764 /* warn when we cannot find a rate. */
4767 /* and return 0 (the lowest index) */
4772 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
4773 struct ieee80211_sta
*sta
)
4777 for (i
= 0; i
< sband
->n_bitrates
; i
++)
4778 if (rate_supported(sta
, sband
->band
, i
))
4784 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4786 * When not doing a rate control probe to test rates, rate control should pass
4787 * its rate selection to mac80211. If the driver supports receiving a station
4788 * rate table, it will use it to ensure that frames are always sent based on
4789 * the most recent rate control module decision.
4791 * @hw: pointer as obtained from ieee80211_alloc_hw()
4792 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4793 * @rates: new tx rate set to be used for this station.
4795 int rate_control_set_rates(struct ieee80211_hw
*hw
,
4796 struct ieee80211_sta
*pubsta
,
4797 struct ieee80211_sta_rates
*rates
);
4799 int ieee80211_rate_control_register(const struct rate_control_ops
*ops
);
4800 void ieee80211_rate_control_unregister(const struct rate_control_ops
*ops
);
4803 conf_is_ht20(struct ieee80211_conf
*conf
)
4805 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_20
;
4809 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
4811 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
4812 conf
->chandef
.center_freq1
< conf
->chandef
.chan
->center_freq
;
4816 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
4818 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
4819 conf
->chandef
.center_freq1
> conf
->chandef
.chan
->center_freq
;
4823 conf_is_ht40(struct ieee80211_conf
*conf
)
4825 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
;
4829 conf_is_ht(struct ieee80211_conf
*conf
)
4831 return (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_5
) &&
4832 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_10
) &&
4833 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_20_NOHT
);
4836 static inline enum nl80211_iftype
4837 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
4841 case NL80211_IFTYPE_STATION
:
4842 return NL80211_IFTYPE_P2P_CLIENT
;
4843 case NL80211_IFTYPE_AP
:
4844 return NL80211_IFTYPE_P2P_GO
;
4852 static inline enum nl80211_iftype
4853 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
4855 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
4858 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
4860 int rssi_max_thold
);
4862 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
4865 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4867 * @vif: the specified virtual interface
4869 * Note: This function assumes that the given vif is valid.
4871 * Return: The average RSSI value for the requested interface, or 0 if not
4874 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
4877 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4878 * @vif: virtual interface
4879 * @wakeup: wakeup reason(s)
4880 * @gfp: allocation flags
4882 * See cfg80211_report_wowlan_wakeup().
4884 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif
*vif
,
4885 struct cfg80211_wowlan_wakeup
*wakeup
,
4889 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4890 * @hw: pointer as obtained from ieee80211_alloc_hw()
4891 * @vif: virtual interface
4892 * @skb: frame to be sent from within the driver
4893 * @band: the band to transmit on
4894 * @sta: optional pointer to get the station to send the frame to
4896 * Note: must be called under RCU lock
4898 bool ieee80211_tx_prepare_skb(struct ieee80211_hw
*hw
,
4899 struct ieee80211_vif
*vif
, struct sk_buff
*skb
,
4900 int band
, struct ieee80211_sta
**sta
);
4903 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4905 * @next_tsf: TSF timestamp of the next absent state change
4906 * @has_next_tsf: next absent state change event pending
4908 * @absent: descriptor bitmask, set if GO is currently absent
4912 * @count: count fields from the NoA descriptors
4913 * @desc: adjusted data from the NoA
4915 struct ieee80211_noa_data
{
4921 u8 count
[IEEE80211_P2P_NOA_DESC_MAX
];
4926 } desc
[IEEE80211_P2P_NOA_DESC_MAX
];
4930 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4933 * @data: NoA tracking data
4934 * @tsf: current TSF timestamp
4936 * Return: number of successfully parsed descriptors
4938 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr
*attr
,
4939 struct ieee80211_noa_data
*data
, u32 tsf
);
4942 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4944 * @data: NoA tracking data
4945 * @tsf: current TSF timestamp
4947 void ieee80211_update_p2p_noa(struct ieee80211_noa_data
*data
, u32 tsf
);
4950 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
4951 * @vif: virtual interface
4952 * @peer: the peer's destination address
4953 * @oper: the requested TDLS operation
4954 * @reason_code: reason code for the operation, valid for TDLS teardown
4955 * @gfp: allocation flags
4957 * See cfg80211_tdls_oper_request().
4959 void ieee80211_tdls_oper_request(struct ieee80211_vif
*vif
, const u8
*peer
,
4960 enum nl80211_tdls_operation oper
,
4961 u16 reason_code
, gfp_t gfp
);
4964 * ieee80211_ie_split - split an IE buffer according to ordering
4966 * @ies: the IE buffer
4967 * @ielen: the length of the IE buffer
4968 * @ids: an array with element IDs that are allowed before
4970 * @n_ids: the size of the element ID array
4971 * @offset: offset where to start splitting in the buffer
4973 * This function splits an IE buffer by updating the @offset
4974 * variable to point to the location where the buffer should be
4977 * It assumes that the given IE buffer is well-formed, this
4978 * has to be guaranteed by the caller!
4980 * It also assumes that the IEs in the buffer are ordered
4981 * correctly, if not the result of using this function will not
4982 * be ordered correctly either, i.e. it does no reordering.
4984 * The function returns the offset where the next part of the
4985 * buffer starts, which may be @ielen if the entire (remainder)
4986 * of the buffer should be used.
4988 size_t ieee80211_ie_split(const u8
*ies
, size_t ielen
,
4989 const u8
*ids
, int n_ids
, size_t offset
);
4990 #endif /* MAC80211_H */