base: Export platform_msi_domain_[alloc,free]_irqs
[linux/fpc-iii.git] / include / net / mac80211.h
blob760bc4d5a2cfe87aadd2e96a98292855cf2eb050
1 /*
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
8 * Copyright (C) 2015 Intel Deutschland GmbH
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #ifndef MAC80211_H
16 #define MAC80211_H
18 #include <linux/bug.h>
19 #include <linux/kernel.h>
20 #include <linux/if_ether.h>
21 #include <linux/skbuff.h>
22 #include <linux/ieee80211.h>
23 #include <net/cfg80211.h>
24 #include <asm/unaligned.h>
26 /**
27 * DOC: Introduction
29 * mac80211 is the Linux stack for 802.11 hardware that implements
30 * only partial functionality in hard- or firmware. This document
31 * defines the interface between mac80211 and low-level hardware
32 * drivers.
35 /**
36 * DOC: Calling mac80211 from interrupts
38 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
39 * called in hardware interrupt context. The low-level driver must not call any
40 * other functions in hardware interrupt context. If there is a need for such
41 * call, the low-level driver should first ACK the interrupt and perform the
42 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * tasklet function.
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46 * use the non-IRQ-safe functions!
49 /**
50 * DOC: Warning
52 * If you're reading this document and not the header file itself, it will
53 * be incomplete because not all documentation has been converted yet.
56 /**
57 * DOC: Frame format
59 * As a general rule, when frames are passed between mac80211 and the driver,
60 * they start with the IEEE 802.11 header and include the same octets that are
61 * sent over the air except for the FCS which should be calculated by the
62 * hardware.
64 * There are, however, various exceptions to this rule for advanced features:
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
73 /**
74 * DOC: mac80211 workqueue
76 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
77 * The workqueue is a single threaded workqueue and can only be accessed by
78 * helpers for sanity checking. Drivers must ensure all work added onto the
79 * mac80211 workqueue should be cancelled on the driver stop() callback.
81 * mac80211 will flushed the workqueue upon interface removal and during
82 * suspend.
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
88 /**
89 * DOC: mac80211 software tx queueing
91 * mac80211 provides an optional intermediate queueing implementation designed
92 * to allow the driver to keep hardware queues short and provide some fairness
93 * between different stations/interfaces.
94 * In this model, the driver pulls data frames from the mac80211 queue instead
95 * of letting mac80211 push them via drv_tx().
96 * Other frames (e.g. control or management) are still pushed using drv_tx().
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
99 * driver operation.
101 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
102 * single per-vif queue for multicast data frames.
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
107 * The driver can't access the queue directly. To dequeue a frame, it calls
108 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
109 * calls the .wake_tx_queue driver op.
111 * For AP powersave TIM handling, the driver only needs to indicate if it has
112 * buffered packets in the driver specific data structures by calling
113 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
114 * struct, mac80211 sets the appropriate TIM PVB bits and calls
115 * .release_buffered_frames().
116 * In that callback the driver is therefore expected to release its own
117 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
118 * via the usual ieee80211_tx_dequeue).
121 struct device;
124 * enum ieee80211_max_queues - maximum number of queues
126 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
127 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
129 enum ieee80211_max_queues {
130 IEEE80211_MAX_QUEUES = 16,
131 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
134 #define IEEE80211_INVAL_HW_QUEUE 0xff
137 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
138 * @IEEE80211_AC_VO: voice
139 * @IEEE80211_AC_VI: video
140 * @IEEE80211_AC_BE: best effort
141 * @IEEE80211_AC_BK: background
143 enum ieee80211_ac_numbers {
144 IEEE80211_AC_VO = 0,
145 IEEE80211_AC_VI = 1,
146 IEEE80211_AC_BE = 2,
147 IEEE80211_AC_BK = 3,
149 #define IEEE80211_NUM_ACS 4
152 * struct ieee80211_tx_queue_params - transmit queue configuration
154 * The information provided in this structure is required for QoS
155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
157 * @aifs: arbitration interframe space [0..255]
158 * @cw_min: minimum contention window [a value of the form
159 * 2^n-1 in the range 1..32767]
160 * @cw_max: maximum contention window [like @cw_min]
161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162 * @acm: is mandatory admission control required for the access category
163 * @uapsd: is U-APSD mode enabled for the queue
165 struct ieee80211_tx_queue_params {
166 u16 txop;
167 u16 cw_min;
168 u16 cw_max;
169 u8 aifs;
170 bool acm;
171 bool uapsd;
174 struct ieee80211_low_level_stats {
175 unsigned int dot11ACKFailureCount;
176 unsigned int dot11RTSFailureCount;
177 unsigned int dot11FCSErrorCount;
178 unsigned int dot11RTSSuccessCount;
182 * enum ieee80211_chanctx_change - change flag for channel context
183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
187 * this is used only with channel switching with CSA
188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
190 enum ieee80211_chanctx_change {
191 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
192 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
193 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
194 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
195 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
201 * This is the driver-visible part. The ieee80211_chanctx
202 * that contains it is visible in mac80211 only.
204 * @def: the channel definition
205 * @min_def: the minimum channel definition currently required.
206 * @rx_chains_static: The number of RX chains that must always be
207 * active on the channel to receive MIMO transmissions
208 * @rx_chains_dynamic: The number of RX chains that must be enabled
209 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
210 * this will always be >= @rx_chains_static.
211 * @radar_enabled: whether radar detection is enabled on this channel.
212 * @drv_priv: data area for driver use, will always be aligned to
213 * sizeof(void *), size is determined in hw information.
215 struct ieee80211_chanctx_conf {
216 struct cfg80211_chan_def def;
217 struct cfg80211_chan_def min_def;
219 u8 rx_chains_static, rx_chains_dynamic;
221 bool radar_enabled;
223 u8 drv_priv[0] __aligned(sizeof(void *));
227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
229 * exist (and will continue to exist), but the virtual interface
230 * needs to be switched from one to the other.
231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
232 * to exist with this call, the new context doesn't exist but
233 * will be active after this call, the virtual interface switches
234 * from the old to the new (note that the driver may of course
235 * implement this as an on-the-fly chandef switch of the existing
236 * hardware context, but the mac80211 pointer for the old context
237 * will cease to exist and only the new one will later be used
238 * for changes/removal.)
240 enum ieee80211_chanctx_switch_mode {
241 CHANCTX_SWMODE_REASSIGN_VIF,
242 CHANCTX_SWMODE_SWAP_CONTEXTS,
246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
248 * This is structure is used to pass information about a vif that
249 * needs to switch from one chanctx to another. The
250 * &ieee80211_chanctx_switch_mode defines how the switch should be
251 * done.
253 * @vif: the vif that should be switched from old_ctx to new_ctx
254 * @old_ctx: the old context to which the vif was assigned
255 * @new_ctx: the new context to which the vif must be assigned
257 struct ieee80211_vif_chanctx_switch {
258 struct ieee80211_vif *vif;
259 struct ieee80211_chanctx_conf *old_ctx;
260 struct ieee80211_chanctx_conf *new_ctx;
264 * enum ieee80211_bss_change - BSS change notification flags
266 * These flags are used with the bss_info_changed() callback
267 * to indicate which BSS parameter changed.
269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
270 * also implies a change in the AID.
271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
274 * @BSS_CHANGED_HT: 802.11n parameters changed
275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
278 * reason (IBSS and managed mode)
279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
280 * new beacon (beaconing modes)
281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
282 * enabled/disabled (beaconing modes)
283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284 * @BSS_CHANGED_IBSS: IBSS join status changed
285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
287 * that it is only ever disabled for station mode.
288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
294 * changed (currently only in P2P client mode, GO mode will be later)
295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
296 * currently dtim_period only is under consideration.
297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
298 * note that this is only called when it changes after the channel
299 * context had been assigned.
300 * @BSS_CHANGED_OCB: OCB join status changed
302 enum ieee80211_bss_change {
303 BSS_CHANGED_ASSOC = 1<<0,
304 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
305 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
306 BSS_CHANGED_ERP_SLOT = 1<<3,
307 BSS_CHANGED_HT = 1<<4,
308 BSS_CHANGED_BASIC_RATES = 1<<5,
309 BSS_CHANGED_BEACON_INT = 1<<6,
310 BSS_CHANGED_BSSID = 1<<7,
311 BSS_CHANGED_BEACON = 1<<8,
312 BSS_CHANGED_BEACON_ENABLED = 1<<9,
313 BSS_CHANGED_CQM = 1<<10,
314 BSS_CHANGED_IBSS = 1<<11,
315 BSS_CHANGED_ARP_FILTER = 1<<12,
316 BSS_CHANGED_QOS = 1<<13,
317 BSS_CHANGED_IDLE = 1<<14,
318 BSS_CHANGED_SSID = 1<<15,
319 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
320 BSS_CHANGED_PS = 1<<17,
321 BSS_CHANGED_TXPOWER = 1<<18,
322 BSS_CHANGED_P2P_PS = 1<<19,
323 BSS_CHANGED_BEACON_INFO = 1<<20,
324 BSS_CHANGED_BANDWIDTH = 1<<21,
325 BSS_CHANGED_OCB = 1<<22,
327 /* when adding here, make sure to change ieee80211_reconfig */
331 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
332 * of addresses for an interface increase beyond this value, hardware ARP
333 * filtering will be disabled.
335 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
338 * enum ieee80211_event_type - event to be notified to the low level driver
339 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
340 * @MLME_EVENT: event related to MLME
341 * @BAR_RX_EVENT: a BAR was received
342 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
343 * they timed out. This won't be called for each frame released, but only
344 * once each time the timeout triggers.
346 enum ieee80211_event_type {
347 RSSI_EVENT,
348 MLME_EVENT,
349 BAR_RX_EVENT,
350 BA_FRAME_TIMEOUT,
354 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
355 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
356 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
358 enum ieee80211_rssi_event_data {
359 RSSI_EVENT_HIGH,
360 RSSI_EVENT_LOW,
364 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
365 * @data: See &enum ieee80211_rssi_event_data
367 struct ieee80211_rssi_event {
368 enum ieee80211_rssi_event_data data;
372 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
373 * @AUTH_EVENT: the MLME operation is authentication
374 * @ASSOC_EVENT: the MLME operation is association
375 * @DEAUTH_RX_EVENT: deauth received..
376 * @DEAUTH_TX_EVENT: deauth sent.
378 enum ieee80211_mlme_event_data {
379 AUTH_EVENT,
380 ASSOC_EVENT,
381 DEAUTH_RX_EVENT,
382 DEAUTH_TX_EVENT,
386 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
387 * @MLME_SUCCESS: the MLME operation completed successfully.
388 * @MLME_DENIED: the MLME operation was denied by the peer.
389 * @MLME_TIMEOUT: the MLME operation timed out.
391 enum ieee80211_mlme_event_status {
392 MLME_SUCCESS,
393 MLME_DENIED,
394 MLME_TIMEOUT,
398 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
399 * @data: See &enum ieee80211_mlme_event_data
400 * @status: See &enum ieee80211_mlme_event_status
401 * @reason: the reason code if applicable
403 struct ieee80211_mlme_event {
404 enum ieee80211_mlme_event_data data;
405 enum ieee80211_mlme_event_status status;
406 u16 reason;
410 * struct ieee80211_ba_event - data attached for BlockAck related events
411 * @sta: pointer to the &ieee80211_sta to which this event relates
412 * @tid: the tid
413 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
415 struct ieee80211_ba_event {
416 struct ieee80211_sta *sta;
417 u16 tid;
418 u16 ssn;
422 * struct ieee80211_event - event to be sent to the driver
423 * @type: The event itself. See &enum ieee80211_event_type.
424 * @rssi: relevant if &type is %RSSI_EVENT
425 * @mlme: relevant if &type is %AUTH_EVENT
426 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
427 * @u:union holding the fields above
429 struct ieee80211_event {
430 enum ieee80211_event_type type;
431 union {
432 struct ieee80211_rssi_event rssi;
433 struct ieee80211_mlme_event mlme;
434 struct ieee80211_ba_event ba;
435 } u;
439 * struct ieee80211_bss_conf - holds the BSS's changing parameters
441 * This structure keeps information about a BSS (and an association
442 * to that BSS) that can change during the lifetime of the BSS.
444 * @assoc: association status
445 * @ibss_joined: indicates whether this station is part of an IBSS
446 * or not
447 * @ibss_creator: indicates if a new IBSS network is being created
448 * @aid: association ID number, valid only when @assoc is true
449 * @use_cts_prot: use CTS protection
450 * @use_short_preamble: use 802.11b short preamble
451 * @use_short_slot: use short slot time (only relevant for ERP)
452 * @dtim_period: num of beacons before the next DTIM, for beaconing,
453 * valid in station mode only if after the driver was notified
454 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
455 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
456 * as it may have been received during scanning long ago). If the
457 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
458 * only come from a beacon, but might not become valid until after
459 * association when a beacon is received (which is notified with the
460 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
461 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
462 * the driver/device can use this to calculate synchronisation
463 * (see @sync_tsf). See also sync_dtim_count important notice.
464 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
465 * is requested, see @sync_tsf/@sync_device_ts.
466 * IMPORTANT: These three sync_* parameters would possibly be out of sync
467 * by the time the driver will use them. The synchronized view is currently
468 * guaranteed only in certain callbacks.
469 * @beacon_int: beacon interval
470 * @assoc_capability: capabilities taken from assoc resp
471 * @basic_rates: bitmap of basic rates, each bit stands for an
472 * index into the rate table configured by the driver in
473 * the current band.
474 * @beacon_rate: associated AP's beacon TX rate
475 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
476 * @bssid: The BSSID for this BSS
477 * @enable_beacon: whether beaconing should be enabled or not
478 * @chandef: Channel definition for this BSS -- the hardware might be
479 * configured a higher bandwidth than this BSS uses, for example.
480 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
481 * This field is only valid when the channel is a wide HT/VHT channel.
482 * Note that with TDLS this can be the case (channel is HT, protection must
483 * be used from this field) even when the BSS association isn't using HT.
484 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
485 * implies disabled. As with the cfg80211 callback, a change here should
486 * cause an event to be sent indicating where the current value is in
487 * relation to the newly configured threshold.
488 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
489 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
490 * may filter ARP queries targeted for other addresses than listed here.
491 * The driver must allow ARP queries targeted for all address listed here
492 * to pass through. An empty list implies no ARP queries need to pass.
493 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
494 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
495 * array size), it's up to the driver what to do in that case.
496 * @qos: This is a QoS-enabled BSS.
497 * @idle: This interface is idle. There's also a global idle flag in the
498 * hardware config which may be more appropriate depending on what
499 * your driver/device needs to do.
500 * @ps: power-save mode (STA only). This flag is NOT affected by
501 * offchannel/dynamic_ps operations.
502 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
503 * @ssid_len: Length of SSID given in @ssid.
504 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
505 * @txpower: TX power in dBm
506 * @txpower_type: TX power adjustment used to control per packet Transmit
507 * Power Control (TPC) in lower driver for the current vif. In particular
508 * TPC is enabled if value passed in %txpower_type is
509 * NL80211_TX_POWER_LIMITED (allow using less than specified from
510 * userspace), whereas TPC is disabled if %txpower_type is set to
511 * NL80211_TX_POWER_FIXED (use value configured from userspace)
512 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
514 struct ieee80211_bss_conf {
515 const u8 *bssid;
516 /* association related data */
517 bool assoc, ibss_joined;
518 bool ibss_creator;
519 u16 aid;
520 /* erp related data */
521 bool use_cts_prot;
522 bool use_short_preamble;
523 bool use_short_slot;
524 bool enable_beacon;
525 u8 dtim_period;
526 u16 beacon_int;
527 u16 assoc_capability;
528 u64 sync_tsf;
529 u32 sync_device_ts;
530 u8 sync_dtim_count;
531 u32 basic_rates;
532 struct ieee80211_rate *beacon_rate;
533 int mcast_rate[IEEE80211_NUM_BANDS];
534 u16 ht_operation_mode;
535 s32 cqm_rssi_thold;
536 u32 cqm_rssi_hyst;
537 struct cfg80211_chan_def chandef;
538 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
539 int arp_addr_cnt;
540 bool qos;
541 bool idle;
542 bool ps;
543 u8 ssid[IEEE80211_MAX_SSID_LEN];
544 size_t ssid_len;
545 bool hidden_ssid;
546 int txpower;
547 enum nl80211_tx_power_setting txpower_type;
548 struct ieee80211_p2p_noa_attr p2p_noa_attr;
552 * enum mac80211_tx_info_flags - flags to describe transmission information/status
554 * These flags are used with the @flags member of &ieee80211_tx_info.
556 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
557 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
558 * number to this frame, taking care of not overwriting the fragment
559 * number and increasing the sequence number only when the
560 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
561 * assign sequence numbers to QoS-data frames but cannot do so correctly
562 * for non-QoS-data and management frames because beacons need them from
563 * that counter as well and mac80211 cannot guarantee proper sequencing.
564 * If this flag is set, the driver should instruct the hardware to
565 * assign a sequence number to the frame or assign one itself. Cf. IEEE
566 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
567 * beacons and always be clear for frames without a sequence number field.
568 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
569 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
570 * station
571 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
572 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
573 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
574 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
575 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
576 * because the destination STA was in powersave mode. Note that to
577 * avoid race conditions, the filter must be set by the hardware or
578 * firmware upon receiving a frame that indicates that the station
579 * went to sleep (must be done on device to filter frames already on
580 * the queue) and may only be unset after mac80211 gives the OK for
581 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
582 * since only then is it guaranteed that no more frames are in the
583 * hardware queue.
584 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
585 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
586 * is for the whole aggregation.
587 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
588 * so consider using block ack request (BAR).
589 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
590 * set by rate control algorithms to indicate probe rate, will
591 * be cleared for fragmented frames (except on the last fragment)
592 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
593 * that a frame can be transmitted while the queues are stopped for
594 * off-channel operation.
595 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
596 * used to indicate that a pending frame requires TX processing before
597 * it can be sent out.
598 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
599 * used to indicate that a frame was already retried due to PS
600 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
601 * used to indicate frame should not be encrypted
602 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
603 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
604 * be sent although the station is in powersave mode.
605 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
606 * transmit function after the current frame, this can be used
607 * by drivers to kick the DMA queue only if unset or when the
608 * queue gets full.
609 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
610 * after TX status because the destination was asleep, it must not
611 * be modified again (no seqno assignment, crypto, etc.)
612 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
613 * code for connection establishment, this indicates that its status
614 * should kick the MLME state machine.
615 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
616 * MLME command (internal to mac80211 to figure out whether to send TX
617 * status to user space)
618 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
619 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
620 * frame and selects the maximum number of streams that it can use.
621 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
622 * the off-channel channel when a remain-on-channel offload is done
623 * in hardware -- normal packets still flow and are expected to be
624 * handled properly by the device.
625 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
626 * testing. It will be sent out with incorrect Michael MIC key to allow
627 * TKIP countermeasures to be tested.
628 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
629 * This flag is actually used for management frame especially for P2P
630 * frames not being sent at CCK rate in 2GHz band.
631 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
632 * when its status is reported the service period ends. For frames in
633 * an SP that mac80211 transmits, it is already set; for driver frames
634 * the driver may set this flag. It is also used to do the same for
635 * PS-Poll responses.
636 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
637 * This flag is used to send nullfunc frame at minimum rate when
638 * the nullfunc is used for connection monitoring purpose.
639 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
640 * would be fragmented by size (this is optional, only used for
641 * monitor injection).
642 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
643 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
644 * any errors (like issues specific to the driver/HW).
645 * This flag must not be set for frames that don't request no-ack
646 * behaviour with IEEE80211_TX_CTL_NO_ACK.
648 * Note: If you have to add new flags to the enumeration, then don't
649 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
651 enum mac80211_tx_info_flags {
652 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
653 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
654 IEEE80211_TX_CTL_NO_ACK = BIT(2),
655 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
656 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
657 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
658 IEEE80211_TX_CTL_AMPDU = BIT(6),
659 IEEE80211_TX_CTL_INJECTED = BIT(7),
660 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
661 IEEE80211_TX_STAT_ACK = BIT(9),
662 IEEE80211_TX_STAT_AMPDU = BIT(10),
663 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
664 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
665 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
666 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
667 IEEE80211_TX_INTFL_RETRIED = BIT(15),
668 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
669 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
670 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
671 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
672 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
673 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
674 IEEE80211_TX_CTL_LDPC = BIT(22),
675 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
676 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
677 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
678 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
679 IEEE80211_TX_STATUS_EOSP = BIT(28),
680 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
681 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
682 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
685 #define IEEE80211_TX_CTL_STBC_SHIFT 23
688 * enum mac80211_tx_control_flags - flags to describe transmit control
690 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
691 * protocol frame (e.g. EAP)
692 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
693 * frame (PS-Poll or uAPSD).
695 * These flags are used in tx_info->control.flags.
697 enum mac80211_tx_control_flags {
698 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
699 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
703 * This definition is used as a mask to clear all temporary flags, which are
704 * set by the tx handlers for each transmission attempt by the mac80211 stack.
706 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
707 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
708 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
709 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
710 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
711 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
712 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
713 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
716 * enum mac80211_rate_control_flags - per-rate flags set by the
717 * Rate Control algorithm.
719 * These flags are set by the Rate control algorithm for each rate during tx,
720 * in the @flags member of struct ieee80211_tx_rate.
722 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
723 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
724 * This is set if the current BSS requires ERP protection.
725 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
726 * @IEEE80211_TX_RC_MCS: HT rate.
727 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
728 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
729 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
730 * Greenfield mode.
731 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
732 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
733 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
734 * (80+80 isn't supported yet)
735 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
736 * adjacent 20 MHz channels, if the current channel type is
737 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
738 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
740 enum mac80211_rate_control_flags {
741 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
742 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
743 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
745 /* rate index is an HT/VHT MCS instead of an index */
746 IEEE80211_TX_RC_MCS = BIT(3),
747 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
748 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
749 IEEE80211_TX_RC_DUP_DATA = BIT(6),
750 IEEE80211_TX_RC_SHORT_GI = BIT(7),
751 IEEE80211_TX_RC_VHT_MCS = BIT(8),
752 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
753 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
757 /* there are 40 bytes if you don't need the rateset to be kept */
758 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
760 /* if you do need the rateset, then you have less space */
761 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
763 /* maximum number of rate stages */
764 #define IEEE80211_TX_MAX_RATES 4
766 /* maximum number of rate table entries */
767 #define IEEE80211_TX_RATE_TABLE_SIZE 4
770 * struct ieee80211_tx_rate - rate selection/status
772 * @idx: rate index to attempt to send with
773 * @flags: rate control flags (&enum mac80211_rate_control_flags)
774 * @count: number of tries in this rate before going to the next rate
776 * A value of -1 for @idx indicates an invalid rate and, if used
777 * in an array of retry rates, that no more rates should be tried.
779 * When used for transmit status reporting, the driver should
780 * always report the rate along with the flags it used.
782 * &struct ieee80211_tx_info contains an array of these structs
783 * in the control information, and it will be filled by the rate
784 * control algorithm according to what should be sent. For example,
785 * if this array contains, in the format { <idx>, <count> } the
786 * information
787 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
788 * then this means that the frame should be transmitted
789 * up to twice at rate 3, up to twice at rate 2, and up to four
790 * times at rate 1 if it doesn't get acknowledged. Say it gets
791 * acknowledged by the peer after the fifth attempt, the status
792 * information should then contain
793 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
794 * since it was transmitted twice at rate 3, twice at rate 2
795 * and once at rate 1 after which we received an acknowledgement.
797 struct ieee80211_tx_rate {
798 s8 idx;
799 u16 count:5,
800 flags:11;
801 } __packed;
803 #define IEEE80211_MAX_TX_RETRY 31
805 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
806 u8 mcs, u8 nss)
808 WARN_ON(mcs & ~0xF);
809 WARN_ON((nss - 1) & ~0x7);
810 rate->idx = ((nss - 1) << 4) | mcs;
813 static inline u8
814 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
816 return rate->idx & 0xF;
819 static inline u8
820 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
822 return (rate->idx >> 4) + 1;
826 * struct ieee80211_tx_info - skb transmit information
828 * This structure is placed in skb->cb for three uses:
829 * (1) mac80211 TX control - mac80211 tells the driver what to do
830 * (2) driver internal use (if applicable)
831 * (3) TX status information - driver tells mac80211 what happened
833 * @flags: transmit info flags, defined above
834 * @band: the band to transmit on (use for checking for races)
835 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
836 * @ack_frame_id: internal frame ID for TX status, used internally
837 * @control: union for control data
838 * @status: union for status data
839 * @driver_data: array of driver_data pointers
840 * @ampdu_ack_len: number of acked aggregated frames.
841 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
842 * @ampdu_len: number of aggregated frames.
843 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
844 * @ack_signal: signal strength of the ACK frame
846 struct ieee80211_tx_info {
847 /* common information */
848 u32 flags;
849 u8 band;
851 u8 hw_queue;
853 u16 ack_frame_id;
855 union {
856 struct {
857 union {
858 /* rate control */
859 struct {
860 struct ieee80211_tx_rate rates[
861 IEEE80211_TX_MAX_RATES];
862 s8 rts_cts_rate_idx;
863 u8 use_rts:1;
864 u8 use_cts_prot:1;
865 u8 short_preamble:1;
866 u8 skip_table:1;
867 /* 2 bytes free */
869 /* only needed before rate control */
870 unsigned long jiffies;
872 /* NB: vif can be NULL for injected frames */
873 struct ieee80211_vif *vif;
874 struct ieee80211_key_conf *hw_key;
875 u32 flags;
876 /* 4 bytes free */
877 } control;
878 struct {
879 u64 cookie;
880 } ack;
881 struct {
882 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
883 s32 ack_signal;
884 u8 ampdu_ack_len;
885 u8 ampdu_len;
886 u8 antenna;
887 u16 tx_time;
888 void *status_driver_data[19 / sizeof(void *)];
889 } status;
890 struct {
891 struct ieee80211_tx_rate driver_rates[
892 IEEE80211_TX_MAX_RATES];
893 u8 pad[4];
895 void *rate_driver_data[
896 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
898 void *driver_data[
899 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
904 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
906 * This structure is used to point to different blocks of IEs in HW scan
907 * and scheduled scan. These blocks contain the IEs passed by userspace
908 * and the ones generated by mac80211.
910 * @ies: pointers to band specific IEs.
911 * @len: lengths of band_specific IEs.
912 * @common_ies: IEs for all bands (especially vendor specific ones)
913 * @common_ie_len: length of the common_ies
915 struct ieee80211_scan_ies {
916 const u8 *ies[IEEE80211_NUM_BANDS];
917 size_t len[IEEE80211_NUM_BANDS];
918 const u8 *common_ies;
919 size_t common_ie_len;
923 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
925 return (struct ieee80211_tx_info *)skb->cb;
928 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
930 return (struct ieee80211_rx_status *)skb->cb;
934 * ieee80211_tx_info_clear_status - clear TX status
936 * @info: The &struct ieee80211_tx_info to be cleared.
938 * When the driver passes an skb back to mac80211, it must report
939 * a number of things in TX status. This function clears everything
940 * in the TX status but the rate control information (it does clear
941 * the count since you need to fill that in anyway).
943 * NOTE: You can only use this function if you do NOT use
944 * info->driver_data! Use info->rate_driver_data
945 * instead if you need only the less space that allows.
947 static inline void
948 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
950 int i;
952 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
953 offsetof(struct ieee80211_tx_info, control.rates));
954 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
955 offsetof(struct ieee80211_tx_info, driver_rates));
956 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
957 /* clear the rate counts */
958 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
959 info->status.rates[i].count = 0;
961 BUILD_BUG_ON(
962 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
963 memset(&info->status.ampdu_ack_len, 0,
964 sizeof(struct ieee80211_tx_info) -
965 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
970 * enum mac80211_rx_flags - receive flags
972 * These flags are used with the @flag member of &struct ieee80211_rx_status.
973 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
974 * Use together with %RX_FLAG_MMIC_STRIPPED.
975 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
976 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
977 * verification has been done by the hardware.
978 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
979 * If this flag is set, the stack cannot do any replay detection
980 * hence the driver or hardware will have to do that.
981 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
982 * flag indicates that the PN was verified for replay protection.
983 * Note that this flag is also currently only supported when a frame
984 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
985 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
986 * the frame.
987 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
988 * the frame.
989 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
990 * field) is valid and contains the time the first symbol of the MPDU
991 * was received. This is useful in monitor mode and for proper IBSS
992 * merging.
993 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
994 * field) is valid and contains the time the last symbol of the MPDU
995 * (including FCS) was received.
996 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
997 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
998 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
999 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
1000 * @RX_FLAG_SHORT_GI: Short guard interval was used
1001 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1002 * Valid only for data frames (mainly A-MPDU)
1003 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1004 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1005 * to hw.radiotap_mcs_details to advertise that fact
1006 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1007 * number (@ampdu_reference) must be populated and be a distinct number for
1008 * each A-MPDU
1009 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1010 * subframes of a single A-MPDU
1011 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1012 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1013 * on this subframe
1014 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1015 * is stored in the @ampdu_delimiter_crc field)
1016 * @RX_FLAG_LDPC: LDPC was used
1017 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1018 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1019 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1020 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1021 * subframes instead of a one huge frame for performance reasons.
1022 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1023 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1024 * the 3rd (last) one must not have this flag set. The flag is used to
1025 * deal with retransmission/duplication recovery properly since A-MSDU
1026 * subframes share the same sequence number. Reported subframes can be
1027 * either regular MSDU or singly A-MSDUs. Subframes must not be
1028 * interleaved with other frames.
1029 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1030 * radiotap data in the skb->data (before the frame) as described by
1031 * the &struct ieee80211_vendor_radiotap.
1033 enum mac80211_rx_flags {
1034 RX_FLAG_MMIC_ERROR = BIT(0),
1035 RX_FLAG_DECRYPTED = BIT(1),
1036 RX_FLAG_MMIC_STRIPPED = BIT(3),
1037 RX_FLAG_IV_STRIPPED = BIT(4),
1038 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1039 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1040 RX_FLAG_MACTIME_START = BIT(7),
1041 RX_FLAG_SHORTPRE = BIT(8),
1042 RX_FLAG_HT = BIT(9),
1043 RX_FLAG_40MHZ = BIT(10),
1044 RX_FLAG_SHORT_GI = BIT(11),
1045 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1046 RX_FLAG_HT_GF = BIT(13),
1047 RX_FLAG_AMPDU_DETAILS = BIT(14),
1048 RX_FLAG_PN_VALIDATED = BIT(15),
1049 /* bit 16 free */
1050 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1051 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1052 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1053 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1054 RX_FLAG_MACTIME_END = BIT(21),
1055 RX_FLAG_VHT = BIT(22),
1056 RX_FLAG_LDPC = BIT(23),
1057 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1058 RX_FLAG_10MHZ = BIT(28),
1059 RX_FLAG_5MHZ = BIT(29),
1060 RX_FLAG_AMSDU_MORE = BIT(30),
1061 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1064 #define RX_FLAG_STBC_SHIFT 26
1067 * enum mac80211_rx_vht_flags - receive VHT flags
1069 * These flags are used with the @vht_flag member of
1070 * &struct ieee80211_rx_status.
1071 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1072 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1073 * @RX_VHT_FLAG_BF: packet was beamformed
1075 enum mac80211_rx_vht_flags {
1076 RX_VHT_FLAG_80MHZ = BIT(0),
1077 RX_VHT_FLAG_160MHZ = BIT(1),
1078 RX_VHT_FLAG_BF = BIT(2),
1082 * struct ieee80211_rx_status - receive status
1084 * The low-level driver should provide this information (the subset
1085 * supported by hardware) to the 802.11 code with each received
1086 * frame, in the skb's control buffer (cb).
1088 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1089 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1090 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1091 * it but can store it and pass it back to the driver for synchronisation
1092 * @band: the active band when this frame was received
1093 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1094 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1095 * unspecified depending on the hardware capabilities flags
1096 * @IEEE80211_HW_SIGNAL_*
1097 * @chains: bitmask of receive chains for which separate signal strength
1098 * values were filled.
1099 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1100 * support dB or unspecified units)
1101 * @antenna: antenna used
1102 * @rate_idx: index of data rate into band's supported rates or MCS index if
1103 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1104 * @vht_nss: number of streams (VHT only)
1105 * @flag: %RX_FLAG_*
1106 * @vht_flag: %RX_VHT_FLAG_*
1107 * @rx_flags: internal RX flags for mac80211
1108 * @ampdu_reference: A-MPDU reference number, must be a different value for
1109 * each A-MPDU but the same for each subframe within one A-MPDU
1110 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1112 struct ieee80211_rx_status {
1113 u64 mactime;
1114 u32 device_timestamp;
1115 u32 ampdu_reference;
1116 u32 flag;
1117 u16 freq;
1118 u8 vht_flag;
1119 u8 rate_idx;
1120 u8 vht_nss;
1121 u8 rx_flags;
1122 u8 band;
1123 u8 antenna;
1124 s8 signal;
1125 u8 chains;
1126 s8 chain_signal[IEEE80211_MAX_CHAINS];
1127 u8 ampdu_delimiter_crc;
1131 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1132 * @present: presence bitmap for this vendor namespace
1133 * (this could be extended in the future if any vendor needs more
1134 * bits, the radiotap spec does allow for that)
1135 * @align: radiotap vendor namespace alignment. This defines the needed
1136 * alignment for the @data field below, not for the vendor namespace
1137 * description itself (which has a fixed 2-byte alignment)
1138 * Must be a power of two, and be set to at least 1!
1139 * @oui: radiotap vendor namespace OUI
1140 * @subns: radiotap vendor sub namespace
1141 * @len: radiotap vendor sub namespace skip length, if alignment is done
1142 * then that's added to this, i.e. this is only the length of the
1143 * @data field.
1144 * @pad: number of bytes of padding after the @data, this exists so that
1145 * the skb data alignment can be preserved even if the data has odd
1146 * length
1147 * @data: the actual vendor namespace data
1149 * This struct, including the vendor data, goes into the skb->data before
1150 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1151 * data.
1153 struct ieee80211_vendor_radiotap {
1154 u32 present;
1155 u8 align;
1156 u8 oui[3];
1157 u8 subns;
1158 u8 pad;
1159 u16 len;
1160 u8 data[];
1161 } __packed;
1164 * enum ieee80211_conf_flags - configuration flags
1166 * Flags to define PHY configuration options
1168 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1169 * to determine for example whether to calculate timestamps for packets
1170 * or not, do not use instead of filter flags!
1171 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1172 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1173 * meaning that the hardware still wakes up for beacons, is able to
1174 * transmit frames and receive the possible acknowledgment frames.
1175 * Not to be confused with hardware specific wakeup/sleep states,
1176 * driver is responsible for that. See the section "Powersave support"
1177 * for more.
1178 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1179 * the driver should be prepared to handle configuration requests but
1180 * may turn the device off as much as possible. Typically, this flag will
1181 * be set when an interface is set UP but not associated or scanning, but
1182 * it can also be unset in that case when monitor interfaces are active.
1183 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1184 * operating channel.
1186 enum ieee80211_conf_flags {
1187 IEEE80211_CONF_MONITOR = (1<<0),
1188 IEEE80211_CONF_PS = (1<<1),
1189 IEEE80211_CONF_IDLE = (1<<2),
1190 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1195 * enum ieee80211_conf_changed - denotes which configuration changed
1197 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1198 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1199 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1200 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1201 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1202 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1203 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1204 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1205 * Note that this is only valid if channel contexts are not used,
1206 * otherwise each channel context has the number of chains listed.
1208 enum ieee80211_conf_changed {
1209 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1210 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1211 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1212 IEEE80211_CONF_CHANGE_PS = BIT(4),
1213 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1214 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1215 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1216 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1220 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1222 * @IEEE80211_SMPS_AUTOMATIC: automatic
1223 * @IEEE80211_SMPS_OFF: off
1224 * @IEEE80211_SMPS_STATIC: static
1225 * @IEEE80211_SMPS_DYNAMIC: dynamic
1226 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1228 enum ieee80211_smps_mode {
1229 IEEE80211_SMPS_AUTOMATIC,
1230 IEEE80211_SMPS_OFF,
1231 IEEE80211_SMPS_STATIC,
1232 IEEE80211_SMPS_DYNAMIC,
1234 /* keep last */
1235 IEEE80211_SMPS_NUM_MODES,
1239 * struct ieee80211_conf - configuration of the device
1241 * This struct indicates how the driver shall configure the hardware.
1243 * @flags: configuration flags defined above
1245 * @listen_interval: listen interval in units of beacon interval
1246 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1247 * in power saving. Power saving will not be enabled until a beacon
1248 * has been received and the DTIM period is known.
1249 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1250 * powersave documentation below. This variable is valid only when
1251 * the CONF_PS flag is set.
1253 * @power_level: requested transmit power (in dBm), backward compatibility
1254 * value only that is set to the minimum of all interfaces
1256 * @chandef: the channel definition to tune to
1257 * @radar_enabled: whether radar detection is enabled
1259 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1260 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1261 * but actually means the number of transmissions not the number of retries
1262 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1263 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1264 * number of transmissions not the number of retries
1266 * @smps_mode: spatial multiplexing powersave mode; note that
1267 * %IEEE80211_SMPS_STATIC is used when the device is not
1268 * configured for an HT channel.
1269 * Note that this is only valid if channel contexts are not used,
1270 * otherwise each channel context has the number of chains listed.
1272 struct ieee80211_conf {
1273 u32 flags;
1274 int power_level, dynamic_ps_timeout;
1276 u16 listen_interval;
1277 u8 ps_dtim_period;
1279 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1281 struct cfg80211_chan_def chandef;
1282 bool radar_enabled;
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
1290 * operation.
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 {
1304 u64 timestamp;
1305 u32 device_timestamp;
1306 bool block_tx;
1307 struct cfg80211_chan_def chandef;
1308 u8 count;
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
1345 * for read access.
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 * @probe_req_reg: probe requests should be reported to mac80211 for this
1361 * interface.
1362 * @drv_priv: data area for driver use, will always be aligned to
1363 * sizeof(void *).
1364 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1366 struct ieee80211_vif {
1367 enum nl80211_iftype type;
1368 struct ieee80211_bss_conf bss_conf;
1369 u8 addr[ETH_ALEN];
1370 bool p2p;
1371 bool csa_active;
1373 u8 cab_queue;
1374 u8 hw_queue[IEEE80211_NUM_ACS];
1376 struct ieee80211_txq *txq;
1378 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1380 u32 driver_flags;
1382 #ifdef CONFIG_MAC80211_DEBUGFS
1383 struct dentry *debugfs_dir;
1384 #endif
1386 unsigned int probe_req_reg;
1388 /* must be last */
1389 u8 drv_priv[0] __aligned(sizeof(void *));
1392 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1394 #ifdef CONFIG_MAC80211_MESH
1395 return vif->type == NL80211_IFTYPE_MESH_POINT;
1396 #endif
1397 return false;
1401 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1402 * @wdev: the wdev to get the vif for
1404 * This can be used by mac80211 drivers with direct cfg80211 APIs
1405 * (like the vendor commands) that get a wdev.
1407 * Note that this function may return %NULL if the given wdev isn't
1408 * associated with a vif that the driver knows about (e.g. monitor
1409 * or AP_VLAN interfaces.)
1411 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1414 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1415 * @vif: the vif to get the wdev for
1417 * This can be used by mac80211 drivers with direct cfg80211 APIs
1418 * (like the vendor commands) that needs to get the wdev for a vif.
1420 * Note that this function may return %NULL if the given wdev isn't
1421 * associated with a vif that the driver knows about (e.g. monitor
1422 * or AP_VLAN interfaces.)
1424 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1427 * enum ieee80211_key_flags - key flags
1429 * These flags are used for communication about keys between the driver
1430 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1432 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1433 * driver to indicate that it requires IV generation for this
1434 * particular key. Setting this flag does not necessarily mean that SKBs
1435 * will have sufficient tailroom for ICV or MIC.
1436 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1437 * the driver for a TKIP key if it requires Michael MIC
1438 * generation in software.
1439 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1440 * that the key is pairwise rather then a shared key.
1441 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1442 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1443 * (MFP) to be done in software.
1444 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1445 * if space should be prepared for the IV, but the IV
1446 * itself should not be generated. Do not set together with
1447 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1448 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1449 * MIC.
1450 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1451 * management frames. The flag can help drivers that have a hardware
1452 * crypto implementation that doesn't deal with management frames
1453 * properly by allowing them to not upload the keys to hardware and
1454 * fall back to software crypto. Note that this flag deals only with
1455 * RX, if your crypto engine can't deal with TX you can also set the
1456 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1457 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1458 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1459 * only for managment frames (MFP).
1460 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1461 * driver for a key to indicate that sufficient tailroom must always
1462 * be reserved for ICV or MIC, even when HW encryption is enabled.
1464 enum ieee80211_key_flags {
1465 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1466 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1467 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1468 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1469 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1470 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1471 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1472 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1476 * struct ieee80211_key_conf - key information
1478 * This key information is given by mac80211 to the driver by
1479 * the set_key() callback in &struct ieee80211_ops.
1481 * @hw_key_idx: To be set by the driver, this is the key index the driver
1482 * wants to be given when a frame is transmitted and needs to be
1483 * encrypted in hardware.
1484 * @cipher: The key's cipher suite selector.
1485 * @tx_pn: PN used for TX on non-TKIP keys, may be used by the driver
1486 * as well if it needs to do software PN assignment by itself
1487 * (e.g. due to TSO)
1488 * @flags: key flags, see &enum ieee80211_key_flags.
1489 * @keyidx: the key index (0-3)
1490 * @keylen: key material length
1491 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1492 * data block:
1493 * - Temporal Encryption Key (128 bits)
1494 * - Temporal Authenticator Tx MIC Key (64 bits)
1495 * - Temporal Authenticator Rx MIC Key (64 bits)
1496 * @icv_len: The ICV length for this key type
1497 * @iv_len: The IV length for this key type
1499 struct ieee80211_key_conf {
1500 atomic64_t tx_pn;
1501 u32 cipher;
1502 u8 icv_len;
1503 u8 iv_len;
1504 u8 hw_key_idx;
1505 u8 flags;
1506 s8 keyidx;
1507 u8 keylen;
1508 u8 key[0];
1511 #define IEEE80211_MAX_PN_LEN 16
1514 * struct ieee80211_key_seq - key sequence counter
1516 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1517 * @ccmp: PN data, most significant byte first (big endian,
1518 * reverse order than in packet)
1519 * @aes_cmac: PN data, most significant byte first (big endian,
1520 * reverse order than in packet)
1521 * @aes_gmac: PN data, most significant byte first (big endian,
1522 * reverse order than in packet)
1523 * @gcmp: PN data, most significant byte first (big endian,
1524 * reverse order than in packet)
1525 * @hw: data for HW-only (e.g. cipher scheme) keys
1527 struct ieee80211_key_seq {
1528 union {
1529 struct {
1530 u32 iv32;
1531 u16 iv16;
1532 } tkip;
1533 struct {
1534 u8 pn[6];
1535 } ccmp;
1536 struct {
1537 u8 pn[6];
1538 } aes_cmac;
1539 struct {
1540 u8 pn[6];
1541 } aes_gmac;
1542 struct {
1543 u8 pn[6];
1544 } gcmp;
1545 struct {
1546 u8 seq[IEEE80211_MAX_PN_LEN];
1547 u8 seq_len;
1548 } hw;
1553 * struct ieee80211_cipher_scheme - cipher scheme
1555 * This structure contains a cipher scheme information defining
1556 * the secure packet crypto handling.
1558 * @cipher: a cipher suite selector
1559 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1560 * @hdr_len: a length of a security header used the cipher
1561 * @pn_len: a length of a packet number in the security header
1562 * @pn_off: an offset of pn from the beginning of the security header
1563 * @key_idx_off: an offset of key index byte in the security header
1564 * @key_idx_mask: a bit mask of key_idx bits
1565 * @key_idx_shift: a bit shift needed to get key_idx
1566 * key_idx value calculation:
1567 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1568 * @mic_len: a mic length in bytes
1570 struct ieee80211_cipher_scheme {
1571 u32 cipher;
1572 u16 iftype;
1573 u8 hdr_len;
1574 u8 pn_len;
1575 u8 pn_off;
1576 u8 key_idx_off;
1577 u8 key_idx_mask;
1578 u8 key_idx_shift;
1579 u8 mic_len;
1583 * enum set_key_cmd - key command
1585 * Used with the set_key() callback in &struct ieee80211_ops, this
1586 * indicates whether a key is being removed or added.
1588 * @SET_KEY: a key is set
1589 * @DISABLE_KEY: a key must be disabled
1591 enum set_key_cmd {
1592 SET_KEY, DISABLE_KEY,
1596 * enum ieee80211_sta_state - station state
1598 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1599 * this is a special state for add/remove transitions
1600 * @IEEE80211_STA_NONE: station exists without special state
1601 * @IEEE80211_STA_AUTH: station is authenticated
1602 * @IEEE80211_STA_ASSOC: station is associated
1603 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1605 enum ieee80211_sta_state {
1606 /* NOTE: These need to be ordered correctly! */
1607 IEEE80211_STA_NOTEXIST,
1608 IEEE80211_STA_NONE,
1609 IEEE80211_STA_AUTH,
1610 IEEE80211_STA_ASSOC,
1611 IEEE80211_STA_AUTHORIZED,
1615 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1616 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1617 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1618 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1619 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1620 * (including 80+80 MHz)
1622 * Implementation note: 20 must be zero to be initialized
1623 * correctly, the values must be sorted.
1625 enum ieee80211_sta_rx_bandwidth {
1626 IEEE80211_STA_RX_BW_20 = 0,
1627 IEEE80211_STA_RX_BW_40,
1628 IEEE80211_STA_RX_BW_80,
1629 IEEE80211_STA_RX_BW_160,
1633 * struct ieee80211_sta_rates - station rate selection table
1635 * @rcu_head: RCU head used for freeing the table on update
1636 * @rate: transmit rates/flags to be used by default.
1637 * Overriding entries per-packet is possible by using cb tx control.
1639 struct ieee80211_sta_rates {
1640 struct rcu_head rcu_head;
1641 struct {
1642 s8 idx;
1643 u8 count;
1644 u8 count_cts;
1645 u8 count_rts;
1646 u16 flags;
1647 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1651 * struct ieee80211_sta - station table entry
1653 * A station table entry represents a station we are possibly
1654 * communicating with. Since stations are RCU-managed in
1655 * mac80211, any ieee80211_sta pointer you get access to must
1656 * either be protected by rcu_read_lock() explicitly or implicitly,
1657 * or you must take good care to not use such a pointer after a
1658 * call to your sta_remove callback that removed it.
1660 * @addr: MAC address
1661 * @aid: AID we assigned to the station if we're an AP
1662 * @supp_rates: Bitmap of supported rates (per band)
1663 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1664 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1665 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1666 * otherwise always false)
1667 * @drv_priv: data area for driver use, will always be aligned to
1668 * sizeof(void *), size is determined in hw information.
1669 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1670 * if wme is supported.
1671 * @max_sp: max Service Period. Only valid if wme is supported.
1672 * @bandwidth: current bandwidth the station can receive with
1673 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1674 * station can receive at the moment, changed by operating mode
1675 * notifications and capabilities. The value is only valid after
1676 * the station moves to associated state.
1677 * @smps_mode: current SMPS mode (off, static or dynamic)
1678 * @rates: rate control selection table
1679 * @tdls: indicates whether the STA is a TDLS peer
1680 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1681 * valid if the STA is a TDLS peer in the first place.
1682 * @mfp: indicates whether the STA uses management frame protection or not.
1683 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1685 struct ieee80211_sta {
1686 u32 supp_rates[IEEE80211_NUM_BANDS];
1687 u8 addr[ETH_ALEN];
1688 u16 aid;
1689 struct ieee80211_sta_ht_cap ht_cap;
1690 struct ieee80211_sta_vht_cap vht_cap;
1691 bool wme;
1692 u8 uapsd_queues;
1693 u8 max_sp;
1694 u8 rx_nss;
1695 enum ieee80211_sta_rx_bandwidth bandwidth;
1696 enum ieee80211_smps_mode smps_mode;
1697 struct ieee80211_sta_rates __rcu *rates;
1698 bool tdls;
1699 bool tdls_initiator;
1700 bool mfp;
1702 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1704 /* must be last */
1705 u8 drv_priv[0] __aligned(sizeof(void *));
1709 * enum sta_notify_cmd - sta notify command
1711 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1712 * indicates if an associated station made a power state transition.
1714 * @STA_NOTIFY_SLEEP: a station is now sleeping
1715 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1717 enum sta_notify_cmd {
1718 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1722 * struct ieee80211_tx_control - TX control data
1724 * @sta: station table entry, this sta pointer may be NULL and
1725 * it is not allowed to copy the pointer, due to RCU.
1727 struct ieee80211_tx_control {
1728 struct ieee80211_sta *sta;
1732 * struct ieee80211_txq - Software intermediate tx queue
1734 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1735 * @sta: station table entry, %NULL for per-vif queue
1736 * @tid: the TID for this queue (unused for per-vif queue)
1737 * @ac: the AC for this queue
1738 * @drv_priv: driver private area, sized by hw->txq_data_size
1740 * The driver can obtain packets from this queue by calling
1741 * ieee80211_tx_dequeue().
1743 struct ieee80211_txq {
1744 struct ieee80211_vif *vif;
1745 struct ieee80211_sta *sta;
1746 u8 tid;
1747 u8 ac;
1749 /* must be last */
1750 u8 drv_priv[0] __aligned(sizeof(void *));
1754 * enum ieee80211_hw_flags - hardware flags
1756 * These flags are used to indicate hardware capabilities to
1757 * the stack. Generally, flags here should have their meaning
1758 * done in a way that the simplest hardware doesn't need setting
1759 * any particular flags. There are some exceptions to this rule,
1760 * however, so you are advised to review these flags carefully.
1762 * @IEEE80211_HW_HAS_RATE_CONTROL:
1763 * The hardware or firmware includes rate control, and cannot be
1764 * controlled by the stack. As such, no rate control algorithm
1765 * should be instantiated, and the TX rate reported to userspace
1766 * will be taken from the TX status instead of the rate control
1767 * algorithm.
1768 * Note that this requires that the driver implement a number of
1769 * callbacks so it has the correct information, it needs to have
1770 * the @set_rts_threshold callback and must look at the BSS config
1771 * @use_cts_prot for G/N protection, @use_short_slot for slot
1772 * timing in 2.4 GHz and @use_short_preamble for preambles for
1773 * CCK frames.
1775 * @IEEE80211_HW_RX_INCLUDES_FCS:
1776 * Indicates that received frames passed to the stack include
1777 * the FCS at the end.
1779 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1780 * Some wireless LAN chipsets buffer broadcast/multicast frames
1781 * for power saving stations in the hardware/firmware and others
1782 * rely on the host system for such buffering. This option is used
1783 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1784 * multicast frames when there are power saving stations so that
1785 * the driver can fetch them with ieee80211_get_buffered_bc().
1787 * @IEEE80211_HW_SIGNAL_UNSPEC:
1788 * Hardware can provide signal values but we don't know its units. We
1789 * expect values between 0 and @max_signal.
1790 * If possible please provide dB or dBm instead.
1792 * @IEEE80211_HW_SIGNAL_DBM:
1793 * Hardware gives signal values in dBm, decibel difference from
1794 * one milliwatt. This is the preferred method since it is standardized
1795 * between different devices. @max_signal does not need to be set.
1797 * @IEEE80211_HW_SPECTRUM_MGMT:
1798 * Hardware supports spectrum management defined in 802.11h
1799 * Measurement, Channel Switch, Quieting, TPC
1801 * @IEEE80211_HW_AMPDU_AGGREGATION:
1802 * Hardware supports 11n A-MPDU aggregation.
1804 * @IEEE80211_HW_SUPPORTS_PS:
1805 * Hardware has power save support (i.e. can go to sleep).
1807 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1808 * Hardware requires nullfunc frame handling in stack, implies
1809 * stack support for dynamic PS.
1811 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1812 * Hardware has support for dynamic PS.
1814 * @IEEE80211_HW_MFP_CAPABLE:
1815 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1817 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1818 * Hardware can provide ack status reports of Tx frames to
1819 * the stack.
1821 * @IEEE80211_HW_CONNECTION_MONITOR:
1822 * The hardware performs its own connection monitoring, including
1823 * periodic keep-alives to the AP and probing the AP on beacon loss.
1825 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1826 * This device needs to get data from beacon before association (i.e.
1827 * dtim_period).
1829 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1830 * per-station GTKs as used by IBSS RSN or during fast transition. If
1831 * the device doesn't support per-station GTKs, but can be asked not
1832 * to decrypt group addressed frames, then IBSS RSN support is still
1833 * possible but software crypto will be used. Advertise the wiphy flag
1834 * only in that case.
1836 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1837 * autonomously manages the PS status of connected stations. When
1838 * this flag is set mac80211 will not trigger PS mode for connected
1839 * stations based on the PM bit of incoming frames.
1840 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1841 * the PS mode of connected stations.
1843 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1844 * setup strictly in HW. mac80211 should not attempt to do this in
1845 * software.
1847 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1848 * a virtual monitor interface when monitor interfaces are the only
1849 * active interfaces.
1851 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1852 * be created. It is expected user-space will create vifs as
1853 * desired (and thus have them named as desired).
1855 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1856 * crypto algorithms can be done in software - so don't automatically
1857 * try to fall back to it if hardware crypto fails, but do so only if
1858 * the driver returns 1. This also forces the driver to advertise its
1859 * supported cipher suites.
1861 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1862 * this currently requires only the ability to calculate the duration
1863 * for frames.
1865 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1866 * queue mapping in order to use different queues (not just one per AC)
1867 * for different virtual interfaces. See the doc section on HW queue
1868 * control for more details.
1870 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1871 * selection table provided by the rate control algorithm.
1873 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1874 * P2P Interface. This will be honoured even if more than one interface
1875 * is supported.
1877 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1878 * only, to allow getting TBTT of a DTIM beacon.
1880 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1881 * and can cope with CCK rates in an aggregation session (e.g. by not
1882 * using aggregation for such frames.)
1884 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1885 * for a single active channel while using channel contexts. When support
1886 * is not enabled the default action is to disconnect when getting the
1887 * CSA frame.
1889 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1890 * or tailroom of TX skbs without copying them first.
1892 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1893 * in one command, mac80211 doesn't have to run separate scans per band.
1895 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1896 * than then BSS bandwidth for a TDLS link on the base channel.
1898 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1899 * within A-MPDU.
1901 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1902 * for sent beacons.
1904 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1906 enum ieee80211_hw_flags {
1907 IEEE80211_HW_HAS_RATE_CONTROL,
1908 IEEE80211_HW_RX_INCLUDES_FCS,
1909 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1910 IEEE80211_HW_SIGNAL_UNSPEC,
1911 IEEE80211_HW_SIGNAL_DBM,
1912 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1913 IEEE80211_HW_SPECTRUM_MGMT,
1914 IEEE80211_HW_AMPDU_AGGREGATION,
1915 IEEE80211_HW_SUPPORTS_PS,
1916 IEEE80211_HW_PS_NULLFUNC_STACK,
1917 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1918 IEEE80211_HW_MFP_CAPABLE,
1919 IEEE80211_HW_WANT_MONITOR_VIF,
1920 IEEE80211_HW_NO_AUTO_VIF,
1921 IEEE80211_HW_SW_CRYPTO_CONTROL,
1922 IEEE80211_HW_SUPPORT_FAST_XMIT,
1923 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1924 IEEE80211_HW_CONNECTION_MONITOR,
1925 IEEE80211_HW_QUEUE_CONTROL,
1926 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1927 IEEE80211_HW_AP_LINK_PS,
1928 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1929 IEEE80211_HW_SUPPORTS_RC_TABLE,
1930 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
1931 IEEE80211_HW_TIMING_BEACON_ONLY,
1932 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
1933 IEEE80211_HW_CHANCTX_STA_CSA,
1934 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
1935 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
1936 IEEE80211_HW_TDLS_WIDER_BW,
1937 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
1938 IEEE80211_HW_BEACON_TX_STATUS,
1940 /* keep last, obviously */
1941 NUM_IEEE80211_HW_FLAGS
1945 * struct ieee80211_hw - hardware information and state
1947 * This structure contains the configuration and hardware
1948 * information for an 802.11 PHY.
1950 * @wiphy: This points to the &struct wiphy allocated for this
1951 * 802.11 PHY. You must fill in the @perm_addr and @dev
1952 * members of this structure using SET_IEEE80211_DEV()
1953 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1954 * bands (with channels, bitrates) are registered here.
1956 * @conf: &struct ieee80211_conf, device configuration, don't use.
1958 * @priv: pointer to private area that was allocated for driver use
1959 * along with this structure.
1961 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1963 * @extra_tx_headroom: headroom to reserve in each transmit skb
1964 * for use by the driver (e.g. for transmit headers.)
1966 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1967 * Can be used by drivers to add extra IEs.
1969 * @max_signal: Maximum value for signal (rssi) in RX information, used
1970 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1972 * @max_listen_interval: max listen interval in units of beacon interval
1973 * that HW supports
1975 * @queues: number of available hardware transmit queues for
1976 * data packets. WMM/QoS requires at least four, these
1977 * queues need to have configurable access parameters.
1979 * @rate_control_algorithm: rate control algorithm for this hardware.
1980 * If unset (NULL), the default algorithm will be used. Must be
1981 * set before calling ieee80211_register_hw().
1983 * @vif_data_size: size (in bytes) of the drv_priv data area
1984 * within &struct ieee80211_vif.
1985 * @sta_data_size: size (in bytes) of the drv_priv data area
1986 * within &struct ieee80211_sta.
1987 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1988 * within &struct ieee80211_chanctx_conf.
1989 * @txq_data_size: size (in bytes) of the drv_priv data area
1990 * within @struct ieee80211_txq.
1992 * @max_rates: maximum number of alternate rate retry stages the hw
1993 * can handle.
1994 * @max_report_rates: maximum number of alternate rate retry stages
1995 * the hw can report back.
1996 * @max_rate_tries: maximum number of tries for each stage
1998 * @max_rx_aggregation_subframes: maximum buffer size (number of
1999 * sub-frames) to be used for A-MPDU block ack receiver
2000 * aggregation.
2001 * This is only relevant if the device has restrictions on the
2002 * number of subframes, if it relies on mac80211 to do reordering
2003 * it shouldn't be set.
2005 * @max_tx_aggregation_subframes: maximum number of subframes in an
2006 * aggregate an HT driver will transmit. Though ADDBA will advertise
2007 * a constant value of 64 as some older APs can crash if the window
2008 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2009 * build 002 Jun 18 2012).
2011 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2012 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2014 * @radiotap_mcs_details: lists which MCS information can the HW
2015 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2016 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2017 * adding _BW is supported today.
2019 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2020 * the default is _GI | _BANDWIDTH.
2021 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2023 * @netdev_features: netdev features to be set in each netdev created
2024 * from this HW. Note that not all features are usable with mac80211,
2025 * other features will be rejected during HW registration.
2027 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2028 * for each access category if it is uAPSD trigger-enabled and delivery-
2029 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2030 * Each bit corresponds to different AC. Value '1' in specific bit means
2031 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2032 * neither enabled.
2034 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2035 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2036 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2038 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2039 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2040 * supported by HW.
2042 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2043 * entries for a vif.
2045 struct ieee80211_hw {
2046 struct ieee80211_conf conf;
2047 struct wiphy *wiphy;
2048 const char *rate_control_algorithm;
2049 void *priv;
2050 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2051 unsigned int extra_tx_headroom;
2052 unsigned int extra_beacon_tailroom;
2053 int vif_data_size;
2054 int sta_data_size;
2055 int chanctx_data_size;
2056 int txq_data_size;
2057 u16 queues;
2058 u16 max_listen_interval;
2059 s8 max_signal;
2060 u8 max_rates;
2061 u8 max_report_rates;
2062 u8 max_rate_tries;
2063 u8 max_rx_aggregation_subframes;
2064 u8 max_tx_aggregation_subframes;
2065 u8 offchannel_tx_hw_queue;
2066 u8 radiotap_mcs_details;
2067 u16 radiotap_vht_details;
2068 netdev_features_t netdev_features;
2069 u8 uapsd_queues;
2070 u8 uapsd_max_sp_len;
2071 u8 n_cipher_schemes;
2072 const struct ieee80211_cipher_scheme *cipher_schemes;
2073 int txq_ac_max_pending;
2076 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2077 enum ieee80211_hw_flags flg)
2079 return test_bit(flg, hw->flags);
2081 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2083 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2084 enum ieee80211_hw_flags flg)
2086 return __set_bit(flg, hw->flags);
2088 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2091 * struct ieee80211_scan_request - hw scan request
2093 * @ies: pointers different parts of IEs (in req.ie)
2094 * @req: cfg80211 request.
2096 struct ieee80211_scan_request {
2097 struct ieee80211_scan_ies ies;
2099 /* Keep last */
2100 struct cfg80211_scan_request req;
2104 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2106 * @sta: peer this TDLS channel-switch request/response came from
2107 * @chandef: channel referenced in a TDLS channel-switch request
2108 * @action_code: see &enum ieee80211_tdls_actioncode
2109 * @status: channel-switch response status
2110 * @timestamp: time at which the frame was received
2111 * @switch_time: switch-timing parameter received in the frame
2112 * @switch_timeout: switch-timing parameter received in the frame
2113 * @tmpl_skb: TDLS switch-channel response template
2114 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2116 struct ieee80211_tdls_ch_sw_params {
2117 struct ieee80211_sta *sta;
2118 struct cfg80211_chan_def *chandef;
2119 u8 action_code;
2120 u32 status;
2121 u32 timestamp;
2122 u16 switch_time;
2123 u16 switch_timeout;
2124 struct sk_buff *tmpl_skb;
2125 u32 ch_sw_tm_ie;
2129 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2131 * @wiphy: the &struct wiphy which we want to query
2133 * mac80211 drivers can use this to get to their respective
2134 * &struct ieee80211_hw. Drivers wishing to get to their own private
2135 * structure can then access it via hw->priv. Note that mac802111 drivers should
2136 * not use wiphy_priv() to try to get their private driver structure as this
2137 * is already used internally by mac80211.
2139 * Return: The mac80211 driver hw struct of @wiphy.
2141 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2144 * SET_IEEE80211_DEV - set device for 802.11 hardware
2146 * @hw: the &struct ieee80211_hw to set the device for
2147 * @dev: the &struct device of this 802.11 device
2149 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2151 set_wiphy_dev(hw->wiphy, dev);
2155 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2157 * @hw: the &struct ieee80211_hw to set the MAC address for
2158 * @addr: the address to set
2160 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
2162 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2165 static inline struct ieee80211_rate *
2166 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2167 const struct ieee80211_tx_info *c)
2169 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2170 return NULL;
2171 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2174 static inline struct ieee80211_rate *
2175 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2176 const struct ieee80211_tx_info *c)
2178 if (c->control.rts_cts_rate_idx < 0)
2179 return NULL;
2180 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2183 static inline struct ieee80211_rate *
2184 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2185 const struct ieee80211_tx_info *c, int idx)
2187 if (c->control.rates[idx + 1].idx < 0)
2188 return NULL;
2189 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2193 * ieee80211_free_txskb - free TX skb
2194 * @hw: the hardware
2195 * @skb: the skb
2197 * Free a transmit skb. Use this funtion when some failure
2198 * to transmit happened and thus status cannot be reported.
2200 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2203 * DOC: Hardware crypto acceleration
2205 * mac80211 is capable of taking advantage of many hardware
2206 * acceleration designs for encryption and decryption operations.
2208 * The set_key() callback in the &struct ieee80211_ops for a given
2209 * device is called to enable hardware acceleration of encryption and
2210 * decryption. The callback takes a @sta parameter that will be NULL
2211 * for default keys or keys used for transmission only, or point to
2212 * the station information for the peer for individual keys.
2213 * Multiple transmission keys with the same key index may be used when
2214 * VLANs are configured for an access point.
2216 * When transmitting, the TX control data will use the @hw_key_idx
2217 * selected by the driver by modifying the &struct ieee80211_key_conf
2218 * pointed to by the @key parameter to the set_key() function.
2220 * The set_key() call for the %SET_KEY command should return 0 if
2221 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2222 * added; if you return 0 then hw_key_idx must be assigned to the
2223 * hardware key index, you are free to use the full u8 range.
2225 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2226 * set, mac80211 will not automatically fall back to software crypto if
2227 * enabling hardware crypto failed. The set_key() call may also return the
2228 * value 1 to permit this specific key/algorithm to be done in software.
2230 * When the cmd is %DISABLE_KEY then it must succeed.
2232 * Note that it is permissible to not decrypt a frame even if a key
2233 * for it has been uploaded to hardware, the stack will not make any
2234 * decision based on whether a key has been uploaded or not but rather
2235 * based on the receive flags.
2237 * The &struct ieee80211_key_conf structure pointed to by the @key
2238 * parameter is guaranteed to be valid until another call to set_key()
2239 * removes it, but it can only be used as a cookie to differentiate
2240 * keys.
2242 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2243 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2244 * handler.
2245 * The update_tkip_key() call updates the driver with the new phase 1 key.
2246 * This happens every time the iv16 wraps around (every 65536 packets). The
2247 * set_key() call will happen only once for each key (unless the AP did
2248 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2249 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2250 * handler is software decryption with wrap around of iv16.
2252 * The set_default_unicast_key() call updates the default WEP key index
2253 * configured to the hardware for WEP encryption type. This is required
2254 * for devices that support offload of data packets (e.g. ARP responses).
2258 * DOC: Powersave support
2260 * mac80211 has support for various powersave implementations.
2262 * First, it can support hardware that handles all powersaving by itself,
2263 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2264 * flag. In that case, it will be told about the desired powersave mode
2265 * with the %IEEE80211_CONF_PS flag depending on the association status.
2266 * The hardware must take care of sending nullfunc frames when necessary,
2267 * i.e. when entering and leaving powersave mode. The hardware is required
2268 * to look at the AID in beacons and signal to the AP that it woke up when
2269 * it finds traffic directed to it.
2271 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2272 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2273 * with hardware wakeup and sleep states. Driver is responsible for waking
2274 * up the hardware before issuing commands to the hardware and putting it
2275 * back to sleep at appropriate times.
2277 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2278 * buffered multicast/broadcast frames after the beacon. Also it must be
2279 * possible to send frames and receive the acknowledment frame.
2281 * Other hardware designs cannot send nullfunc frames by themselves and also
2282 * need software support for parsing the TIM bitmap. This is also supported
2283 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2284 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2285 * required to pass up beacons. The hardware is still required to handle
2286 * waking up for multicast traffic; if it cannot the driver must handle that
2287 * as best as it can, mac80211 is too slow to do that.
2289 * Dynamic powersave is an extension to normal powersave in which the
2290 * hardware stays awake for a user-specified period of time after sending a
2291 * frame so that reply frames need not be buffered and therefore delayed to
2292 * the next wakeup. It's compromise of getting good enough latency when
2293 * there's data traffic and still saving significantly power in idle
2294 * periods.
2296 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2297 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2298 * flag and mac80211 will handle everything automatically. Additionally,
2299 * hardware having support for the dynamic PS feature may set the
2300 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2301 * dynamic PS mode itself. The driver needs to look at the
2302 * @dynamic_ps_timeout hardware configuration value and use it that value
2303 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2304 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2305 * enabled whenever user has enabled powersave.
2307 * Driver informs U-APSD client support by enabling
2308 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2309 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2310 * Nullfunc frames and stay awake until the service period has ended. To
2311 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2312 * from that AC are transmitted with powersave enabled.
2314 * Note: U-APSD client mode is not yet supported with
2315 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2319 * DOC: Beacon filter support
2321 * Some hardware have beacon filter support to reduce host cpu wakeups
2322 * which will reduce system power consumption. It usually works so that
2323 * the firmware creates a checksum of the beacon but omits all constantly
2324 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2325 * beacon is forwarded to the host, otherwise it will be just dropped. That
2326 * way the host will only receive beacons where some relevant information
2327 * (for example ERP protection or WMM settings) have changed.
2329 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2330 * interface capability. The driver needs to enable beacon filter support
2331 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2332 * power save is enabled, the stack will not check for beacon loss and the
2333 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2335 * The time (or number of beacons missed) until the firmware notifies the
2336 * driver of a beacon loss event (which in turn causes the driver to call
2337 * ieee80211_beacon_loss()) should be configurable and will be controlled
2338 * by mac80211 and the roaming algorithm in the future.
2340 * Since there may be constantly changing information elements that nothing
2341 * in the software stack cares about, we will, in the future, have mac80211
2342 * tell the driver which information elements are interesting in the sense
2343 * that we want to see changes in them. This will include
2344 * - a list of information element IDs
2345 * - a list of OUIs for the vendor information element
2347 * Ideally, the hardware would filter out any beacons without changes in the
2348 * requested elements, but if it cannot support that it may, at the expense
2349 * of some efficiency, filter out only a subset. For example, if the device
2350 * doesn't support checking for OUIs it should pass up all changes in all
2351 * vendor information elements.
2353 * Note that change, for the sake of simplification, also includes information
2354 * elements appearing or disappearing from the beacon.
2356 * Some hardware supports an "ignore list" instead, just make sure nothing
2357 * that was requested is on the ignore list, and include commonly changing
2358 * information element IDs in the ignore list, for example 11 (BSS load) and
2359 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2360 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2361 * it could also include some currently unused IDs.
2364 * In addition to these capabilities, hardware should support notifying the
2365 * host of changes in the beacon RSSI. This is relevant to implement roaming
2366 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2367 * the received data packets). This can consist in notifying the host when
2368 * the RSSI changes significantly or when it drops below or rises above
2369 * configurable thresholds. In the future these thresholds will also be
2370 * configured by mac80211 (which gets them from userspace) to implement
2371 * them as the roaming algorithm requires.
2373 * If the hardware cannot implement this, the driver should ask it to
2374 * periodically pass beacon frames to the host so that software can do the
2375 * signal strength threshold checking.
2379 * DOC: Spatial multiplexing power save
2381 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2382 * power in an 802.11n implementation. For details on the mechanism
2383 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2384 * "11.2.3 SM power save".
2386 * The mac80211 implementation is capable of sending action frames
2387 * to update the AP about the station's SMPS mode, and will instruct
2388 * the driver to enter the specific mode. It will also announce the
2389 * requested SMPS mode during the association handshake. Hardware
2390 * support for this feature is required, and can be indicated by
2391 * hardware flags.
2393 * The default mode will be "automatic", which nl80211/cfg80211
2394 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2395 * turned off otherwise.
2397 * To support this feature, the driver must set the appropriate
2398 * hardware support flags, and handle the SMPS flag to the config()
2399 * operation. It will then with this mechanism be instructed to
2400 * enter the requested SMPS mode while associated to an HT AP.
2404 * DOC: Frame filtering
2406 * mac80211 requires to see many management frames for proper
2407 * operation, and users may want to see many more frames when
2408 * in monitor mode. However, for best CPU usage and power consumption,
2409 * having as few frames as possible percolate through the stack is
2410 * desirable. Hence, the hardware should filter as much as possible.
2412 * To achieve this, mac80211 uses filter flags (see below) to tell
2413 * the driver's configure_filter() function which frames should be
2414 * passed to mac80211 and which should be filtered out.
2416 * Before configure_filter() is invoked, the prepare_multicast()
2417 * callback is invoked with the parameters @mc_count and @mc_list
2418 * for the combined multicast address list of all virtual interfaces.
2419 * It's use is optional, and it returns a u64 that is passed to
2420 * configure_filter(). Additionally, configure_filter() has the
2421 * arguments @changed_flags telling which flags were changed and
2422 * @total_flags with the new flag states.
2424 * If your device has no multicast address filters your driver will
2425 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2426 * parameter to see whether multicast frames should be accepted
2427 * or dropped.
2429 * All unsupported flags in @total_flags must be cleared.
2430 * Hardware does not support a flag if it is incapable of _passing_
2431 * the frame to the stack. Otherwise the driver must ignore
2432 * the flag, but not clear it.
2433 * You must _only_ clear the flag (announce no support for the
2434 * flag to mac80211) if you are not able to pass the packet type
2435 * to the stack (so the hardware always filters it).
2436 * So for example, you should clear @FIF_CONTROL, if your hardware
2437 * always filters control frames. If your hardware always passes
2438 * control frames to the kernel and is incapable of filtering them,
2439 * you do _not_ clear the @FIF_CONTROL flag.
2440 * This rule applies to all other FIF flags as well.
2444 * DOC: AP support for powersaving clients
2446 * In order to implement AP and P2P GO modes, mac80211 has support for
2447 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2448 * There currently is no support for sAPSD.
2450 * There is one assumption that mac80211 makes, namely that a client
2451 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2452 * Both are supported, and both can be used by the same client, but
2453 * they can't be used concurrently by the same client. This simplifies
2454 * the driver code.
2456 * The first thing to keep in mind is that there is a flag for complete
2457 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2458 * mac80211 expects the driver to handle most of the state machine for
2459 * powersaving clients and will ignore the PM bit in incoming frames.
2460 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2461 * stations' powersave transitions. In this mode, mac80211 also doesn't
2462 * handle PS-Poll/uAPSD.
2464 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2465 * PM bit in incoming frames for client powersave transitions. When a
2466 * station goes to sleep, we will stop transmitting to it. There is,
2467 * however, a race condition: a station might go to sleep while there is
2468 * data buffered on hardware queues. If the device has support for this
2469 * it will reject frames, and the driver should give the frames back to
2470 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2471 * cause mac80211 to retry the frame when the station wakes up. The
2472 * driver is also notified of powersave transitions by calling its
2473 * @sta_notify callback.
2475 * When the station is asleep, it has three choices: it can wake up,
2476 * it can PS-Poll, or it can possibly start a uAPSD service period.
2477 * Waking up is implemented by simply transmitting all buffered (and
2478 * filtered) frames to the station. This is the easiest case. When
2479 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2480 * will inform the driver of this with the @allow_buffered_frames
2481 * callback; this callback is optional. mac80211 will then transmit
2482 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2483 * on each frame. The last frame in the service period (or the only
2484 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2485 * indicate that it ends the service period; as this frame must have
2486 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2487 * When TX status is reported for this frame, the service period is
2488 * marked has having ended and a new one can be started by the peer.
2490 * Additionally, non-bufferable MMPDUs can also be transmitted by
2491 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2493 * Another race condition can happen on some devices like iwlwifi
2494 * when there are frames queued for the station and it wakes up
2495 * or polls; the frames that are already queued could end up being
2496 * transmitted first instead, causing reordering and/or wrong
2497 * processing of the EOSP. The cause is that allowing frames to be
2498 * transmitted to a certain station is out-of-band communication to
2499 * the device. To allow this problem to be solved, the driver can
2500 * call ieee80211_sta_block_awake() if frames are buffered when it
2501 * is notified that the station went to sleep. When all these frames
2502 * have been filtered (see above), it must call the function again
2503 * to indicate that the station is no longer blocked.
2505 * If the driver buffers frames in the driver for aggregation in any
2506 * way, it must use the ieee80211_sta_set_buffered() call when it is
2507 * notified of the station going to sleep to inform mac80211 of any
2508 * TIDs that have frames buffered. Note that when a station wakes up
2509 * this information is reset (hence the requirement to call it when
2510 * informed of the station going to sleep). Then, when a service
2511 * period starts for any reason, @release_buffered_frames is called
2512 * with the number of frames to be released and which TIDs they are
2513 * to come from. In this case, the driver is responsible for setting
2514 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2515 * to help the @more_data parameter is passed to tell the driver if
2516 * there is more data on other TIDs -- the TIDs to release frames
2517 * from are ignored since mac80211 doesn't know how many frames the
2518 * buffers for those TIDs contain.
2520 * If the driver also implement GO mode, where absence periods may
2521 * shorten service periods (or abort PS-Poll responses), it must
2522 * filter those response frames except in the case of frames that
2523 * are buffered in the driver -- those must remain buffered to avoid
2524 * reordering. Because it is possible that no frames are released
2525 * in this case, the driver must call ieee80211_sta_eosp()
2526 * to indicate to mac80211 that the service period ended anyway.
2528 * Finally, if frames from multiple TIDs are released from mac80211
2529 * but the driver might reorder them, it must clear & set the flags
2530 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2531 * and also take care of the EOSP and MORE_DATA bits in the frame.
2532 * The driver may also use ieee80211_sta_eosp() in this case.
2534 * Note that if the driver ever buffers frames other than QoS-data
2535 * frames, it must take care to never send a non-QoS-data frame as
2536 * the last frame in a service period, adding a QoS-nulldata frame
2537 * after a non-QoS-data frame if needed.
2541 * DOC: HW queue control
2543 * Before HW queue control was introduced, mac80211 only had a single static
2544 * assignment of per-interface AC software queues to hardware queues. This
2545 * was problematic for a few reasons:
2546 * 1) off-channel transmissions might get stuck behind other frames
2547 * 2) multiple virtual interfaces couldn't be handled correctly
2548 * 3) after-DTIM frames could get stuck behind other frames
2550 * To solve this, hardware typically uses multiple different queues for all
2551 * the different usages, and this needs to be propagated into mac80211 so it
2552 * won't have the same problem with the software queues.
2554 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2555 * flag that tells it that the driver implements its own queue control. To do
2556 * so, the driver will set up the various queues in each &struct ieee80211_vif
2557 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2558 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2559 * if necessary will queue the frame on the right software queue that mirrors
2560 * the hardware queue.
2561 * Additionally, the driver has to then use these HW queue IDs for the queue
2562 * management functions (ieee80211_stop_queue() et al.)
2564 * The driver is free to set up the queue mappings as needed, multiple virtual
2565 * interfaces may map to the same hardware queues if needed. The setup has to
2566 * happen during add_interface or change_interface callbacks. For example, a
2567 * driver supporting station+station and station+AP modes might decide to have
2568 * 10 hardware queues to handle different scenarios:
2570 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2571 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2572 * after-DTIM queue for AP: 8
2573 * off-channel queue: 9
2575 * It would then set up the hardware like this:
2576 * hw.offchannel_tx_hw_queue = 9
2578 * and the first virtual interface that is added as follows:
2579 * vif.hw_queue[IEEE80211_AC_VO] = 0
2580 * vif.hw_queue[IEEE80211_AC_VI] = 1
2581 * vif.hw_queue[IEEE80211_AC_BE] = 2
2582 * vif.hw_queue[IEEE80211_AC_BK] = 3
2583 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2584 * and the second virtual interface with 4-7.
2586 * If queue 6 gets full, for example, mac80211 would only stop the second
2587 * virtual interface's BE queue since virtual interface queues are per AC.
2589 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2590 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2591 * queue could potentially be shared since mac80211 will look at cab_queue when
2592 * a queue is stopped/woken even if the interface is not in AP mode.
2596 * enum ieee80211_filter_flags - hardware filter flags
2598 * These flags determine what the filter in hardware should be
2599 * programmed to let through and what should not be passed to the
2600 * stack. It is always safe to pass more frames than requested,
2601 * but this has negative impact on power consumption.
2603 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2604 * by the user or if the hardware is not capable of filtering by
2605 * multicast address.
2607 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2608 * %RX_FLAG_FAILED_FCS_CRC for them)
2610 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2611 * the %RX_FLAG_FAILED_PLCP_CRC for them
2613 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2614 * to the hardware that it should not filter beacons or probe responses
2615 * by BSSID. Filtering them can greatly reduce the amount of processing
2616 * mac80211 needs to do and the amount of CPU wakeups, so you should
2617 * honour this flag if possible.
2619 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2620 * station
2622 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2624 * @FIF_PSPOLL: pass PS Poll frames
2626 * @FIF_PROBE_REQ: pass probe request frames
2628 enum ieee80211_filter_flags {
2629 FIF_ALLMULTI = 1<<1,
2630 FIF_FCSFAIL = 1<<2,
2631 FIF_PLCPFAIL = 1<<3,
2632 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2633 FIF_CONTROL = 1<<5,
2634 FIF_OTHER_BSS = 1<<6,
2635 FIF_PSPOLL = 1<<7,
2636 FIF_PROBE_REQ = 1<<8,
2640 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2642 * These flags are used with the ampdu_action() callback in
2643 * &struct ieee80211_ops to indicate which action is needed.
2645 * Note that drivers MUST be able to deal with a TX aggregation
2646 * session being stopped even before they OK'ed starting it by
2647 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2648 * might receive the addBA frame and send a delBA right away!
2650 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2651 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2652 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2653 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2654 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2655 * queued packets, now unaggregated. After all packets are transmitted the
2656 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2657 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2658 * called when the station is removed. There's no need or reason to call
2659 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2660 * session is gone and removes the station.
2661 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2662 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2663 * now the connection is dropped and the station will be removed. Drivers
2664 * should clean up and drop remaining packets when this is called.
2666 enum ieee80211_ampdu_mlme_action {
2667 IEEE80211_AMPDU_RX_START,
2668 IEEE80211_AMPDU_RX_STOP,
2669 IEEE80211_AMPDU_TX_START,
2670 IEEE80211_AMPDU_TX_STOP_CONT,
2671 IEEE80211_AMPDU_TX_STOP_FLUSH,
2672 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2673 IEEE80211_AMPDU_TX_OPERATIONAL,
2677 * enum ieee80211_frame_release_type - frame release reason
2678 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2679 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2680 * frame received on trigger-enabled AC
2682 enum ieee80211_frame_release_type {
2683 IEEE80211_FRAME_RELEASE_PSPOLL,
2684 IEEE80211_FRAME_RELEASE_UAPSD,
2688 * enum ieee80211_rate_control_changed - flags to indicate what changed
2690 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2691 * to this station changed. The actual bandwidth is in the station
2692 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2693 * flag changes, for HT and VHT the bandwidth field changes.
2694 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2695 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2696 * changed (in IBSS mode) due to discovering more information about
2697 * the peer.
2698 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2699 * by the peer
2701 enum ieee80211_rate_control_changed {
2702 IEEE80211_RC_BW_CHANGED = BIT(0),
2703 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2704 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2705 IEEE80211_RC_NSS_CHANGED = BIT(3),
2709 * enum ieee80211_roc_type - remain on channel type
2711 * With the support for multi channel contexts and multi channel operations,
2712 * remain on channel operations might be limited/deferred/aborted by other
2713 * flows/operations which have higher priority (and vise versa).
2714 * Specifying the ROC type can be used by devices to prioritize the ROC
2715 * operations compared to other operations/flows.
2717 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2718 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2719 * for sending managment frames offchannel.
2721 enum ieee80211_roc_type {
2722 IEEE80211_ROC_TYPE_NORMAL = 0,
2723 IEEE80211_ROC_TYPE_MGMT_TX,
2727 * enum ieee80211_reconfig_complete_type - reconfig type
2729 * This enum is used by the reconfig_complete() callback to indicate what
2730 * reconfiguration type was completed.
2732 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2733 * (also due to resume() callback returning 1)
2734 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2735 * of wowlan configuration)
2737 enum ieee80211_reconfig_type {
2738 IEEE80211_RECONFIG_TYPE_RESTART,
2739 IEEE80211_RECONFIG_TYPE_SUSPEND,
2743 * struct ieee80211_ops - callbacks from mac80211 to the driver
2745 * This structure contains various callbacks that the driver may
2746 * handle or, in some cases, must handle, for example to configure
2747 * the hardware to a new channel or to transmit a frame.
2749 * @tx: Handler that 802.11 module calls for each transmitted frame.
2750 * skb contains the buffer starting from the IEEE 802.11 header.
2751 * The low-level driver should send the frame out based on
2752 * configuration in the TX control data. This handler should,
2753 * preferably, never fail and stop queues appropriately.
2754 * Must be atomic.
2756 * @start: Called before the first netdevice attached to the hardware
2757 * is enabled. This should turn on the hardware and must turn on
2758 * frame reception (for possibly enabled monitor interfaces.)
2759 * Returns negative error codes, these may be seen in userspace,
2760 * or zero.
2761 * When the device is started it should not have a MAC address
2762 * to avoid acknowledging frames before a non-monitor device
2763 * is added.
2764 * Must be implemented and can sleep.
2766 * @stop: Called after last netdevice attached to the hardware
2767 * is disabled. This should turn off the hardware (at least
2768 * it must turn off frame reception.)
2769 * May be called right after add_interface if that rejects
2770 * an interface. If you added any work onto the mac80211 workqueue
2771 * you should ensure to cancel it on this callback.
2772 * Must be implemented and can sleep.
2774 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2775 * stop transmitting and doing any other configuration, and then
2776 * ask the device to suspend. This is only invoked when WoWLAN is
2777 * configured, otherwise the device is deconfigured completely and
2778 * reconfigured at resume time.
2779 * The driver may also impose special conditions under which it
2780 * wants to use the "normal" suspend (deconfigure), say if it only
2781 * supports WoWLAN when the device is associated. In this case, it
2782 * must return 1 from this function.
2784 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2785 * now resuming its operation, after this the device must be fully
2786 * functional again. If this returns an error, the only way out is
2787 * to also unregister the device. If it returns 1, then mac80211
2788 * will also go through the regular complete restart on resume.
2790 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2791 * modified. The reason is that device_set_wakeup_enable() is
2792 * supposed to be called when the configuration changes, not only
2793 * in suspend().
2795 * @add_interface: Called when a netdevice attached to the hardware is
2796 * enabled. Because it is not called for monitor mode devices, @start
2797 * and @stop must be implemented.
2798 * The driver should perform any initialization it needs before
2799 * the device can be enabled. The initial configuration for the
2800 * interface is given in the conf parameter.
2801 * The callback may refuse to add an interface by returning a
2802 * negative error code (which will be seen in userspace.)
2803 * Must be implemented and can sleep.
2805 * @change_interface: Called when a netdevice changes type. This callback
2806 * is optional, but only if it is supported can interface types be
2807 * switched while the interface is UP. The callback may sleep.
2808 * Note that while an interface is being switched, it will not be
2809 * found by the interface iteration callbacks.
2811 * @remove_interface: Notifies a driver that an interface is going down.
2812 * The @stop callback is called after this if it is the last interface
2813 * and no monitor interfaces are present.
2814 * When all interfaces are removed, the MAC address in the hardware
2815 * must be cleared so the device no longer acknowledges packets,
2816 * the mac_addr member of the conf structure is, however, set to the
2817 * MAC address of the device going away.
2818 * Hence, this callback must be implemented. It can sleep.
2820 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2821 * function to change hardware configuration, e.g., channel.
2822 * This function should never fail but returns a negative error code
2823 * if it does. The callback can sleep.
2825 * @bss_info_changed: Handler for configuration requests related to BSS
2826 * parameters that may vary during BSS's lifespan, and may affect low
2827 * level driver (e.g. assoc/disassoc status, erp parameters).
2828 * This function should not be used if no BSS has been set, unless
2829 * for association indication. The @changed parameter indicates which
2830 * of the bss parameters has changed when a call is made. The callback
2831 * can sleep.
2833 * @prepare_multicast: Prepare for multicast filter configuration.
2834 * This callback is optional, and its return value is passed
2835 * to configure_filter(). This callback must be atomic.
2837 * @configure_filter: Configure the device's RX filter.
2838 * See the section "Frame filtering" for more information.
2839 * This callback must be implemented and can sleep.
2841 * @config_iface_filter: Configure the interface's RX filter.
2842 * This callback is optional and is used to configure which frames
2843 * should be passed to mac80211. The filter_flags is the combination
2844 * of FIF_* flags. The changed_flags is a bit mask that indicates
2845 * which flags are changed.
2846 * This callback can sleep.
2848 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2849 * must be set or cleared for a given STA. Must be atomic.
2851 * @set_key: See the section "Hardware crypto acceleration"
2852 * This callback is only called between add_interface and
2853 * remove_interface calls, i.e. while the given virtual interface
2854 * is enabled.
2855 * Returns a negative error code if the key can't be added.
2856 * The callback can sleep.
2858 * @update_tkip_key: See the section "Hardware crypto acceleration"
2859 * This callback will be called in the context of Rx. Called for drivers
2860 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2861 * The callback must be atomic.
2863 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2864 * host is suspended, it can assign this callback to retrieve the data
2865 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2866 * After rekeying was done it should (for example during resume) notify
2867 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2869 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2870 * WEP when the device sends data packets autonomously, e.g. for ARP
2871 * offloading. The index can be 0-3, or -1 for unsetting it.
2873 * @hw_scan: Ask the hardware to service the scan request, no need to start
2874 * the scan state machine in stack. The scan must honour the channel
2875 * configuration done by the regulatory agent in the wiphy's
2876 * registered bands. The hardware (or the driver) needs to make sure
2877 * that power save is disabled.
2878 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2879 * entire IEs after the SSID, so that drivers need not look at these
2880 * at all but just send them after the SSID -- mac80211 includes the
2881 * (extended) supported rates and HT information (where applicable).
2882 * When the scan finishes, ieee80211_scan_completed() must be called;
2883 * note that it also must be called when the scan cannot finish due to
2884 * any error unless this callback returned a negative error code.
2885 * The callback can sleep.
2887 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2888 * The driver should ask the hardware to cancel the scan (if possible),
2889 * but the scan will be completed only after the driver will call
2890 * ieee80211_scan_completed().
2891 * This callback is needed for wowlan, to prevent enqueueing a new
2892 * scan_work after the low-level driver was already suspended.
2893 * The callback can sleep.
2895 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2896 * specific intervals. The driver must call the
2897 * ieee80211_sched_scan_results() function whenever it finds results.
2898 * This process will continue until sched_scan_stop is called.
2900 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2901 * In this case, ieee80211_sched_scan_stopped() must not be called.
2903 * @sw_scan_start: Notifier function that is called just before a software scan
2904 * is started. Can be NULL, if the driver doesn't need this notification.
2905 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2906 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2907 * can use this parameter. The callback can sleep.
2909 * @sw_scan_complete: Notifier function that is called just after a
2910 * software scan finished. Can be NULL, if the driver doesn't need
2911 * this notification.
2912 * The callback can sleep.
2914 * @get_stats: Return low-level statistics.
2915 * Returns zero if statistics are available.
2916 * The callback can sleep.
2918 * @get_key_seq: If your device implements encryption in hardware and does
2919 * IV/PN assignment then this callback should be provided to read the
2920 * IV/PN for the given key from hardware.
2921 * The callback must be atomic.
2923 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2924 * if the device does fragmentation by itself; if this callback is
2925 * implemented then the stack will not do fragmentation.
2926 * The callback can sleep.
2928 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2929 * The callback can sleep.
2931 * @sta_add: Notifies low level driver about addition of an associated station,
2932 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2934 * @sta_remove: Notifies low level driver about removal of an associated
2935 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2936 * returns it isn't safe to use the pointer, not even RCU protected;
2937 * no RCU grace period is guaranteed between returning here and freeing
2938 * the station. See @sta_pre_rcu_remove if needed.
2939 * This callback can sleep.
2941 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2942 * when a station is added to mac80211's station list. This callback
2943 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2944 * conditional. This callback can sleep.
2946 * @sta_remove_debugfs: Remove the debugfs files which were added using
2947 * @sta_add_debugfs. This callback can sleep.
2949 * @sta_notify: Notifies low level driver about power state transition of an
2950 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2951 * in AP mode, this callback will not be called when the flag
2952 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2954 * @sta_state: Notifies low level driver about state transition of a
2955 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2956 * This callback is mutually exclusive with @sta_add/@sta_remove.
2957 * It must not fail for down transitions but may fail for transitions
2958 * up the list of states. Also note that after the callback returns it
2959 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2960 * period is guaranteed between returning here and freeing the station.
2961 * See @sta_pre_rcu_remove if needed.
2962 * The callback can sleep.
2964 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2965 * synchronisation. This is useful if a driver needs to have station
2966 * pointers protected using RCU, it can then use this call to clear
2967 * the pointers instead of waiting for an RCU grace period to elapse
2968 * in @sta_state.
2969 * The callback can sleep.
2971 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2972 * used to transmit to the station. The changes are advertised with bits
2973 * from &enum ieee80211_rate_control_changed and the values are reflected
2974 * in the station data. This callback should only be used when the driver
2975 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2976 * otherwise the rate control algorithm is notified directly.
2977 * Must be atomic.
2978 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2979 * is only used if the configured rate control algorithm actually uses
2980 * the new rate table API, and is therefore optional. Must be atomic.
2982 * @sta_statistics: Get statistics for this station. For example with beacon
2983 * filtering, the statistics kept by mac80211 might not be accurate, so
2984 * let the driver pre-fill the statistics. The driver can fill most of
2985 * the values (indicating which by setting the filled bitmap), but not
2986 * all of them make sense - see the source for which ones are possible.
2987 * Statistics that the driver doesn't fill will be filled by mac80211.
2988 * The callback can sleep.
2990 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2991 * bursting) for a hardware TX queue.
2992 * Returns a negative error code on failure.
2993 * The callback can sleep.
2995 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2996 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2997 * required function.
2998 * The callback can sleep.
3000 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3001 * Currently, this is only used for IBSS mode debugging. Is not a
3002 * required function.
3003 * The callback can sleep.
3005 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3006 * with other STAs in the IBSS. This is only used in IBSS mode. This
3007 * function is optional if the firmware/hardware takes full care of
3008 * TSF synchronization.
3009 * The callback can sleep.
3011 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3012 * This is needed only for IBSS mode and the result of this function is
3013 * used to determine whether to reply to Probe Requests.
3014 * Returns non-zero if this device sent the last beacon.
3015 * The callback can sleep.
3017 * @ampdu_action: Perform a certain A-MPDU action
3018 * The RA/TID combination determines the destination and TID we want
3019 * the ampdu action to be performed for. The action is defined through
3020 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
3021 * is the first frame we expect to perform the action on. Notice
3022 * that TX/RX_STOP can pass NULL for this parameter.
3023 * The @buf_size parameter is only valid when the action is set to
3024 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
3025 * buffer size (number of subframes) for this session -- the driver
3026 * may neither send aggregates containing more subframes than this
3027 * nor send aggregates in a way that lost frames would exceed the
3028 * buffer size. If just limiting the aggregate size, this would be
3029 * possible with a buf_size of 8:
3030 * - TX: 1.....7
3031 * - RX: 2....7 (lost frame #1)
3032 * - TX: 8..1...
3033 * which is invalid since #1 was now re-transmitted well past the
3034 * buffer size of 8. Correct ways to retransmit #1 would be:
3035 * - TX: 1 or 18 or 81
3036 * Even "189" would be wrong since 1 could be lost again.
3037 * The @amsdu parameter is valid when the action is set to
3038 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's ability
3039 * to receive A-MSDU within A-MPDU.
3041 * Returns a negative error code on failure.
3042 * The callback can sleep.
3044 * @get_survey: Return per-channel survey information
3046 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3047 * need to set wiphy->rfkill_poll to %true before registration,
3048 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3049 * The callback can sleep.
3051 * @set_coverage_class: Set slot time for given coverage class as specified
3052 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3053 * accordingly; coverage class equals to -1 to enable ACK timeout
3054 * estimation algorithm (dynack). To disable dynack set valid value for
3055 * coverage class. This callback is not required and may sleep.
3057 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3058 * be %NULL. The callback can sleep.
3059 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3061 * @flush: Flush all pending frames from the hardware queue, making sure
3062 * that the hardware queues are empty. The @queues parameter is a bitmap
3063 * of queues to flush, which is useful if different virtual interfaces
3064 * use different hardware queues; it may also indicate all queues.
3065 * If the parameter @drop is set to %true, pending frames may be dropped.
3066 * Note that vif can be NULL.
3067 * The callback can sleep.
3069 * @channel_switch: Drivers that need (or want) to offload the channel
3070 * switch operation for CSAs received from the AP may implement this
3071 * callback. They must then call ieee80211_chswitch_done() to indicate
3072 * completion of the channel switch.
3074 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3075 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3076 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3077 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3079 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3081 * @remain_on_channel: Starts an off-channel period on the given channel, must
3082 * call back to ieee80211_ready_on_channel() when on that channel. Note
3083 * that normal channel traffic is not stopped as this is intended for hw
3084 * offload. Frames to transmit on the off-channel channel are transmitted
3085 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3086 * duration (which will always be non-zero) expires, the driver must call
3087 * ieee80211_remain_on_channel_expired().
3088 * Note that this callback may be called while the device is in IDLE and
3089 * must be accepted in this case.
3090 * This callback may sleep.
3091 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3092 * aborted before it expires. This callback may sleep.
3094 * @set_ringparam: Set tx and rx ring sizes.
3096 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3098 * @tx_frames_pending: Check if there is any pending frame in the hardware
3099 * queues before entering power save.
3101 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3102 * when transmitting a frame. Currently only legacy rates are handled.
3103 * The callback can sleep.
3104 * @event_callback: Notify driver about any event in mac80211. See
3105 * &enum ieee80211_event_type for the different types.
3106 * The callback must be atomic.
3108 * @release_buffered_frames: Release buffered frames according to the given
3109 * parameters. In the case where the driver buffers some frames for
3110 * sleeping stations mac80211 will use this callback to tell the driver
3111 * to release some frames, either for PS-poll or uAPSD.
3112 * Note that if the @more_data parameter is %false the driver must check
3113 * if there are more frames on the given TIDs, and if there are more than
3114 * the frames being released then it must still set the more-data bit in
3115 * the frame. If the @more_data parameter is %true, then of course the
3116 * more-data bit must always be set.
3117 * The @tids parameter tells the driver which TIDs to release frames
3118 * from, for PS-poll it will always have only a single bit set.
3119 * In the case this is used for a PS-poll initiated release, the
3120 * @num_frames parameter will always be 1 so code can be shared. In
3121 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3122 * on the TX status (and must report TX status) so that the PS-poll
3123 * period is properly ended. This is used to avoid sending multiple
3124 * responses for a retried PS-poll frame.
3125 * In the case this is used for uAPSD, the @num_frames parameter may be
3126 * bigger than one, but the driver may send fewer frames (it must send
3127 * at least one, however). In this case it is also responsible for
3128 * setting the EOSP flag in the QoS header of the frames. Also, when the
3129 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3130 * on the last frame in the SP. Alternatively, it may call the function
3131 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3132 * This callback must be atomic.
3133 * @allow_buffered_frames: Prepare device to allow the given number of frames
3134 * to go out to the given station. The frames will be sent by mac80211
3135 * via the usual TX path after this call. The TX information for frames
3136 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3137 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3138 * frames from multiple TIDs are released and the driver might reorder
3139 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3140 * on the last frame and clear it on all others and also handle the EOSP
3141 * bit in the QoS header correctly. Alternatively, it can also call the
3142 * ieee80211_sta_eosp() function.
3143 * The @tids parameter is a bitmap and tells the driver which TIDs the
3144 * frames will be on; it will at most have two bits set.
3145 * This callback must be atomic.
3147 * @get_et_sset_count: Ethtool API to get string-set count.
3149 * @get_et_stats: Ethtool API to get a set of u64 stats.
3151 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3152 * and perhaps other supported types of ethtool data-sets.
3154 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3155 * before associated. In multi-channel scenarios, a virtual interface is
3156 * bound to a channel before it is associated, but as it isn't associated
3157 * yet it need not necessarily be given airtime, in particular since any
3158 * transmission to a P2P GO needs to be synchronized against the GO's
3159 * powersave state. mac80211 will call this function before transmitting a
3160 * management frame prior to having successfully associated to allow the
3161 * driver to give it channel time for the transmission, to get a response
3162 * and to be able to synchronize with the GO.
3163 * The callback will be called before each transmission and upon return
3164 * mac80211 will transmit the frame right away.
3165 * The callback is optional and can (should!) sleep.
3167 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3168 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3169 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3170 * setup-response is a direct packet not buffered by the AP.
3171 * mac80211 will call this function just before the transmission of a TDLS
3172 * discovery-request. The recommended period of protection is at least
3173 * 2 * (DTIM period).
3174 * The callback is optional and can sleep.
3176 * @add_chanctx: Notifies device driver about new channel context creation.
3177 * This callback may sleep.
3178 * @remove_chanctx: Notifies device driver about channel context destruction.
3179 * This callback may sleep.
3180 * @change_chanctx: Notifies device driver about channel context changes that
3181 * may happen when combining different virtual interfaces on the same
3182 * channel context with different settings
3183 * This callback may sleep.
3184 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3185 * to vif. Possible use is for hw queue remapping.
3186 * This callback may sleep.
3187 * @unassign_vif_chanctx: Notifies device driver about channel context being
3188 * unbound from vif.
3189 * This callback may sleep.
3190 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3191 * another, as specified in the list of
3192 * @ieee80211_vif_chanctx_switch passed to the driver, according
3193 * to the mode defined in &ieee80211_chanctx_switch_mode.
3194 * This callback may sleep.
3196 * @start_ap: Start operation on the AP interface, this is called after all the
3197 * information in bss_conf is set and beacon can be retrieved. A channel
3198 * context is bound before this is called. Note that if the driver uses
3199 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3200 * just "paused" for scanning/ROC, which is indicated by the beacon being
3201 * disabled/enabled via @bss_info_changed.
3202 * @stop_ap: Stop operation on the AP interface.
3204 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3205 * during resume, when the reconfiguration has completed.
3206 * This can help the driver implement the reconfiguration step (and
3207 * indicate mac80211 is ready to receive frames).
3208 * This callback may sleep.
3210 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3211 * Currently, this is only called for managed or P2P client interfaces.
3212 * This callback is optional; it must not sleep.
3214 * @channel_switch_beacon: Starts a channel switch to a new channel.
3215 * Beacons are modified to include CSA or ECSA IEs before calling this
3216 * function. The corresponding count fields in these IEs must be
3217 * decremented, and when they reach 1 the driver must call
3218 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3219 * get the csa counter decremented by mac80211, but must check if it is
3220 * 1 using ieee80211_csa_is_complete() after the beacon has been
3221 * transmitted and then call ieee80211_csa_finish().
3222 * If the CSA count starts as zero or 1, this function will not be called,
3223 * since there won't be any time to beacon before the switch anyway.
3224 * @pre_channel_switch: This is an optional callback that is called
3225 * before a channel switch procedure is started (ie. when a STA
3226 * gets a CSA or an userspace initiated channel-switch), allowing
3227 * the driver to prepare for the channel switch.
3228 * @post_channel_switch: This is an optional callback that is called
3229 * after a channel switch procedure is completed, allowing the
3230 * driver to go back to a normal configuration.
3232 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3233 * information in bss_conf is set up and the beacon can be retrieved. A
3234 * channel context is bound before this is called.
3235 * @leave_ibss: Leave the IBSS again.
3237 * @get_expected_throughput: extract the expected throughput towards the
3238 * specified station. The returned value is expressed in Kbps. It returns 0
3239 * if the RC algorithm does not have proper data to provide.
3241 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3242 * and hardware limits.
3244 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3245 * is responsible for continually initiating channel-switching operations
3246 * and returning to the base channel for communication with the AP. The
3247 * driver receives a channel-switch request template and the location of
3248 * the switch-timing IE within the template as part of the invocation.
3249 * The template is valid only within the call, and the driver can
3250 * optionally copy the skb for further re-use.
3251 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3252 * peers must be on the base channel when the call completes.
3253 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3254 * response) has been received from a remote peer. The driver gets
3255 * parameters parsed from the incoming frame and may use them to continue
3256 * an ongoing channel-switch operation. In addition, a channel-switch
3257 * response template is provided, together with the location of the
3258 * switch-timing IE within the template. The skb can only be used within
3259 * the function call.
3261 * @wake_tx_queue: Called when new packets have been added to the queue.
3263 struct ieee80211_ops {
3264 void (*tx)(struct ieee80211_hw *hw,
3265 struct ieee80211_tx_control *control,
3266 struct sk_buff *skb);
3267 int (*start)(struct ieee80211_hw *hw);
3268 void (*stop)(struct ieee80211_hw *hw);
3269 #ifdef CONFIG_PM
3270 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3271 int (*resume)(struct ieee80211_hw *hw);
3272 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3273 #endif
3274 int (*add_interface)(struct ieee80211_hw *hw,
3275 struct ieee80211_vif *vif);
3276 int (*change_interface)(struct ieee80211_hw *hw,
3277 struct ieee80211_vif *vif,
3278 enum nl80211_iftype new_type, bool p2p);
3279 void (*remove_interface)(struct ieee80211_hw *hw,
3280 struct ieee80211_vif *vif);
3281 int (*config)(struct ieee80211_hw *hw, u32 changed);
3282 void (*bss_info_changed)(struct ieee80211_hw *hw,
3283 struct ieee80211_vif *vif,
3284 struct ieee80211_bss_conf *info,
3285 u32 changed);
3287 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3288 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3290 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3291 struct netdev_hw_addr_list *mc_list);
3292 void (*configure_filter)(struct ieee80211_hw *hw,
3293 unsigned int changed_flags,
3294 unsigned int *total_flags,
3295 u64 multicast);
3296 void (*config_iface_filter)(struct ieee80211_hw *hw,
3297 struct ieee80211_vif *vif,
3298 unsigned int filter_flags,
3299 unsigned int changed_flags);
3300 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3301 bool set);
3302 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3303 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3304 struct ieee80211_key_conf *key);
3305 void (*update_tkip_key)(struct ieee80211_hw *hw,
3306 struct ieee80211_vif *vif,
3307 struct ieee80211_key_conf *conf,
3308 struct ieee80211_sta *sta,
3309 u32 iv32, u16 *phase1key);
3310 void (*set_rekey_data)(struct ieee80211_hw *hw,
3311 struct ieee80211_vif *vif,
3312 struct cfg80211_gtk_rekey_data *data);
3313 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3314 struct ieee80211_vif *vif, int idx);
3315 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3316 struct ieee80211_scan_request *req);
3317 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3318 struct ieee80211_vif *vif);
3319 int (*sched_scan_start)(struct ieee80211_hw *hw,
3320 struct ieee80211_vif *vif,
3321 struct cfg80211_sched_scan_request *req,
3322 struct ieee80211_scan_ies *ies);
3323 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3324 struct ieee80211_vif *vif);
3325 void (*sw_scan_start)(struct ieee80211_hw *hw,
3326 struct ieee80211_vif *vif,
3327 const u8 *mac_addr);
3328 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3329 struct ieee80211_vif *vif);
3330 int (*get_stats)(struct ieee80211_hw *hw,
3331 struct ieee80211_low_level_stats *stats);
3332 void (*get_key_seq)(struct ieee80211_hw *hw,
3333 struct ieee80211_key_conf *key,
3334 struct ieee80211_key_seq *seq);
3335 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3336 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3337 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3338 struct ieee80211_sta *sta);
3339 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3340 struct ieee80211_sta *sta);
3341 #ifdef CONFIG_MAC80211_DEBUGFS
3342 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3343 struct ieee80211_vif *vif,
3344 struct ieee80211_sta *sta,
3345 struct dentry *dir);
3346 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3347 struct ieee80211_vif *vif,
3348 struct ieee80211_sta *sta,
3349 struct dentry *dir);
3350 #endif
3351 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3352 enum sta_notify_cmd, struct ieee80211_sta *sta);
3353 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3354 struct ieee80211_sta *sta,
3355 enum ieee80211_sta_state old_state,
3356 enum ieee80211_sta_state new_state);
3357 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3358 struct ieee80211_vif *vif,
3359 struct ieee80211_sta *sta);
3360 void (*sta_rc_update)(struct ieee80211_hw *hw,
3361 struct ieee80211_vif *vif,
3362 struct ieee80211_sta *sta,
3363 u32 changed);
3364 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3365 struct ieee80211_vif *vif,
3366 struct ieee80211_sta *sta);
3367 void (*sta_statistics)(struct ieee80211_hw *hw,
3368 struct ieee80211_vif *vif,
3369 struct ieee80211_sta *sta,
3370 struct station_info *sinfo);
3371 int (*conf_tx)(struct ieee80211_hw *hw,
3372 struct ieee80211_vif *vif, u16 ac,
3373 const struct ieee80211_tx_queue_params *params);
3374 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3375 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3376 u64 tsf);
3377 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3378 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3379 int (*ampdu_action)(struct ieee80211_hw *hw,
3380 struct ieee80211_vif *vif,
3381 enum ieee80211_ampdu_mlme_action action,
3382 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3383 u8 buf_size, bool amsdu);
3384 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3385 struct survey_info *survey);
3386 void (*rfkill_poll)(struct ieee80211_hw *hw);
3387 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3388 #ifdef CONFIG_NL80211_TESTMODE
3389 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3390 void *data, int len);
3391 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3392 struct netlink_callback *cb,
3393 void *data, int len);
3394 #endif
3395 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3396 u32 queues, bool drop);
3397 void (*channel_switch)(struct ieee80211_hw *hw,
3398 struct ieee80211_vif *vif,
3399 struct ieee80211_channel_switch *ch_switch);
3400 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3401 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3403 int (*remain_on_channel)(struct ieee80211_hw *hw,
3404 struct ieee80211_vif *vif,
3405 struct ieee80211_channel *chan,
3406 int duration,
3407 enum ieee80211_roc_type type);
3408 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3409 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3410 void (*get_ringparam)(struct ieee80211_hw *hw,
3411 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3412 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3413 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3414 const struct cfg80211_bitrate_mask *mask);
3415 void (*event_callback)(struct ieee80211_hw *hw,
3416 struct ieee80211_vif *vif,
3417 const struct ieee80211_event *event);
3419 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3420 struct ieee80211_sta *sta,
3421 u16 tids, int num_frames,
3422 enum ieee80211_frame_release_type reason,
3423 bool more_data);
3424 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3425 struct ieee80211_sta *sta,
3426 u16 tids, int num_frames,
3427 enum ieee80211_frame_release_type reason,
3428 bool more_data);
3430 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3431 struct ieee80211_vif *vif, int sset);
3432 void (*get_et_stats)(struct ieee80211_hw *hw,
3433 struct ieee80211_vif *vif,
3434 struct ethtool_stats *stats, u64 *data);
3435 void (*get_et_strings)(struct ieee80211_hw *hw,
3436 struct ieee80211_vif *vif,
3437 u32 sset, u8 *data);
3439 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3440 struct ieee80211_vif *vif);
3442 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3443 struct ieee80211_vif *vif);
3445 int (*add_chanctx)(struct ieee80211_hw *hw,
3446 struct ieee80211_chanctx_conf *ctx);
3447 void (*remove_chanctx)(struct ieee80211_hw *hw,
3448 struct ieee80211_chanctx_conf *ctx);
3449 void (*change_chanctx)(struct ieee80211_hw *hw,
3450 struct ieee80211_chanctx_conf *ctx,
3451 u32 changed);
3452 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3453 struct ieee80211_vif *vif,
3454 struct ieee80211_chanctx_conf *ctx);
3455 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3456 struct ieee80211_vif *vif,
3457 struct ieee80211_chanctx_conf *ctx);
3458 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3459 struct ieee80211_vif_chanctx_switch *vifs,
3460 int n_vifs,
3461 enum ieee80211_chanctx_switch_mode mode);
3463 void (*reconfig_complete)(struct ieee80211_hw *hw,
3464 enum ieee80211_reconfig_type reconfig_type);
3466 #if IS_ENABLED(CONFIG_IPV6)
3467 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3468 struct ieee80211_vif *vif,
3469 struct inet6_dev *idev);
3470 #endif
3471 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3472 struct ieee80211_vif *vif,
3473 struct cfg80211_chan_def *chandef);
3474 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3475 struct ieee80211_vif *vif,
3476 struct ieee80211_channel_switch *ch_switch);
3478 int (*post_channel_switch)(struct ieee80211_hw *hw,
3479 struct ieee80211_vif *vif);
3481 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3482 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3483 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3484 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3485 int *dbm);
3487 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3488 struct ieee80211_vif *vif,
3489 struct ieee80211_sta *sta, u8 oper_class,
3490 struct cfg80211_chan_def *chandef,
3491 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3492 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3493 struct ieee80211_vif *vif,
3494 struct ieee80211_sta *sta);
3495 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3496 struct ieee80211_vif *vif,
3497 struct ieee80211_tdls_ch_sw_params *params);
3499 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3500 struct ieee80211_txq *txq);
3504 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3506 * This must be called once for each hardware device. The returned pointer
3507 * must be used to refer to this device when calling other functions.
3508 * mac80211 allocates a private data area for the driver pointed to by
3509 * @priv in &struct ieee80211_hw, the size of this area is given as
3510 * @priv_data_len.
3512 * @priv_data_len: length of private data
3513 * @ops: callbacks for this device
3514 * @requested_name: Requested name for this device.
3515 * NULL is valid value, and means use the default naming (phy%d)
3517 * Return: A pointer to the new hardware device, or %NULL on error.
3519 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3520 const struct ieee80211_ops *ops,
3521 const char *requested_name);
3524 * ieee80211_alloc_hw - Allocate a new hardware device
3526 * This must be called once for each hardware device. The returned pointer
3527 * must be used to refer to this device when calling other functions.
3528 * mac80211 allocates a private data area for the driver pointed to by
3529 * @priv in &struct ieee80211_hw, the size of this area is given as
3530 * @priv_data_len.
3532 * @priv_data_len: length of private data
3533 * @ops: callbacks for this device
3535 * Return: A pointer to the new hardware device, or %NULL on error.
3537 static inline
3538 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3539 const struct ieee80211_ops *ops)
3541 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3545 * ieee80211_register_hw - Register hardware device
3547 * You must call this function before any other functions in
3548 * mac80211. Note that before a hardware can be registered, you
3549 * need to fill the contained wiphy's information.
3551 * @hw: the device to register as returned by ieee80211_alloc_hw()
3553 * Return: 0 on success. An error code otherwise.
3555 int ieee80211_register_hw(struct ieee80211_hw *hw);
3558 * struct ieee80211_tpt_blink - throughput blink description
3559 * @throughput: throughput in Kbit/sec
3560 * @blink_time: blink time in milliseconds
3561 * (full cycle, ie. one off + one on period)
3563 struct ieee80211_tpt_blink {
3564 int throughput;
3565 int blink_time;
3569 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3570 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3571 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3572 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3573 * interface is connected in some way, including being an AP
3575 enum ieee80211_tpt_led_trigger_flags {
3576 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3577 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3578 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3581 #ifdef CONFIG_MAC80211_LEDS
3582 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3583 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3584 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3585 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3586 const char *
3587 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3588 unsigned int flags,
3589 const struct ieee80211_tpt_blink *blink_table,
3590 unsigned int blink_table_len);
3591 #endif
3593 * ieee80211_get_tx_led_name - get name of TX LED
3595 * mac80211 creates a transmit LED trigger for each wireless hardware
3596 * that can be used to drive LEDs if your driver registers a LED device.
3597 * This function returns the name (or %NULL if not configured for LEDs)
3598 * of the trigger so you can automatically link the LED device.
3600 * @hw: the hardware to get the LED trigger name for
3602 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3604 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3606 #ifdef CONFIG_MAC80211_LEDS
3607 return __ieee80211_get_tx_led_name(hw);
3608 #else
3609 return NULL;
3610 #endif
3614 * ieee80211_get_rx_led_name - get name of RX LED
3616 * mac80211 creates a receive LED trigger for each wireless hardware
3617 * that can be used to drive LEDs if your driver registers a LED device.
3618 * This function returns the name (or %NULL if not configured for LEDs)
3619 * of the trigger so you can automatically link the LED device.
3621 * @hw: the hardware to get the LED trigger name for
3623 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3625 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3627 #ifdef CONFIG_MAC80211_LEDS
3628 return __ieee80211_get_rx_led_name(hw);
3629 #else
3630 return NULL;
3631 #endif
3635 * ieee80211_get_assoc_led_name - get name of association LED
3637 * mac80211 creates a association LED trigger for each wireless hardware
3638 * that can be used to drive LEDs if your driver registers a LED device.
3639 * This function returns the name (or %NULL if not configured for LEDs)
3640 * of the trigger so you can automatically link the LED device.
3642 * @hw: the hardware to get the LED trigger name for
3644 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3646 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3648 #ifdef CONFIG_MAC80211_LEDS
3649 return __ieee80211_get_assoc_led_name(hw);
3650 #else
3651 return NULL;
3652 #endif
3656 * ieee80211_get_radio_led_name - get name of radio LED
3658 * mac80211 creates a radio change LED trigger for each wireless hardware
3659 * that can be used to drive LEDs if your driver registers a LED device.
3660 * This function returns the name (or %NULL if not configured for LEDs)
3661 * of the trigger so you can automatically link the LED device.
3663 * @hw: the hardware to get the LED trigger name for
3665 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3667 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3669 #ifdef CONFIG_MAC80211_LEDS
3670 return __ieee80211_get_radio_led_name(hw);
3671 #else
3672 return NULL;
3673 #endif
3677 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3678 * @hw: the hardware to create the trigger for
3679 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3680 * @blink_table: the blink table -- needs to be ordered by throughput
3681 * @blink_table_len: size of the blink table
3683 * Return: %NULL (in case of error, or if no LED triggers are
3684 * configured) or the name of the new trigger.
3686 * Note: This function must be called before ieee80211_register_hw().
3688 static inline const char *
3689 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3690 const struct ieee80211_tpt_blink *blink_table,
3691 unsigned int blink_table_len)
3693 #ifdef CONFIG_MAC80211_LEDS
3694 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3695 blink_table_len);
3696 #else
3697 return NULL;
3698 #endif
3702 * ieee80211_unregister_hw - Unregister a hardware device
3704 * This function instructs mac80211 to free allocated resources
3705 * and unregister netdevices from the networking subsystem.
3707 * @hw: the hardware to unregister
3709 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3712 * ieee80211_free_hw - free hardware descriptor
3714 * This function frees everything that was allocated, including the
3715 * private data for the driver. You must call ieee80211_unregister_hw()
3716 * before calling this function.
3718 * @hw: the hardware to free
3720 void ieee80211_free_hw(struct ieee80211_hw *hw);
3723 * ieee80211_restart_hw - restart hardware completely
3725 * Call this function when the hardware was restarted for some reason
3726 * (hardware error, ...) and the driver is unable to restore its state
3727 * by itself. mac80211 assumes that at this point the driver/hardware
3728 * is completely uninitialised and stopped, it starts the process by
3729 * calling the ->start() operation. The driver will need to reset all
3730 * internal state that it has prior to calling this function.
3732 * @hw: the hardware to restart
3734 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3737 * ieee80211_rx_napi - receive frame from NAPI context
3739 * Use this function to hand received frames to mac80211. The receive
3740 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3741 * paged @skb is used, the driver is recommended to put the ieee80211
3742 * header of the frame on the linear part of the @skb to avoid memory
3743 * allocation and/or memcpy by the stack.
3745 * This function may not be called in IRQ context. Calls to this function
3746 * for a single hardware must be synchronized against each other. Calls to
3747 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3748 * mixed for a single hardware. Must not run concurrently with
3749 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3751 * This function must be called with BHs disabled.
3753 * @hw: the hardware this frame came in on
3754 * @skb: the buffer to receive, owned by mac80211 after this call
3755 * @napi: the NAPI context
3757 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3758 struct napi_struct *napi);
3761 * ieee80211_rx - receive frame
3763 * Use this function to hand received frames to mac80211. The receive
3764 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3765 * paged @skb is used, the driver is recommended to put the ieee80211
3766 * header of the frame on the linear part of the @skb to avoid memory
3767 * allocation and/or memcpy by the stack.
3769 * This function may not be called in IRQ context. Calls to this function
3770 * for a single hardware must be synchronized against each other. Calls to
3771 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3772 * mixed for a single hardware. Must not run concurrently with
3773 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3775 * In process context use instead ieee80211_rx_ni().
3777 * @hw: the hardware this frame came in on
3778 * @skb: the buffer to receive, owned by mac80211 after this call
3780 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3782 ieee80211_rx_napi(hw, skb, NULL);
3786 * ieee80211_rx_irqsafe - receive frame
3788 * Like ieee80211_rx() but can be called in IRQ context
3789 * (internally defers to a tasklet.)
3791 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3792 * be mixed for a single hardware.Must not run concurrently with
3793 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3795 * @hw: the hardware this frame came in on
3796 * @skb: the buffer to receive, owned by mac80211 after this call
3798 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3801 * ieee80211_rx_ni - receive frame (in process context)
3803 * Like ieee80211_rx() but can be called in process context
3804 * (internally disables bottom halves).
3806 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3807 * not be mixed for a single hardware. Must not run concurrently with
3808 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3810 * @hw: the hardware this frame came in on
3811 * @skb: the buffer to receive, owned by mac80211 after this call
3813 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3814 struct sk_buff *skb)
3816 local_bh_disable();
3817 ieee80211_rx(hw, skb);
3818 local_bh_enable();
3822 * ieee80211_sta_ps_transition - PS transition for connected sta
3824 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3825 * flag set, use this function to inform mac80211 about a connected station
3826 * entering/leaving PS mode.
3828 * This function may not be called in IRQ context or with softirqs enabled.
3830 * Calls to this function for a single hardware must be synchronized against
3831 * each other.
3833 * @sta: currently connected sta
3834 * @start: start or stop PS
3836 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3838 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3841 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3842 * (in process context)
3844 * Like ieee80211_sta_ps_transition() but can be called in process context
3845 * (internally disables bottom halves). Concurrent call restriction still
3846 * applies.
3848 * @sta: currently connected sta
3849 * @start: start or stop PS
3851 * Return: Like ieee80211_sta_ps_transition().
3853 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3854 bool start)
3856 int ret;
3858 local_bh_disable();
3859 ret = ieee80211_sta_ps_transition(sta, start);
3860 local_bh_enable();
3862 return ret;
3866 * The TX headroom reserved by mac80211 for its own tx_status functions.
3867 * This is enough for the radiotap header.
3869 #define IEEE80211_TX_STATUS_HEADROOM 14
3872 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3873 * @sta: &struct ieee80211_sta pointer for the sleeping station
3874 * @tid: the TID that has buffered frames
3875 * @buffered: indicates whether or not frames are buffered for this TID
3877 * If a driver buffers frames for a powersave station instead of passing
3878 * them back to mac80211 for retransmission, the station may still need
3879 * to be told that there are buffered frames via the TIM bit.
3881 * This function informs mac80211 whether or not there are frames that are
3882 * buffered in the driver for a given TID; mac80211 can then use this data
3883 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3884 * call! Beware of the locking!)
3886 * If all frames are released to the station (due to PS-poll or uAPSD)
3887 * then the driver needs to inform mac80211 that there no longer are
3888 * frames buffered. However, when the station wakes up mac80211 assumes
3889 * that all buffered frames will be transmitted and clears this data,
3890 * drivers need to make sure they inform mac80211 about all buffered
3891 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3893 * Note that technically mac80211 only needs to know this per AC, not per
3894 * TID, but since driver buffering will inevitably happen per TID (since
3895 * it is related to aggregation) it is easier to make mac80211 map the
3896 * TID to the AC as required instead of keeping track in all drivers that
3897 * use this API.
3899 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3900 u8 tid, bool buffered);
3903 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3905 * Call this function in a driver with per-packet rate selection support
3906 * to combine the rate info in the packet tx info with the most recent
3907 * rate selection table for the station entry.
3909 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3910 * @sta: the receiver station to which this packet is sent.
3911 * @skb: the frame to be transmitted.
3912 * @dest: buffer for extracted rate/retry information
3913 * @max_rates: maximum number of rates to fetch
3915 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3916 struct ieee80211_sta *sta,
3917 struct sk_buff *skb,
3918 struct ieee80211_tx_rate *dest,
3919 int max_rates);
3922 * ieee80211_tx_status - transmit status callback
3924 * Call this function for all transmitted frames after they have been
3925 * transmitted. It is permissible to not call this function for
3926 * multicast frames but this can affect statistics.
3928 * This function may not be called in IRQ context. Calls to this function
3929 * for a single hardware must be synchronized against each other. Calls
3930 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3931 * may not be mixed for a single hardware. Must not run concurrently with
3932 * ieee80211_rx() or ieee80211_rx_ni().
3934 * @hw: the hardware the frame was transmitted by
3935 * @skb: the frame that was transmitted, owned by mac80211 after this call
3937 void ieee80211_tx_status(struct ieee80211_hw *hw,
3938 struct sk_buff *skb);
3941 * ieee80211_tx_status_noskb - transmit status callback without skb
3943 * This function can be used as a replacement for ieee80211_tx_status
3944 * in drivers that cannot reliably map tx status information back to
3945 * specific skbs.
3947 * Calls to this function for a single hardware must be synchronized
3948 * against each other. Calls to this function, ieee80211_tx_status_ni()
3949 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3951 * @hw: the hardware the frame was transmitted by
3952 * @sta: the receiver station to which this packet is sent
3953 * (NULL for multicast packets)
3954 * @info: tx status information
3956 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3957 struct ieee80211_sta *sta,
3958 struct ieee80211_tx_info *info);
3961 * ieee80211_tx_status_ni - transmit status callback (in process context)
3963 * Like ieee80211_tx_status() but can be called in process context.
3965 * Calls to this function, ieee80211_tx_status() and
3966 * ieee80211_tx_status_irqsafe() may not be mixed
3967 * for a single hardware.
3969 * @hw: the hardware the frame was transmitted by
3970 * @skb: the frame that was transmitted, owned by mac80211 after this call
3972 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3973 struct sk_buff *skb)
3975 local_bh_disable();
3976 ieee80211_tx_status(hw, skb);
3977 local_bh_enable();
3981 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3983 * Like ieee80211_tx_status() but can be called in IRQ context
3984 * (internally defers to a tasklet.)
3986 * Calls to this function, ieee80211_tx_status() and
3987 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3989 * @hw: the hardware the frame was transmitted by
3990 * @skb: the frame that was transmitted, owned by mac80211 after this call
3992 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3993 struct sk_buff *skb);
3996 * ieee80211_report_low_ack - report non-responding station
3998 * When operating in AP-mode, call this function to report a non-responding
3999 * connected STA.
4001 * @sta: the non-responding connected sta
4002 * @num_packets: number of packets sent to @sta without a response
4004 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4006 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4009 * struct ieee80211_mutable_offsets - mutable beacon offsets
4010 * @tim_offset: position of TIM element
4011 * @tim_length: size of TIM element
4012 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4013 * to CSA counters. This array can contain zero values which
4014 * should be ignored.
4016 struct ieee80211_mutable_offsets {
4017 u16 tim_offset;
4018 u16 tim_length;
4020 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4024 * ieee80211_beacon_get_template - beacon template generation function
4025 * @hw: pointer obtained from ieee80211_alloc_hw().
4026 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4027 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4028 * receive the offsets that may be updated by the driver.
4030 * If the driver implements beaconing modes, it must use this function to
4031 * obtain the beacon template.
4033 * This function should be used if the beacon frames are generated by the
4034 * device, and then the driver must use the returned beacon as the template
4035 * The driver or the device are responsible to update the DTIM and, when
4036 * applicable, the CSA count.
4038 * The driver is responsible for freeing the returned skb.
4040 * Return: The beacon template. %NULL on error.
4042 struct sk_buff *
4043 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4044 struct ieee80211_vif *vif,
4045 struct ieee80211_mutable_offsets *offs);
4048 * ieee80211_beacon_get_tim - beacon generation function
4049 * @hw: pointer obtained from ieee80211_alloc_hw().
4050 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4051 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4052 * Set to 0 if invalid (in non-AP modes).
4053 * @tim_length: pointer to variable that will receive the TIM IE length,
4054 * (including the ID and length bytes!).
4055 * Set to 0 if invalid (in non-AP modes).
4057 * If the driver implements beaconing modes, it must use this function to
4058 * obtain the beacon frame.
4060 * If the beacon frames are generated by the host system (i.e., not in
4061 * hardware/firmware), the driver uses this function to get each beacon
4062 * frame from mac80211 -- it is responsible for calling this function exactly
4063 * once before the beacon is needed (e.g. based on hardware interrupt).
4065 * The driver is responsible for freeing the returned skb.
4067 * Return: The beacon template. %NULL on error.
4069 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4070 struct ieee80211_vif *vif,
4071 u16 *tim_offset, u16 *tim_length);
4074 * ieee80211_beacon_get - beacon generation function
4075 * @hw: pointer obtained from ieee80211_alloc_hw().
4076 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4078 * See ieee80211_beacon_get_tim().
4080 * Return: See ieee80211_beacon_get_tim().
4082 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4083 struct ieee80211_vif *vif)
4085 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4089 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4090 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4092 * The csa counter should be updated after each beacon transmission.
4093 * This function is called implicitly when
4094 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4095 * beacon frames are generated by the device, the driver should call this
4096 * function after each beacon transmission to sync mac80211's csa counters.
4098 * Return: new csa counter value
4100 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4103 * ieee80211_csa_finish - notify mac80211 about channel switch
4104 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4106 * After a channel switch announcement was scheduled and the counter in this
4107 * announcement hits 1, this function must be called by the driver to
4108 * notify mac80211 that the channel can be changed.
4110 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4113 * ieee80211_csa_is_complete - find out if counters reached 1
4114 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4116 * This function returns whether the channel switch counters reached zero.
4118 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4122 * ieee80211_proberesp_get - retrieve a Probe Response template
4123 * @hw: pointer obtained from ieee80211_alloc_hw().
4124 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4126 * Creates a Probe Response template which can, for example, be uploaded to
4127 * hardware. The destination address should be set by the caller.
4129 * Can only be called in AP mode.
4131 * Return: The Probe Response template. %NULL on error.
4133 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4134 struct ieee80211_vif *vif);
4137 * ieee80211_pspoll_get - retrieve a PS Poll template
4138 * @hw: pointer obtained from ieee80211_alloc_hw().
4139 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4141 * Creates a PS Poll a template which can, for example, uploaded to
4142 * hardware. The template must be updated after association so that correct
4143 * AID, BSSID and MAC address is used.
4145 * Note: Caller (or hardware) is responsible for setting the
4146 * &IEEE80211_FCTL_PM bit.
4148 * Return: The PS Poll template. %NULL on error.
4150 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4151 struct ieee80211_vif *vif);
4154 * ieee80211_nullfunc_get - retrieve a nullfunc template
4155 * @hw: pointer obtained from ieee80211_alloc_hw().
4156 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4158 * Creates a Nullfunc template which can, for example, uploaded to
4159 * hardware. The template must be updated after association so that correct
4160 * BSSID and address is used.
4162 * Note: Caller (or hardware) is responsible for setting the
4163 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4165 * Return: The nullfunc template. %NULL on error.
4167 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4168 struct ieee80211_vif *vif);
4171 * ieee80211_probereq_get - retrieve a Probe Request template
4172 * @hw: pointer obtained from ieee80211_alloc_hw().
4173 * @src_addr: source MAC address
4174 * @ssid: SSID buffer
4175 * @ssid_len: length of SSID
4176 * @tailroom: tailroom to reserve at end of SKB for IEs
4178 * Creates a Probe Request template which can, for example, be uploaded to
4179 * hardware.
4181 * Return: The Probe Request template. %NULL on error.
4183 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4184 const u8 *src_addr,
4185 const u8 *ssid, size_t ssid_len,
4186 size_t tailroom);
4189 * ieee80211_rts_get - RTS frame generation function
4190 * @hw: pointer obtained from ieee80211_alloc_hw().
4191 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4192 * @frame: pointer to the frame that is going to be protected by the RTS.
4193 * @frame_len: the frame length (in octets).
4194 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4195 * @rts: The buffer where to store the RTS frame.
4197 * If the RTS frames are generated by the host system (i.e., not in
4198 * hardware/firmware), the low-level driver uses this function to receive
4199 * the next RTS frame from the 802.11 code. The low-level is responsible
4200 * for calling this function before and RTS frame is needed.
4202 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4203 const void *frame, size_t frame_len,
4204 const struct ieee80211_tx_info *frame_txctl,
4205 struct ieee80211_rts *rts);
4208 * ieee80211_rts_duration - Get the duration field for an RTS frame
4209 * @hw: pointer obtained from ieee80211_alloc_hw().
4210 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4211 * @frame_len: the length of the frame that is going to be protected by the RTS.
4212 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4214 * If the RTS is generated in firmware, but the host system must provide
4215 * the duration field, the low-level driver uses this function to receive
4216 * the duration field value in little-endian byteorder.
4218 * Return: The duration.
4220 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4221 struct ieee80211_vif *vif, size_t frame_len,
4222 const struct ieee80211_tx_info *frame_txctl);
4225 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4226 * @hw: pointer obtained from ieee80211_alloc_hw().
4227 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4228 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4229 * @frame_len: the frame length (in octets).
4230 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4231 * @cts: The buffer where to store the CTS-to-self frame.
4233 * If the CTS-to-self frames are generated by the host system (i.e., not in
4234 * hardware/firmware), the low-level driver uses this function to receive
4235 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4236 * for calling this function before and CTS-to-self frame is needed.
4238 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4239 struct ieee80211_vif *vif,
4240 const void *frame, size_t frame_len,
4241 const struct ieee80211_tx_info *frame_txctl,
4242 struct ieee80211_cts *cts);
4245 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4246 * @hw: pointer obtained from ieee80211_alloc_hw().
4247 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4248 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4249 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4251 * If the CTS-to-self is generated in firmware, but the host system must provide
4252 * the duration field, the low-level driver uses this function to receive
4253 * the duration field value in little-endian byteorder.
4255 * Return: The duration.
4257 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4258 struct ieee80211_vif *vif,
4259 size_t frame_len,
4260 const struct ieee80211_tx_info *frame_txctl);
4263 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4264 * @hw: pointer obtained from ieee80211_alloc_hw().
4265 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4266 * @band: the band to calculate the frame duration on
4267 * @frame_len: the length of the frame.
4268 * @rate: the rate at which the frame is going to be transmitted.
4270 * Calculate the duration field of some generic frame, given its
4271 * length and transmission rate (in 100kbps).
4273 * Return: The duration.
4275 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4276 struct ieee80211_vif *vif,
4277 enum ieee80211_band band,
4278 size_t frame_len,
4279 struct ieee80211_rate *rate);
4282 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4283 * @hw: pointer as obtained from ieee80211_alloc_hw().
4284 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4286 * Function for accessing buffered broadcast and multicast frames. If
4287 * hardware/firmware does not implement buffering of broadcast/multicast
4288 * frames when power saving is used, 802.11 code buffers them in the host
4289 * memory. The low-level driver uses this function to fetch next buffered
4290 * frame. In most cases, this is used when generating beacon frame.
4292 * Return: A pointer to the next buffered skb or NULL if no more buffered
4293 * frames are available.
4295 * Note: buffered frames are returned only after DTIM beacon frame was
4296 * generated with ieee80211_beacon_get() and the low-level driver must thus
4297 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4298 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4299 * does not need to check for DTIM beacons separately and should be able to
4300 * use common code for all beacons.
4302 struct sk_buff *
4303 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4306 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4308 * This function returns the TKIP phase 1 key for the given IV32.
4310 * @keyconf: the parameter passed with the set key
4311 * @iv32: IV32 to get the P1K for
4312 * @p1k: a buffer to which the key will be written, as 5 u16 values
4314 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4315 u32 iv32, u16 *p1k);
4318 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4320 * This function returns the TKIP phase 1 key for the IV32 taken
4321 * from the given packet.
4323 * @keyconf: the parameter passed with the set key
4324 * @skb: the packet to take the IV32 value from that will be encrypted
4325 * with this P1K
4326 * @p1k: a buffer to which the key will be written, as 5 u16 values
4328 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4329 struct sk_buff *skb, u16 *p1k)
4331 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4332 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4333 u32 iv32 = get_unaligned_le32(&data[4]);
4335 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4339 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4341 * This function returns the TKIP phase 1 key for the given IV32
4342 * and transmitter address.
4344 * @keyconf: the parameter passed with the set key
4345 * @ta: TA that will be used with the key
4346 * @iv32: IV32 to get the P1K for
4347 * @p1k: a buffer to which the key will be written, as 5 u16 values
4349 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4350 const u8 *ta, u32 iv32, u16 *p1k);
4353 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4355 * This function computes the TKIP RC4 key for the IV values
4356 * in the packet.
4358 * @keyconf: the parameter passed with the set key
4359 * @skb: the packet to take the IV32/IV16 values from that will be
4360 * encrypted with this key
4361 * @p2k: a buffer to which the key will be written, 16 bytes
4363 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4364 struct sk_buff *skb, u8 *p2k);
4367 * ieee80211_get_key_tx_seq - get key TX sequence counter
4369 * @keyconf: the parameter passed with the set key
4370 * @seq: buffer to receive the sequence data
4372 * This function allows a driver to retrieve the current TX IV/PN
4373 * for the given key. It must not be called if IV generation is
4374 * offloaded to the device.
4376 * Note that this function may only be called when no TX processing
4377 * can be done concurrently, for example when queues are stopped
4378 * and the stop has been synchronized.
4380 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4381 struct ieee80211_key_seq *seq);
4384 * ieee80211_get_key_rx_seq - get key RX sequence counter
4386 * @keyconf: the parameter passed with the set key
4387 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4388 * the value on TID 0 is also used for non-QoS frames. For
4389 * CMAC, only TID 0 is valid.
4390 * @seq: buffer to receive the sequence data
4392 * This function allows a driver to retrieve the current RX IV/PNs
4393 * for the given key. It must not be called if IV checking is done
4394 * by the device and not by mac80211.
4396 * Note that this function may only be called when no RX processing
4397 * can be done concurrently.
4399 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4400 int tid, struct ieee80211_key_seq *seq);
4403 * ieee80211_set_key_tx_seq - set key TX sequence counter
4405 * @keyconf: the parameter passed with the set key
4406 * @seq: new sequence data
4408 * This function allows a driver to set the current TX IV/PNs for the
4409 * given key. This is useful when resuming from WoWLAN sleep and the
4410 * device may have transmitted frames using the PTK, e.g. replies to
4411 * ARP requests.
4413 * Note that this function may only be called when no TX processing
4414 * can be done concurrently.
4416 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4417 struct ieee80211_key_seq *seq);
4420 * ieee80211_set_key_rx_seq - set key RX sequence counter
4422 * @keyconf: the parameter passed with the set key
4423 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4424 * the value on TID 0 is also used for non-QoS frames. For
4425 * CMAC, only TID 0 is valid.
4426 * @seq: new sequence data
4428 * This function allows a driver to set the current RX IV/PNs for the
4429 * given key. This is useful when resuming from WoWLAN sleep and GTK
4430 * rekey may have been done while suspended. It should not be called
4431 * if IV checking is done by the device and not by mac80211.
4433 * Note that this function may only be called when no RX processing
4434 * can be done concurrently.
4436 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4437 int tid, struct ieee80211_key_seq *seq);
4440 * ieee80211_remove_key - remove the given key
4441 * @keyconf: the parameter passed with the set key
4443 * Remove the given key. If the key was uploaded to the hardware at the
4444 * time this function is called, it is not deleted in the hardware but
4445 * instead assumed to have been removed already.
4447 * Note that due to locking considerations this function can (currently)
4448 * only be called during key iteration (ieee80211_iter_keys().)
4450 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4453 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4454 * @vif: the virtual interface to add the key on
4455 * @keyconf: new key data
4457 * When GTK rekeying was done while the system was suspended, (a) new
4458 * key(s) will be available. These will be needed by mac80211 for proper
4459 * RX processing, so this function allows setting them.
4461 * The function returns the newly allocated key structure, which will
4462 * have similar contents to the passed key configuration but point to
4463 * mac80211-owned memory. In case of errors, the function returns an
4464 * ERR_PTR(), use IS_ERR() etc.
4466 * Note that this function assumes the key isn't added to hardware
4467 * acceleration, so no TX will be done with the key. Since it's a GTK
4468 * on managed (station) networks, this is true anyway. If the driver
4469 * calls this function from the resume callback and subsequently uses
4470 * the return code 1 to reconfigure the device, this key will be part
4471 * of the reconfiguration.
4473 * Note that the driver should also call ieee80211_set_key_rx_seq()
4474 * for the new key for each TID to set up sequence counters properly.
4476 * IMPORTANT: If this replaces a key that is present in the hardware,
4477 * then it will attempt to remove it during this call. In many cases
4478 * this isn't what you want, so call ieee80211_remove_key() first for
4479 * the key that's being replaced.
4481 struct ieee80211_key_conf *
4482 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4483 struct ieee80211_key_conf *keyconf);
4486 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4487 * @vif: virtual interface the rekeying was done on
4488 * @bssid: The BSSID of the AP, for checking association
4489 * @replay_ctr: the new replay counter after GTK rekeying
4490 * @gfp: allocation flags
4492 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4493 const u8 *replay_ctr, gfp_t gfp);
4496 * ieee80211_wake_queue - wake specific queue
4497 * @hw: pointer as obtained from ieee80211_alloc_hw().
4498 * @queue: queue number (counted from zero).
4500 * Drivers should use this function instead of netif_wake_queue.
4502 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4505 * ieee80211_stop_queue - stop specific queue
4506 * @hw: pointer as obtained from ieee80211_alloc_hw().
4507 * @queue: queue number (counted from zero).
4509 * Drivers should use this function instead of netif_stop_queue.
4511 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4514 * ieee80211_queue_stopped - test status of the queue
4515 * @hw: pointer as obtained from ieee80211_alloc_hw().
4516 * @queue: queue number (counted from zero).
4518 * Drivers should use this function instead of netif_stop_queue.
4520 * Return: %true if the queue is stopped. %false otherwise.
4523 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4526 * ieee80211_stop_queues - stop all queues
4527 * @hw: pointer as obtained from ieee80211_alloc_hw().
4529 * Drivers should use this function instead of netif_stop_queue.
4531 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4534 * ieee80211_wake_queues - wake all queues
4535 * @hw: pointer as obtained from ieee80211_alloc_hw().
4537 * Drivers should use this function instead of netif_wake_queue.
4539 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4542 * ieee80211_scan_completed - completed hardware scan
4544 * When hardware scan offload is used (i.e. the hw_scan() callback is
4545 * assigned) this function needs to be called by the driver to notify
4546 * mac80211 that the scan finished. This function can be called from
4547 * any context, including hardirq context.
4549 * @hw: the hardware that finished the scan
4550 * @aborted: set to true if scan was aborted
4552 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4555 * ieee80211_sched_scan_results - got results from scheduled scan
4557 * When a scheduled scan is running, this function needs to be called by the
4558 * driver whenever there are new scan results available.
4560 * @hw: the hardware that is performing scheduled scans
4562 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4565 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4567 * When a scheduled scan is running, this function can be called by
4568 * the driver if it needs to stop the scan to perform another task.
4569 * Usual scenarios are drivers that cannot continue the scheduled scan
4570 * while associating, for instance.
4572 * @hw: the hardware that is performing scheduled scans
4574 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4577 * enum ieee80211_interface_iteration_flags - interface iteration flags
4578 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4579 * been added to the driver; However, note that during hardware
4580 * reconfiguration (after restart_hw) it will iterate over a new
4581 * interface and over all the existing interfaces even if they
4582 * haven't been re-added to the driver yet.
4583 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4584 * interfaces, even if they haven't been re-added to the driver yet.
4585 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4587 enum ieee80211_interface_iteration_flags {
4588 IEEE80211_IFACE_ITER_NORMAL = 0,
4589 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4590 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4594 * ieee80211_iterate_interfaces - iterate interfaces
4596 * This function iterates over the interfaces associated with a given
4597 * hardware and calls the callback for them. This includes active as well as
4598 * inactive interfaces. This function allows the iterator function to sleep.
4599 * Will iterate over a new interface during add_interface().
4601 * @hw: the hardware struct of which the interfaces should be iterated over
4602 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4603 * @iterator: the iterator function to call
4604 * @data: first argument of the iterator function
4606 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4607 void (*iterator)(void *data, u8 *mac,
4608 struct ieee80211_vif *vif),
4609 void *data);
4612 * ieee80211_iterate_active_interfaces - iterate active interfaces
4614 * This function iterates over the interfaces associated with a given
4615 * hardware that are currently active and calls the callback for them.
4616 * This function allows the iterator function to sleep, when the iterator
4617 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4618 * be used.
4619 * Does not iterate over a new interface during add_interface().
4621 * @hw: the hardware struct of which the interfaces should be iterated over
4622 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4623 * @iterator: the iterator function to call
4624 * @data: first argument of the iterator function
4626 static inline void
4627 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4628 void (*iterator)(void *data, u8 *mac,
4629 struct ieee80211_vif *vif),
4630 void *data)
4632 ieee80211_iterate_interfaces(hw,
4633 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4634 iterator, data);
4638 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4640 * This function iterates over the interfaces associated with a given
4641 * hardware that are currently active and calls the callback for them.
4642 * This function requires the iterator callback function to be atomic,
4643 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4644 * Does not iterate over a new interface during add_interface().
4646 * @hw: the hardware struct of which the interfaces should be iterated over
4647 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4648 * @iterator: the iterator function to call, cannot sleep
4649 * @data: first argument of the iterator function
4651 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4652 u32 iter_flags,
4653 void (*iterator)(void *data,
4654 u8 *mac,
4655 struct ieee80211_vif *vif),
4656 void *data);
4659 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4661 * This function iterates over the interfaces associated with a given
4662 * hardware that are currently active and calls the callback for them.
4663 * This version can only be used while holding the RTNL.
4665 * @hw: the hardware struct of which the interfaces should be iterated over
4666 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4667 * @iterator: the iterator function to call, cannot sleep
4668 * @data: first argument of the iterator function
4670 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4671 u32 iter_flags,
4672 void (*iterator)(void *data,
4673 u8 *mac,
4674 struct ieee80211_vif *vif),
4675 void *data);
4678 * ieee80211_iterate_stations_atomic - iterate stations
4680 * This function iterates over all stations associated with a given
4681 * hardware that are currently uploaded to the driver and calls the callback
4682 * function for them.
4683 * This function requires the iterator callback function to be atomic,
4685 * @hw: the hardware struct of which the interfaces should be iterated over
4686 * @iterator: the iterator function to call, cannot sleep
4687 * @data: first argument of the iterator function
4689 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4690 void (*iterator)(void *data,
4691 struct ieee80211_sta *sta),
4692 void *data);
4694 * ieee80211_queue_work - add work onto the mac80211 workqueue
4696 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4697 * This helper ensures drivers are not queueing work when they should not be.
4699 * @hw: the hardware struct for the interface we are adding work for
4700 * @work: the work we want to add onto the mac80211 workqueue
4702 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4705 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4707 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4708 * workqueue.
4710 * @hw: the hardware struct for the interface we are adding work for
4711 * @dwork: delayable work to queue onto the mac80211 workqueue
4712 * @delay: number of jiffies to wait before queueing
4714 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4715 struct delayed_work *dwork,
4716 unsigned long delay);
4719 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4720 * @sta: the station for which to start a BA session
4721 * @tid: the TID to BA on.
4722 * @timeout: session timeout value (in TUs)
4724 * Return: success if addBA request was sent, failure otherwise
4726 * Although mac80211/low level driver/user space application can estimate
4727 * the need to start aggregation on a certain RA/TID, the session level
4728 * will be managed by the mac80211.
4730 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4731 u16 timeout);
4734 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4735 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4736 * @ra: receiver address of the BA session recipient.
4737 * @tid: the TID to BA on.
4739 * This function must be called by low level driver once it has
4740 * finished with preparations for the BA session. It can be called
4741 * from any context.
4743 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4744 u16 tid);
4747 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4748 * @sta: the station whose BA session to stop
4749 * @tid: the TID to stop BA.
4751 * Return: negative error if the TID is invalid, or no aggregation active
4753 * Although mac80211/low level driver/user space application can estimate
4754 * the need to stop aggregation on a certain RA/TID, the session level
4755 * will be managed by the mac80211.
4757 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4760 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4761 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4762 * @ra: receiver address of the BA session recipient.
4763 * @tid: the desired TID to BA on.
4765 * This function must be called by low level driver once it has
4766 * finished with preparations for the BA session tear down. It
4767 * can be called from any context.
4769 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4770 u16 tid);
4773 * ieee80211_find_sta - find a station
4775 * @vif: virtual interface to look for station on
4776 * @addr: station's address
4778 * Return: The station, if found. %NULL otherwise.
4780 * Note: This function must be called under RCU lock and the
4781 * resulting pointer is only valid under RCU lock as well.
4783 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4784 const u8 *addr);
4787 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4789 * @hw: pointer as obtained from ieee80211_alloc_hw()
4790 * @addr: remote station's address
4791 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4793 * Return: The station, if found. %NULL otherwise.
4795 * Note: This function must be called under RCU lock and the
4796 * resulting pointer is only valid under RCU lock as well.
4798 * NOTE: You may pass NULL for localaddr, but then you will just get
4799 * the first STA that matches the remote address 'addr'.
4800 * We can have multiple STA associated with multiple
4801 * logical stations (e.g. consider a station connecting to another
4802 * BSSID on the same AP hardware without disconnecting first).
4803 * In this case, the result of this method with localaddr NULL
4804 * is not reliable.
4806 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4808 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4809 const u8 *addr,
4810 const u8 *localaddr);
4813 * ieee80211_sta_block_awake - block station from waking up
4814 * @hw: the hardware
4815 * @pubsta: the station
4816 * @block: whether to block or unblock
4818 * Some devices require that all frames that are on the queues
4819 * for a specific station that went to sleep are flushed before
4820 * a poll response or frames after the station woke up can be
4821 * delivered to that it. Note that such frames must be rejected
4822 * by the driver as filtered, with the appropriate status flag.
4824 * This function allows implementing this mode in a race-free
4825 * manner.
4827 * To do this, a driver must keep track of the number of frames
4828 * still enqueued for a specific station. If this number is not
4829 * zero when the station goes to sleep, the driver must call
4830 * this function to force mac80211 to consider the station to
4831 * be asleep regardless of the station's actual state. Once the
4832 * number of outstanding frames reaches zero, the driver must
4833 * call this function again to unblock the station. That will
4834 * cause mac80211 to be able to send ps-poll responses, and if
4835 * the station queried in the meantime then frames will also
4836 * be sent out as a result of this. Additionally, the driver
4837 * will be notified that the station woke up some time after
4838 * it is unblocked, regardless of whether the station actually
4839 * woke up while blocked or not.
4841 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4842 struct ieee80211_sta *pubsta, bool block);
4845 * ieee80211_sta_eosp - notify mac80211 about end of SP
4846 * @pubsta: the station
4848 * When a device transmits frames in a way that it can't tell
4849 * mac80211 in the TX status about the EOSP, it must clear the
4850 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4851 * This applies for PS-Poll as well as uAPSD.
4853 * Note that just like with _tx_status() and _rx() drivers must
4854 * not mix calls to irqsafe/non-irqsafe versions, this function
4855 * must not be mixed with those either. Use the all irqsafe, or
4856 * all non-irqsafe, don't mix!
4858 * NB: the _irqsafe version of this function doesn't exist, no
4859 * driver needs it right now. Don't call this function if
4860 * you'd need the _irqsafe version, look at the git history
4861 * and restore the _irqsafe version!
4863 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4866 * ieee80211_iter_keys - iterate keys programmed into the device
4867 * @hw: pointer obtained from ieee80211_alloc_hw()
4868 * @vif: virtual interface to iterate, may be %NULL for all
4869 * @iter: iterator function that will be called for each key
4870 * @iter_data: custom data to pass to the iterator function
4872 * This function can be used to iterate all the keys known to
4873 * mac80211, even those that weren't previously programmed into
4874 * the device. This is intended for use in WoWLAN if the device
4875 * needs reprogramming of the keys during suspend. Note that due
4876 * to locking reasons, it is also only safe to call this at few
4877 * spots since it must hold the RTNL and be able to sleep.
4879 * The order in which the keys are iterated matches the order
4880 * in which they were originally installed and handed to the
4881 * set_key callback.
4883 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4884 struct ieee80211_vif *vif,
4885 void (*iter)(struct ieee80211_hw *hw,
4886 struct ieee80211_vif *vif,
4887 struct ieee80211_sta *sta,
4888 struct ieee80211_key_conf *key,
4889 void *data),
4890 void *iter_data);
4893 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4894 * @hw: pointre obtained from ieee80211_alloc_hw().
4895 * @iter: iterator function
4896 * @iter_data: data passed to iterator function
4898 * Iterate all active channel contexts. This function is atomic and
4899 * doesn't acquire any locks internally that might be held in other
4900 * places while calling into the driver.
4902 * The iterator will not find a context that's being added (during
4903 * the driver callback to add it) but will find it while it's being
4904 * removed.
4906 * Note that during hardware restart, all contexts that existed
4907 * before the restart are considered already present so will be
4908 * found while iterating, whether they've been re-added already
4909 * or not.
4911 void ieee80211_iter_chan_contexts_atomic(
4912 struct ieee80211_hw *hw,
4913 void (*iter)(struct ieee80211_hw *hw,
4914 struct ieee80211_chanctx_conf *chanctx_conf,
4915 void *data),
4916 void *iter_data);
4919 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4920 * @hw: pointer obtained from ieee80211_alloc_hw().
4921 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4923 * Creates a Probe Request template which can, for example, be uploaded to
4924 * hardware. The template is filled with bssid, ssid and supported rate
4925 * information. This function must only be called from within the
4926 * .bss_info_changed callback function and only in managed mode. The function
4927 * is only useful when the interface is associated, otherwise it will return
4928 * %NULL.
4930 * Return: The Probe Request template. %NULL on error.
4932 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4933 struct ieee80211_vif *vif);
4936 * ieee80211_beacon_loss - inform hardware does not receive beacons
4938 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4940 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4941 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4942 * hardware is not receiving beacons with this function.
4944 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4947 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4949 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4951 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4952 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4953 * needs to inform if the connection to the AP has been lost.
4954 * The function may also be called if the connection needs to be terminated
4955 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4957 * This function will cause immediate change to disassociated state,
4958 * without connection recovery attempts.
4960 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4963 * ieee80211_resume_disconnect - disconnect from AP after resume
4965 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4967 * Instructs mac80211 to disconnect from the AP after resume.
4968 * Drivers can use this after WoWLAN if they know that the
4969 * connection cannot be kept up, for example because keys were
4970 * used while the device was asleep but the replay counters or
4971 * similar cannot be retrieved from the device during resume.
4973 * Note that due to implementation issues, if the driver uses
4974 * the reconfiguration functionality during resume the interface
4975 * will still be added as associated first during resume and then
4976 * disconnect normally later.
4978 * This function can only be called from the resume callback and
4979 * the driver must not be holding any of its own locks while it
4980 * calls this function, or at least not any locks it needs in the
4981 * key configuration paths (if it supports HW crypto).
4983 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4986 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4987 * rssi threshold triggered
4989 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4990 * @rssi_event: the RSSI trigger event type
4991 * @gfp: context flags
4993 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4994 * monitoring is configured with an rssi threshold, the driver will inform
4995 * whenever the rssi level reaches the threshold.
4997 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4998 enum nl80211_cqm_rssi_threshold_event rssi_event,
4999 gfp_t gfp);
5002 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5004 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5005 * @gfp: context flags
5007 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5010 * ieee80211_radar_detected - inform that a radar was detected
5012 * @hw: pointer as obtained from ieee80211_alloc_hw()
5014 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5017 * ieee80211_chswitch_done - Complete channel switch process
5018 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5019 * @success: make the channel switch successful or not
5021 * Complete the channel switch post-process: set the new operational channel
5022 * and wake up the suspended queues.
5024 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5027 * ieee80211_request_smps - request SM PS transition
5028 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5029 * @smps_mode: new SM PS mode
5031 * This allows the driver to request an SM PS transition in managed
5032 * mode. This is useful when the driver has more information than
5033 * the stack about possible interference, for example by bluetooth.
5035 void ieee80211_request_smps(struct ieee80211_vif *vif,
5036 enum ieee80211_smps_mode smps_mode);
5039 * ieee80211_ready_on_channel - notification of remain-on-channel start
5040 * @hw: pointer as obtained from ieee80211_alloc_hw()
5042 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5045 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5046 * @hw: pointer as obtained from ieee80211_alloc_hw()
5048 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5051 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5053 * in order not to harm the system performance and user experience, the device
5054 * may request not to allow any rx ba session and tear down existing rx ba
5055 * sessions based on system constraints such as periodic BT activity that needs
5056 * to limit wlan activity (eg.sco or a2dp)."
5057 * in such cases, the intention is to limit the duration of the rx ppdu and
5058 * therefore prevent the peer device to use a-mpdu aggregation.
5060 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5061 * @ba_rx_bitmap: Bit map of open rx ba per tid
5062 * @addr: & to bssid mac address
5064 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5065 const u8 *addr);
5068 * ieee80211_send_bar - send a BlockAckReq frame
5070 * can be used to flush pending frames from the peer's aggregation reorder
5071 * buffer.
5073 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5074 * @ra: the peer's destination address
5075 * @tid: the TID of the aggregation session
5076 * @ssn: the new starting sequence number for the receiver
5078 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5081 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5083 * Some device drivers may offload part of the Rx aggregation flow including
5084 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5085 * reordering.
5087 * Create structures responsible for reordering so device drivers may call here
5088 * when they complete AddBa negotiation.
5090 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5091 * @addr: station mac address
5092 * @tid: the rx tid
5094 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5095 const u8 *addr, u16 tid);
5098 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5100 * Some device drivers may offload part of the Rx aggregation flow including
5101 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5102 * reordering.
5104 * Destroy structures responsible for reordering so device drivers may call here
5105 * when they complete DelBa negotiation.
5107 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5108 * @addr: station mac address
5109 * @tid: the rx tid
5111 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5112 const u8 *addr, u16 tid);
5114 /* Rate control API */
5117 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5119 * @hw: The hardware the algorithm is invoked for.
5120 * @sband: The band this frame is being transmitted on.
5121 * @bss_conf: the current BSS configuration
5122 * @skb: the skb that will be transmitted, the control information in it needs
5123 * to be filled in
5124 * @reported_rate: The rate control algorithm can fill this in to indicate
5125 * which rate should be reported to userspace as the current rate and
5126 * used for rate calculations in the mesh network.
5127 * @rts: whether RTS will be used for this frame because it is longer than the
5128 * RTS threshold
5129 * @short_preamble: whether mac80211 will request short-preamble transmission
5130 * if the selected rate supports it
5131 * @max_rate_idx: user-requested maximum (legacy) rate
5132 * (deprecated; this will be removed once drivers get updated to use
5133 * rate_idx_mask)
5134 * @rate_idx_mask: user-requested (legacy) rate mask
5135 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5136 * @bss: whether this frame is sent out in AP or IBSS mode
5138 struct ieee80211_tx_rate_control {
5139 struct ieee80211_hw *hw;
5140 struct ieee80211_supported_band *sband;
5141 struct ieee80211_bss_conf *bss_conf;
5142 struct sk_buff *skb;
5143 struct ieee80211_tx_rate reported_rate;
5144 bool rts, short_preamble;
5145 u8 max_rate_idx;
5146 u32 rate_idx_mask;
5147 u8 *rate_idx_mcs_mask;
5148 bool bss;
5151 struct rate_control_ops {
5152 const char *name;
5153 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5154 void (*free)(void *priv);
5156 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5157 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5158 struct cfg80211_chan_def *chandef,
5159 struct ieee80211_sta *sta, void *priv_sta);
5160 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5161 struct cfg80211_chan_def *chandef,
5162 struct ieee80211_sta *sta, void *priv_sta,
5163 u32 changed);
5164 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5165 void *priv_sta);
5167 void (*tx_status_noskb)(void *priv,
5168 struct ieee80211_supported_band *sband,
5169 struct ieee80211_sta *sta, void *priv_sta,
5170 struct ieee80211_tx_info *info);
5171 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5172 struct ieee80211_sta *sta, void *priv_sta,
5173 struct sk_buff *skb);
5174 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5175 struct ieee80211_tx_rate_control *txrc);
5177 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5178 struct dentry *dir);
5179 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5181 u32 (*get_expected_throughput)(void *priv_sta);
5184 static inline int rate_supported(struct ieee80211_sta *sta,
5185 enum ieee80211_band band,
5186 int index)
5188 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5192 * rate_control_send_low - helper for drivers for management/no-ack frames
5194 * Rate control algorithms that agree to use the lowest rate to
5195 * send management frames and NO_ACK data with the respective hw
5196 * retries should use this in the beginning of their mac80211 get_rate
5197 * callback. If true is returned the rate control can simply return.
5198 * If false is returned we guarantee that sta and sta and priv_sta is
5199 * not null.
5201 * Rate control algorithms wishing to do more intelligent selection of
5202 * rate for multicast/broadcast frames may choose to not use this.
5204 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5205 * that this may be null.
5206 * @priv_sta: private rate control structure. This may be null.
5207 * @txrc: rate control information we sholud populate for mac80211.
5209 bool rate_control_send_low(struct ieee80211_sta *sta,
5210 void *priv_sta,
5211 struct ieee80211_tx_rate_control *txrc);
5214 static inline s8
5215 rate_lowest_index(struct ieee80211_supported_band *sband,
5216 struct ieee80211_sta *sta)
5218 int i;
5220 for (i = 0; i < sband->n_bitrates; i++)
5221 if (rate_supported(sta, sband->band, i))
5222 return i;
5224 /* warn when we cannot find a rate. */
5225 WARN_ON_ONCE(1);
5227 /* and return 0 (the lowest index) */
5228 return 0;
5231 static inline
5232 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5233 struct ieee80211_sta *sta)
5235 unsigned int i;
5237 for (i = 0; i < sband->n_bitrates; i++)
5238 if (rate_supported(sta, sband->band, i))
5239 return true;
5240 return false;
5244 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5246 * When not doing a rate control probe to test rates, rate control should pass
5247 * its rate selection to mac80211. If the driver supports receiving a station
5248 * rate table, it will use it to ensure that frames are always sent based on
5249 * the most recent rate control module decision.
5251 * @hw: pointer as obtained from ieee80211_alloc_hw()
5252 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5253 * @rates: new tx rate set to be used for this station.
5255 int rate_control_set_rates(struct ieee80211_hw *hw,
5256 struct ieee80211_sta *pubsta,
5257 struct ieee80211_sta_rates *rates);
5259 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5260 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5262 static inline bool
5263 conf_is_ht20(struct ieee80211_conf *conf)
5265 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5268 static inline bool
5269 conf_is_ht40_minus(struct ieee80211_conf *conf)
5271 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5272 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5275 static inline bool
5276 conf_is_ht40_plus(struct ieee80211_conf *conf)
5278 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5279 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5282 static inline bool
5283 conf_is_ht40(struct ieee80211_conf *conf)
5285 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5288 static inline bool
5289 conf_is_ht(struct ieee80211_conf *conf)
5291 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5292 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5293 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5296 static inline enum nl80211_iftype
5297 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5299 if (p2p) {
5300 switch (type) {
5301 case NL80211_IFTYPE_STATION:
5302 return NL80211_IFTYPE_P2P_CLIENT;
5303 case NL80211_IFTYPE_AP:
5304 return NL80211_IFTYPE_P2P_GO;
5305 default:
5306 break;
5309 return type;
5312 static inline enum nl80211_iftype
5313 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5315 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5318 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5319 int rssi_min_thold,
5320 int rssi_max_thold);
5322 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5325 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5327 * @vif: the specified virtual interface
5329 * Note: This function assumes that the given vif is valid.
5331 * Return: The average RSSI value for the requested interface, or 0 if not
5332 * applicable.
5334 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5337 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5338 * @vif: virtual interface
5339 * @wakeup: wakeup reason(s)
5340 * @gfp: allocation flags
5342 * See cfg80211_report_wowlan_wakeup().
5344 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5345 struct cfg80211_wowlan_wakeup *wakeup,
5346 gfp_t gfp);
5349 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5350 * @hw: pointer as obtained from ieee80211_alloc_hw()
5351 * @vif: virtual interface
5352 * @skb: frame to be sent from within the driver
5353 * @band: the band to transmit on
5354 * @sta: optional pointer to get the station to send the frame to
5356 * Note: must be called under RCU lock
5358 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5359 struct ieee80211_vif *vif, struct sk_buff *skb,
5360 int band, struct ieee80211_sta **sta);
5363 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5365 * @next_tsf: TSF timestamp of the next absent state change
5366 * @has_next_tsf: next absent state change event pending
5368 * @absent: descriptor bitmask, set if GO is currently absent
5370 * private:
5372 * @count: count fields from the NoA descriptors
5373 * @desc: adjusted data from the NoA
5375 struct ieee80211_noa_data {
5376 u32 next_tsf;
5377 bool has_next_tsf;
5379 u8 absent;
5381 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5382 struct {
5383 u32 start;
5384 u32 duration;
5385 u32 interval;
5386 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5390 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5392 * @attr: P2P NoA IE
5393 * @data: NoA tracking data
5394 * @tsf: current TSF timestamp
5396 * Return: number of successfully parsed descriptors
5398 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5399 struct ieee80211_noa_data *data, u32 tsf);
5402 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5404 * @data: NoA tracking data
5405 * @tsf: current TSF timestamp
5407 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5410 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5411 * @vif: virtual interface
5412 * @peer: the peer's destination address
5413 * @oper: the requested TDLS operation
5414 * @reason_code: reason code for the operation, valid for TDLS teardown
5415 * @gfp: allocation flags
5417 * See cfg80211_tdls_oper_request().
5419 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5420 enum nl80211_tdls_operation oper,
5421 u16 reason_code, gfp_t gfp);
5424 * ieee80211_reserve_tid - request to reserve a specific TID
5426 * There is sometimes a need (such as in TDLS) for blocking the driver from
5427 * using a specific TID so that the FW can use it for certain operations such
5428 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5429 * this function must be called as it flushes out packets on this TID and marks
5430 * it as blocked, so that any transmit for the station on this TID will be
5431 * redirected to the alternative TID in the same AC.
5433 * Note that this function blocks and may call back into the driver, so it
5434 * should be called without driver locks held. Also note this function should
5435 * only be called from the driver's @sta_state callback.
5437 * @sta: the station to reserve the TID for
5438 * @tid: the TID to reserve
5440 * Returns: 0 on success, else on failure
5442 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5445 * ieee80211_unreserve_tid - request to unreserve a specific TID
5447 * Once there is no longer any need for reserving a certain TID, this function
5448 * should be called, and no longer will packets have their TID modified for
5449 * preventing use of this TID in the driver.
5451 * Note that this function blocks and acquires a lock, so it should be called
5452 * without driver locks held. Also note this function should only be called
5453 * from the driver's @sta_state callback.
5455 * @sta: the station
5456 * @tid: the TID to unreserve
5458 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5461 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5463 * @hw: pointer as obtained from ieee80211_alloc_hw()
5464 * @txq: pointer obtained from station or virtual interface
5466 * Returns the skb if successful, %NULL if no frame was available.
5468 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5469 struct ieee80211_txq *txq);
5470 #endif /* MAC80211_H */