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.
88 * DOC: mac80211 software tx queueing
90 * mac80211 provides an optional intermediate queueing implementation designed
91 * to allow the driver to keep hardware queues short and provide some fairness
92 * between different stations/interfaces.
93 * In this model, the driver pulls data frames from the mac80211 queue instead
94 * of letting mac80211 push them via drv_tx().
95 * Other frames (e.g. control or management) are still pushed using drv_tx().
97 * Drivers indicate that they use this model by implementing the .wake_tx_queue
100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
101 * single per-vif queue for multicast data frames.
103 * The driver is expected to initialize its private per-queue data for stations
104 * and interfaces in the .add_interface and .sta_add ops.
106 * The driver can't access the queue directly. To dequeue a frame, it calls
107 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
108 * calls the .wake_tx_queue driver op.
110 * For AP powersave TIM handling, the driver only needs to indicate if it has
111 * buffered packets in the driver specific data structures by calling
112 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
113 * struct, mac80211 sets the appropriate TIM PVB bits and calls
114 * .release_buffered_frames().
115 * In that callback the driver is therefore expected to release its own
116 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
117 * via the usual ieee80211_tx_dequeue).
123 * enum ieee80211_max_queues - maximum number of queues
125 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
126 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
128 enum ieee80211_max_queues {
129 IEEE80211_MAX_QUEUES = 16,
130 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
133 #define IEEE80211_INVAL_HW_QUEUE 0xff
136 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
137 * @IEEE80211_AC_VO: voice
138 * @IEEE80211_AC_VI: video
139 * @IEEE80211_AC_BE: best effort
140 * @IEEE80211_AC_BK: background
142 enum ieee80211_ac_numbers {
148 #define IEEE80211_NUM_ACS 4
151 * struct ieee80211_tx_queue_params - transmit queue configuration
153 * The information provided in this structure is required for QoS
154 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
156 * @aifs: arbitration interframe space [0..255]
157 * @cw_min: minimum contention window [a value of the form
158 * 2^n-1 in the range 1..32767]
159 * @cw_max: maximum contention window [like @cw_min]
160 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
161 * @acm: is mandatory admission control required for the access category
162 * @uapsd: is U-APSD mode enabled for the queue
164 struct ieee80211_tx_queue_params {
173 struct ieee80211_low_level_stats {
174 unsigned int dot11ACKFailureCount;
175 unsigned int dot11RTSFailureCount;
176 unsigned int dot11FCSErrorCount;
177 unsigned int dot11RTSSuccessCount;
181 * enum ieee80211_chanctx_change - change flag for channel context
182 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
183 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
184 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
185 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
186 * this is used only with channel switching with CSA
187 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
189 enum ieee80211_chanctx_change {
190 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
191 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
192 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
193 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
194 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
198 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
200 * This is the driver-visible part. The ieee80211_chanctx
201 * that contains it is visible in mac80211 only.
203 * @def: the channel definition
204 * @min_def: the minimum channel definition currently required.
205 * @rx_chains_static: The number of RX chains that must always be
206 * active on the channel to receive MIMO transmissions
207 * @rx_chains_dynamic: The number of RX chains that must be enabled
208 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
209 * this will always be >= @rx_chains_static.
210 * @radar_enabled: whether radar detection is enabled on this channel.
211 * @drv_priv: data area for driver use, will always be aligned to
212 * sizeof(void *), size is determined in hw information.
214 struct ieee80211_chanctx_conf {
215 struct cfg80211_chan_def def;
216 struct cfg80211_chan_def min_def;
218 u8 rx_chains_static, rx_chains_dynamic;
222 u8 drv_priv[0] __aligned(sizeof(void *));
226 * enum ieee80211_chanctx_switch_mode - channel context switch mode
227 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
228 * exist (and will continue to exist), but the virtual interface
229 * needs to be switched from one to the other.
230 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
231 * to exist with this call, the new context doesn't exist but
232 * will be active after this call, the virtual interface switches
233 * from the old to the new (note that the driver may of course
234 * implement this as an on-the-fly chandef switch of the existing
235 * hardware context, but the mac80211 pointer for the old context
236 * will cease to exist and only the new one will later be used
237 * for changes/removal.)
239 enum ieee80211_chanctx_switch_mode {
240 CHANCTX_SWMODE_REASSIGN_VIF,
241 CHANCTX_SWMODE_SWAP_CONTEXTS,
245 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
247 * This is structure is used to pass information about a vif that
248 * needs to switch from one chanctx to another. The
249 * &ieee80211_chanctx_switch_mode defines how the switch should be
252 * @vif: the vif that should be switched from old_ctx to new_ctx
253 * @old_ctx: the old context to which the vif was assigned
254 * @new_ctx: the new context to which the vif must be assigned
256 struct ieee80211_vif_chanctx_switch {
257 struct ieee80211_vif *vif;
258 struct ieee80211_chanctx_conf *old_ctx;
259 struct ieee80211_chanctx_conf *new_ctx;
263 * enum ieee80211_bss_change - BSS change notification flags
265 * These flags are used with the bss_info_changed() callback
266 * to indicate which BSS parameter changed.
268 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
269 * also implies a change in the AID.
270 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
271 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
272 * @BSS_CHANGED_ERP_SLOT: slot timing changed
273 * @BSS_CHANGED_HT: 802.11n parameters changed
274 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
275 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
276 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
277 * reason (IBSS and managed mode)
278 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
279 * new beacon (beaconing modes)
280 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
281 * enabled/disabled (beaconing modes)
282 * @BSS_CHANGED_CQM: Connection quality monitor config changed
283 * @BSS_CHANGED_IBSS: IBSS join status changed
284 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
285 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
286 * that it is only ever disabled for station mode.
287 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
288 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
289 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
290 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
291 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
292 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
293 * changed (currently only in P2P client mode, GO mode will be later)
294 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
295 * currently dtim_period only is under consideration.
296 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
297 * note that this is only called when it changes after the channel
298 * context had been assigned.
299 * @BSS_CHANGED_OCB: OCB join status changed
301 enum ieee80211_bss_change {
302 BSS_CHANGED_ASSOC = 1<<0,
303 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
304 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
305 BSS_CHANGED_ERP_SLOT = 1<<3,
306 BSS_CHANGED_HT = 1<<4,
307 BSS_CHANGED_BASIC_RATES = 1<<5,
308 BSS_CHANGED_BEACON_INT = 1<<6,
309 BSS_CHANGED_BSSID = 1<<7,
310 BSS_CHANGED_BEACON = 1<<8,
311 BSS_CHANGED_BEACON_ENABLED = 1<<9,
312 BSS_CHANGED_CQM = 1<<10,
313 BSS_CHANGED_IBSS = 1<<11,
314 BSS_CHANGED_ARP_FILTER = 1<<12,
315 BSS_CHANGED_QOS = 1<<13,
316 BSS_CHANGED_IDLE = 1<<14,
317 BSS_CHANGED_SSID = 1<<15,
318 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
319 BSS_CHANGED_PS = 1<<17,
320 BSS_CHANGED_TXPOWER = 1<<18,
321 BSS_CHANGED_P2P_PS = 1<<19,
322 BSS_CHANGED_BEACON_INFO = 1<<20,
323 BSS_CHANGED_BANDWIDTH = 1<<21,
324 BSS_CHANGED_OCB = 1<<22,
326 /* when adding here, make sure to change ieee80211_reconfig */
330 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
331 * of addresses for an interface increase beyond this value, hardware ARP
332 * filtering will be disabled.
334 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
337 * enum ieee80211_event_type - event to be notified to the low level driver
338 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
339 * @MLME_EVENT: event related to MLME
340 * @BAR_RX_EVENT: a BAR was received
341 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
342 * they timed out. This won't be called for each frame released, but only
343 * once each time the timeout triggers.
345 enum ieee80211_event_type {
353 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
354 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
355 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
357 enum ieee80211_rssi_event_data {
363 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
364 * @data: See &enum ieee80211_rssi_event_data
366 struct ieee80211_rssi_event {
367 enum ieee80211_rssi_event_data data;
371 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
372 * @AUTH_EVENT: the MLME operation is authentication
373 * @ASSOC_EVENT: the MLME operation is association
374 * @DEAUTH_RX_EVENT: deauth received..
375 * @DEAUTH_TX_EVENT: deauth sent.
377 enum ieee80211_mlme_event_data {
385 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
386 * @MLME_SUCCESS: the MLME operation completed successfully.
387 * @MLME_DENIED: the MLME operation was denied by the peer.
388 * @MLME_TIMEOUT: the MLME operation timed out.
390 enum ieee80211_mlme_event_status {
397 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
398 * @data: See &enum ieee80211_mlme_event_data
399 * @status: See &enum ieee80211_mlme_event_status
400 * @reason: the reason code if applicable
402 struct ieee80211_mlme_event {
403 enum ieee80211_mlme_event_data data;
404 enum ieee80211_mlme_event_status status;
409 * struct ieee80211_ba_event - data attached for BlockAck related events
410 * @sta: pointer to the &ieee80211_sta to which this event relates
412 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
414 struct ieee80211_ba_event {
415 struct ieee80211_sta *sta;
421 * struct ieee80211_event - event to be sent to the driver
422 * @type: The event itself. See &enum ieee80211_event_type.
423 * @rssi: relevant if &type is %RSSI_EVENT
424 * @mlme: relevant if &type is %AUTH_EVENT
425 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
426 * @u:union holding the fields above
428 struct ieee80211_event {
429 enum ieee80211_event_type type;
431 struct ieee80211_rssi_event rssi;
432 struct ieee80211_mlme_event mlme;
433 struct ieee80211_ba_event ba;
438 * struct ieee80211_bss_conf - holds the BSS's changing parameters
440 * This structure keeps information about a BSS (and an association
441 * to that BSS) that can change during the lifetime of the BSS.
443 * @assoc: association status
444 * @ibss_joined: indicates whether this station is part of an IBSS
446 * @ibss_creator: indicates if a new IBSS network is being created
447 * @aid: association ID number, valid only when @assoc is true
448 * @use_cts_prot: use CTS protection
449 * @use_short_preamble: use 802.11b short preamble
450 * @use_short_slot: use short slot time (only relevant for ERP)
451 * @dtim_period: num of beacons before the next DTIM, for beaconing,
452 * valid in station mode only if after the driver was notified
453 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
454 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
455 * as it may have been received during scanning long ago). If the
456 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
457 * only come from a beacon, but might not become valid until after
458 * association when a beacon is received (which is notified with the
459 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
460 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
461 * the driver/device can use this to calculate synchronisation
462 * (see @sync_tsf). See also sync_dtim_count important notice.
463 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
464 * is requested, see @sync_tsf/@sync_device_ts.
465 * IMPORTANT: These three sync_* parameters would possibly be out of sync
466 * by the time the driver will use them. The synchronized view is currently
467 * guaranteed only in certain callbacks.
468 * @beacon_int: beacon interval
469 * @assoc_capability: capabilities taken from assoc resp
470 * @basic_rates: bitmap of basic rates, each bit stands for an
471 * index into the rate table configured by the driver in
473 * @beacon_rate: associated AP's beacon TX rate
474 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
475 * @bssid: The BSSID for this BSS
476 * @enable_beacon: whether beaconing should be enabled or not
477 * @chandef: Channel definition for this BSS -- the hardware might be
478 * configured a higher bandwidth than this BSS uses, for example.
479 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
480 * This field is only valid when the channel type is one of the HT types.
481 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
483 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
484 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
485 * may filter ARP queries targeted for other addresses than listed here.
486 * The driver must allow ARP queries targeted for all address listed here
487 * to pass through. An empty list implies no ARP queries need to pass.
488 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
489 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
490 * array size), it's up to the driver what to do in that case.
491 * @qos: This is a QoS-enabled BSS.
492 * @idle: This interface is idle. There's also a global idle flag in the
493 * hardware config which may be more appropriate depending on what
494 * your driver/device needs to do.
495 * @ps: power-save mode (STA only). This flag is NOT affected by
496 * offchannel/dynamic_ps operations.
497 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
498 * @ssid_len: Length of SSID given in @ssid.
499 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
500 * @txpower: TX power in dBm
501 * @txpower_type: TX power adjustment used to control per packet Transmit
502 * Power Control (TPC) in lower driver for the current vif. In particular
503 * TPC is enabled if value passed in %txpower_type is
504 * NL80211_TX_POWER_LIMITED (allow using less than specified from
505 * userspace), whereas TPC is disabled if %txpower_type is set to
506 * NL80211_TX_POWER_FIXED (use value configured from userspace)
507 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
509 struct ieee80211_bss_conf {
511 /* association related data */
512 bool assoc, ibss_joined;
515 /* erp related data */
517 bool use_short_preamble;
522 u16 assoc_capability;
527 struct ieee80211_rate *beacon_rate;
528 int mcast_rate[IEEE80211_NUM_BANDS];
529 u16 ht_operation_mode;
532 struct cfg80211_chan_def chandef;
533 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
538 u8 ssid[IEEE80211_MAX_SSID_LEN];
542 enum nl80211_tx_power_setting txpower_type;
543 struct ieee80211_p2p_noa_attr p2p_noa_attr;
547 * enum mac80211_tx_info_flags - flags to describe transmission information/status
549 * These flags are used with the @flags member of &ieee80211_tx_info.
551 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
552 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
553 * number to this frame, taking care of not overwriting the fragment
554 * number and increasing the sequence number only when the
555 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
556 * assign sequence numbers to QoS-data frames but cannot do so correctly
557 * for non-QoS-data and management frames because beacons need them from
558 * that counter as well and mac80211 cannot guarantee proper sequencing.
559 * If this flag is set, the driver should instruct the hardware to
560 * assign a sequence number to the frame or assign one itself. Cf. IEEE
561 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
562 * beacons and always be clear for frames without a sequence number field.
563 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
564 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
566 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
567 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
568 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
569 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
570 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
571 * because the destination STA was in powersave mode. Note that to
572 * avoid race conditions, the filter must be set by the hardware or
573 * firmware upon receiving a frame that indicates that the station
574 * went to sleep (must be done on device to filter frames already on
575 * the queue) and may only be unset after mac80211 gives the OK for
576 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
577 * since only then is it guaranteed that no more frames are in the
579 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
580 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
581 * is for the whole aggregation.
582 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
583 * so consider using block ack request (BAR).
584 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
585 * set by rate control algorithms to indicate probe rate, will
586 * be cleared for fragmented frames (except on the last fragment)
587 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
588 * that a frame can be transmitted while the queues are stopped for
589 * off-channel operation.
590 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
591 * used to indicate that a pending frame requires TX processing before
592 * it can be sent out.
593 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
594 * used to indicate that a frame was already retried due to PS
595 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
596 * used to indicate frame should not be encrypted
597 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
598 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
599 * be sent although the station is in powersave mode.
600 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
601 * transmit function after the current frame, this can be used
602 * by drivers to kick the DMA queue only if unset or when the
604 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
605 * after TX status because the destination was asleep, it must not
606 * be modified again (no seqno assignment, crypto, etc.)
607 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
608 * code for connection establishment, this indicates that its status
609 * should kick the MLME state machine.
610 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
611 * MLME command (internal to mac80211 to figure out whether to send TX
612 * status to user space)
613 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
614 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
615 * frame and selects the maximum number of streams that it can use.
616 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
617 * the off-channel channel when a remain-on-channel offload is done
618 * in hardware -- normal packets still flow and are expected to be
619 * handled properly by the device.
620 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
621 * testing. It will be sent out with incorrect Michael MIC key to allow
622 * TKIP countermeasures to be tested.
623 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
624 * This flag is actually used for management frame especially for P2P
625 * frames not being sent at CCK rate in 2GHz band.
626 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
627 * when its status is reported the service period ends. For frames in
628 * an SP that mac80211 transmits, it is already set; for driver frames
629 * the driver may set this flag. It is also used to do the same for
631 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
632 * This flag is used to send nullfunc frame at minimum rate when
633 * the nullfunc is used for connection monitoring purpose.
634 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
635 * would be fragmented by size (this is optional, only used for
636 * monitor injection).
637 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
638 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
639 * any errors (like issues specific to the driver/HW).
640 * This flag must not be set for frames that don't request no-ack
641 * behaviour with IEEE80211_TX_CTL_NO_ACK.
643 * Note: If you have to add new flags to the enumeration, then don't
644 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
646 enum mac80211_tx_info_flags {
647 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
648 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
649 IEEE80211_TX_CTL_NO_ACK = BIT(2),
650 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
651 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
652 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
653 IEEE80211_TX_CTL_AMPDU = BIT(6),
654 IEEE80211_TX_CTL_INJECTED = BIT(7),
655 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
656 IEEE80211_TX_STAT_ACK = BIT(9),
657 IEEE80211_TX_STAT_AMPDU = BIT(10),
658 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
659 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
660 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
661 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
662 IEEE80211_TX_INTFL_RETRIED = BIT(15),
663 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
664 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
665 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
666 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
667 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
668 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
669 IEEE80211_TX_CTL_LDPC = BIT(22),
670 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
671 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
672 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
673 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
674 IEEE80211_TX_STATUS_EOSP = BIT(28),
675 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
676 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
677 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
680 #define IEEE80211_TX_CTL_STBC_SHIFT 23
683 * enum mac80211_tx_control_flags - flags to describe transmit control
685 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
686 * protocol frame (e.g. EAP)
687 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
688 * frame (PS-Poll or uAPSD).
690 * These flags are used in tx_info->control.flags.
692 enum mac80211_tx_control_flags {
693 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
694 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
698 * This definition is used as a mask to clear all temporary flags, which are
699 * set by the tx handlers for each transmission attempt by the mac80211 stack.
701 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
702 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
703 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
704 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
705 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
706 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
707 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
708 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
711 * enum mac80211_rate_control_flags - per-rate flags set by the
712 * Rate Control algorithm.
714 * These flags are set by the Rate control algorithm for each rate during tx,
715 * in the @flags member of struct ieee80211_tx_rate.
717 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
718 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
719 * This is set if the current BSS requires ERP protection.
720 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
721 * @IEEE80211_TX_RC_MCS: HT rate.
722 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
723 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
724 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
726 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
727 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
728 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
729 * (80+80 isn't supported yet)
730 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
731 * adjacent 20 MHz channels, if the current channel type is
732 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
733 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
735 enum mac80211_rate_control_flags {
736 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
737 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
738 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
740 /* rate index is an HT/VHT MCS instead of an index */
741 IEEE80211_TX_RC_MCS = BIT(3),
742 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
743 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
744 IEEE80211_TX_RC_DUP_DATA = BIT(6),
745 IEEE80211_TX_RC_SHORT_GI = BIT(7),
746 IEEE80211_TX_RC_VHT_MCS = BIT(8),
747 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
748 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
752 /* there are 40 bytes if you don't need the rateset to be kept */
753 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
755 /* if you do need the rateset, then you have less space */
756 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
758 /* maximum number of rate stages */
759 #define IEEE80211_TX_MAX_RATES 4
761 /* maximum number of rate table entries */
762 #define IEEE80211_TX_RATE_TABLE_SIZE 4
765 * struct ieee80211_tx_rate - rate selection/status
767 * @idx: rate index to attempt to send with
768 * @flags: rate control flags (&enum mac80211_rate_control_flags)
769 * @count: number of tries in this rate before going to the next rate
771 * A value of -1 for @idx indicates an invalid rate and, if used
772 * in an array of retry rates, that no more rates should be tried.
774 * When used for transmit status reporting, the driver should
775 * always report the rate along with the flags it used.
777 * &struct ieee80211_tx_info contains an array of these structs
778 * in the control information, and it will be filled by the rate
779 * control algorithm according to what should be sent. For example,
780 * if this array contains, in the format { <idx>, <count> } the
782 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
783 * then this means that the frame should be transmitted
784 * up to twice at rate 3, up to twice at rate 2, and up to four
785 * times at rate 1 if it doesn't get acknowledged. Say it gets
786 * acknowledged by the peer after the fifth attempt, the status
787 * information should then contain
788 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
789 * since it was transmitted twice at rate 3, twice at rate 2
790 * and once at rate 1 after which we received an acknowledgement.
792 struct ieee80211_tx_rate {
798 #define IEEE80211_MAX_TX_RETRY 31
800 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
804 WARN_ON((nss - 1) & ~0x7);
805 rate->idx = ((nss - 1) << 4) | mcs;
809 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
811 return rate->idx & 0xF;
815 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
817 return (rate->idx >> 4) + 1;
821 * struct ieee80211_tx_info - skb transmit information
823 * This structure is placed in skb->cb for three uses:
824 * (1) mac80211 TX control - mac80211 tells the driver what to do
825 * (2) driver internal use (if applicable)
826 * (3) TX status information - driver tells mac80211 what happened
828 * @flags: transmit info flags, defined above
829 * @band: the band to transmit on (use for checking for races)
830 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
831 * @ack_frame_id: internal frame ID for TX status, used internally
832 * @control: union for control data
833 * @status: union for status data
834 * @driver_data: array of driver_data pointers
835 * @ampdu_ack_len: number of acked aggregated frames.
836 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
837 * @ampdu_len: number of aggregated frames.
838 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
839 * @ack_signal: signal strength of the ACK frame
841 struct ieee80211_tx_info {
842 /* common information */
855 struct ieee80211_tx_rate rates[
856 IEEE80211_TX_MAX_RATES];
864 /* only needed before rate control */
865 unsigned long jiffies;
867 /* NB: vif can be NULL for injected frames */
868 struct ieee80211_vif *vif;
869 struct ieee80211_key_conf *hw_key;
877 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
883 void *status_driver_data[19 / sizeof(void *)];
886 struct ieee80211_tx_rate driver_rates[
887 IEEE80211_TX_MAX_RATES];
890 void *rate_driver_data[
891 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
894 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
899 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
901 * This structure is used to point to different blocks of IEs in HW scan
902 * and scheduled scan. These blocks contain the IEs passed by userspace
903 * and the ones generated by mac80211.
905 * @ies: pointers to band specific IEs.
906 * @len: lengths of band_specific IEs.
907 * @common_ies: IEs for all bands (especially vendor specific ones)
908 * @common_ie_len: length of the common_ies
910 struct ieee80211_scan_ies {
911 const u8 *ies[IEEE80211_NUM_BANDS];
912 size_t len[IEEE80211_NUM_BANDS];
913 const u8 *common_ies;
914 size_t common_ie_len;
918 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
920 return (struct ieee80211_tx_info *)skb->cb;
923 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
925 return (struct ieee80211_rx_status *)skb->cb;
929 * ieee80211_tx_info_clear_status - clear TX status
931 * @info: The &struct ieee80211_tx_info to be cleared.
933 * When the driver passes an skb back to mac80211, it must report
934 * a number of things in TX status. This function clears everything
935 * in the TX status but the rate control information (it does clear
936 * the count since you need to fill that in anyway).
938 * NOTE: You can only use this function if you do NOT use
939 * info->driver_data! Use info->rate_driver_data
940 * instead if you need only the less space that allows.
943 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
947 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
948 offsetof(struct ieee80211_tx_info, control.rates));
949 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
950 offsetof(struct ieee80211_tx_info, driver_rates));
951 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
952 /* clear the rate counts */
953 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
954 info->status.rates[i].count = 0;
957 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
958 memset(&info->status.ampdu_ack_len, 0,
959 sizeof(struct ieee80211_tx_info) -
960 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
965 * enum mac80211_rx_flags - receive flags
967 * These flags are used with the @flag member of &struct ieee80211_rx_status.
968 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
969 * Use together with %RX_FLAG_MMIC_STRIPPED.
970 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
971 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
972 * verification has been done by the hardware.
973 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
974 * If this flag is set, the stack cannot do any replay detection
975 * hence the driver or hardware will have to do that.
976 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
978 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
980 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
981 * field) is valid and contains the time the first symbol of the MPDU
982 * was received. This is useful in monitor mode and for proper IBSS
984 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
985 * field) is valid and contains the time the last symbol of the MPDU
986 * (including FCS) was received.
987 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
988 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
989 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
990 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
991 * @RX_FLAG_SHORT_GI: Short guard interval was used
992 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
993 * Valid only for data frames (mainly A-MPDU)
994 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
995 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
996 * to hw.radiotap_mcs_details to advertise that fact
997 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
998 * number (@ampdu_reference) must be populated and be a distinct number for
1000 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
1001 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
1002 * monitoring purposes only
1003 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1004 * subframes of a single A-MPDU
1005 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1006 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1008 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1009 * is stored in the @ampdu_delimiter_crc field)
1010 * @RX_FLAG_LDPC: LDPC was used
1011 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1012 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1013 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1014 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1015 * subframes instead of a one huge frame for performance reasons.
1016 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1017 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1018 * the 3rd (last) one must not have this flag set. The flag is used to
1019 * deal with retransmission/duplication recovery properly since A-MSDU
1020 * subframes share the same sequence number. Reported subframes can be
1021 * either regular MSDU or singly A-MSDUs. Subframes must not be
1022 * interleaved with other frames.
1023 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1024 * radiotap data in the skb->data (before the frame) as described by
1025 * the &struct ieee80211_vendor_radiotap.
1027 enum mac80211_rx_flags {
1028 RX_FLAG_MMIC_ERROR = BIT(0),
1029 RX_FLAG_DECRYPTED = BIT(1),
1030 RX_FLAG_MMIC_STRIPPED = BIT(3),
1031 RX_FLAG_IV_STRIPPED = BIT(4),
1032 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1033 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1034 RX_FLAG_MACTIME_START = BIT(7),
1035 RX_FLAG_SHORTPRE = BIT(8),
1036 RX_FLAG_HT = BIT(9),
1037 RX_FLAG_40MHZ = BIT(10),
1038 RX_FLAG_SHORT_GI = BIT(11),
1039 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1040 RX_FLAG_HT_GF = BIT(13),
1041 RX_FLAG_AMPDU_DETAILS = BIT(14),
1042 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
1043 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
1044 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1045 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1046 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1047 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1048 RX_FLAG_MACTIME_END = BIT(21),
1049 RX_FLAG_VHT = BIT(22),
1050 RX_FLAG_LDPC = BIT(23),
1051 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1052 RX_FLAG_10MHZ = BIT(28),
1053 RX_FLAG_5MHZ = BIT(29),
1054 RX_FLAG_AMSDU_MORE = BIT(30),
1055 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1058 #define RX_FLAG_STBC_SHIFT 26
1061 * enum mac80211_rx_vht_flags - receive VHT flags
1063 * These flags are used with the @vht_flag member of
1064 * &struct ieee80211_rx_status.
1065 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1066 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1067 * @RX_VHT_FLAG_BF: packet was beamformed
1069 enum mac80211_rx_vht_flags {
1070 RX_VHT_FLAG_80MHZ = BIT(0),
1071 RX_VHT_FLAG_160MHZ = BIT(1),
1072 RX_VHT_FLAG_BF = BIT(2),
1076 * struct ieee80211_rx_status - receive status
1078 * The low-level driver should provide this information (the subset
1079 * supported by hardware) to the 802.11 code with each received
1080 * frame, in the skb's control buffer (cb).
1082 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1083 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1084 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1085 * it but can store it and pass it back to the driver for synchronisation
1086 * @band: the active band when this frame was received
1087 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1088 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1089 * unspecified depending on the hardware capabilities flags
1090 * @IEEE80211_HW_SIGNAL_*
1091 * @chains: bitmask of receive chains for which separate signal strength
1092 * values were filled.
1093 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1094 * support dB or unspecified units)
1095 * @antenna: antenna used
1096 * @rate_idx: index of data rate into band's supported rates or MCS index if
1097 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1098 * @vht_nss: number of streams (VHT only)
1100 * @vht_flag: %RX_VHT_FLAG_*
1101 * @rx_flags: internal RX flags for mac80211
1102 * @ampdu_reference: A-MPDU reference number, must be a different value for
1103 * each A-MPDU but the same for each subframe within one A-MPDU
1104 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1106 struct ieee80211_rx_status {
1108 u32 device_timestamp;
1109 u32 ampdu_reference;
1120 s8 chain_signal[IEEE80211_MAX_CHAINS];
1121 u8 ampdu_delimiter_crc;
1125 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1126 * @present: presence bitmap for this vendor namespace
1127 * (this could be extended in the future if any vendor needs more
1128 * bits, the radiotap spec does allow for that)
1129 * @align: radiotap vendor namespace alignment. This defines the needed
1130 * alignment for the @data field below, not for the vendor namespace
1131 * description itself (which has a fixed 2-byte alignment)
1132 * Must be a power of two, and be set to at least 1!
1133 * @oui: radiotap vendor namespace OUI
1134 * @subns: radiotap vendor sub namespace
1135 * @len: radiotap vendor sub namespace skip length, if alignment is done
1136 * then that's added to this, i.e. this is only the length of the
1138 * @pad: number of bytes of padding after the @data, this exists so that
1139 * the skb data alignment can be preserved even if the data has odd
1141 * @data: the actual vendor namespace data
1143 * This struct, including the vendor data, goes into the skb->data before
1144 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1147 struct ieee80211_vendor_radiotap {
1158 * enum ieee80211_conf_flags - configuration flags
1160 * Flags to define PHY configuration options
1162 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1163 * to determine for example whether to calculate timestamps for packets
1164 * or not, do not use instead of filter flags!
1165 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1166 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1167 * meaning that the hardware still wakes up for beacons, is able to
1168 * transmit frames and receive the possible acknowledgment frames.
1169 * Not to be confused with hardware specific wakeup/sleep states,
1170 * driver is responsible for that. See the section "Powersave support"
1172 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1173 * the driver should be prepared to handle configuration requests but
1174 * may turn the device off as much as possible. Typically, this flag will
1175 * be set when an interface is set UP but not associated or scanning, but
1176 * it can also be unset in that case when monitor interfaces are active.
1177 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1178 * operating channel.
1180 enum ieee80211_conf_flags {
1181 IEEE80211_CONF_MONITOR = (1<<0),
1182 IEEE80211_CONF_PS = (1<<1),
1183 IEEE80211_CONF_IDLE = (1<<2),
1184 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1189 * enum ieee80211_conf_changed - denotes which configuration changed
1191 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1192 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1193 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1194 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1195 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1196 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1197 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1198 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1199 * Note that this is only valid if channel contexts are not used,
1200 * otherwise each channel context has the number of chains listed.
1202 enum ieee80211_conf_changed {
1203 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1204 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1205 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1206 IEEE80211_CONF_CHANGE_PS = BIT(4),
1207 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1208 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1209 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1210 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1214 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1216 * @IEEE80211_SMPS_AUTOMATIC: automatic
1217 * @IEEE80211_SMPS_OFF: off
1218 * @IEEE80211_SMPS_STATIC: static
1219 * @IEEE80211_SMPS_DYNAMIC: dynamic
1220 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1222 enum ieee80211_smps_mode {
1223 IEEE80211_SMPS_AUTOMATIC,
1225 IEEE80211_SMPS_STATIC,
1226 IEEE80211_SMPS_DYNAMIC,
1229 IEEE80211_SMPS_NUM_MODES,
1233 * struct ieee80211_conf - configuration of the device
1235 * This struct indicates how the driver shall configure the hardware.
1237 * @flags: configuration flags defined above
1239 * @listen_interval: listen interval in units of beacon interval
1240 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1241 * before checking the beacon for a TIM bit (managed mode only); this
1242 * value will be only achievable between DTIM frames, the hardware
1243 * needs to check for the multicast traffic bit in DTIM beacons.
1244 * This variable is valid only when the CONF_PS flag is set.
1245 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1246 * in power saving. Power saving will not be enabled until a beacon
1247 * has been received and the DTIM period is known.
1248 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1249 * powersave documentation below. This variable is valid only when
1250 * the CONF_PS flag is set.
1252 * @power_level: requested transmit power (in dBm), backward compatibility
1253 * value only that is set to the minimum of all interfaces
1255 * @chandef: the channel definition to tune to
1256 * @radar_enabled: whether radar detection is enabled
1258 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1259 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1260 * but actually means the number of transmissions not the number of retries
1261 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1262 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1263 * number of transmissions not the number of retries
1265 * @smps_mode: spatial multiplexing powersave mode; note that
1266 * %IEEE80211_SMPS_STATIC is used when the device is not
1267 * configured for an HT channel.
1268 * Note that this is only valid if channel contexts are not used,
1269 * otherwise each channel context has the number of chains listed.
1271 struct ieee80211_conf {
1273 int power_level, dynamic_ps_timeout;
1274 int max_sleep_period;
1276 u16 listen_interval;
1279 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1281 struct cfg80211_chan_def chandef;
1283 enum ieee80211_smps_mode smps_mode;
1287 * struct ieee80211_channel_switch - holds the channel switch data
1289 * The information provided in this structure is required for channel switch
1292 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1293 * Function (TSF) timer when the frame containing the channel switch
1294 * announcement was received. This is simply the rx.mactime parameter
1295 * the driver passed into mac80211.
1296 * @device_timestamp: arbitrary timestamp for the device, this is the
1297 * rx.device_timestamp parameter the driver passed to mac80211.
1298 * @block_tx: Indicates whether transmission must be blocked before the
1299 * scheduled channel switch, as indicated by the AP.
1300 * @chandef: the new channel to switch to
1301 * @count: the number of TBTT's until the channel switch event
1303 struct ieee80211_channel_switch {
1305 u32 device_timestamp;
1307 struct cfg80211_chan_def chandef;
1312 * enum ieee80211_vif_flags - virtual interface flags
1314 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1315 * on this virtual interface to avoid unnecessary CPU wakeups
1316 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1317 * monitoring on this virtual interface -- i.e. it can monitor
1318 * connection quality related parameters, such as the RSSI level and
1319 * provide notifications if configured trigger levels are reached.
1320 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1321 * interface. This flag should be set during interface addition,
1322 * but may be set/cleared as late as authentication to an AP. It is
1323 * only valid for managed/station mode interfaces.
1325 enum ieee80211_vif_flags {
1326 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1327 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1328 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1332 * struct ieee80211_vif - per-interface data
1334 * Data in this structure is continually present for driver
1335 * use during the life of a virtual interface.
1337 * @type: type of this virtual interface
1338 * @bss_conf: BSS configuration for this interface, either our own
1339 * or the BSS we're associated to
1340 * @addr: address of this interface
1341 * @p2p: indicates whether this AP or STA interface is a p2p
1342 * interface, i.e. a GO or p2p-sta respectively
1343 * @csa_active: marks whether a channel switch is going on. Internally it is
1344 * write-protected by sdata_lock and local->mtx so holding either is fine
1346 * @driver_flags: flags/capabilities the driver has for this interface,
1347 * these need to be set (or cleared) when the interface is added
1348 * or, if supported by the driver, the interface type is changed
1349 * at runtime, mac80211 will never touch this field
1350 * @hw_queue: hardware queue for each AC
1351 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1352 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1353 * when it is not assigned. This pointer is RCU-protected due to the TX
1354 * path needing to access it; even though the netdev carrier will always
1355 * be off when it is %NULL there can still be races and packets could be
1356 * processed after it switches back to %NULL.
1357 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1358 * interface debug files. Note that it will be NULL for the virtual
1359 * monitor interface (if that is requested.)
1360 * @drv_priv: data area for driver use, will always be aligned to
1362 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1364 struct ieee80211_vif {
1365 enum nl80211_iftype type;
1366 struct ieee80211_bss_conf bss_conf;
1372 u8 hw_queue[IEEE80211_NUM_ACS];
1374 struct ieee80211_txq *txq;
1376 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1380 #ifdef CONFIG_MAC80211_DEBUGFS
1381 struct dentry *debugfs_dir;
1385 u8 drv_priv[0] __aligned(sizeof(void *));
1388 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1390 #ifdef CONFIG_MAC80211_MESH
1391 return vif->type == NL80211_IFTYPE_MESH_POINT;
1397 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1398 * @wdev: the wdev to get the vif for
1400 * This can be used by mac80211 drivers with direct cfg80211 APIs
1401 * (like the vendor commands) that get a wdev.
1403 * Note that this function may return %NULL if the given wdev isn't
1404 * associated with a vif that the driver knows about (e.g. monitor
1405 * or AP_VLAN interfaces.)
1407 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1410 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1411 * @vif: the vif to get the wdev for
1413 * This can be used by mac80211 drivers with direct cfg80211 APIs
1414 * (like the vendor commands) that needs to get the wdev for a vif.
1416 * Note that this function may return %NULL if the given wdev isn't
1417 * associated with a vif that the driver knows about (e.g. monitor
1418 * or AP_VLAN interfaces.)
1420 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1423 * enum ieee80211_key_flags - key flags
1425 * These flags are used for communication about keys between the driver
1426 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1428 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1429 * driver to indicate that it requires IV generation for this
1430 * particular key. Setting this flag does not necessarily mean that SKBs
1431 * will have sufficient tailroom for ICV or MIC.
1432 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1433 * the driver for a TKIP key if it requires Michael MIC
1434 * generation in software.
1435 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1436 * that the key is pairwise rather then a shared key.
1437 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1438 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1439 * (MFP) to be done in software.
1440 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1441 * if space should be prepared for the IV, but the IV
1442 * itself should not be generated. Do not set together with
1443 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1444 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1446 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1447 * management frames. The flag can help drivers that have a hardware
1448 * crypto implementation that doesn't deal with management frames
1449 * properly by allowing them to not upload the keys to hardware and
1450 * fall back to software crypto. Note that this flag deals only with
1451 * RX, if your crypto engine can't deal with TX you can also set the
1452 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1453 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1454 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1455 * only for managment frames (MFP).
1456 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1457 * driver for a key to indicate that sufficient tailroom must always
1458 * be reserved for ICV or MIC, even when HW encryption is enabled.
1460 enum ieee80211_key_flags {
1461 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1462 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1463 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1464 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1465 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1466 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1467 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1468 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1472 * struct ieee80211_key_conf - key information
1474 * This key information is given by mac80211 to the driver by
1475 * the set_key() callback in &struct ieee80211_ops.
1477 * @hw_key_idx: To be set by the driver, this is the key index the driver
1478 * wants to be given when a frame is transmitted and needs to be
1479 * encrypted in hardware.
1480 * @cipher: The key's cipher suite selector.
1481 * @tx_pn: PN used for TX on non-TKIP keys, may be used by the driver
1482 * as well if it needs to do software PN assignment by itself
1484 * @flags: key flags, see &enum ieee80211_key_flags.
1485 * @keyidx: the key index (0-3)
1486 * @keylen: key material length
1487 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1489 * - Temporal Encryption Key (128 bits)
1490 * - Temporal Authenticator Tx MIC Key (64 bits)
1491 * - Temporal Authenticator Rx MIC Key (64 bits)
1492 * @icv_len: The ICV length for this key type
1493 * @iv_len: The IV length for this key type
1495 struct ieee80211_key_conf {
1507 #define IEEE80211_MAX_PN_LEN 16
1510 * struct ieee80211_key_seq - key sequence counter
1512 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1513 * @ccmp: PN data, most significant byte first (big endian,
1514 * reverse order than in packet)
1515 * @aes_cmac: PN data, most significant byte first (big endian,
1516 * reverse order than in packet)
1517 * @aes_gmac: PN data, most significant byte first (big endian,
1518 * reverse order than in packet)
1519 * @gcmp: PN data, most significant byte first (big endian,
1520 * reverse order than in packet)
1521 * @hw: data for HW-only (e.g. cipher scheme) keys
1523 struct ieee80211_key_seq {
1542 u8 seq[IEEE80211_MAX_PN_LEN];
1549 * struct ieee80211_cipher_scheme - cipher scheme
1551 * This structure contains a cipher scheme information defining
1552 * the secure packet crypto handling.
1554 * @cipher: a cipher suite selector
1555 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1556 * @hdr_len: a length of a security header used the cipher
1557 * @pn_len: a length of a packet number in the security header
1558 * @pn_off: an offset of pn from the beginning of the security header
1559 * @key_idx_off: an offset of key index byte in the security header
1560 * @key_idx_mask: a bit mask of key_idx bits
1561 * @key_idx_shift: a bit shift needed to get key_idx
1562 * key_idx value calculation:
1563 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1564 * @mic_len: a mic length in bytes
1566 struct ieee80211_cipher_scheme {
1579 * enum set_key_cmd - key command
1581 * Used with the set_key() callback in &struct ieee80211_ops, this
1582 * indicates whether a key is being removed or added.
1584 * @SET_KEY: a key is set
1585 * @DISABLE_KEY: a key must be disabled
1588 SET_KEY, DISABLE_KEY,
1592 * enum ieee80211_sta_state - station state
1594 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1595 * this is a special state for add/remove transitions
1596 * @IEEE80211_STA_NONE: station exists without special state
1597 * @IEEE80211_STA_AUTH: station is authenticated
1598 * @IEEE80211_STA_ASSOC: station is associated
1599 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1601 enum ieee80211_sta_state {
1602 /* NOTE: These need to be ordered correctly! */
1603 IEEE80211_STA_NOTEXIST,
1606 IEEE80211_STA_ASSOC,
1607 IEEE80211_STA_AUTHORIZED,
1611 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1612 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1613 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1614 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1615 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1616 * (including 80+80 MHz)
1618 * Implementation note: 20 must be zero to be initialized
1619 * correctly, the values must be sorted.
1621 enum ieee80211_sta_rx_bandwidth {
1622 IEEE80211_STA_RX_BW_20 = 0,
1623 IEEE80211_STA_RX_BW_40,
1624 IEEE80211_STA_RX_BW_80,
1625 IEEE80211_STA_RX_BW_160,
1629 * struct ieee80211_sta_rates - station rate selection table
1631 * @rcu_head: RCU head used for freeing the table on update
1632 * @rate: transmit rates/flags to be used by default.
1633 * Overriding entries per-packet is possible by using cb tx control.
1635 struct ieee80211_sta_rates {
1636 struct rcu_head rcu_head;
1643 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1647 * struct ieee80211_sta - station table entry
1649 * A station table entry represents a station we are possibly
1650 * communicating with. Since stations are RCU-managed in
1651 * mac80211, any ieee80211_sta pointer you get access to must
1652 * either be protected by rcu_read_lock() explicitly or implicitly,
1653 * or you must take good care to not use such a pointer after a
1654 * call to your sta_remove callback that removed it.
1656 * @addr: MAC address
1657 * @aid: AID we assigned to the station if we're an AP
1658 * @supp_rates: Bitmap of supported rates (per band)
1659 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1660 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1661 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1662 * otherwise always false)
1663 * @drv_priv: data area for driver use, will always be aligned to
1664 * sizeof(void *), size is determined in hw information.
1665 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1666 * if wme is supported.
1667 * @max_sp: max Service Period. Only valid if wme is supported.
1668 * @bandwidth: current bandwidth the station can receive with
1669 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1670 * station can receive at the moment, changed by operating mode
1671 * notifications and capabilities. The value is only valid after
1672 * the station moves to associated state.
1673 * @smps_mode: current SMPS mode (off, static or dynamic)
1674 * @rates: rate control selection table
1675 * @tdls: indicates whether the STA is a TDLS peer
1676 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1677 * valid if the STA is a TDLS peer in the first place.
1678 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1680 struct ieee80211_sta {
1681 u32 supp_rates[IEEE80211_NUM_BANDS];
1684 struct ieee80211_sta_ht_cap ht_cap;
1685 struct ieee80211_sta_vht_cap vht_cap;
1690 enum ieee80211_sta_rx_bandwidth bandwidth;
1691 enum ieee80211_smps_mode smps_mode;
1692 struct ieee80211_sta_rates __rcu *rates;
1694 bool tdls_initiator;
1696 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1699 u8 drv_priv[0] __aligned(sizeof(void *));
1703 * enum sta_notify_cmd - sta notify command
1705 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1706 * indicates if an associated station made a power state transition.
1708 * @STA_NOTIFY_SLEEP: a station is now sleeping
1709 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1711 enum sta_notify_cmd {
1712 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1716 * struct ieee80211_tx_control - TX control data
1718 * @sta: station table entry, this sta pointer may be NULL and
1719 * it is not allowed to copy the pointer, due to RCU.
1721 struct ieee80211_tx_control {
1722 struct ieee80211_sta *sta;
1726 * struct ieee80211_txq - Software intermediate tx queue
1728 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1729 * @sta: station table entry, %NULL for per-vif queue
1730 * @tid: the TID for this queue (unused for per-vif queue)
1731 * @ac: the AC for this queue
1732 * @drv_priv: driver private area, sized by hw->txq_data_size
1734 * The driver can obtain packets from this queue by calling
1735 * ieee80211_tx_dequeue().
1737 struct ieee80211_txq {
1738 struct ieee80211_vif *vif;
1739 struct ieee80211_sta *sta;
1744 u8 drv_priv[0] __aligned(sizeof(void *));
1748 * enum ieee80211_hw_flags - hardware flags
1750 * These flags are used to indicate hardware capabilities to
1751 * the stack. Generally, flags here should have their meaning
1752 * done in a way that the simplest hardware doesn't need setting
1753 * any particular flags. There are some exceptions to this rule,
1754 * however, so you are advised to review these flags carefully.
1756 * @IEEE80211_HW_HAS_RATE_CONTROL:
1757 * The hardware or firmware includes rate control, and cannot be
1758 * controlled by the stack. As such, no rate control algorithm
1759 * should be instantiated, and the TX rate reported to userspace
1760 * will be taken from the TX status instead of the rate control
1762 * Note that this requires that the driver implement a number of
1763 * callbacks so it has the correct information, it needs to have
1764 * the @set_rts_threshold callback and must look at the BSS config
1765 * @use_cts_prot for G/N protection, @use_short_slot for slot
1766 * timing in 2.4 GHz and @use_short_preamble for preambles for
1769 * @IEEE80211_HW_RX_INCLUDES_FCS:
1770 * Indicates that received frames passed to the stack include
1771 * the FCS at the end.
1773 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1774 * Some wireless LAN chipsets buffer broadcast/multicast frames
1775 * for power saving stations in the hardware/firmware and others
1776 * rely on the host system for such buffering. This option is used
1777 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1778 * multicast frames when there are power saving stations so that
1779 * the driver can fetch them with ieee80211_get_buffered_bc().
1781 * @IEEE80211_HW_SIGNAL_UNSPEC:
1782 * Hardware can provide signal values but we don't know its units. We
1783 * expect values between 0 and @max_signal.
1784 * If possible please provide dB or dBm instead.
1786 * @IEEE80211_HW_SIGNAL_DBM:
1787 * Hardware gives signal values in dBm, decibel difference from
1788 * one milliwatt. This is the preferred method since it is standardized
1789 * between different devices. @max_signal does not need to be set.
1791 * @IEEE80211_HW_SPECTRUM_MGMT:
1792 * Hardware supports spectrum management defined in 802.11h
1793 * Measurement, Channel Switch, Quieting, TPC
1795 * @IEEE80211_HW_AMPDU_AGGREGATION:
1796 * Hardware supports 11n A-MPDU aggregation.
1798 * @IEEE80211_HW_SUPPORTS_PS:
1799 * Hardware has power save support (i.e. can go to sleep).
1801 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1802 * Hardware requires nullfunc frame handling in stack, implies
1803 * stack support for dynamic PS.
1805 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1806 * Hardware has support for dynamic PS.
1808 * @IEEE80211_HW_MFP_CAPABLE:
1809 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1811 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1812 * Hardware can provide ack status reports of Tx frames to
1815 * @IEEE80211_HW_CONNECTION_MONITOR:
1816 * The hardware performs its own connection monitoring, including
1817 * periodic keep-alives to the AP and probing the AP on beacon loss.
1819 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1820 * This device needs to get data from beacon before association (i.e.
1823 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1824 * per-station GTKs as used by IBSS RSN or during fast transition. If
1825 * the device doesn't support per-station GTKs, but can be asked not
1826 * to decrypt group addressed frames, then IBSS RSN support is still
1827 * possible but software crypto will be used. Advertise the wiphy flag
1828 * only in that case.
1830 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1831 * autonomously manages the PS status of connected stations. When
1832 * this flag is set mac80211 will not trigger PS mode for connected
1833 * stations based on the PM bit of incoming frames.
1834 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1835 * the PS mode of connected stations.
1837 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1838 * setup strictly in HW. mac80211 should not attempt to do this in
1841 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1842 * a virtual monitor interface when monitor interfaces are the only
1843 * active interfaces.
1845 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1846 * be created. It is expected user-space will create vifs as
1847 * desired (and thus have them named as desired).
1849 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1850 * crypto algorithms can be done in software - so don't automatically
1851 * try to fall back to it if hardware crypto fails, but do so only if
1852 * the driver returns 1. This also forces the driver to advertise its
1853 * supported cipher suites.
1855 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1856 * this currently requires only the ability to calculate the duration
1859 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1860 * queue mapping in order to use different queues (not just one per AC)
1861 * for different virtual interfaces. See the doc section on HW queue
1862 * control for more details.
1864 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1865 * selection table provided by the rate control algorithm.
1867 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1868 * P2P Interface. This will be honoured even if more than one interface
1871 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1872 * only, to allow getting TBTT of a DTIM beacon.
1874 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1875 * and can cope with CCK rates in an aggregation session (e.g. by not
1876 * using aggregation for such frames.)
1878 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1879 * for a single active channel while using channel contexts. When support
1880 * is not enabled the default action is to disconnect when getting the
1883 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1884 * or tailroom of TX skbs without copying them first.
1886 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1887 * in one command, mac80211 doesn't have to run separate scans per band.
1889 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1891 enum ieee80211_hw_flags {
1892 IEEE80211_HW_HAS_RATE_CONTROL,
1893 IEEE80211_HW_RX_INCLUDES_FCS,
1894 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1895 IEEE80211_HW_SIGNAL_UNSPEC,
1896 IEEE80211_HW_SIGNAL_DBM,
1897 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1898 IEEE80211_HW_SPECTRUM_MGMT,
1899 IEEE80211_HW_AMPDU_AGGREGATION,
1900 IEEE80211_HW_SUPPORTS_PS,
1901 IEEE80211_HW_PS_NULLFUNC_STACK,
1902 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1903 IEEE80211_HW_MFP_CAPABLE,
1904 IEEE80211_HW_WANT_MONITOR_VIF,
1905 IEEE80211_HW_NO_AUTO_VIF,
1906 IEEE80211_HW_SW_CRYPTO_CONTROL,
1907 IEEE80211_HW_SUPPORT_FAST_XMIT,
1908 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1909 IEEE80211_HW_CONNECTION_MONITOR,
1910 IEEE80211_HW_QUEUE_CONTROL,
1911 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1912 IEEE80211_HW_AP_LINK_PS,
1913 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1914 IEEE80211_HW_SUPPORTS_RC_TABLE,
1915 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
1916 IEEE80211_HW_TIMING_BEACON_ONLY,
1917 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
1918 IEEE80211_HW_CHANCTX_STA_CSA,
1919 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
1920 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
1922 /* keep last, obviously */
1923 NUM_IEEE80211_HW_FLAGS
1927 * struct ieee80211_hw - hardware information and state
1929 * This structure contains the configuration and hardware
1930 * information for an 802.11 PHY.
1932 * @wiphy: This points to the &struct wiphy allocated for this
1933 * 802.11 PHY. You must fill in the @perm_addr and @dev
1934 * members of this structure using SET_IEEE80211_DEV()
1935 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1936 * bands (with channels, bitrates) are registered here.
1938 * @conf: &struct ieee80211_conf, device configuration, don't use.
1940 * @priv: pointer to private area that was allocated for driver use
1941 * along with this structure.
1943 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1945 * @extra_tx_headroom: headroom to reserve in each transmit skb
1946 * for use by the driver (e.g. for transmit headers.)
1948 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1949 * Can be used by drivers to add extra IEs.
1951 * @max_signal: Maximum value for signal (rssi) in RX information, used
1952 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1954 * @max_listen_interval: max listen interval in units of beacon interval
1957 * @queues: number of available hardware transmit queues for
1958 * data packets. WMM/QoS requires at least four, these
1959 * queues need to have configurable access parameters.
1961 * @rate_control_algorithm: rate control algorithm for this hardware.
1962 * If unset (NULL), the default algorithm will be used. Must be
1963 * set before calling ieee80211_register_hw().
1965 * @vif_data_size: size (in bytes) of the drv_priv data area
1966 * within &struct ieee80211_vif.
1967 * @sta_data_size: size (in bytes) of the drv_priv data area
1968 * within &struct ieee80211_sta.
1969 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1970 * within &struct ieee80211_chanctx_conf.
1971 * @txq_data_size: size (in bytes) of the drv_priv data area
1972 * within @struct ieee80211_txq.
1974 * @max_rates: maximum number of alternate rate retry stages the hw
1976 * @max_report_rates: maximum number of alternate rate retry stages
1977 * the hw can report back.
1978 * @max_rate_tries: maximum number of tries for each stage
1980 * @max_rx_aggregation_subframes: maximum buffer size (number of
1981 * sub-frames) to be used for A-MPDU block ack receiver
1983 * This is only relevant if the device has restrictions on the
1984 * number of subframes, if it relies on mac80211 to do reordering
1985 * it shouldn't be set.
1987 * @max_tx_aggregation_subframes: maximum number of subframes in an
1988 * aggregate an HT driver will transmit, used by the peer as a
1989 * hint to size its reorder buffer.
1991 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1992 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1994 * @radiotap_mcs_details: lists which MCS information can the HW
1995 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1996 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1997 * adding _BW is supported today.
1999 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2000 * the default is _GI | _BANDWIDTH.
2001 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2003 * @netdev_features: netdev features to be set in each netdev created
2004 * from this HW. Note that not all features are usable with mac80211,
2005 * other features will be rejected during HW registration.
2007 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2008 * for each access category if it is uAPSD trigger-enabled and delivery-
2009 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2010 * Each bit corresponds to different AC. Value '1' in specific bit means
2011 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2014 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2015 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2016 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2018 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2019 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2022 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2023 * entries for a vif.
2025 struct ieee80211_hw {
2026 struct ieee80211_conf conf;
2027 struct wiphy *wiphy;
2028 const char *rate_control_algorithm;
2030 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2031 unsigned int extra_tx_headroom;
2032 unsigned int extra_beacon_tailroom;
2035 int chanctx_data_size;
2038 u16 max_listen_interval;
2041 u8 max_report_rates;
2043 u8 max_rx_aggregation_subframes;
2044 u8 max_tx_aggregation_subframes;
2045 u8 offchannel_tx_hw_queue;
2046 u8 radiotap_mcs_details;
2047 u16 radiotap_vht_details;
2048 netdev_features_t netdev_features;
2050 u8 uapsd_max_sp_len;
2051 u8 n_cipher_schemes;
2052 const struct ieee80211_cipher_scheme *cipher_schemes;
2053 int txq_ac_max_pending;
2056 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2057 enum ieee80211_hw_flags flg)
2059 return test_bit(flg, hw->flags);
2061 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2063 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2064 enum ieee80211_hw_flags flg)
2066 return __set_bit(flg, hw->flags);
2068 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2071 * struct ieee80211_scan_request - hw scan request
2073 * @ies: pointers different parts of IEs (in req.ie)
2074 * @req: cfg80211 request.
2076 struct ieee80211_scan_request {
2077 struct ieee80211_scan_ies ies;
2080 struct cfg80211_scan_request req;
2084 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2086 * @sta: peer this TDLS channel-switch request/response came from
2087 * @chandef: channel referenced in a TDLS channel-switch request
2088 * @action_code: see &enum ieee80211_tdls_actioncode
2089 * @status: channel-switch response status
2090 * @timestamp: time at which the frame was received
2091 * @switch_time: switch-timing parameter received in the frame
2092 * @switch_timeout: switch-timing parameter received in the frame
2093 * @tmpl_skb: TDLS switch-channel response template
2094 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2096 struct ieee80211_tdls_ch_sw_params {
2097 struct ieee80211_sta *sta;
2098 struct cfg80211_chan_def *chandef;
2104 struct sk_buff *tmpl_skb;
2109 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2111 * @wiphy: the &struct wiphy which we want to query
2113 * mac80211 drivers can use this to get to their respective
2114 * &struct ieee80211_hw. Drivers wishing to get to their own private
2115 * structure can then access it via hw->priv. Note that mac802111 drivers should
2116 * not use wiphy_priv() to try to get their private driver structure as this
2117 * is already used internally by mac80211.
2119 * Return: The mac80211 driver hw struct of @wiphy.
2121 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2124 * SET_IEEE80211_DEV - set device for 802.11 hardware
2126 * @hw: the &struct ieee80211_hw to set the device for
2127 * @dev: the &struct device of this 802.11 device
2129 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2131 set_wiphy_dev(hw->wiphy, dev);
2135 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2137 * @hw: the &struct ieee80211_hw to set the MAC address for
2138 * @addr: the address to set
2140 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
2142 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2145 static inline struct ieee80211_rate *
2146 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2147 const struct ieee80211_tx_info *c)
2149 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2151 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2154 static inline struct ieee80211_rate *
2155 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2156 const struct ieee80211_tx_info *c)
2158 if (c->control.rts_cts_rate_idx < 0)
2160 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2163 static inline struct ieee80211_rate *
2164 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2165 const struct ieee80211_tx_info *c, int idx)
2167 if (c->control.rates[idx + 1].idx < 0)
2169 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2173 * ieee80211_free_txskb - free TX skb
2177 * Free a transmit skb. Use this funtion when some failure
2178 * to transmit happened and thus status cannot be reported.
2180 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2183 * DOC: Hardware crypto acceleration
2185 * mac80211 is capable of taking advantage of many hardware
2186 * acceleration designs for encryption and decryption operations.
2188 * The set_key() callback in the &struct ieee80211_ops for a given
2189 * device is called to enable hardware acceleration of encryption and
2190 * decryption. The callback takes a @sta parameter that will be NULL
2191 * for default keys or keys used for transmission only, or point to
2192 * the station information for the peer for individual keys.
2193 * Multiple transmission keys with the same key index may be used when
2194 * VLANs are configured for an access point.
2196 * When transmitting, the TX control data will use the @hw_key_idx
2197 * selected by the driver by modifying the &struct ieee80211_key_conf
2198 * pointed to by the @key parameter to the set_key() function.
2200 * The set_key() call for the %SET_KEY command should return 0 if
2201 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2202 * added; if you return 0 then hw_key_idx must be assigned to the
2203 * hardware key index, you are free to use the full u8 range.
2205 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2206 * set, mac80211 will not automatically fall back to software crypto if
2207 * enabling hardware crypto failed. The set_key() call may also return the
2208 * value 1 to permit this specific key/algorithm to be done in software.
2210 * When the cmd is %DISABLE_KEY then it must succeed.
2212 * Note that it is permissible to not decrypt a frame even if a key
2213 * for it has been uploaded to hardware, the stack will not make any
2214 * decision based on whether a key has been uploaded or not but rather
2215 * based on the receive flags.
2217 * The &struct ieee80211_key_conf structure pointed to by the @key
2218 * parameter is guaranteed to be valid until another call to set_key()
2219 * removes it, but it can only be used as a cookie to differentiate
2222 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2223 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2225 * The update_tkip_key() call updates the driver with the new phase 1 key.
2226 * This happens every time the iv16 wraps around (every 65536 packets). The
2227 * set_key() call will happen only once for each key (unless the AP did
2228 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2229 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2230 * handler is software decryption with wrap around of iv16.
2232 * The set_default_unicast_key() call updates the default WEP key index
2233 * configured to the hardware for WEP encryption type. This is required
2234 * for devices that support offload of data packets (e.g. ARP responses).
2238 * DOC: Powersave support
2240 * mac80211 has support for various powersave implementations.
2242 * First, it can support hardware that handles all powersaving by itself,
2243 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2244 * flag. In that case, it will be told about the desired powersave mode
2245 * with the %IEEE80211_CONF_PS flag depending on the association status.
2246 * The hardware must take care of sending nullfunc frames when necessary,
2247 * i.e. when entering and leaving powersave mode. The hardware is required
2248 * to look at the AID in beacons and signal to the AP that it woke up when
2249 * it finds traffic directed to it.
2251 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2252 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2253 * with hardware wakeup and sleep states. Driver is responsible for waking
2254 * up the hardware before issuing commands to the hardware and putting it
2255 * back to sleep at appropriate times.
2257 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2258 * buffered multicast/broadcast frames after the beacon. Also it must be
2259 * possible to send frames and receive the acknowledment frame.
2261 * Other hardware designs cannot send nullfunc frames by themselves and also
2262 * need software support for parsing the TIM bitmap. This is also supported
2263 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2264 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2265 * required to pass up beacons. The hardware is still required to handle
2266 * waking up for multicast traffic; if it cannot the driver must handle that
2267 * as best as it can, mac80211 is too slow to do that.
2269 * Dynamic powersave is an extension to normal powersave in which the
2270 * hardware stays awake for a user-specified period of time after sending a
2271 * frame so that reply frames need not be buffered and therefore delayed to
2272 * the next wakeup. It's compromise of getting good enough latency when
2273 * there's data traffic and still saving significantly power in idle
2276 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2277 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2278 * flag and mac80211 will handle everything automatically. Additionally,
2279 * hardware having support for the dynamic PS feature may set the
2280 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2281 * dynamic PS mode itself. The driver needs to look at the
2282 * @dynamic_ps_timeout hardware configuration value and use it that value
2283 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2284 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2285 * enabled whenever user has enabled powersave.
2287 * Driver informs U-APSD client support by enabling
2288 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2289 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2290 * Nullfunc frames and stay awake until the service period has ended. To
2291 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2292 * from that AC are transmitted with powersave enabled.
2294 * Note: U-APSD client mode is not yet supported with
2295 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2299 * DOC: Beacon filter support
2301 * Some hardware have beacon filter support to reduce host cpu wakeups
2302 * which will reduce system power consumption. It usually works so that
2303 * the firmware creates a checksum of the beacon but omits all constantly
2304 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2305 * beacon is forwarded to the host, otherwise it will be just dropped. That
2306 * way the host will only receive beacons where some relevant information
2307 * (for example ERP protection or WMM settings) have changed.
2309 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2310 * interface capability. The driver needs to enable beacon filter support
2311 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2312 * power save is enabled, the stack will not check for beacon loss and the
2313 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2315 * The time (or number of beacons missed) until the firmware notifies the
2316 * driver of a beacon loss event (which in turn causes the driver to call
2317 * ieee80211_beacon_loss()) should be configurable and will be controlled
2318 * by mac80211 and the roaming algorithm in the future.
2320 * Since there may be constantly changing information elements that nothing
2321 * in the software stack cares about, we will, in the future, have mac80211
2322 * tell the driver which information elements are interesting in the sense
2323 * that we want to see changes in them. This will include
2324 * - a list of information element IDs
2325 * - a list of OUIs for the vendor information element
2327 * Ideally, the hardware would filter out any beacons without changes in the
2328 * requested elements, but if it cannot support that it may, at the expense
2329 * of some efficiency, filter out only a subset. For example, if the device
2330 * doesn't support checking for OUIs it should pass up all changes in all
2331 * vendor information elements.
2333 * Note that change, for the sake of simplification, also includes information
2334 * elements appearing or disappearing from the beacon.
2336 * Some hardware supports an "ignore list" instead, just make sure nothing
2337 * that was requested is on the ignore list, and include commonly changing
2338 * information element IDs in the ignore list, for example 11 (BSS load) and
2339 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2340 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2341 * it could also include some currently unused IDs.
2344 * In addition to these capabilities, hardware should support notifying the
2345 * host of changes in the beacon RSSI. This is relevant to implement roaming
2346 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2347 * the received data packets). This can consist in notifying the host when
2348 * the RSSI changes significantly or when it drops below or rises above
2349 * configurable thresholds. In the future these thresholds will also be
2350 * configured by mac80211 (which gets them from userspace) to implement
2351 * them as the roaming algorithm requires.
2353 * If the hardware cannot implement this, the driver should ask it to
2354 * periodically pass beacon frames to the host so that software can do the
2355 * signal strength threshold checking.
2359 * DOC: Spatial multiplexing power save
2361 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2362 * power in an 802.11n implementation. For details on the mechanism
2363 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2364 * "11.2.3 SM power save".
2366 * The mac80211 implementation is capable of sending action frames
2367 * to update the AP about the station's SMPS mode, and will instruct
2368 * the driver to enter the specific mode. It will also announce the
2369 * requested SMPS mode during the association handshake. Hardware
2370 * support for this feature is required, and can be indicated by
2373 * The default mode will be "automatic", which nl80211/cfg80211
2374 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2375 * turned off otherwise.
2377 * To support this feature, the driver must set the appropriate
2378 * hardware support flags, and handle the SMPS flag to the config()
2379 * operation. It will then with this mechanism be instructed to
2380 * enter the requested SMPS mode while associated to an HT AP.
2384 * DOC: Frame filtering
2386 * mac80211 requires to see many management frames for proper
2387 * operation, and users may want to see many more frames when
2388 * in monitor mode. However, for best CPU usage and power consumption,
2389 * having as few frames as possible percolate through the stack is
2390 * desirable. Hence, the hardware should filter as much as possible.
2392 * To achieve this, mac80211 uses filter flags (see below) to tell
2393 * the driver's configure_filter() function which frames should be
2394 * passed to mac80211 and which should be filtered out.
2396 * Before configure_filter() is invoked, the prepare_multicast()
2397 * callback is invoked with the parameters @mc_count and @mc_list
2398 * for the combined multicast address list of all virtual interfaces.
2399 * It's use is optional, and it returns a u64 that is passed to
2400 * configure_filter(). Additionally, configure_filter() has the
2401 * arguments @changed_flags telling which flags were changed and
2402 * @total_flags with the new flag states.
2404 * If your device has no multicast address filters your driver will
2405 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2406 * parameter to see whether multicast frames should be accepted
2409 * All unsupported flags in @total_flags must be cleared.
2410 * Hardware does not support a flag if it is incapable of _passing_
2411 * the frame to the stack. Otherwise the driver must ignore
2412 * the flag, but not clear it.
2413 * You must _only_ clear the flag (announce no support for the
2414 * flag to mac80211) if you are not able to pass the packet type
2415 * to the stack (so the hardware always filters it).
2416 * So for example, you should clear @FIF_CONTROL, if your hardware
2417 * always filters control frames. If your hardware always passes
2418 * control frames to the kernel and is incapable of filtering them,
2419 * you do _not_ clear the @FIF_CONTROL flag.
2420 * This rule applies to all other FIF flags as well.
2424 * DOC: AP support for powersaving clients
2426 * In order to implement AP and P2P GO modes, mac80211 has support for
2427 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2428 * There currently is no support for sAPSD.
2430 * There is one assumption that mac80211 makes, namely that a client
2431 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2432 * Both are supported, and both can be used by the same client, but
2433 * they can't be used concurrently by the same client. This simplifies
2436 * The first thing to keep in mind is that there is a flag for complete
2437 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2438 * mac80211 expects the driver to handle most of the state machine for
2439 * powersaving clients and will ignore the PM bit in incoming frames.
2440 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2441 * stations' powersave transitions. In this mode, mac80211 also doesn't
2442 * handle PS-Poll/uAPSD.
2444 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2445 * PM bit in incoming frames for client powersave transitions. When a
2446 * station goes to sleep, we will stop transmitting to it. There is,
2447 * however, a race condition: a station might go to sleep while there is
2448 * data buffered on hardware queues. If the device has support for this
2449 * it will reject frames, and the driver should give the frames back to
2450 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2451 * cause mac80211 to retry the frame when the station wakes up. The
2452 * driver is also notified of powersave transitions by calling its
2453 * @sta_notify callback.
2455 * When the station is asleep, it has three choices: it can wake up,
2456 * it can PS-Poll, or it can possibly start a uAPSD service period.
2457 * Waking up is implemented by simply transmitting all buffered (and
2458 * filtered) frames to the station. This is the easiest case. When
2459 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2460 * will inform the driver of this with the @allow_buffered_frames
2461 * callback; this callback is optional. mac80211 will then transmit
2462 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2463 * on each frame. The last frame in the service period (or the only
2464 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2465 * indicate that it ends the service period; as this frame must have
2466 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2467 * When TX status is reported for this frame, the service period is
2468 * marked has having ended and a new one can be started by the peer.
2470 * Additionally, non-bufferable MMPDUs can also be transmitted by
2471 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2473 * Another race condition can happen on some devices like iwlwifi
2474 * when there are frames queued for the station and it wakes up
2475 * or polls; the frames that are already queued could end up being
2476 * transmitted first instead, causing reordering and/or wrong
2477 * processing of the EOSP. The cause is that allowing frames to be
2478 * transmitted to a certain station is out-of-band communication to
2479 * the device. To allow this problem to be solved, the driver can
2480 * call ieee80211_sta_block_awake() if frames are buffered when it
2481 * is notified that the station went to sleep. When all these frames
2482 * have been filtered (see above), it must call the function again
2483 * to indicate that the station is no longer blocked.
2485 * If the driver buffers frames in the driver for aggregation in any
2486 * way, it must use the ieee80211_sta_set_buffered() call when it is
2487 * notified of the station going to sleep to inform mac80211 of any
2488 * TIDs that have frames buffered. Note that when a station wakes up
2489 * this information is reset (hence the requirement to call it when
2490 * informed of the station going to sleep). Then, when a service
2491 * period starts for any reason, @release_buffered_frames is called
2492 * with the number of frames to be released and which TIDs they are
2493 * to come from. In this case, the driver is responsible for setting
2494 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2495 * to help the @more_data parameter is passed to tell the driver if
2496 * there is more data on other TIDs -- the TIDs to release frames
2497 * from are ignored since mac80211 doesn't know how many frames the
2498 * buffers for those TIDs contain.
2500 * If the driver also implement GO mode, where absence periods may
2501 * shorten service periods (or abort PS-Poll responses), it must
2502 * filter those response frames except in the case of frames that
2503 * are buffered in the driver -- those must remain buffered to avoid
2504 * reordering. Because it is possible that no frames are released
2505 * in this case, the driver must call ieee80211_sta_eosp()
2506 * to indicate to mac80211 that the service period ended anyway.
2508 * Finally, if frames from multiple TIDs are released from mac80211
2509 * but the driver might reorder them, it must clear & set the flags
2510 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2511 * and also take care of the EOSP and MORE_DATA bits in the frame.
2512 * The driver may also use ieee80211_sta_eosp() in this case.
2514 * Note that if the driver ever buffers frames other than QoS-data
2515 * frames, it must take care to never send a non-QoS-data frame as
2516 * the last frame in a service period, adding a QoS-nulldata frame
2517 * after a non-QoS-data frame if needed.
2521 * DOC: HW queue control
2523 * Before HW queue control was introduced, mac80211 only had a single static
2524 * assignment of per-interface AC software queues to hardware queues. This
2525 * was problematic for a few reasons:
2526 * 1) off-channel transmissions might get stuck behind other frames
2527 * 2) multiple virtual interfaces couldn't be handled correctly
2528 * 3) after-DTIM frames could get stuck behind other frames
2530 * To solve this, hardware typically uses multiple different queues for all
2531 * the different usages, and this needs to be propagated into mac80211 so it
2532 * won't have the same problem with the software queues.
2534 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2535 * flag that tells it that the driver implements its own queue control. To do
2536 * so, the driver will set up the various queues in each &struct ieee80211_vif
2537 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2538 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2539 * if necessary will queue the frame on the right software queue that mirrors
2540 * the hardware queue.
2541 * Additionally, the driver has to then use these HW queue IDs for the queue
2542 * management functions (ieee80211_stop_queue() et al.)
2544 * The driver is free to set up the queue mappings as needed, multiple virtual
2545 * interfaces may map to the same hardware queues if needed. The setup has to
2546 * happen during add_interface or change_interface callbacks. For example, a
2547 * driver supporting station+station and station+AP modes might decide to have
2548 * 10 hardware queues to handle different scenarios:
2550 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2551 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2552 * after-DTIM queue for AP: 8
2553 * off-channel queue: 9
2555 * It would then set up the hardware like this:
2556 * hw.offchannel_tx_hw_queue = 9
2558 * and the first virtual interface that is added as follows:
2559 * vif.hw_queue[IEEE80211_AC_VO] = 0
2560 * vif.hw_queue[IEEE80211_AC_VI] = 1
2561 * vif.hw_queue[IEEE80211_AC_BE] = 2
2562 * vif.hw_queue[IEEE80211_AC_BK] = 3
2563 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2564 * and the second virtual interface with 4-7.
2566 * If queue 6 gets full, for example, mac80211 would only stop the second
2567 * virtual interface's BE queue since virtual interface queues are per AC.
2569 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2570 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2571 * queue could potentially be shared since mac80211 will look at cab_queue when
2572 * a queue is stopped/woken even if the interface is not in AP mode.
2576 * enum ieee80211_filter_flags - hardware filter flags
2578 * These flags determine what the filter in hardware should be
2579 * programmed to let through and what should not be passed to the
2580 * stack. It is always safe to pass more frames than requested,
2581 * but this has negative impact on power consumption.
2583 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2584 * by the user or if the hardware is not capable of filtering by
2585 * multicast address.
2587 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2588 * %RX_FLAG_FAILED_FCS_CRC for them)
2590 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2591 * the %RX_FLAG_FAILED_PLCP_CRC for them
2593 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2594 * to the hardware that it should not filter beacons or probe responses
2595 * by BSSID. Filtering them can greatly reduce the amount of processing
2596 * mac80211 needs to do and the amount of CPU wakeups, so you should
2597 * honour this flag if possible.
2599 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2602 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2604 * @FIF_PSPOLL: pass PS Poll frames
2606 * @FIF_PROBE_REQ: pass probe request frames
2608 enum ieee80211_filter_flags {
2609 FIF_ALLMULTI = 1<<1,
2611 FIF_PLCPFAIL = 1<<3,
2612 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2614 FIF_OTHER_BSS = 1<<6,
2616 FIF_PROBE_REQ = 1<<8,
2620 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2622 * These flags are used with the ampdu_action() callback in
2623 * &struct ieee80211_ops to indicate which action is needed.
2625 * Note that drivers MUST be able to deal with a TX aggregation
2626 * session being stopped even before they OK'ed starting it by
2627 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2628 * might receive the addBA frame and send a delBA right away!
2630 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2631 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2632 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2633 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2634 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2635 * queued packets, now unaggregated. After all packets are transmitted the
2636 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2637 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2638 * called when the station is removed. There's no need or reason to call
2639 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2640 * session is gone and removes the station.
2641 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2642 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2643 * now the connection is dropped and the station will be removed. Drivers
2644 * should clean up and drop remaining packets when this is called.
2646 enum ieee80211_ampdu_mlme_action {
2647 IEEE80211_AMPDU_RX_START,
2648 IEEE80211_AMPDU_RX_STOP,
2649 IEEE80211_AMPDU_TX_START,
2650 IEEE80211_AMPDU_TX_STOP_CONT,
2651 IEEE80211_AMPDU_TX_STOP_FLUSH,
2652 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2653 IEEE80211_AMPDU_TX_OPERATIONAL,
2657 * enum ieee80211_frame_release_type - frame release reason
2658 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2659 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2660 * frame received on trigger-enabled AC
2662 enum ieee80211_frame_release_type {
2663 IEEE80211_FRAME_RELEASE_PSPOLL,
2664 IEEE80211_FRAME_RELEASE_UAPSD,
2668 * enum ieee80211_rate_control_changed - flags to indicate what changed
2670 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2671 * to this station changed. The actual bandwidth is in the station
2672 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2673 * flag changes, for HT and VHT the bandwidth field changes.
2674 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2675 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2676 * changed (in IBSS mode) due to discovering more information about
2678 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2681 enum ieee80211_rate_control_changed {
2682 IEEE80211_RC_BW_CHANGED = BIT(0),
2683 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2684 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2685 IEEE80211_RC_NSS_CHANGED = BIT(3),
2689 * enum ieee80211_roc_type - remain on channel type
2691 * With the support for multi channel contexts and multi channel operations,
2692 * remain on channel operations might be limited/deferred/aborted by other
2693 * flows/operations which have higher priority (and vise versa).
2694 * Specifying the ROC type can be used by devices to prioritize the ROC
2695 * operations compared to other operations/flows.
2697 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2698 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2699 * for sending managment frames offchannel.
2701 enum ieee80211_roc_type {
2702 IEEE80211_ROC_TYPE_NORMAL = 0,
2703 IEEE80211_ROC_TYPE_MGMT_TX,
2707 * enum ieee80211_reconfig_complete_type - reconfig type
2709 * This enum is used by the reconfig_complete() callback to indicate what
2710 * reconfiguration type was completed.
2712 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2713 * (also due to resume() callback returning 1)
2714 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2715 * of wowlan configuration)
2717 enum ieee80211_reconfig_type {
2718 IEEE80211_RECONFIG_TYPE_RESTART,
2719 IEEE80211_RECONFIG_TYPE_SUSPEND,
2723 * struct ieee80211_ops - callbacks from mac80211 to the driver
2725 * This structure contains various callbacks that the driver may
2726 * handle or, in some cases, must handle, for example to configure
2727 * the hardware to a new channel or to transmit a frame.
2729 * @tx: Handler that 802.11 module calls for each transmitted frame.
2730 * skb contains the buffer starting from the IEEE 802.11 header.
2731 * The low-level driver should send the frame out based on
2732 * configuration in the TX control data. This handler should,
2733 * preferably, never fail and stop queues appropriately.
2736 * @start: Called before the first netdevice attached to the hardware
2737 * is enabled. This should turn on the hardware and must turn on
2738 * frame reception (for possibly enabled monitor interfaces.)
2739 * Returns negative error codes, these may be seen in userspace,
2741 * When the device is started it should not have a MAC address
2742 * to avoid acknowledging frames before a non-monitor device
2744 * Must be implemented and can sleep.
2746 * @stop: Called after last netdevice attached to the hardware
2747 * is disabled. This should turn off the hardware (at least
2748 * it must turn off frame reception.)
2749 * May be called right after add_interface if that rejects
2750 * an interface. If you added any work onto the mac80211 workqueue
2751 * you should ensure to cancel it on this callback.
2752 * Must be implemented and can sleep.
2754 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2755 * stop transmitting and doing any other configuration, and then
2756 * ask the device to suspend. This is only invoked when WoWLAN is
2757 * configured, otherwise the device is deconfigured completely and
2758 * reconfigured at resume time.
2759 * The driver may also impose special conditions under which it
2760 * wants to use the "normal" suspend (deconfigure), say if it only
2761 * supports WoWLAN when the device is associated. In this case, it
2762 * must return 1 from this function.
2764 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2765 * now resuming its operation, after this the device must be fully
2766 * functional again. If this returns an error, the only way out is
2767 * to also unregister the device. If it returns 1, then mac80211
2768 * will also go through the regular complete restart on resume.
2770 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2771 * modified. The reason is that device_set_wakeup_enable() is
2772 * supposed to be called when the configuration changes, not only
2775 * @add_interface: Called when a netdevice attached to the hardware is
2776 * enabled. Because it is not called for monitor mode devices, @start
2777 * and @stop must be implemented.
2778 * The driver should perform any initialization it needs before
2779 * the device can be enabled. The initial configuration for the
2780 * interface is given in the conf parameter.
2781 * The callback may refuse to add an interface by returning a
2782 * negative error code (which will be seen in userspace.)
2783 * Must be implemented and can sleep.
2785 * @change_interface: Called when a netdevice changes type. This callback
2786 * is optional, but only if it is supported can interface types be
2787 * switched while the interface is UP. The callback may sleep.
2788 * Note that while an interface is being switched, it will not be
2789 * found by the interface iteration callbacks.
2791 * @remove_interface: Notifies a driver that an interface is going down.
2792 * The @stop callback is called after this if it is the last interface
2793 * and no monitor interfaces are present.
2794 * When all interfaces are removed, the MAC address in the hardware
2795 * must be cleared so the device no longer acknowledges packets,
2796 * the mac_addr member of the conf structure is, however, set to the
2797 * MAC address of the device going away.
2798 * Hence, this callback must be implemented. It can sleep.
2800 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2801 * function to change hardware configuration, e.g., channel.
2802 * This function should never fail but returns a negative error code
2803 * if it does. The callback can sleep.
2805 * @bss_info_changed: Handler for configuration requests related to BSS
2806 * parameters that may vary during BSS's lifespan, and may affect low
2807 * level driver (e.g. assoc/disassoc status, erp parameters).
2808 * This function should not be used if no BSS has been set, unless
2809 * for association indication. The @changed parameter indicates which
2810 * of the bss parameters has changed when a call is made. The callback
2813 * @prepare_multicast: Prepare for multicast filter configuration.
2814 * This callback is optional, and its return value is passed
2815 * to configure_filter(). This callback must be atomic.
2817 * @configure_filter: Configure the device's RX filter.
2818 * See the section "Frame filtering" for more information.
2819 * This callback must be implemented and can sleep.
2821 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2822 * must be set or cleared for a given STA. Must be atomic.
2824 * @set_key: See the section "Hardware crypto acceleration"
2825 * This callback is only called between add_interface and
2826 * remove_interface calls, i.e. while the given virtual interface
2828 * Returns a negative error code if the key can't be added.
2829 * The callback can sleep.
2831 * @update_tkip_key: See the section "Hardware crypto acceleration"
2832 * This callback will be called in the context of Rx. Called for drivers
2833 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2834 * The callback must be atomic.
2836 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2837 * host is suspended, it can assign this callback to retrieve the data
2838 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2839 * After rekeying was done it should (for example during resume) notify
2840 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2842 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2843 * WEP when the device sends data packets autonomously, e.g. for ARP
2844 * offloading. The index can be 0-3, or -1 for unsetting it.
2846 * @hw_scan: Ask the hardware to service the scan request, no need to start
2847 * the scan state machine in stack. The scan must honour the channel
2848 * configuration done by the regulatory agent in the wiphy's
2849 * registered bands. The hardware (or the driver) needs to make sure
2850 * that power save is disabled.
2851 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2852 * entire IEs after the SSID, so that drivers need not look at these
2853 * at all but just send them after the SSID -- mac80211 includes the
2854 * (extended) supported rates and HT information (where applicable).
2855 * When the scan finishes, ieee80211_scan_completed() must be called;
2856 * note that it also must be called when the scan cannot finish due to
2857 * any error unless this callback returned a negative error code.
2858 * The callback can sleep.
2860 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2861 * The driver should ask the hardware to cancel the scan (if possible),
2862 * but the scan will be completed only after the driver will call
2863 * ieee80211_scan_completed().
2864 * This callback is needed for wowlan, to prevent enqueueing a new
2865 * scan_work after the low-level driver was already suspended.
2866 * The callback can sleep.
2868 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2869 * specific intervals. The driver must call the
2870 * ieee80211_sched_scan_results() function whenever it finds results.
2871 * This process will continue until sched_scan_stop is called.
2873 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2874 * In this case, ieee80211_sched_scan_stopped() must not be called.
2876 * @sw_scan_start: Notifier function that is called just before a software scan
2877 * is started. Can be NULL, if the driver doesn't need this notification.
2878 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2879 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2880 * can use this parameter. The callback can sleep.
2882 * @sw_scan_complete: Notifier function that is called just after a
2883 * software scan finished. Can be NULL, if the driver doesn't need
2884 * this notification.
2885 * The callback can sleep.
2887 * @get_stats: Return low-level statistics.
2888 * Returns zero if statistics are available.
2889 * The callback can sleep.
2891 * @get_key_seq: If your device implements encryption in hardware and does
2892 * IV/PN assignment then this callback should be provided to read the
2893 * IV/PN for the given key from hardware.
2894 * The callback must be atomic.
2896 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2897 * if the device does fragmentation by itself; if this callback is
2898 * implemented then the stack will not do fragmentation.
2899 * The callback can sleep.
2901 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2902 * The callback can sleep.
2904 * @sta_add: Notifies low level driver about addition of an associated station,
2905 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2907 * @sta_remove: Notifies low level driver about removal of an associated
2908 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2909 * returns it isn't safe to use the pointer, not even RCU protected;
2910 * no RCU grace period is guaranteed between returning here and freeing
2911 * the station. See @sta_pre_rcu_remove if needed.
2912 * This callback can sleep.
2914 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2915 * when a station is added to mac80211's station list. This callback
2916 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2917 * conditional. This callback can sleep.
2919 * @sta_remove_debugfs: Remove the debugfs files which were added using
2920 * @sta_add_debugfs. This callback can sleep.
2922 * @sta_notify: Notifies low level driver about power state transition of an
2923 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2924 * in AP mode, this callback will not be called when the flag
2925 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2927 * @sta_state: Notifies low level driver about state transition of a
2928 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2929 * This callback is mutually exclusive with @sta_add/@sta_remove.
2930 * It must not fail for down transitions but may fail for transitions
2931 * up the list of states. Also note that after the callback returns it
2932 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2933 * period is guaranteed between returning here and freeing the station.
2934 * See @sta_pre_rcu_remove if needed.
2935 * The callback can sleep.
2937 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2938 * synchronisation. This is useful if a driver needs to have station
2939 * pointers protected using RCU, it can then use this call to clear
2940 * the pointers instead of waiting for an RCU grace period to elapse
2942 * The callback can sleep.
2944 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2945 * used to transmit to the station. The changes are advertised with bits
2946 * from &enum ieee80211_rate_control_changed and the values are reflected
2947 * in the station data. This callback should only be used when the driver
2948 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2949 * otherwise the rate control algorithm is notified directly.
2951 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2952 * is only used if the configured rate control algorithm actually uses
2953 * the new rate table API, and is therefore optional. Must be atomic.
2955 * @sta_statistics: Get statistics for this station. For example with beacon
2956 * filtering, the statistics kept by mac80211 might not be accurate, so
2957 * let the driver pre-fill the statistics. The driver can fill most of
2958 * the values (indicating which by setting the filled bitmap), but not
2959 * all of them make sense - see the source for which ones are possible.
2960 * Statistics that the driver doesn't fill will be filled by mac80211.
2961 * The callback can sleep.
2963 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2964 * bursting) for a hardware TX queue.
2965 * Returns a negative error code on failure.
2966 * The callback can sleep.
2968 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2969 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2970 * required function.
2971 * The callback can sleep.
2973 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2974 * Currently, this is only used for IBSS mode debugging. Is not a
2975 * required function.
2976 * The callback can sleep.
2978 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2979 * with other STAs in the IBSS. This is only used in IBSS mode. This
2980 * function is optional if the firmware/hardware takes full care of
2981 * TSF synchronization.
2982 * The callback can sleep.
2984 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2985 * This is needed only for IBSS mode and the result of this function is
2986 * used to determine whether to reply to Probe Requests.
2987 * Returns non-zero if this device sent the last beacon.
2988 * The callback can sleep.
2990 * @ampdu_action: Perform a certain A-MPDU action
2991 * The RA/TID combination determines the destination and TID we want
2992 * the ampdu action to be performed for. The action is defined through
2993 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2994 * is the first frame we expect to perform the action on. Notice
2995 * that TX/RX_STOP can pass NULL for this parameter.
2996 * The @buf_size parameter is only valid when the action is set to
2997 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2998 * buffer size (number of subframes) for this session -- the driver
2999 * may neither send aggregates containing more subframes than this
3000 * nor send aggregates in a way that lost frames would exceed the
3001 * buffer size. If just limiting the aggregate size, this would be
3002 * possible with a buf_size of 8:
3004 * - RX: 2....7 (lost frame #1)
3006 * which is invalid since #1 was now re-transmitted well past the
3007 * buffer size of 8. Correct ways to retransmit #1 would be:
3008 * - TX: 1 or 18 or 81
3009 * Even "189" would be wrong since 1 could be lost again.
3011 * Returns a negative error code on failure.
3012 * The callback can sleep.
3014 * @get_survey: Return per-channel survey information
3016 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3017 * need to set wiphy->rfkill_poll to %true before registration,
3018 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3019 * The callback can sleep.
3021 * @set_coverage_class: Set slot time for given coverage class as specified
3022 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3023 * accordingly; coverage class equals to -1 to enable ACK timeout
3024 * estimation algorithm (dynack). To disable dynack set valid value for
3025 * coverage class. This callback is not required and may sleep.
3027 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3028 * be %NULL. The callback can sleep.
3029 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3031 * @flush: Flush all pending frames from the hardware queue, making sure
3032 * that the hardware queues are empty. The @queues parameter is a bitmap
3033 * of queues to flush, which is useful if different virtual interfaces
3034 * use different hardware queues; it may also indicate all queues.
3035 * If the parameter @drop is set to %true, pending frames may be dropped.
3036 * Note that vif can be NULL.
3037 * The callback can sleep.
3039 * @channel_switch: Drivers that need (or want) to offload the channel
3040 * switch operation for CSAs received from the AP may implement this
3041 * callback. They must then call ieee80211_chswitch_done() to indicate
3042 * completion of the channel switch.
3044 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3045 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3046 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3047 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3049 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3051 * @remain_on_channel: Starts an off-channel period on the given channel, must
3052 * call back to ieee80211_ready_on_channel() when on that channel. Note
3053 * that normal channel traffic is not stopped as this is intended for hw
3054 * offload. Frames to transmit on the off-channel channel are transmitted
3055 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3056 * duration (which will always be non-zero) expires, the driver must call
3057 * ieee80211_remain_on_channel_expired().
3058 * Note that this callback may be called while the device is in IDLE and
3059 * must be accepted in this case.
3060 * This callback may sleep.
3061 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3062 * aborted before it expires. This callback may sleep.
3064 * @set_ringparam: Set tx and rx ring sizes.
3066 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3068 * @tx_frames_pending: Check if there is any pending frame in the hardware
3069 * queues before entering power save.
3071 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3072 * when transmitting a frame. Currently only legacy rates are handled.
3073 * The callback can sleep.
3074 * @event_callback: Notify driver about any event in mac80211. See
3075 * &enum ieee80211_event_type for the different types.
3076 * The callback must be atomic.
3078 * @release_buffered_frames: Release buffered frames according to the given
3079 * parameters. In the case where the driver buffers some frames for
3080 * sleeping stations mac80211 will use this callback to tell the driver
3081 * to release some frames, either for PS-poll or uAPSD.
3082 * Note that if the @more_data parameter is %false the driver must check
3083 * if there are more frames on the given TIDs, and if there are more than
3084 * the frames being released then it must still set the more-data bit in
3085 * the frame. If the @more_data parameter is %true, then of course the
3086 * more-data bit must always be set.
3087 * The @tids parameter tells the driver which TIDs to release frames
3088 * from, for PS-poll it will always have only a single bit set.
3089 * In the case this is used for a PS-poll initiated release, the
3090 * @num_frames parameter will always be 1 so code can be shared. In
3091 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3092 * on the TX status (and must report TX status) so that the PS-poll
3093 * period is properly ended. This is used to avoid sending multiple
3094 * responses for a retried PS-poll frame.
3095 * In the case this is used for uAPSD, the @num_frames parameter may be
3096 * bigger than one, but the driver may send fewer frames (it must send
3097 * at least one, however). In this case it is also responsible for
3098 * setting the EOSP flag in the QoS header of the frames. Also, when the
3099 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3100 * on the last frame in the SP. Alternatively, it may call the function
3101 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3102 * This callback must be atomic.
3103 * @allow_buffered_frames: Prepare device to allow the given number of frames
3104 * to go out to the given station. The frames will be sent by mac80211
3105 * via the usual TX path after this call. The TX information for frames
3106 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3107 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3108 * frames from multiple TIDs are released and the driver might reorder
3109 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3110 * on the last frame and clear it on all others and also handle the EOSP
3111 * bit in the QoS header correctly. Alternatively, it can also call the
3112 * ieee80211_sta_eosp() function.
3113 * The @tids parameter is a bitmap and tells the driver which TIDs the
3114 * frames will be on; it will at most have two bits set.
3115 * This callback must be atomic.
3117 * @get_et_sset_count: Ethtool API to get string-set count.
3119 * @get_et_stats: Ethtool API to get a set of u64 stats.
3121 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3122 * and perhaps other supported types of ethtool data-sets.
3124 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3125 * before associated. In multi-channel scenarios, a virtual interface is
3126 * bound to a channel before it is associated, but as it isn't associated
3127 * yet it need not necessarily be given airtime, in particular since any
3128 * transmission to a P2P GO needs to be synchronized against the GO's
3129 * powersave state. mac80211 will call this function before transmitting a
3130 * management frame prior to having successfully associated to allow the
3131 * driver to give it channel time for the transmission, to get a response
3132 * and to be able to synchronize with the GO.
3133 * The callback will be called before each transmission and upon return
3134 * mac80211 will transmit the frame right away.
3135 * The callback is optional and can (should!) sleep.
3137 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3138 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3139 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3140 * setup-response is a direct packet not buffered by the AP.
3141 * mac80211 will call this function just before the transmission of a TDLS
3142 * discovery-request. The recommended period of protection is at least
3143 * 2 * (DTIM period).
3144 * The callback is optional and can sleep.
3146 * @add_chanctx: Notifies device driver about new channel context creation.
3147 * @remove_chanctx: Notifies device driver about channel context destruction.
3148 * @change_chanctx: Notifies device driver about channel context changes that
3149 * may happen when combining different virtual interfaces on the same
3150 * channel context with different settings
3151 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3152 * to vif. Possible use is for hw queue remapping.
3153 * @unassign_vif_chanctx: Notifies device driver about channel context being
3155 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3156 * another, as specified in the list of
3157 * @ieee80211_vif_chanctx_switch passed to the driver, according
3158 * to the mode defined in &ieee80211_chanctx_switch_mode.
3160 * @start_ap: Start operation on the AP interface, this is called after all the
3161 * information in bss_conf is set and beacon can be retrieved. A channel
3162 * context is bound before this is called. Note that if the driver uses
3163 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3164 * just "paused" for scanning/ROC, which is indicated by the beacon being
3165 * disabled/enabled via @bss_info_changed.
3166 * @stop_ap: Stop operation on the AP interface.
3168 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3169 * during resume, when the reconfiguration has completed.
3170 * This can help the driver implement the reconfiguration step (and
3171 * indicate mac80211 is ready to receive frames).
3172 * This callback may sleep.
3174 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3175 * Currently, this is only called for managed or P2P client interfaces.
3176 * This callback is optional; it must not sleep.
3178 * @channel_switch_beacon: Starts a channel switch to a new channel.
3179 * Beacons are modified to include CSA or ECSA IEs before calling this
3180 * function. The corresponding count fields in these IEs must be
3181 * decremented, and when they reach 1 the driver must call
3182 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3183 * get the csa counter decremented by mac80211, but must check if it is
3184 * 1 using ieee80211_csa_is_complete() after the beacon has been
3185 * transmitted and then call ieee80211_csa_finish().
3186 * If the CSA count starts as zero or 1, this function will not be called,
3187 * since there won't be any time to beacon before the switch anyway.
3188 * @pre_channel_switch: This is an optional callback that is called
3189 * before a channel switch procedure is started (ie. when a STA
3190 * gets a CSA or an userspace initiated channel-switch), allowing
3191 * the driver to prepare for the channel switch.
3192 * @post_channel_switch: This is an optional callback that is called
3193 * after a channel switch procedure is completed, allowing the
3194 * driver to go back to a normal configuration.
3196 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3197 * information in bss_conf is set up and the beacon can be retrieved. A
3198 * channel context is bound before this is called.
3199 * @leave_ibss: Leave the IBSS again.
3201 * @get_expected_throughput: extract the expected throughput towards the
3202 * specified station. The returned value is expressed in Kbps. It returns 0
3203 * if the RC algorithm does not have proper data to provide.
3205 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3206 * and hardware limits.
3208 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3209 * is responsible for continually initiating channel-switching operations
3210 * and returning to the base channel for communication with the AP. The
3211 * driver receives a channel-switch request template and the location of
3212 * the switch-timing IE within the template as part of the invocation.
3213 * The template is valid only within the call, and the driver can
3214 * optionally copy the skb for further re-use.
3215 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3216 * peers must be on the base channel when the call completes.
3217 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3218 * response) has been received from a remote peer. The driver gets
3219 * parameters parsed from the incoming frame and may use them to continue
3220 * an ongoing channel-switch operation. In addition, a channel-switch
3221 * response template is provided, together with the location of the
3222 * switch-timing IE within the template. The skb can only be used within
3223 * the function call.
3225 * @wake_tx_queue: Called when new packets have been added to the queue.
3227 struct ieee80211_ops {
3228 void (*tx)(struct ieee80211_hw *hw,
3229 struct ieee80211_tx_control *control,
3230 struct sk_buff *skb);
3231 int (*start)(struct ieee80211_hw *hw);
3232 void (*stop)(struct ieee80211_hw *hw);
3234 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3235 int (*resume)(struct ieee80211_hw *hw);
3236 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3238 int (*add_interface)(struct ieee80211_hw *hw,
3239 struct ieee80211_vif *vif);
3240 int (*change_interface)(struct ieee80211_hw *hw,
3241 struct ieee80211_vif *vif,
3242 enum nl80211_iftype new_type, bool p2p);
3243 void (*remove_interface)(struct ieee80211_hw *hw,
3244 struct ieee80211_vif *vif);
3245 int (*config)(struct ieee80211_hw *hw, u32 changed);
3246 void (*bss_info_changed)(struct ieee80211_hw *hw,
3247 struct ieee80211_vif *vif,
3248 struct ieee80211_bss_conf *info,
3251 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3252 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3254 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3255 struct netdev_hw_addr_list *mc_list);
3256 void (*configure_filter)(struct ieee80211_hw *hw,
3257 unsigned int changed_flags,
3258 unsigned int *total_flags,
3260 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3262 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3263 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3264 struct ieee80211_key_conf *key);
3265 void (*update_tkip_key)(struct ieee80211_hw *hw,
3266 struct ieee80211_vif *vif,
3267 struct ieee80211_key_conf *conf,
3268 struct ieee80211_sta *sta,
3269 u32 iv32, u16 *phase1key);
3270 void (*set_rekey_data)(struct ieee80211_hw *hw,
3271 struct ieee80211_vif *vif,
3272 struct cfg80211_gtk_rekey_data *data);
3273 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3274 struct ieee80211_vif *vif, int idx);
3275 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3276 struct ieee80211_scan_request *req);
3277 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3278 struct ieee80211_vif *vif);
3279 int (*sched_scan_start)(struct ieee80211_hw *hw,
3280 struct ieee80211_vif *vif,
3281 struct cfg80211_sched_scan_request *req,
3282 struct ieee80211_scan_ies *ies);
3283 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3284 struct ieee80211_vif *vif);
3285 void (*sw_scan_start)(struct ieee80211_hw *hw,
3286 struct ieee80211_vif *vif,
3287 const u8 *mac_addr);
3288 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3289 struct ieee80211_vif *vif);
3290 int (*get_stats)(struct ieee80211_hw *hw,
3291 struct ieee80211_low_level_stats *stats);
3292 void (*get_key_seq)(struct ieee80211_hw *hw,
3293 struct ieee80211_key_conf *key,
3294 struct ieee80211_key_seq *seq);
3295 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3296 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3297 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3298 struct ieee80211_sta *sta);
3299 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3300 struct ieee80211_sta *sta);
3301 #ifdef CONFIG_MAC80211_DEBUGFS
3302 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3303 struct ieee80211_vif *vif,
3304 struct ieee80211_sta *sta,
3305 struct dentry *dir);
3306 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3307 struct ieee80211_vif *vif,
3308 struct ieee80211_sta *sta,
3309 struct dentry *dir);
3311 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3312 enum sta_notify_cmd, struct ieee80211_sta *sta);
3313 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3314 struct ieee80211_sta *sta,
3315 enum ieee80211_sta_state old_state,
3316 enum ieee80211_sta_state new_state);
3317 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3318 struct ieee80211_vif *vif,
3319 struct ieee80211_sta *sta);
3320 void (*sta_rc_update)(struct ieee80211_hw *hw,
3321 struct ieee80211_vif *vif,
3322 struct ieee80211_sta *sta,
3324 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3325 struct ieee80211_vif *vif,
3326 struct ieee80211_sta *sta);
3327 void (*sta_statistics)(struct ieee80211_hw *hw,
3328 struct ieee80211_vif *vif,
3329 struct ieee80211_sta *sta,
3330 struct station_info *sinfo);
3331 int (*conf_tx)(struct ieee80211_hw *hw,
3332 struct ieee80211_vif *vif, u16 ac,
3333 const struct ieee80211_tx_queue_params *params);
3334 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3335 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3337 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3338 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3339 int (*ampdu_action)(struct ieee80211_hw *hw,
3340 struct ieee80211_vif *vif,
3341 enum ieee80211_ampdu_mlme_action action,
3342 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3344 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3345 struct survey_info *survey);
3346 void (*rfkill_poll)(struct ieee80211_hw *hw);
3347 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3348 #ifdef CONFIG_NL80211_TESTMODE
3349 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3350 void *data, int len);
3351 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3352 struct netlink_callback *cb,
3353 void *data, int len);
3355 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3356 u32 queues, bool drop);
3357 void (*channel_switch)(struct ieee80211_hw *hw,
3358 struct ieee80211_vif *vif,
3359 struct ieee80211_channel_switch *ch_switch);
3360 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3361 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3363 int (*remain_on_channel)(struct ieee80211_hw *hw,
3364 struct ieee80211_vif *vif,
3365 struct ieee80211_channel *chan,
3367 enum ieee80211_roc_type type);
3368 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3369 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3370 void (*get_ringparam)(struct ieee80211_hw *hw,
3371 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3372 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3373 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3374 const struct cfg80211_bitrate_mask *mask);
3375 void (*event_callback)(struct ieee80211_hw *hw,
3376 struct ieee80211_vif *vif,
3377 const struct ieee80211_event *event);
3379 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3380 struct ieee80211_sta *sta,
3381 u16 tids, int num_frames,
3382 enum ieee80211_frame_release_type reason,
3384 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3385 struct ieee80211_sta *sta,
3386 u16 tids, int num_frames,
3387 enum ieee80211_frame_release_type reason,
3390 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3391 struct ieee80211_vif *vif, int sset);
3392 void (*get_et_stats)(struct ieee80211_hw *hw,
3393 struct ieee80211_vif *vif,
3394 struct ethtool_stats *stats, u64 *data);
3395 void (*get_et_strings)(struct ieee80211_hw *hw,
3396 struct ieee80211_vif *vif,
3397 u32 sset, u8 *data);
3399 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3400 struct ieee80211_vif *vif);
3402 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3403 struct ieee80211_vif *vif);
3405 int (*add_chanctx)(struct ieee80211_hw *hw,
3406 struct ieee80211_chanctx_conf *ctx);
3407 void (*remove_chanctx)(struct ieee80211_hw *hw,
3408 struct ieee80211_chanctx_conf *ctx);
3409 void (*change_chanctx)(struct ieee80211_hw *hw,
3410 struct ieee80211_chanctx_conf *ctx,
3412 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3413 struct ieee80211_vif *vif,
3414 struct ieee80211_chanctx_conf *ctx);
3415 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3416 struct ieee80211_vif *vif,
3417 struct ieee80211_chanctx_conf *ctx);
3418 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3419 struct ieee80211_vif_chanctx_switch *vifs,
3421 enum ieee80211_chanctx_switch_mode mode);
3423 void (*reconfig_complete)(struct ieee80211_hw *hw,
3424 enum ieee80211_reconfig_type reconfig_type);
3426 #if IS_ENABLED(CONFIG_IPV6)
3427 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3428 struct ieee80211_vif *vif,
3429 struct inet6_dev *idev);
3431 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3432 struct ieee80211_vif *vif,
3433 struct cfg80211_chan_def *chandef);
3434 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3435 struct ieee80211_vif *vif,
3436 struct ieee80211_channel_switch *ch_switch);
3438 int (*post_channel_switch)(struct ieee80211_hw *hw,
3439 struct ieee80211_vif *vif);
3441 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3442 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3443 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3444 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3447 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3448 struct ieee80211_vif *vif,
3449 struct ieee80211_sta *sta, u8 oper_class,
3450 struct cfg80211_chan_def *chandef,
3451 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3452 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3453 struct ieee80211_vif *vif,
3454 struct ieee80211_sta *sta);
3455 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3456 struct ieee80211_vif *vif,
3457 struct ieee80211_tdls_ch_sw_params *params);
3459 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3460 struct ieee80211_txq *txq);
3464 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3466 * This must be called once for each hardware device. The returned pointer
3467 * must be used to refer to this device when calling other functions.
3468 * mac80211 allocates a private data area for the driver pointed to by
3469 * @priv in &struct ieee80211_hw, the size of this area is given as
3472 * @priv_data_len: length of private data
3473 * @ops: callbacks for this device
3474 * @requested_name: Requested name for this device.
3475 * NULL is valid value, and means use the default naming (phy%d)
3477 * Return: A pointer to the new hardware device, or %NULL on error.
3479 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3480 const struct ieee80211_ops *ops,
3481 const char *requested_name);
3484 * ieee80211_alloc_hw - Allocate a new hardware device
3486 * This must be called once for each hardware device. The returned pointer
3487 * must be used to refer to this device when calling other functions.
3488 * mac80211 allocates a private data area for the driver pointed to by
3489 * @priv in &struct ieee80211_hw, the size of this area is given as
3492 * @priv_data_len: length of private data
3493 * @ops: callbacks for this device
3495 * Return: A pointer to the new hardware device, or %NULL on error.
3498 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3499 const struct ieee80211_ops *ops)
3501 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3505 * ieee80211_register_hw - Register hardware device
3507 * You must call this function before any other functions in
3508 * mac80211. Note that before a hardware can be registered, you
3509 * need to fill the contained wiphy's information.
3511 * @hw: the device to register as returned by ieee80211_alloc_hw()
3513 * Return: 0 on success. An error code otherwise.
3515 int ieee80211_register_hw(struct ieee80211_hw *hw);
3518 * struct ieee80211_tpt_blink - throughput blink description
3519 * @throughput: throughput in Kbit/sec
3520 * @blink_time: blink time in milliseconds
3521 * (full cycle, ie. one off + one on period)
3523 struct ieee80211_tpt_blink {
3529 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3530 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3531 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3532 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3533 * interface is connected in some way, including being an AP
3535 enum ieee80211_tpt_led_trigger_flags {
3536 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3537 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3538 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3541 #ifdef CONFIG_MAC80211_LEDS
3542 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3543 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3544 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3545 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3547 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3549 const struct ieee80211_tpt_blink *blink_table,
3550 unsigned int blink_table_len);
3553 * ieee80211_get_tx_led_name - get name of TX LED
3555 * mac80211 creates a transmit LED trigger for each wireless hardware
3556 * that can be used to drive LEDs if your driver registers a LED device.
3557 * This function returns the name (or %NULL if not configured for LEDs)
3558 * of the trigger so you can automatically link the LED device.
3560 * @hw: the hardware to get the LED trigger name for
3562 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3564 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3566 #ifdef CONFIG_MAC80211_LEDS
3567 return __ieee80211_get_tx_led_name(hw);
3574 * ieee80211_get_rx_led_name - get name of RX LED
3576 * mac80211 creates a receive LED trigger for each wireless hardware
3577 * that can be used to drive LEDs if your driver registers a LED device.
3578 * This function returns the name (or %NULL if not configured for LEDs)
3579 * of the trigger so you can automatically link the LED device.
3581 * @hw: the hardware to get the LED trigger name for
3583 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3585 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3587 #ifdef CONFIG_MAC80211_LEDS
3588 return __ieee80211_get_rx_led_name(hw);
3595 * ieee80211_get_assoc_led_name - get name of association LED
3597 * mac80211 creates a association LED trigger for each wireless hardware
3598 * that can be used to drive LEDs if your driver registers a LED device.
3599 * This function returns the name (or %NULL if not configured for LEDs)
3600 * of the trigger so you can automatically link the LED device.
3602 * @hw: the hardware to get the LED trigger name for
3604 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3606 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3608 #ifdef CONFIG_MAC80211_LEDS
3609 return __ieee80211_get_assoc_led_name(hw);
3616 * ieee80211_get_radio_led_name - get name of radio LED
3618 * mac80211 creates a radio change LED trigger for each wireless hardware
3619 * that can be used to drive LEDs if your driver registers a LED device.
3620 * This function returns the name (or %NULL if not configured for LEDs)
3621 * of the trigger so you can automatically link the LED device.
3623 * @hw: the hardware to get the LED trigger name for
3625 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3627 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3629 #ifdef CONFIG_MAC80211_LEDS
3630 return __ieee80211_get_radio_led_name(hw);
3637 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3638 * @hw: the hardware to create the trigger for
3639 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3640 * @blink_table: the blink table -- needs to be ordered by throughput
3641 * @blink_table_len: size of the blink table
3643 * Return: %NULL (in case of error, or if no LED triggers are
3644 * configured) or the name of the new trigger.
3646 * Note: This function must be called before ieee80211_register_hw().
3648 static inline const char *
3649 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3650 const struct ieee80211_tpt_blink *blink_table,
3651 unsigned int blink_table_len)
3653 #ifdef CONFIG_MAC80211_LEDS
3654 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3662 * ieee80211_unregister_hw - Unregister a hardware device
3664 * This function instructs mac80211 to free allocated resources
3665 * and unregister netdevices from the networking subsystem.
3667 * @hw: the hardware to unregister
3669 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3672 * ieee80211_free_hw - free hardware descriptor
3674 * This function frees everything that was allocated, including the
3675 * private data for the driver. You must call ieee80211_unregister_hw()
3676 * before calling this function.
3678 * @hw: the hardware to free
3680 void ieee80211_free_hw(struct ieee80211_hw *hw);
3683 * ieee80211_restart_hw - restart hardware completely
3685 * Call this function when the hardware was restarted for some reason
3686 * (hardware error, ...) and the driver is unable to restore its state
3687 * by itself. mac80211 assumes that at this point the driver/hardware
3688 * is completely uninitialised and stopped, it starts the process by
3689 * calling the ->start() operation. The driver will need to reset all
3690 * internal state that it has prior to calling this function.
3692 * @hw: the hardware to restart
3694 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3697 * ieee80211_rx_napi - receive frame from NAPI context
3699 * Use this function to hand received frames to mac80211. The receive
3700 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3701 * paged @skb is used, the driver is recommended to put the ieee80211
3702 * header of the frame on the linear part of the @skb to avoid memory
3703 * allocation and/or memcpy by the stack.
3705 * This function may not be called in IRQ context. Calls to this function
3706 * for a single hardware must be synchronized against each other. Calls to
3707 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3708 * mixed for a single hardware. Must not run concurrently with
3709 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3711 * This function must be called with BHs disabled.
3713 * @hw: the hardware this frame came in on
3714 * @skb: the buffer to receive, owned by mac80211 after this call
3715 * @napi: the NAPI context
3717 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3718 struct napi_struct *napi);
3721 * ieee80211_rx - receive frame
3723 * Use this function to hand received frames to mac80211. The receive
3724 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3725 * paged @skb is used, the driver is recommended to put the ieee80211
3726 * header of the frame on the linear part of the @skb to avoid memory
3727 * allocation and/or memcpy by the stack.
3729 * This function may not be called in IRQ context. Calls to this function
3730 * for a single hardware must be synchronized against each other. Calls to
3731 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3732 * mixed for a single hardware. Must not run concurrently with
3733 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3735 * In process context use instead ieee80211_rx_ni().
3737 * @hw: the hardware this frame came in on
3738 * @skb: the buffer to receive, owned by mac80211 after this call
3740 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3742 ieee80211_rx_napi(hw, skb, NULL);
3746 * ieee80211_rx_irqsafe - receive frame
3748 * Like ieee80211_rx() but can be called in IRQ context
3749 * (internally defers to a tasklet.)
3751 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3752 * be mixed for a single hardware.Must not run concurrently with
3753 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3755 * @hw: the hardware this frame came in on
3756 * @skb: the buffer to receive, owned by mac80211 after this call
3758 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3761 * ieee80211_rx_ni - receive frame (in process context)
3763 * Like ieee80211_rx() but can be called in process context
3764 * (internally disables bottom halves).
3766 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3767 * not be mixed for a single hardware. Must not run concurrently with
3768 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3770 * @hw: the hardware this frame came in on
3771 * @skb: the buffer to receive, owned by mac80211 after this call
3773 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3774 struct sk_buff *skb)
3777 ieee80211_rx(hw, skb);
3782 * ieee80211_sta_ps_transition - PS transition for connected sta
3784 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3785 * flag set, use this function to inform mac80211 about a connected station
3786 * entering/leaving PS mode.
3788 * This function may not be called in IRQ context or with softirqs enabled.
3790 * Calls to this function for a single hardware must be synchronized against
3793 * @sta: currently connected sta
3794 * @start: start or stop PS
3796 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3798 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3801 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3802 * (in process context)
3804 * Like ieee80211_sta_ps_transition() but can be called in process context
3805 * (internally disables bottom halves). Concurrent call restriction still
3808 * @sta: currently connected sta
3809 * @start: start or stop PS
3811 * Return: Like ieee80211_sta_ps_transition().
3813 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3819 ret = ieee80211_sta_ps_transition(sta, start);
3826 * The TX headroom reserved by mac80211 for its own tx_status functions.
3827 * This is enough for the radiotap header.
3829 #define IEEE80211_TX_STATUS_HEADROOM 14
3832 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3833 * @sta: &struct ieee80211_sta pointer for the sleeping station
3834 * @tid: the TID that has buffered frames
3835 * @buffered: indicates whether or not frames are buffered for this TID
3837 * If a driver buffers frames for a powersave station instead of passing
3838 * them back to mac80211 for retransmission, the station may still need
3839 * to be told that there are buffered frames via the TIM bit.
3841 * This function informs mac80211 whether or not there are frames that are
3842 * buffered in the driver for a given TID; mac80211 can then use this data
3843 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3844 * call! Beware of the locking!)
3846 * If all frames are released to the station (due to PS-poll or uAPSD)
3847 * then the driver needs to inform mac80211 that there no longer are
3848 * frames buffered. However, when the station wakes up mac80211 assumes
3849 * that all buffered frames will be transmitted and clears this data,
3850 * drivers need to make sure they inform mac80211 about all buffered
3851 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3853 * Note that technically mac80211 only needs to know this per AC, not per
3854 * TID, but since driver buffering will inevitably happen per TID (since
3855 * it is related to aggregation) it is easier to make mac80211 map the
3856 * TID to the AC as required instead of keeping track in all drivers that
3859 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3860 u8 tid, bool buffered);
3863 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3865 * Call this function in a driver with per-packet rate selection support
3866 * to combine the rate info in the packet tx info with the most recent
3867 * rate selection table for the station entry.
3869 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3870 * @sta: the receiver station to which this packet is sent.
3871 * @skb: the frame to be transmitted.
3872 * @dest: buffer for extracted rate/retry information
3873 * @max_rates: maximum number of rates to fetch
3875 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3876 struct ieee80211_sta *sta,
3877 struct sk_buff *skb,
3878 struct ieee80211_tx_rate *dest,
3882 * ieee80211_tx_status - transmit status callback
3884 * Call this function for all transmitted frames after they have been
3885 * transmitted. It is permissible to not call this function for
3886 * multicast frames but this can affect statistics.
3888 * This function may not be called in IRQ context. Calls to this function
3889 * for a single hardware must be synchronized against each other. Calls
3890 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3891 * may not be mixed for a single hardware. Must not run concurrently with
3892 * ieee80211_rx() or ieee80211_rx_ni().
3894 * @hw: the hardware the frame was transmitted by
3895 * @skb: the frame that was transmitted, owned by mac80211 after this call
3897 void ieee80211_tx_status(struct ieee80211_hw *hw,
3898 struct sk_buff *skb);
3901 * ieee80211_tx_status_noskb - transmit status callback without skb
3903 * This function can be used as a replacement for ieee80211_tx_status
3904 * in drivers that cannot reliably map tx status information back to
3907 * Calls to this function for a single hardware must be synchronized
3908 * against each other. Calls to this function, ieee80211_tx_status_ni()
3909 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3911 * @hw: the hardware the frame was transmitted by
3912 * @sta: the receiver station to which this packet is sent
3913 * (NULL for multicast packets)
3914 * @info: tx status information
3916 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3917 struct ieee80211_sta *sta,
3918 struct ieee80211_tx_info *info);
3921 * ieee80211_tx_status_ni - transmit status callback (in process context)
3923 * Like ieee80211_tx_status() but can be called in process context.
3925 * Calls to this function, ieee80211_tx_status() and
3926 * ieee80211_tx_status_irqsafe() may not be mixed
3927 * for a single hardware.
3929 * @hw: the hardware the frame was transmitted by
3930 * @skb: the frame that was transmitted, owned by mac80211 after this call
3932 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3933 struct sk_buff *skb)
3936 ieee80211_tx_status(hw, skb);
3941 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3943 * Like ieee80211_tx_status() but can be called in IRQ context
3944 * (internally defers to a tasklet.)
3946 * Calls to this function, ieee80211_tx_status() and
3947 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3949 * @hw: the hardware the frame was transmitted by
3950 * @skb: the frame that was transmitted, owned by mac80211 after this call
3952 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3953 struct sk_buff *skb);
3956 * ieee80211_report_low_ack - report non-responding station
3958 * When operating in AP-mode, call this function to report a non-responding
3961 * @sta: the non-responding connected sta
3962 * @num_packets: number of packets sent to @sta without a response
3964 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3966 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3969 * struct ieee80211_mutable_offsets - mutable beacon offsets
3970 * @tim_offset: position of TIM element
3971 * @tim_length: size of TIM element
3972 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3973 * to CSA counters. This array can contain zero values which
3974 * should be ignored.
3976 struct ieee80211_mutable_offsets {
3980 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
3984 * ieee80211_beacon_get_template - beacon template generation function
3985 * @hw: pointer obtained from ieee80211_alloc_hw().
3986 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3987 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3988 * receive the offsets that may be updated by the driver.
3990 * If the driver implements beaconing modes, it must use this function to
3991 * obtain the beacon template.
3993 * This function should be used if the beacon frames are generated by the
3994 * device, and then the driver must use the returned beacon as the template
3995 * The driver or the device are responsible to update the DTIM and, when
3996 * applicable, the CSA count.
3998 * The driver is responsible for freeing the returned skb.
4000 * Return: The beacon template. %NULL on error.
4003 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4004 struct ieee80211_vif *vif,
4005 struct ieee80211_mutable_offsets *offs);
4008 * ieee80211_beacon_get_tim - beacon generation function
4009 * @hw: pointer obtained from ieee80211_alloc_hw().
4010 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4011 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4012 * Set to 0 if invalid (in non-AP modes).
4013 * @tim_length: pointer to variable that will receive the TIM IE length,
4014 * (including the ID and length bytes!).
4015 * Set to 0 if invalid (in non-AP modes).
4017 * If the driver implements beaconing modes, it must use this function to
4018 * obtain the beacon frame.
4020 * If the beacon frames are generated by the host system (i.e., not in
4021 * hardware/firmware), the driver uses this function to get each beacon
4022 * frame from mac80211 -- it is responsible for calling this function exactly
4023 * once before the beacon is needed (e.g. based on hardware interrupt).
4025 * The driver is responsible for freeing the returned skb.
4027 * Return: The beacon template. %NULL on error.
4029 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4030 struct ieee80211_vif *vif,
4031 u16 *tim_offset, u16 *tim_length);
4034 * ieee80211_beacon_get - beacon generation function
4035 * @hw: pointer obtained from ieee80211_alloc_hw().
4036 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4038 * See ieee80211_beacon_get_tim().
4040 * Return: See ieee80211_beacon_get_tim().
4042 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4043 struct ieee80211_vif *vif)
4045 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4049 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4050 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4052 * The csa counter should be updated after each beacon transmission.
4053 * This function is called implicitly when
4054 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4055 * beacon frames are generated by the device, the driver should call this
4056 * function after each beacon transmission to sync mac80211's csa counters.
4058 * Return: new csa counter value
4060 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4063 * ieee80211_csa_finish - notify mac80211 about channel switch
4064 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4066 * After a channel switch announcement was scheduled and the counter in this
4067 * announcement hits 1, this function must be called by the driver to
4068 * notify mac80211 that the channel can be changed.
4070 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4073 * ieee80211_csa_is_complete - find out if counters reached 1
4074 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4076 * This function returns whether the channel switch counters reached zero.
4078 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4082 * ieee80211_proberesp_get - retrieve a Probe Response template
4083 * @hw: pointer obtained from ieee80211_alloc_hw().
4084 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4086 * Creates a Probe Response template which can, for example, be uploaded to
4087 * hardware. The destination address should be set by the caller.
4089 * Can only be called in AP mode.
4091 * Return: The Probe Response template. %NULL on error.
4093 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4094 struct ieee80211_vif *vif);
4097 * ieee80211_pspoll_get - retrieve a PS Poll template
4098 * @hw: pointer obtained from ieee80211_alloc_hw().
4099 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4101 * Creates a PS Poll a template which can, for example, uploaded to
4102 * hardware. The template must be updated after association so that correct
4103 * AID, BSSID and MAC address is used.
4105 * Note: Caller (or hardware) is responsible for setting the
4106 * &IEEE80211_FCTL_PM bit.
4108 * Return: The PS Poll template. %NULL on error.
4110 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4111 struct ieee80211_vif *vif);
4114 * ieee80211_nullfunc_get - retrieve a nullfunc template
4115 * @hw: pointer obtained from ieee80211_alloc_hw().
4116 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4118 * Creates a Nullfunc template which can, for example, uploaded to
4119 * hardware. The template must be updated after association so that correct
4120 * BSSID and address is used.
4122 * Note: Caller (or hardware) is responsible for setting the
4123 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4125 * Return: The nullfunc template. %NULL on error.
4127 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4128 struct ieee80211_vif *vif);
4131 * ieee80211_probereq_get - retrieve a Probe Request template
4132 * @hw: pointer obtained from ieee80211_alloc_hw().
4133 * @src_addr: source MAC address
4134 * @ssid: SSID buffer
4135 * @ssid_len: length of SSID
4136 * @tailroom: tailroom to reserve at end of SKB for IEs
4138 * Creates a Probe Request template which can, for example, be uploaded to
4141 * Return: The Probe Request template. %NULL on error.
4143 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4145 const u8 *ssid, size_t ssid_len,
4149 * ieee80211_rts_get - RTS frame generation function
4150 * @hw: pointer obtained from ieee80211_alloc_hw().
4151 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4152 * @frame: pointer to the frame that is going to be protected by the RTS.
4153 * @frame_len: the frame length (in octets).
4154 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4155 * @rts: The buffer where to store the RTS frame.
4157 * If the RTS frames are generated by the host system (i.e., not in
4158 * hardware/firmware), the low-level driver uses this function to receive
4159 * the next RTS frame from the 802.11 code. The low-level is responsible
4160 * for calling this function before and RTS frame is needed.
4162 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4163 const void *frame, size_t frame_len,
4164 const struct ieee80211_tx_info *frame_txctl,
4165 struct ieee80211_rts *rts);
4168 * ieee80211_rts_duration - Get the duration field for an RTS frame
4169 * @hw: pointer obtained from ieee80211_alloc_hw().
4170 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4171 * @frame_len: the length of the frame that is going to be protected by the RTS.
4172 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4174 * If the RTS is generated in firmware, but the host system must provide
4175 * the duration field, the low-level driver uses this function to receive
4176 * the duration field value in little-endian byteorder.
4178 * Return: The duration.
4180 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4181 struct ieee80211_vif *vif, size_t frame_len,
4182 const struct ieee80211_tx_info *frame_txctl);
4185 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4186 * @hw: pointer obtained from ieee80211_alloc_hw().
4187 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4188 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4189 * @frame_len: the frame length (in octets).
4190 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4191 * @cts: The buffer where to store the CTS-to-self frame.
4193 * If the CTS-to-self frames are generated by the host system (i.e., not in
4194 * hardware/firmware), the low-level driver uses this function to receive
4195 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4196 * for calling this function before and CTS-to-self frame is needed.
4198 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4199 struct ieee80211_vif *vif,
4200 const void *frame, size_t frame_len,
4201 const struct ieee80211_tx_info *frame_txctl,
4202 struct ieee80211_cts *cts);
4205 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4206 * @hw: pointer obtained from ieee80211_alloc_hw().
4207 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4208 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4209 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4211 * If the CTS-to-self is generated in firmware, but the host system must provide
4212 * the duration field, the low-level driver uses this function to receive
4213 * the duration field value in little-endian byteorder.
4215 * Return: The duration.
4217 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4218 struct ieee80211_vif *vif,
4220 const struct ieee80211_tx_info *frame_txctl);
4223 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4224 * @hw: pointer obtained from ieee80211_alloc_hw().
4225 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4226 * @band: the band to calculate the frame duration on
4227 * @frame_len: the length of the frame.
4228 * @rate: the rate at which the frame is going to be transmitted.
4230 * Calculate the duration field of some generic frame, given its
4231 * length and transmission rate (in 100kbps).
4233 * Return: The duration.
4235 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4236 struct ieee80211_vif *vif,
4237 enum ieee80211_band band,
4239 struct ieee80211_rate *rate);
4242 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4243 * @hw: pointer as obtained from ieee80211_alloc_hw().
4244 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4246 * Function for accessing buffered broadcast and multicast frames. If
4247 * hardware/firmware does not implement buffering of broadcast/multicast
4248 * frames when power saving is used, 802.11 code buffers them in the host
4249 * memory. The low-level driver uses this function to fetch next buffered
4250 * frame. In most cases, this is used when generating beacon frame.
4252 * Return: A pointer to the next buffered skb or NULL if no more buffered
4253 * frames are available.
4255 * Note: buffered frames are returned only after DTIM beacon frame was
4256 * generated with ieee80211_beacon_get() and the low-level driver must thus
4257 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4258 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4259 * does not need to check for DTIM beacons separately and should be able to
4260 * use common code for all beacons.
4263 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4266 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4268 * This function returns the TKIP phase 1 key for the given IV32.
4270 * @keyconf: the parameter passed with the set key
4271 * @iv32: IV32 to get the P1K for
4272 * @p1k: a buffer to which the key will be written, as 5 u16 values
4274 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4275 u32 iv32, u16 *p1k);
4278 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4280 * This function returns the TKIP phase 1 key for the IV32 taken
4281 * from the given packet.
4283 * @keyconf: the parameter passed with the set key
4284 * @skb: the packet to take the IV32 value from that will be encrypted
4286 * @p1k: a buffer to which the key will be written, as 5 u16 values
4288 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4289 struct sk_buff *skb, u16 *p1k)
4291 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4292 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4293 u32 iv32 = get_unaligned_le32(&data[4]);
4295 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4299 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4301 * This function returns the TKIP phase 1 key for the given IV32
4302 * and transmitter address.
4304 * @keyconf: the parameter passed with the set key
4305 * @ta: TA that will be used with the key
4306 * @iv32: IV32 to get the P1K for
4307 * @p1k: a buffer to which the key will be written, as 5 u16 values
4309 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4310 const u8 *ta, u32 iv32, u16 *p1k);
4313 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4315 * This function computes the TKIP RC4 key for the IV values
4318 * @keyconf: the parameter passed with the set key
4319 * @skb: the packet to take the IV32/IV16 values from that will be
4320 * encrypted with this key
4321 * @p2k: a buffer to which the key will be written, 16 bytes
4323 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4324 struct sk_buff *skb, u8 *p2k);
4327 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
4329 * This function computes the two AES-CMAC sub-keys, based on the
4330 * previously installed master key.
4332 * @keyconf: the parameter passed with the set key
4333 * @k1: a buffer to be filled with the 1st sub-key
4334 * @k2: a buffer to be filled with the 2nd sub-key
4336 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
4340 * ieee80211_get_key_tx_seq - get key TX sequence counter
4342 * @keyconf: the parameter passed with the set key
4343 * @seq: buffer to receive the sequence data
4345 * This function allows a driver to retrieve the current TX IV/PN
4346 * for the given key. It must not be called if IV generation is
4347 * offloaded to the device.
4349 * Note that this function may only be called when no TX processing
4350 * can be done concurrently, for example when queues are stopped
4351 * and the stop has been synchronized.
4353 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4354 struct ieee80211_key_seq *seq);
4357 * ieee80211_get_key_rx_seq - get key RX sequence counter
4359 * @keyconf: the parameter passed with the set key
4360 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4361 * the value on TID 0 is also used for non-QoS frames. For
4362 * CMAC, only TID 0 is valid.
4363 * @seq: buffer to receive the sequence data
4365 * This function allows a driver to retrieve the current RX IV/PNs
4366 * for the given key. It must not be called if IV checking is done
4367 * by the device and not by mac80211.
4369 * Note that this function may only be called when no RX processing
4370 * can be done concurrently.
4372 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4373 int tid, struct ieee80211_key_seq *seq);
4376 * ieee80211_set_key_tx_seq - set key TX sequence counter
4378 * @keyconf: the parameter passed with the set key
4379 * @seq: new sequence data
4381 * This function allows a driver to set the current TX IV/PNs for the
4382 * given key. This is useful when resuming from WoWLAN sleep and the
4383 * device may have transmitted frames using the PTK, e.g. replies to
4386 * Note that this function may only be called when no TX processing
4387 * can be done concurrently.
4389 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4390 struct ieee80211_key_seq *seq);
4393 * ieee80211_set_key_rx_seq - set key RX sequence counter
4395 * @keyconf: the parameter passed with the set key
4396 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4397 * the value on TID 0 is also used for non-QoS frames. For
4398 * CMAC, only TID 0 is valid.
4399 * @seq: new sequence data
4401 * This function allows a driver to set the current RX IV/PNs for the
4402 * given key. This is useful when resuming from WoWLAN sleep and GTK
4403 * rekey may have been done while suspended. It should not be called
4404 * if IV checking is done by the device and not by mac80211.
4406 * Note that this function may only be called when no RX processing
4407 * can be done concurrently.
4409 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4410 int tid, struct ieee80211_key_seq *seq);
4413 * ieee80211_remove_key - remove the given key
4414 * @keyconf: the parameter passed with the set key
4416 * Remove the given key. If the key was uploaded to the hardware at the
4417 * time this function is called, it is not deleted in the hardware but
4418 * instead assumed to have been removed already.
4420 * Note that due to locking considerations this function can (currently)
4421 * only be called during key iteration (ieee80211_iter_keys().)
4423 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4426 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4427 * @vif: the virtual interface to add the key on
4428 * @keyconf: new key data
4430 * When GTK rekeying was done while the system was suspended, (a) new
4431 * key(s) will be available. These will be needed by mac80211 for proper
4432 * RX processing, so this function allows setting them.
4434 * The function returns the newly allocated key structure, which will
4435 * have similar contents to the passed key configuration but point to
4436 * mac80211-owned memory. In case of errors, the function returns an
4437 * ERR_PTR(), use IS_ERR() etc.
4439 * Note that this function assumes the key isn't added to hardware
4440 * acceleration, so no TX will be done with the key. Since it's a GTK
4441 * on managed (station) networks, this is true anyway. If the driver
4442 * calls this function from the resume callback and subsequently uses
4443 * the return code 1 to reconfigure the device, this key will be part
4444 * of the reconfiguration.
4446 * Note that the driver should also call ieee80211_set_key_rx_seq()
4447 * for the new key for each TID to set up sequence counters properly.
4449 * IMPORTANT: If this replaces a key that is present in the hardware,
4450 * then it will attempt to remove it during this call. In many cases
4451 * this isn't what you want, so call ieee80211_remove_key() first for
4452 * the key that's being replaced.
4454 struct ieee80211_key_conf *
4455 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4456 struct ieee80211_key_conf *keyconf);
4459 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4460 * @vif: virtual interface the rekeying was done on
4461 * @bssid: The BSSID of the AP, for checking association
4462 * @replay_ctr: the new replay counter after GTK rekeying
4463 * @gfp: allocation flags
4465 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4466 const u8 *replay_ctr, gfp_t gfp);
4469 * ieee80211_wake_queue - wake specific queue
4470 * @hw: pointer as obtained from ieee80211_alloc_hw().
4471 * @queue: queue number (counted from zero).
4473 * Drivers should use this function instead of netif_wake_queue.
4475 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4478 * ieee80211_stop_queue - stop specific queue
4479 * @hw: pointer as obtained from ieee80211_alloc_hw().
4480 * @queue: queue number (counted from zero).
4482 * Drivers should use this function instead of netif_stop_queue.
4484 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4487 * ieee80211_queue_stopped - test status of the queue
4488 * @hw: pointer as obtained from ieee80211_alloc_hw().
4489 * @queue: queue number (counted from zero).
4491 * Drivers should use this function instead of netif_stop_queue.
4493 * Return: %true if the queue is stopped. %false otherwise.
4496 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4499 * ieee80211_stop_queues - stop all queues
4500 * @hw: pointer as obtained from ieee80211_alloc_hw().
4502 * Drivers should use this function instead of netif_stop_queue.
4504 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4507 * ieee80211_wake_queues - wake all queues
4508 * @hw: pointer as obtained from ieee80211_alloc_hw().
4510 * Drivers should use this function instead of netif_wake_queue.
4512 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4515 * ieee80211_scan_completed - completed hardware scan
4517 * When hardware scan offload is used (i.e. the hw_scan() callback is
4518 * assigned) this function needs to be called by the driver to notify
4519 * mac80211 that the scan finished. This function can be called from
4520 * any context, including hardirq context.
4522 * @hw: the hardware that finished the scan
4523 * @aborted: set to true if scan was aborted
4525 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4528 * ieee80211_sched_scan_results - got results from scheduled scan
4530 * When a scheduled scan is running, this function needs to be called by the
4531 * driver whenever there are new scan results available.
4533 * @hw: the hardware that is performing scheduled scans
4535 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4538 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4540 * When a scheduled scan is running, this function can be called by
4541 * the driver if it needs to stop the scan to perform another task.
4542 * Usual scenarios are drivers that cannot continue the scheduled scan
4543 * while associating, for instance.
4545 * @hw: the hardware that is performing scheduled scans
4547 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4550 * enum ieee80211_interface_iteration_flags - interface iteration flags
4551 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4552 * been added to the driver; However, note that during hardware
4553 * reconfiguration (after restart_hw) it will iterate over a new
4554 * interface and over all the existing interfaces even if they
4555 * haven't been re-added to the driver yet.
4556 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4557 * interfaces, even if they haven't been re-added to the driver yet.
4558 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4560 enum ieee80211_interface_iteration_flags {
4561 IEEE80211_IFACE_ITER_NORMAL = 0,
4562 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4563 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4567 * ieee80211_iterate_interfaces - iterate interfaces
4569 * This function iterates over the interfaces associated with a given
4570 * hardware and calls the callback for them. This includes active as well as
4571 * inactive interfaces. This function allows the iterator function to sleep.
4572 * Will iterate over a new interface during add_interface().
4574 * @hw: the hardware struct of which the interfaces should be iterated over
4575 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4576 * @iterator: the iterator function to call
4577 * @data: first argument of the iterator function
4579 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4580 void (*iterator)(void *data, u8 *mac,
4581 struct ieee80211_vif *vif),
4585 * ieee80211_iterate_active_interfaces - iterate active interfaces
4587 * This function iterates over the interfaces associated with a given
4588 * hardware that are currently active and calls the callback for them.
4589 * This function allows the iterator function to sleep, when the iterator
4590 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4592 * Does not iterate over a new interface during add_interface().
4594 * @hw: the hardware struct of which the interfaces should be iterated over
4595 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4596 * @iterator: the iterator function to call
4597 * @data: first argument of the iterator function
4600 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4601 void (*iterator)(void *data, u8 *mac,
4602 struct ieee80211_vif *vif),
4605 ieee80211_iterate_interfaces(hw,
4606 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4611 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4613 * This function iterates over the interfaces associated with a given
4614 * hardware that are currently active and calls the callback for them.
4615 * This function requires the iterator callback function to be atomic,
4616 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4617 * Does not iterate over a new interface during add_interface().
4619 * @hw: the hardware struct of which the interfaces should be iterated over
4620 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4621 * @iterator: the iterator function to call, cannot sleep
4622 * @data: first argument of the iterator function
4624 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4626 void (*iterator)(void *data,
4628 struct ieee80211_vif *vif),
4632 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4634 * This function iterates over the interfaces associated with a given
4635 * hardware that are currently active and calls the callback for them.
4636 * This version can only be used while holding the RTNL.
4638 * @hw: the hardware struct of which the interfaces should be iterated over
4639 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4640 * @iterator: the iterator function to call, cannot sleep
4641 * @data: first argument of the iterator function
4643 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4645 void (*iterator)(void *data,
4647 struct ieee80211_vif *vif),
4651 * ieee80211_iterate_stations_atomic - iterate stations
4653 * This function iterates over all stations associated with a given
4654 * hardware that are currently uploaded to the driver and calls the callback
4655 * function for them.
4656 * This function requires the iterator callback function to be atomic,
4658 * @hw: the hardware struct of which the interfaces should be iterated over
4659 * @iterator: the iterator function to call, cannot sleep
4660 * @data: first argument of the iterator function
4662 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4663 void (*iterator)(void *data,
4664 struct ieee80211_sta *sta),
4667 * ieee80211_queue_work - add work onto the mac80211 workqueue
4669 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4670 * This helper ensures drivers are not queueing work when they should not be.
4672 * @hw: the hardware struct for the interface we are adding work for
4673 * @work: the work we want to add onto the mac80211 workqueue
4675 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4678 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4680 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4683 * @hw: the hardware struct for the interface we are adding work for
4684 * @dwork: delayable work to queue onto the mac80211 workqueue
4685 * @delay: number of jiffies to wait before queueing
4687 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4688 struct delayed_work *dwork,
4689 unsigned long delay);
4692 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4693 * @sta: the station for which to start a BA session
4694 * @tid: the TID to BA on.
4695 * @timeout: session timeout value (in TUs)
4697 * Return: success if addBA request was sent, failure otherwise
4699 * Although mac80211/low level driver/user space application can estimate
4700 * the need to start aggregation on a certain RA/TID, the session level
4701 * will be managed by the mac80211.
4703 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4707 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4708 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4709 * @ra: receiver address of the BA session recipient.
4710 * @tid: the TID to BA on.
4712 * This function must be called by low level driver once it has
4713 * finished with preparations for the BA session. It can be called
4716 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4720 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4721 * @sta: the station whose BA session to stop
4722 * @tid: the TID to stop BA.
4724 * Return: negative error if the TID is invalid, or no aggregation active
4726 * Although mac80211/low level driver/user space application can estimate
4727 * the need to stop aggregation on a certain RA/TID, the session level
4728 * will be managed by the mac80211.
4730 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4733 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4734 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4735 * @ra: receiver address of the BA session recipient.
4736 * @tid: the desired TID to BA on.
4738 * This function must be called by low level driver once it has
4739 * finished with preparations for the BA session tear down. It
4740 * can be called from any context.
4742 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4746 * ieee80211_find_sta - find a station
4748 * @vif: virtual interface to look for station on
4749 * @addr: station's address
4751 * Return: The station, if found. %NULL otherwise.
4753 * Note: This function must be called under RCU lock and the
4754 * resulting pointer is only valid under RCU lock as well.
4756 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4760 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4762 * @hw: pointer as obtained from ieee80211_alloc_hw()
4763 * @addr: remote station's address
4764 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4766 * Return: The station, if found. %NULL otherwise.
4768 * Note: This function must be called under RCU lock and the
4769 * resulting pointer is only valid under RCU lock as well.
4771 * NOTE: You may pass NULL for localaddr, but then you will just get
4772 * the first STA that matches the remote address 'addr'.
4773 * We can have multiple STA associated with multiple
4774 * logical stations (e.g. consider a station connecting to another
4775 * BSSID on the same AP hardware without disconnecting first).
4776 * In this case, the result of this method with localaddr NULL
4779 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4781 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4783 const u8 *localaddr);
4786 * ieee80211_sta_block_awake - block station from waking up
4788 * @pubsta: the station
4789 * @block: whether to block or unblock
4791 * Some devices require that all frames that are on the queues
4792 * for a specific station that went to sleep are flushed before
4793 * a poll response or frames after the station woke up can be
4794 * delivered to that it. Note that such frames must be rejected
4795 * by the driver as filtered, with the appropriate status flag.
4797 * This function allows implementing this mode in a race-free
4800 * To do this, a driver must keep track of the number of frames
4801 * still enqueued for a specific station. If this number is not
4802 * zero when the station goes to sleep, the driver must call
4803 * this function to force mac80211 to consider the station to
4804 * be asleep regardless of the station's actual state. Once the
4805 * number of outstanding frames reaches zero, the driver must
4806 * call this function again to unblock the station. That will
4807 * cause mac80211 to be able to send ps-poll responses, and if
4808 * the station queried in the meantime then frames will also
4809 * be sent out as a result of this. Additionally, the driver
4810 * will be notified that the station woke up some time after
4811 * it is unblocked, regardless of whether the station actually
4812 * woke up while blocked or not.
4814 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4815 struct ieee80211_sta *pubsta, bool block);
4818 * ieee80211_sta_eosp - notify mac80211 about end of SP
4819 * @pubsta: the station
4821 * When a device transmits frames in a way that it can't tell
4822 * mac80211 in the TX status about the EOSP, it must clear the
4823 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4824 * This applies for PS-Poll as well as uAPSD.
4826 * Note that just like with _tx_status() and _rx() drivers must
4827 * not mix calls to irqsafe/non-irqsafe versions, this function
4828 * must not be mixed with those either. Use the all irqsafe, or
4829 * all non-irqsafe, don't mix!
4831 * NB: the _irqsafe version of this function doesn't exist, no
4832 * driver needs it right now. Don't call this function if
4833 * you'd need the _irqsafe version, look at the git history
4834 * and restore the _irqsafe version!
4836 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4839 * ieee80211_iter_keys - iterate keys programmed into the device
4840 * @hw: pointer obtained from ieee80211_alloc_hw()
4841 * @vif: virtual interface to iterate, may be %NULL for all
4842 * @iter: iterator function that will be called for each key
4843 * @iter_data: custom data to pass to the iterator function
4845 * This function can be used to iterate all the keys known to
4846 * mac80211, even those that weren't previously programmed into
4847 * the device. This is intended for use in WoWLAN if the device
4848 * needs reprogramming of the keys during suspend. Note that due
4849 * to locking reasons, it is also only safe to call this at few
4850 * spots since it must hold the RTNL and be able to sleep.
4852 * The order in which the keys are iterated matches the order
4853 * in which they were originally installed and handed to the
4856 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4857 struct ieee80211_vif *vif,
4858 void (*iter)(struct ieee80211_hw *hw,
4859 struct ieee80211_vif *vif,
4860 struct ieee80211_sta *sta,
4861 struct ieee80211_key_conf *key,
4866 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4867 * @hw: pointre obtained from ieee80211_alloc_hw().
4868 * @iter: iterator function
4869 * @iter_data: data passed to iterator function
4871 * Iterate all active channel contexts. This function is atomic and
4872 * doesn't acquire any locks internally that might be held in other
4873 * places while calling into the driver.
4875 * The iterator will not find a context that's being added (during
4876 * the driver callback to add it) but will find it while it's being
4879 * Note that during hardware restart, all contexts that existed
4880 * before the restart are considered already present so will be
4881 * found while iterating, whether they've been re-added already
4884 void ieee80211_iter_chan_contexts_atomic(
4885 struct ieee80211_hw *hw,
4886 void (*iter)(struct ieee80211_hw *hw,
4887 struct ieee80211_chanctx_conf *chanctx_conf,
4892 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4893 * @hw: pointer obtained from ieee80211_alloc_hw().
4894 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4896 * Creates a Probe Request template which can, for example, be uploaded to
4897 * hardware. The template is filled with bssid, ssid and supported rate
4898 * information. This function must only be called from within the
4899 * .bss_info_changed callback function and only in managed mode. The function
4900 * is only useful when the interface is associated, otherwise it will return
4903 * Return: The Probe Request template. %NULL on error.
4905 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4906 struct ieee80211_vif *vif);
4909 * ieee80211_beacon_loss - inform hardware does not receive beacons
4911 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4913 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4914 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4915 * hardware is not receiving beacons with this function.
4917 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4920 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4922 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4924 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4925 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4926 * needs to inform if the connection to the AP has been lost.
4927 * The function may also be called if the connection needs to be terminated
4928 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4930 * This function will cause immediate change to disassociated state,
4931 * without connection recovery attempts.
4933 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4936 * ieee80211_resume_disconnect - disconnect from AP after resume
4938 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4940 * Instructs mac80211 to disconnect from the AP after resume.
4941 * Drivers can use this after WoWLAN if they know that the
4942 * connection cannot be kept up, for example because keys were
4943 * used while the device was asleep but the replay counters or
4944 * similar cannot be retrieved from the device during resume.
4946 * Note that due to implementation issues, if the driver uses
4947 * the reconfiguration functionality during resume the interface
4948 * will still be added as associated first during resume and then
4949 * disconnect normally later.
4951 * This function can only be called from the resume callback and
4952 * the driver must not be holding any of its own locks while it
4953 * calls this function, or at least not any locks it needs in the
4954 * key configuration paths (if it supports HW crypto).
4956 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4959 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4960 * rssi threshold triggered
4962 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4963 * @rssi_event: the RSSI trigger event type
4964 * @gfp: context flags
4966 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4967 * monitoring is configured with an rssi threshold, the driver will inform
4968 * whenever the rssi level reaches the threshold.
4970 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4971 enum nl80211_cqm_rssi_threshold_event rssi_event,
4975 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4977 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4978 * @gfp: context flags
4980 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
4983 * ieee80211_radar_detected - inform that a radar was detected
4985 * @hw: pointer as obtained from ieee80211_alloc_hw()
4987 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4990 * ieee80211_chswitch_done - Complete channel switch process
4991 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4992 * @success: make the channel switch successful or not
4994 * Complete the channel switch post-process: set the new operational channel
4995 * and wake up the suspended queues.
4997 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5000 * ieee80211_request_smps - request SM PS transition
5001 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5002 * @smps_mode: new SM PS mode
5004 * This allows the driver to request an SM PS transition in managed
5005 * mode. This is useful when the driver has more information than
5006 * the stack about possible interference, for example by bluetooth.
5008 void ieee80211_request_smps(struct ieee80211_vif *vif,
5009 enum ieee80211_smps_mode smps_mode);
5012 * ieee80211_ready_on_channel - notification of remain-on-channel start
5013 * @hw: pointer as obtained from ieee80211_alloc_hw()
5015 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5018 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5019 * @hw: pointer as obtained from ieee80211_alloc_hw()
5021 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5024 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5026 * in order not to harm the system performance and user experience, the device
5027 * may request not to allow any rx ba session and tear down existing rx ba
5028 * sessions based on system constraints such as periodic BT activity that needs
5029 * to limit wlan activity (eg.sco or a2dp)."
5030 * in such cases, the intention is to limit the duration of the rx ppdu and
5031 * therefore prevent the peer device to use a-mpdu aggregation.
5033 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5034 * @ba_rx_bitmap: Bit map of open rx ba per tid
5035 * @addr: & to bssid mac address
5037 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5041 * ieee80211_send_bar - send a BlockAckReq frame
5043 * can be used to flush pending frames from the peer's aggregation reorder
5046 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5047 * @ra: the peer's destination address
5048 * @tid: the TID of the aggregation session
5049 * @ssn: the new starting sequence number for the receiver
5051 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5054 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5056 * Some device drivers may offload part of the Rx aggregation flow including
5057 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5060 * Create structures responsible for reordering so device drivers may call here
5061 * when they complete AddBa negotiation.
5063 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5064 * @addr: station mac address
5067 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5068 const u8 *addr, u16 tid);
5071 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5073 * Some device drivers may offload part of the Rx aggregation flow including
5074 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5077 * Destroy structures responsible for reordering so device drivers may call here
5078 * when they complete DelBa negotiation.
5080 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5081 * @addr: station mac address
5084 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5085 const u8 *addr, u16 tid);
5087 /* Rate control API */
5090 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5092 * @hw: The hardware the algorithm is invoked for.
5093 * @sband: The band this frame is being transmitted on.
5094 * @bss_conf: the current BSS configuration
5095 * @skb: the skb that will be transmitted, the control information in it needs
5097 * @reported_rate: The rate control algorithm can fill this in to indicate
5098 * which rate should be reported to userspace as the current rate and
5099 * used for rate calculations in the mesh network.
5100 * @rts: whether RTS will be used for this frame because it is longer than the
5102 * @short_preamble: whether mac80211 will request short-preamble transmission
5103 * if the selected rate supports it
5104 * @max_rate_idx: user-requested maximum (legacy) rate
5105 * (deprecated; this will be removed once drivers get updated to use
5107 * @rate_idx_mask: user-requested (legacy) rate mask
5108 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5109 * @bss: whether this frame is sent out in AP or IBSS mode
5111 struct ieee80211_tx_rate_control {
5112 struct ieee80211_hw *hw;
5113 struct ieee80211_supported_band *sband;
5114 struct ieee80211_bss_conf *bss_conf;
5115 struct sk_buff *skb;
5116 struct ieee80211_tx_rate reported_rate;
5117 bool rts, short_preamble;
5120 u8 *rate_idx_mcs_mask;
5124 struct rate_control_ops {
5126 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5127 void (*free)(void *priv);
5129 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5130 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5131 struct cfg80211_chan_def *chandef,
5132 struct ieee80211_sta *sta, void *priv_sta);
5133 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5134 struct cfg80211_chan_def *chandef,
5135 struct ieee80211_sta *sta, void *priv_sta,
5137 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5140 void (*tx_status_noskb)(void *priv,
5141 struct ieee80211_supported_band *sband,
5142 struct ieee80211_sta *sta, void *priv_sta,
5143 struct ieee80211_tx_info *info);
5144 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5145 struct ieee80211_sta *sta, void *priv_sta,
5146 struct sk_buff *skb);
5147 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5148 struct ieee80211_tx_rate_control *txrc);
5150 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5151 struct dentry *dir);
5152 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5154 u32 (*get_expected_throughput)(void *priv_sta);
5157 static inline int rate_supported(struct ieee80211_sta *sta,
5158 enum ieee80211_band band,
5161 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5165 * rate_control_send_low - helper for drivers for management/no-ack frames
5167 * Rate control algorithms that agree to use the lowest rate to
5168 * send management frames and NO_ACK data with the respective hw
5169 * retries should use this in the beginning of their mac80211 get_rate
5170 * callback. If true is returned the rate control can simply return.
5171 * If false is returned we guarantee that sta and sta and priv_sta is
5174 * Rate control algorithms wishing to do more intelligent selection of
5175 * rate for multicast/broadcast frames may choose to not use this.
5177 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5178 * that this may be null.
5179 * @priv_sta: private rate control structure. This may be null.
5180 * @txrc: rate control information we sholud populate for mac80211.
5182 bool rate_control_send_low(struct ieee80211_sta *sta,
5184 struct ieee80211_tx_rate_control *txrc);
5188 rate_lowest_index(struct ieee80211_supported_band *sband,
5189 struct ieee80211_sta *sta)
5193 for (i = 0; i < sband->n_bitrates; i++)
5194 if (rate_supported(sta, sband->band, i))
5197 /* warn when we cannot find a rate. */
5200 /* and return 0 (the lowest index) */
5205 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5206 struct ieee80211_sta *sta)
5210 for (i = 0; i < sband->n_bitrates; i++)
5211 if (rate_supported(sta, sband->band, i))
5217 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5219 * When not doing a rate control probe to test rates, rate control should pass
5220 * its rate selection to mac80211. If the driver supports receiving a station
5221 * rate table, it will use it to ensure that frames are always sent based on
5222 * the most recent rate control module decision.
5224 * @hw: pointer as obtained from ieee80211_alloc_hw()
5225 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5226 * @rates: new tx rate set to be used for this station.
5228 int rate_control_set_rates(struct ieee80211_hw *hw,
5229 struct ieee80211_sta *pubsta,
5230 struct ieee80211_sta_rates *rates);
5232 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5233 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5236 conf_is_ht20(struct ieee80211_conf *conf)
5238 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5242 conf_is_ht40_minus(struct ieee80211_conf *conf)
5244 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5245 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5249 conf_is_ht40_plus(struct ieee80211_conf *conf)
5251 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5252 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5256 conf_is_ht40(struct ieee80211_conf *conf)
5258 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5262 conf_is_ht(struct ieee80211_conf *conf)
5264 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5265 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5266 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5269 static inline enum nl80211_iftype
5270 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5274 case NL80211_IFTYPE_STATION:
5275 return NL80211_IFTYPE_P2P_CLIENT;
5276 case NL80211_IFTYPE_AP:
5277 return NL80211_IFTYPE_P2P_GO;
5285 static inline enum nl80211_iftype
5286 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5288 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5291 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5293 int rssi_max_thold);
5295 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5298 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5300 * @vif: the specified virtual interface
5302 * Note: This function assumes that the given vif is valid.
5304 * Return: The average RSSI value for the requested interface, or 0 if not
5307 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5310 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5311 * @vif: virtual interface
5312 * @wakeup: wakeup reason(s)
5313 * @gfp: allocation flags
5315 * See cfg80211_report_wowlan_wakeup().
5317 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5318 struct cfg80211_wowlan_wakeup *wakeup,
5322 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5323 * @hw: pointer as obtained from ieee80211_alloc_hw()
5324 * @vif: virtual interface
5325 * @skb: frame to be sent from within the driver
5326 * @band: the band to transmit on
5327 * @sta: optional pointer to get the station to send the frame to
5329 * Note: must be called under RCU lock
5331 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5332 struct ieee80211_vif *vif, struct sk_buff *skb,
5333 int band, struct ieee80211_sta **sta);
5336 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5338 * @next_tsf: TSF timestamp of the next absent state change
5339 * @has_next_tsf: next absent state change event pending
5341 * @absent: descriptor bitmask, set if GO is currently absent
5345 * @count: count fields from the NoA descriptors
5346 * @desc: adjusted data from the NoA
5348 struct ieee80211_noa_data {
5354 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5359 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5363 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5366 * @data: NoA tracking data
5367 * @tsf: current TSF timestamp
5369 * Return: number of successfully parsed descriptors
5371 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5372 struct ieee80211_noa_data *data, u32 tsf);
5375 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5377 * @data: NoA tracking data
5378 * @tsf: current TSF timestamp
5380 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5383 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5384 * @vif: virtual interface
5385 * @peer: the peer's destination address
5386 * @oper: the requested TDLS operation
5387 * @reason_code: reason code for the operation, valid for TDLS teardown
5388 * @gfp: allocation flags
5390 * See cfg80211_tdls_oper_request().
5392 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5393 enum nl80211_tdls_operation oper,
5394 u16 reason_code, gfp_t gfp);
5397 * ieee80211_reserve_tid - request to reserve a specific TID
5399 * There is sometimes a need (such as in TDLS) for blocking the driver from
5400 * using a specific TID so that the FW can use it for certain operations such
5401 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5402 * this function must be called as it flushes out packets on this TID and marks
5403 * it as blocked, so that any transmit for the station on this TID will be
5404 * redirected to the alternative TID in the same AC.
5406 * Note that this function blocks and may call back into the driver, so it
5407 * should be called without driver locks held. Also note this function should
5408 * only be called from the driver's @sta_state callback.
5410 * @sta: the station to reserve the TID for
5411 * @tid: the TID to reserve
5413 * Returns: 0 on success, else on failure
5415 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5418 * ieee80211_unreserve_tid - request to unreserve a specific TID
5420 * Once there is no longer any need for reserving a certain TID, this function
5421 * should be called, and no longer will packets have their TID modified for
5422 * preventing use of this TID in the driver.
5424 * Note that this function blocks and acquires a lock, so it should be called
5425 * without driver locks held. Also note this function should only be called
5426 * from the driver's @sta_state callback.
5429 * @tid: the TID to unreserve
5431 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5434 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5436 * @hw: pointer as obtained from ieee80211_alloc_hw()
5437 * @txq: pointer obtained from station or virtual interface
5439 * Returns the skb if successful, %NULL if no frame was available.
5441 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5442 struct ieee80211_txq *txq);
5443 #endif /* MAC80211_H */