2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
97 enum ieee80211_max_queues {
98 IEEE80211_MAX_QUEUES = 16,
101 #define IEEE80211_INVAL_HW_QUEUE 0xff
104 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
105 * @IEEE80211_AC_VO: voice
106 * @IEEE80211_AC_VI: video
107 * @IEEE80211_AC_BE: best effort
108 * @IEEE80211_AC_BK: background
110 enum ieee80211_ac_numbers {
116 #define IEEE80211_NUM_ACS 4
119 * struct ieee80211_tx_queue_params - transmit queue configuration
121 * The information provided in this structure is required for QoS
122 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
124 * @aifs: arbitration interframe space [0..255]
125 * @cw_min: minimum contention window [a value of the form
126 * 2^n-1 in the range 1..32767]
127 * @cw_max: maximum contention window [like @cw_min]
128 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
129 * @uapsd: is U-APSD mode enabled for the queue
131 struct ieee80211_tx_queue_params {
139 struct ieee80211_low_level_stats {
140 unsigned int dot11ACKFailureCount;
141 unsigned int dot11RTSFailureCount;
142 unsigned int dot11FCSErrorCount;
143 unsigned int dot11RTSSuccessCount;
147 * enum ieee80211_chanctx_change - change flag for channel context
148 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 enum ieee80211_chanctx_change {
152 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
153 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
157 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
159 * This is the driver-visible part. The ieee80211_chanctx
160 * that contains it is visible in mac80211 only.
162 * @def: the channel definition
163 * @rx_chains_static: The number of RX chains that must always be
164 * active on the channel to receive MIMO transmissions
165 * @rx_chains_dynamic: The number of RX chains that must be enabled
166 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
167 * this will always be >= @rx_chains_always.
168 * @drv_priv: data area for driver use, will always be aligned to
169 * sizeof(void *), size is determined in hw information.
171 struct ieee80211_chanctx_conf {
172 struct cfg80211_chan_def def;
174 u8 rx_chains_static, rx_chains_dynamic;
176 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
180 * enum ieee80211_bss_change - BSS change notification flags
182 * These flags are used with the bss_info_changed() callback
183 * to indicate which BSS parameter changed.
185 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
186 * also implies a change in the AID.
187 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
188 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
189 * @BSS_CHANGED_ERP_SLOT: slot timing changed
190 * @BSS_CHANGED_HT: 802.11n parameters changed
191 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
192 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
193 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
194 * reason (IBSS and managed mode)
195 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
196 * new beacon (beaconing modes)
197 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
198 * enabled/disabled (beaconing modes)
199 * @BSS_CHANGED_CQM: Connection quality monitor config changed
200 * @BSS_CHANGED_IBSS: IBSS join status changed
201 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
202 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
203 * that it is only ever disabled for station mode.
204 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
205 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
206 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
207 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
208 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
209 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
210 * changed (currently only in P2P client mode, GO mode will be later)
212 enum ieee80211_bss_change {
213 BSS_CHANGED_ASSOC = 1<<0,
214 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
215 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
216 BSS_CHANGED_ERP_SLOT = 1<<3,
217 BSS_CHANGED_HT = 1<<4,
218 BSS_CHANGED_BASIC_RATES = 1<<5,
219 BSS_CHANGED_BEACON_INT = 1<<6,
220 BSS_CHANGED_BSSID = 1<<7,
221 BSS_CHANGED_BEACON = 1<<8,
222 BSS_CHANGED_BEACON_ENABLED = 1<<9,
223 BSS_CHANGED_CQM = 1<<10,
224 BSS_CHANGED_IBSS = 1<<11,
225 BSS_CHANGED_ARP_FILTER = 1<<12,
226 BSS_CHANGED_QOS = 1<<13,
227 BSS_CHANGED_IDLE = 1<<14,
228 BSS_CHANGED_SSID = 1<<15,
229 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
230 BSS_CHANGED_PS = 1<<17,
231 BSS_CHANGED_TXPOWER = 1<<18,
232 BSS_CHANGED_P2P_PS = 1<<19,
234 /* when adding here, make sure to change ieee80211_reconfig */
238 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
239 * of addresses for an interface increase beyond this value, hardware ARP
240 * filtering will be disabled.
242 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
245 * enum ieee80211_rssi_event - RSSI threshold event
246 * An indicator for when RSSI goes below/above a certain threshold.
247 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
248 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
250 enum ieee80211_rssi_event {
256 * struct ieee80211_bss_conf - holds the BSS's changing parameters
258 * This structure keeps information about a BSS (and an association
259 * to that BSS) that can change during the lifetime of the BSS.
261 * @assoc: association status
262 * @ibss_joined: indicates whether this station is part of an IBSS
264 * @ibss_creator: indicates if a new IBSS network is being created
265 * @aid: association ID number, valid only when @assoc is true
266 * @use_cts_prot: use CTS protection
267 * @use_short_preamble: use 802.11b short preamble;
268 * if the hardware cannot handle this it must set the
269 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
270 * @use_short_slot: use short slot time (only relevant for ERP);
271 * if the hardware cannot handle this it must set the
272 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
273 * @dtim_period: num of beacons before the next DTIM, for beaconing,
274 * valid in station mode only while @assoc is true and if also
275 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
277 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
278 * as it may have been received during scanning long ago)
279 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
280 * the driver/device can use this to calculate synchronisation
281 * @beacon_int: beacon interval
282 * @assoc_capability: capabilities taken from assoc resp
283 * @basic_rates: bitmap of basic rates, each bit stands for an
284 * index into the rate table configured by the driver in
286 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
287 * @bssid: The BSSID for this BSS
288 * @enable_beacon: whether beaconing should be enabled or not
289 * @chandef: Channel definition for this BSS -- the hardware might be
290 * configured a higher bandwidth than this BSS uses, for example.
291 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
292 * This field is only valid when the channel type is one of the HT types.
293 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
295 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
296 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
297 * may filter ARP queries targeted for other addresses than listed here.
298 * The driver must allow ARP queries targeted for all address listed here
299 * to pass through. An empty list implies no ARP queries need to pass.
300 * @arp_addr_cnt: Number of addresses currently on the list.
301 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
302 * filter ARP queries based on the @arp_addr_list, if disabled, the
303 * hardware must not perform any ARP filtering. Note, that the filter will
304 * be enabled also in promiscuous mode.
305 * @qos: This is a QoS-enabled BSS.
306 * @idle: This interface is idle. There's also a global idle flag in the
307 * hardware config which may be more appropriate depending on what
308 * your driver/device needs to do.
309 * @ps: power-save mode (STA only). This flag is NOT affected by
310 * offchannel/dynamic_ps operations.
311 * @ssid: The SSID of the current vif. Only valid in AP-mode.
312 * @ssid_len: Length of SSID given in @ssid.
313 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
314 * @txpower: TX power in dBm
315 * @p2p_ctwindow: P2P CTWindow, only for P2P client interfaces
316 * @p2p_oppps: P2P opportunistic PS is enabled
318 struct ieee80211_bss_conf {
320 /* association related data */
321 bool assoc, ibss_joined;
324 /* erp related data */
326 bool use_short_preamble;
331 u16 assoc_capability;
335 int mcast_rate[IEEE80211_NUM_BANDS];
336 u16 ht_operation_mode;
339 struct cfg80211_chan_def chandef;
340 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
342 bool arp_filter_enabled;
346 u8 ssid[IEEE80211_MAX_SSID_LEN];
355 * enum mac80211_tx_control_flags - flags to describe transmission information/status
357 * These flags are used with the @flags member of &ieee80211_tx_info.
359 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
360 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
361 * number to this frame, taking care of not overwriting the fragment
362 * number and increasing the sequence number only when the
363 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
364 * assign sequence numbers to QoS-data frames but cannot do so correctly
365 * for non-QoS-data and management frames because beacons need them from
366 * that counter as well and mac80211 cannot guarantee proper sequencing.
367 * If this flag is set, the driver should instruct the hardware to
368 * assign a sequence number to the frame or assign one itself. Cf. IEEE
369 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
370 * beacons and always be clear for frames without a sequence number field.
371 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
372 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
374 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
375 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
376 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
377 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
378 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
379 * because the destination STA was in powersave mode. Note that to
380 * avoid race conditions, the filter must be set by the hardware or
381 * firmware upon receiving a frame that indicates that the station
382 * went to sleep (must be done on device to filter frames already on
383 * the queue) and may only be unset after mac80211 gives the OK for
384 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
385 * since only then is it guaranteed that no more frames are in the
387 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
388 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
389 * is for the whole aggregation.
390 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
391 * so consider using block ack request (BAR).
392 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
393 * set by rate control algorithms to indicate probe rate, will
394 * be cleared for fragmented frames (except on the last fragment)
395 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
396 * used to indicate that a pending frame requires TX processing before
397 * it can be sent out.
398 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
399 * used to indicate that a frame was already retried due to PS
400 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
401 * used to indicate frame should not be encrypted
402 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
403 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
404 * be sent although the station is in powersave mode.
405 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
406 * transmit function after the current frame, this can be used
407 * by drivers to kick the DMA queue only if unset or when the
409 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
410 * after TX status because the destination was asleep, it must not
411 * be modified again (no seqno assignment, crypto, etc.)
412 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
413 * MLME command (internal to mac80211 to figure out whether to send TX
414 * status to user space)
415 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
416 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
417 * frame and selects the maximum number of streams that it can use.
418 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
419 * the off-channel channel when a remain-on-channel offload is done
420 * in hardware -- normal packets still flow and are expected to be
421 * handled properly by the device.
422 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
423 * testing. It will be sent out with incorrect Michael MIC key to allow
424 * TKIP countermeasures to be tested.
425 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
426 * This flag is actually used for management frame especially for P2P
427 * frames not being sent at CCK rate in 2GHz band.
428 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
429 * when its status is reported the service period ends. For frames in
430 * an SP that mac80211 transmits, it is already set; for driver frames
431 * the driver may set this flag. It is also used to do the same for
433 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
434 * This flag is used to send nullfunc frame at minimum rate when
435 * the nullfunc is used for connection monitoring purpose.
436 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
437 * would be fragmented by size (this is optional, only used for
438 * monitor injection).
440 * Note: If you have to add new flags to the enumeration, then don't
441 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
443 enum mac80211_tx_control_flags {
444 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
445 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
446 IEEE80211_TX_CTL_NO_ACK = BIT(2),
447 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
448 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
449 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
450 IEEE80211_TX_CTL_AMPDU = BIT(6),
451 IEEE80211_TX_CTL_INJECTED = BIT(7),
452 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
453 IEEE80211_TX_STAT_ACK = BIT(9),
454 IEEE80211_TX_STAT_AMPDU = BIT(10),
455 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
456 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
457 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
458 IEEE80211_TX_INTFL_RETRIED = BIT(15),
459 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
460 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
461 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
462 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
463 /* hole at 20, use later */
464 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
465 IEEE80211_TX_CTL_LDPC = BIT(22),
466 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
467 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
468 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
469 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
470 IEEE80211_TX_STATUS_EOSP = BIT(28),
471 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
472 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
475 #define IEEE80211_TX_CTL_STBC_SHIFT 23
478 * This definition is used as a mask to clear all temporary flags, which are
479 * set by the tx handlers for each transmission attempt by the mac80211 stack.
481 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
482 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
483 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
484 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
485 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
486 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
487 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
488 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
491 * enum mac80211_rate_control_flags - per-rate flags set by the
492 * Rate Control algorithm.
494 * These flags are set by the Rate control algorithm for each rate during tx,
495 * in the @flags member of struct ieee80211_tx_rate.
497 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
498 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
499 * This is set if the current BSS requires ERP protection.
500 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
501 * @IEEE80211_TX_RC_MCS: HT rate.
502 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
503 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
504 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
506 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
507 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
508 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
509 * (80+80 isn't supported yet)
510 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
511 * adjacent 20 MHz channels, if the current channel type is
512 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
513 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
515 enum mac80211_rate_control_flags {
516 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
517 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
518 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
520 /* rate index is an HT/VHT MCS instead of an index */
521 IEEE80211_TX_RC_MCS = BIT(3),
522 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
523 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
524 IEEE80211_TX_RC_DUP_DATA = BIT(6),
525 IEEE80211_TX_RC_SHORT_GI = BIT(7),
526 IEEE80211_TX_RC_VHT_MCS = BIT(8),
527 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
528 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
532 /* there are 40 bytes if you don't need the rateset to be kept */
533 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
535 /* if you do need the rateset, then you have less space */
536 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
538 /* maximum number of rate stages */
539 #define IEEE80211_TX_MAX_RATES 4
542 * struct ieee80211_tx_rate - rate selection/status
544 * @idx: rate index to attempt to send with
545 * @flags: rate control flags (&enum mac80211_rate_control_flags)
546 * @count: number of tries in this rate before going to the next rate
548 * A value of -1 for @idx indicates an invalid rate and, if used
549 * in an array of retry rates, that no more rates should be tried.
551 * When used for transmit status reporting, the driver should
552 * always report the rate along with the flags it used.
554 * &struct ieee80211_tx_info contains an array of these structs
555 * in the control information, and it will be filled by the rate
556 * control algorithm according to what should be sent. For example,
557 * if this array contains, in the format { <idx>, <count> } the
559 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
560 * then this means that the frame should be transmitted
561 * up to twice at rate 3, up to twice at rate 2, and up to four
562 * times at rate 1 if it doesn't get acknowledged. Say it gets
563 * acknowledged by the peer after the fifth attempt, the status
564 * information should then contain
565 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
566 * since it was transmitted twice at rate 3, twice at rate 2
567 * and once at rate 1 after which we received an acknowledgement.
569 struct ieee80211_tx_rate {
575 #define IEEE80211_MAX_TX_RETRY 31
577 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
582 rate->idx = (nss << 4) | mcs;
586 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
588 return rate->idx & 0xF;
592 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
594 return rate->idx >> 4;
598 * struct ieee80211_tx_info - skb transmit information
600 * This structure is placed in skb->cb for three uses:
601 * (1) mac80211 TX control - mac80211 tells the driver what to do
602 * (2) driver internal use (if applicable)
603 * (3) TX status information - driver tells mac80211 what happened
605 * @flags: transmit info flags, defined above
606 * @band: the band to transmit on (use for checking for races)
607 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
608 * @ack_frame_id: internal frame ID for TX status, used internally
609 * @control: union for control data
610 * @status: union for status data
611 * @driver_data: array of driver_data pointers
612 * @ampdu_ack_len: number of acked aggregated frames.
613 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
614 * @ampdu_len: number of aggregated frames.
615 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
616 * @ack_signal: signal strength of the ACK frame
618 struct ieee80211_tx_info {
619 /* common information */
632 struct ieee80211_tx_rate rates[
633 IEEE80211_TX_MAX_RATES];
637 /* only needed before rate control */
638 unsigned long jiffies;
640 /* NB: vif can be NULL for injected frames */
641 struct ieee80211_vif *vif;
642 struct ieee80211_key_conf *hw_key;
646 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
654 struct ieee80211_tx_rate driver_rates[
655 IEEE80211_TX_MAX_RATES];
656 void *rate_driver_data[
657 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
660 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
665 * struct ieee80211_sched_scan_ies - scheduled scan IEs
667 * This structure is used to pass the appropriate IEs to be used in scheduled
668 * scans for all bands. It contains both the IEs passed from the userspace
669 * and the ones generated by mac80211.
671 * @ie: array with the IEs for each supported band
672 * @len: array with the total length of the IEs for each band
674 struct ieee80211_sched_scan_ies {
675 u8 *ie[IEEE80211_NUM_BANDS];
676 size_t len[IEEE80211_NUM_BANDS];
679 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
681 return (struct ieee80211_tx_info *)skb->cb;
684 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
686 return (struct ieee80211_rx_status *)skb->cb;
690 * ieee80211_tx_info_clear_status - clear TX status
692 * @info: The &struct ieee80211_tx_info to be cleared.
694 * When the driver passes an skb back to mac80211, it must report
695 * a number of things in TX status. This function clears everything
696 * in the TX status but the rate control information (it does clear
697 * the count since you need to fill that in anyway).
699 * NOTE: You can only use this function if you do NOT use
700 * info->driver_data! Use info->rate_driver_data
701 * instead if you need only the less space that allows.
704 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
708 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
709 offsetof(struct ieee80211_tx_info, control.rates));
710 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
711 offsetof(struct ieee80211_tx_info, driver_rates));
712 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
713 /* clear the rate counts */
714 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
715 info->status.rates[i].count = 0;
718 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
719 memset(&info->status.ampdu_ack_len, 0,
720 sizeof(struct ieee80211_tx_info) -
721 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
726 * enum mac80211_rx_flags - receive flags
728 * These flags are used with the @flag member of &struct ieee80211_rx_status.
729 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
730 * Use together with %RX_FLAG_MMIC_STRIPPED.
731 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
732 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
733 * verification has been done by the hardware.
734 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
735 * If this flag is set, the stack cannot do any replay detection
736 * hence the driver or hardware will have to do that.
737 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
739 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
741 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
742 * field) is valid and contains the time the first symbol of the MPDU
743 * was received. This is useful in monitor mode and for proper IBSS
745 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
746 * field) is valid and contains the time the last symbol of the MPDU
747 * (including FCS) was received.
748 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
749 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
750 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
751 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
752 * @RX_FLAG_80MHZ: 80 MHz was used
753 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
754 * @RX_FLAG_160MHZ: 160 MHz was used
755 * @RX_FLAG_SHORT_GI: Short guard interval was used
756 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
757 * Valid only for data frames (mainly A-MPDU)
758 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
759 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
760 * to hw.radiotap_mcs_details to advertise that fact
761 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
762 * number (@ampdu_reference) must be populated and be a distinct number for
764 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
765 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
766 * monitoring purposes only
767 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
768 * subframes of a single A-MPDU
769 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
770 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
772 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
773 * is stored in the @ampdu_delimiter_crc field)
775 enum mac80211_rx_flags {
776 RX_FLAG_MMIC_ERROR = BIT(0),
777 RX_FLAG_DECRYPTED = BIT(1),
778 RX_FLAG_MMIC_STRIPPED = BIT(3),
779 RX_FLAG_IV_STRIPPED = BIT(4),
780 RX_FLAG_FAILED_FCS_CRC = BIT(5),
781 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
782 RX_FLAG_MACTIME_START = BIT(7),
783 RX_FLAG_SHORTPRE = BIT(8),
785 RX_FLAG_40MHZ = BIT(10),
786 RX_FLAG_SHORT_GI = BIT(11),
787 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
788 RX_FLAG_HT_GF = BIT(13),
789 RX_FLAG_AMPDU_DETAILS = BIT(14),
790 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
791 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
792 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
793 RX_FLAG_AMPDU_IS_LAST = BIT(18),
794 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
795 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
796 RX_FLAG_MACTIME_END = BIT(21),
797 RX_FLAG_VHT = BIT(22),
798 RX_FLAG_80MHZ = BIT(23),
799 RX_FLAG_80P80MHZ = BIT(24),
800 RX_FLAG_160MHZ = BIT(25),
804 * struct ieee80211_rx_status - receive status
806 * The low-level driver should provide this information (the subset
807 * supported by hardware) to the 802.11 code with each received
808 * frame, in the skb's control buffer (cb).
810 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
811 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
812 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
813 * it but can store it and pass it back to the driver for synchronisation
814 * @band: the active band when this frame was received
815 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
816 * @signal: signal strength when receiving this frame, either in dBm, in dB or
817 * unspecified depending on the hardware capabilities flags
818 * @IEEE80211_HW_SIGNAL_*
819 * @antenna: antenna used
820 * @rate_idx: index of data rate into band's supported rates or MCS index if
821 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
822 * @vht_nss: number of streams (VHT only)
824 * @rx_flags: internal RX flags for mac80211
825 * @ampdu_reference: A-MPDU reference number, must be a different value for
826 * each A-MPDU but the same for each subframe within one A-MPDU
827 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
828 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
829 * @vendor_radiotap_len: radiotap vendor namespace length
830 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
831 * that the actual data must be at the start of the SKB data
833 * @vendor_radiotap_oui: radiotap vendor namespace OUI
834 * @vendor_radiotap_subns: radiotap vendor sub namespace
836 struct ieee80211_rx_status {
838 u32 device_timestamp;
841 u32 vendor_radiotap_bitmap;
842 u16 vendor_radiotap_len;
850 u8 ampdu_delimiter_crc;
851 u8 vendor_radiotap_align;
852 u8 vendor_radiotap_oui[3];
853 u8 vendor_radiotap_subns;
857 * enum ieee80211_conf_flags - configuration flags
859 * Flags to define PHY configuration options
861 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
862 * to determine for example whether to calculate timestamps for packets
863 * or not, do not use instead of filter flags!
864 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
865 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
866 * meaning that the hardware still wakes up for beacons, is able to
867 * transmit frames and receive the possible acknowledgment frames.
868 * Not to be confused with hardware specific wakeup/sleep states,
869 * driver is responsible for that. See the section "Powersave support"
871 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
872 * the driver should be prepared to handle configuration requests but
873 * may turn the device off as much as possible. Typically, this flag will
874 * be set when an interface is set UP but not associated or scanning, but
875 * it can also be unset in that case when monitor interfaces are active.
876 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
879 enum ieee80211_conf_flags {
880 IEEE80211_CONF_MONITOR = (1<<0),
881 IEEE80211_CONF_PS = (1<<1),
882 IEEE80211_CONF_IDLE = (1<<2),
883 IEEE80211_CONF_OFFCHANNEL = (1<<3),
888 * enum ieee80211_conf_changed - denotes which configuration changed
890 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
891 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
892 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
893 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
894 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
895 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
896 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
897 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
898 * Note that this is only valid if channel contexts are not used,
899 * otherwise each channel context has the number of chains listed.
901 enum ieee80211_conf_changed {
902 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
903 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
904 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
905 IEEE80211_CONF_CHANGE_PS = BIT(4),
906 IEEE80211_CONF_CHANGE_POWER = BIT(5),
907 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
908 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
909 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
913 * enum ieee80211_smps_mode - spatial multiplexing power save mode
915 * @IEEE80211_SMPS_AUTOMATIC: automatic
916 * @IEEE80211_SMPS_OFF: off
917 * @IEEE80211_SMPS_STATIC: static
918 * @IEEE80211_SMPS_DYNAMIC: dynamic
919 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
921 enum ieee80211_smps_mode {
922 IEEE80211_SMPS_AUTOMATIC,
924 IEEE80211_SMPS_STATIC,
925 IEEE80211_SMPS_DYNAMIC,
928 IEEE80211_SMPS_NUM_MODES,
932 * struct ieee80211_conf - configuration of the device
934 * This struct indicates how the driver shall configure the hardware.
936 * @flags: configuration flags defined above
938 * @listen_interval: listen interval in units of beacon interval
939 * @max_sleep_period: the maximum number of beacon intervals to sleep for
940 * before checking the beacon for a TIM bit (managed mode only); this
941 * value will be only achievable between DTIM frames, the hardware
942 * needs to check for the multicast traffic bit in DTIM beacons.
943 * This variable is valid only when the CONF_PS flag is set.
944 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
945 * in power saving. Power saving will not be enabled until a beacon
946 * has been received and the DTIM period is known.
947 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
948 * powersave documentation below. This variable is valid only when
949 * the CONF_PS flag is set.
951 * @power_level: requested transmit power (in dBm), backward compatibility
952 * value only that is set to the minimum of all interfaces
954 * @channel: the channel to tune to
955 * @channel_type: the channel (HT) type
957 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
958 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
959 * but actually means the number of transmissions not the number of retries
960 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
961 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
962 * number of transmissions not the number of retries
964 * @smps_mode: spatial multiplexing powersave mode; note that
965 * %IEEE80211_SMPS_STATIC is used when the device is not
966 * configured for an HT channel.
967 * Note that this is only valid if channel contexts are not used,
968 * otherwise each channel context has the number of chains listed.
970 struct ieee80211_conf {
972 int power_level, dynamic_ps_timeout;
973 int max_sleep_period;
978 u8 long_frame_max_tx_count, short_frame_max_tx_count;
980 struct ieee80211_channel *channel;
981 enum nl80211_channel_type channel_type;
982 enum ieee80211_smps_mode smps_mode;
986 * struct ieee80211_channel_switch - holds the channel switch data
988 * The information provided in this structure is required for channel switch
991 * @timestamp: value in microseconds of the 64-bit Time Synchronization
992 * Function (TSF) timer when the frame containing the channel switch
993 * announcement was received. This is simply the rx.mactime parameter
994 * the driver passed into mac80211.
995 * @block_tx: Indicates whether transmission must be blocked before the
996 * scheduled channel switch, as indicated by the AP.
997 * @channel: the new channel to switch to
998 * @count: the number of TBTT's until the channel switch event
1000 struct ieee80211_channel_switch {
1003 struct ieee80211_channel *channel;
1008 * enum ieee80211_vif_flags - virtual interface flags
1010 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1011 * on this virtual interface to avoid unnecessary CPU wakeups
1012 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1013 * monitoring on this virtual interface -- i.e. it can monitor
1014 * connection quality related parameters, such as the RSSI level and
1015 * provide notifications if configured trigger levels are reached.
1017 enum ieee80211_vif_flags {
1018 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1019 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1023 * struct ieee80211_vif - per-interface data
1025 * Data in this structure is continually present for driver
1026 * use during the life of a virtual interface.
1028 * @type: type of this virtual interface
1029 * @bss_conf: BSS configuration for this interface, either our own
1030 * or the BSS we're associated to
1031 * @addr: address of this interface
1032 * @p2p: indicates whether this AP or STA interface is a p2p
1033 * interface, i.e. a GO or p2p-sta respectively
1034 * @driver_flags: flags/capabilities the driver has for this interface,
1035 * these need to be set (or cleared) when the interface is added
1036 * or, if supported by the driver, the interface type is changed
1037 * at runtime, mac80211 will never touch this field
1038 * @hw_queue: hardware queue for each AC
1039 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1040 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1041 * when it is not assigned. This pointer is RCU-protected due to the TX
1042 * path needing to access it; even though the netdev carrier will always
1043 * be off when it is %NULL there can still be races and packets could be
1044 * processed after it switches back to %NULL.
1045 * @drv_priv: data area for driver use, will always be aligned to
1048 struct ieee80211_vif {
1049 enum nl80211_iftype type;
1050 struct ieee80211_bss_conf bss_conf;
1055 u8 hw_queue[IEEE80211_NUM_ACS];
1057 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1062 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1065 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1067 #ifdef CONFIG_MAC80211_MESH
1068 return vif->type == NL80211_IFTYPE_MESH_POINT;
1074 * enum ieee80211_key_flags - key flags
1076 * These flags are used for communication about keys between the driver
1077 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1079 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
1080 * that the STA this key will be used with could be using QoS.
1081 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1082 * driver to indicate that it requires IV generation for this
1084 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1085 * the driver for a TKIP key if it requires Michael MIC
1086 * generation in software.
1087 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1088 * that the key is pairwise rather then a shared key.
1089 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1090 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1091 * be done in software.
1092 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1093 * if space should be prepared for the IV, but the IV
1094 * itself should not be generated. Do not set together with
1095 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1096 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1097 * management frames. The flag can help drivers that have a hardware
1098 * crypto implementation that doesn't deal with management frames
1099 * properly by allowing them to not upload the keys to hardware and
1100 * fall back to software crypto. Note that this flag deals only with
1101 * RX, if your crypto engine can't deal with TX you can also set the
1102 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1104 enum ieee80211_key_flags {
1105 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
1106 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1107 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1108 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
1109 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
1110 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1111 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
1115 * struct ieee80211_key_conf - key information
1117 * This key information is given by mac80211 to the driver by
1118 * the set_key() callback in &struct ieee80211_ops.
1120 * @hw_key_idx: To be set by the driver, this is the key index the driver
1121 * wants to be given when a frame is transmitted and needs to be
1122 * encrypted in hardware.
1123 * @cipher: The key's cipher suite selector.
1124 * @flags: key flags, see &enum ieee80211_key_flags.
1125 * @keyidx: the key index (0-3)
1126 * @keylen: key material length
1127 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1129 * - Temporal Encryption Key (128 bits)
1130 * - Temporal Authenticator Tx MIC Key (64 bits)
1131 * - Temporal Authenticator Rx MIC Key (64 bits)
1132 * @icv_len: The ICV length for this key type
1133 * @iv_len: The IV length for this key type
1135 struct ieee80211_key_conf {
1147 * enum set_key_cmd - key command
1149 * Used with the set_key() callback in &struct ieee80211_ops, this
1150 * indicates whether a key is being removed or added.
1152 * @SET_KEY: a key is set
1153 * @DISABLE_KEY: a key must be disabled
1156 SET_KEY, DISABLE_KEY,
1160 * enum ieee80211_sta_state - station state
1162 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1163 * this is a special state for add/remove transitions
1164 * @IEEE80211_STA_NONE: station exists without special state
1165 * @IEEE80211_STA_AUTH: station is authenticated
1166 * @IEEE80211_STA_ASSOC: station is associated
1167 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1169 enum ieee80211_sta_state {
1170 /* NOTE: These need to be ordered correctly! */
1171 IEEE80211_STA_NOTEXIST,
1174 IEEE80211_STA_ASSOC,
1175 IEEE80211_STA_AUTHORIZED,
1179 * struct ieee80211_sta - station table entry
1181 * A station table entry represents a station we are possibly
1182 * communicating with. Since stations are RCU-managed in
1183 * mac80211, any ieee80211_sta pointer you get access to must
1184 * either be protected by rcu_read_lock() explicitly or implicitly,
1185 * or you must take good care to not use such a pointer after a
1186 * call to your sta_remove callback that removed it.
1188 * @addr: MAC address
1189 * @aid: AID we assigned to the station if we're an AP
1190 * @supp_rates: Bitmap of supported rates (per band)
1191 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1192 * @vht_cap: VHT capabilities of this STA; Not restricting any capabilities
1193 * of remote STA. Taking as is.
1194 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1195 * @drv_priv: data area for driver use, will always be aligned to
1196 * sizeof(void *), size is determined in hw information.
1197 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1198 * if wme is supported.
1199 * @max_sp: max Service Period. Only valid if wme is supported.
1201 struct ieee80211_sta {
1202 u32 supp_rates[IEEE80211_NUM_BANDS];
1205 struct ieee80211_sta_ht_cap ht_cap;
1206 struct ieee80211_sta_vht_cap vht_cap;
1212 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1216 * enum sta_notify_cmd - sta notify command
1218 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1219 * indicates if an associated station made a power state transition.
1221 * @STA_NOTIFY_SLEEP: a station is now sleeping
1222 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1224 enum sta_notify_cmd {
1225 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1229 * struct ieee80211_tx_control - TX control data
1231 * @sta: station table entry, this sta pointer may be NULL and
1232 * it is not allowed to copy the pointer, due to RCU.
1234 struct ieee80211_tx_control {
1235 struct ieee80211_sta *sta;
1239 * enum ieee80211_hw_flags - hardware flags
1241 * These flags are used to indicate hardware capabilities to
1242 * the stack. Generally, flags here should have their meaning
1243 * done in a way that the simplest hardware doesn't need setting
1244 * any particular flags. There are some exceptions to this rule,
1245 * however, so you are advised to review these flags carefully.
1247 * @IEEE80211_HW_HAS_RATE_CONTROL:
1248 * The hardware or firmware includes rate control, and cannot be
1249 * controlled by the stack. As such, no rate control algorithm
1250 * should be instantiated, and the TX rate reported to userspace
1251 * will be taken from the TX status instead of the rate control
1253 * Note that this requires that the driver implement a number of
1254 * callbacks so it has the correct information, it needs to have
1255 * the @set_rts_threshold callback and must look at the BSS config
1256 * @use_cts_prot for G/N protection, @use_short_slot for slot
1257 * timing in 2.4 GHz and @use_short_preamble for preambles for
1260 * @IEEE80211_HW_RX_INCLUDES_FCS:
1261 * Indicates that received frames passed to the stack include
1262 * the FCS at the end.
1264 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1265 * Some wireless LAN chipsets buffer broadcast/multicast frames
1266 * for power saving stations in the hardware/firmware and others
1267 * rely on the host system for such buffering. This option is used
1268 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1269 * multicast frames when there are power saving stations so that
1270 * the driver can fetch them with ieee80211_get_buffered_bc().
1272 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1273 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1275 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1276 * Hardware is not capable of receiving frames with short preamble on
1279 * @IEEE80211_HW_SIGNAL_UNSPEC:
1280 * Hardware can provide signal values but we don't know its units. We
1281 * expect values between 0 and @max_signal.
1282 * If possible please provide dB or dBm instead.
1284 * @IEEE80211_HW_SIGNAL_DBM:
1285 * Hardware gives signal values in dBm, decibel difference from
1286 * one milliwatt. This is the preferred method since it is standardized
1287 * between different devices. @max_signal does not need to be set.
1289 * @IEEE80211_HW_SPECTRUM_MGMT:
1290 * Hardware supports spectrum management defined in 802.11h
1291 * Measurement, Channel Switch, Quieting, TPC
1293 * @IEEE80211_HW_AMPDU_AGGREGATION:
1294 * Hardware supports 11n A-MPDU aggregation.
1296 * @IEEE80211_HW_SUPPORTS_PS:
1297 * Hardware has power save support (i.e. can go to sleep).
1299 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1300 * Hardware requires nullfunc frame handling in stack, implies
1301 * stack support for dynamic PS.
1303 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1304 * Hardware has support for dynamic PS.
1306 * @IEEE80211_HW_MFP_CAPABLE:
1307 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1309 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1310 * Hardware supports static spatial multiplexing powersave,
1311 * ie. can turn off all but one chain even on HT connections
1312 * that should be using more chains.
1314 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1315 * Hardware supports dynamic spatial multiplexing powersave,
1316 * ie. can turn off all but one chain and then wake the rest
1317 * up as required after, for example, rts/cts handshake.
1319 * @IEEE80211_HW_SUPPORTS_UAPSD:
1320 * Hardware supports Unscheduled Automatic Power Save Delivery
1321 * (U-APSD) in managed mode. The mode is configured with
1322 * conf_tx() operation.
1324 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1325 * Hardware can provide ack status reports of Tx frames to
1328 * @IEEE80211_HW_CONNECTION_MONITOR:
1329 * The hardware performs its own connection monitoring, including
1330 * periodic keep-alives to the AP and probing the AP on beacon loss.
1331 * When this flag is set, signaling beacon-loss will cause an immediate
1332 * change to disassociated state.
1334 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1335 * This device needs to know the DTIM period for the BSS before
1338 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1339 * per-station GTKs as used by IBSS RSN or during fast transition. If
1340 * the device doesn't support per-station GTKs, but can be asked not
1341 * to decrypt group addressed frames, then IBSS RSN support is still
1342 * possible but software crypto will be used. Advertise the wiphy flag
1343 * only in that case.
1345 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1346 * autonomously manages the PS status of connected stations. When
1347 * this flag is set mac80211 will not trigger PS mode for connected
1348 * stations based on the PM bit of incoming frames.
1349 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1350 * the PS mode of connected stations.
1352 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1353 * setup strictly in HW. mac80211 should not attempt to do this in
1356 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1357 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1360 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1361 * a virtual monitor interface when monitor interfaces are the only
1362 * active interfaces.
1364 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1365 * queue mapping in order to use different queues (not just one per AC)
1366 * for different virtual interfaces. See the doc section on HW queue
1367 * control for more details.
1369 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1370 * P2P Interface. This will be honoured even if more than one interface
1373 enum ieee80211_hw_flags {
1374 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1375 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1376 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1377 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1378 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1379 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1380 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1381 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1382 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1383 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1384 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1385 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1386 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1387 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1388 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1389 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1390 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1391 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1392 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1393 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1394 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1395 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1396 IEEE80211_HW_AP_LINK_PS = 1<<22,
1397 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1398 IEEE80211_HW_SCAN_WHILE_IDLE = 1<<24,
1399 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1403 * struct ieee80211_hw - hardware information and state
1405 * This structure contains the configuration and hardware
1406 * information for an 802.11 PHY.
1408 * @wiphy: This points to the &struct wiphy allocated for this
1409 * 802.11 PHY. You must fill in the @perm_addr and @dev
1410 * members of this structure using SET_IEEE80211_DEV()
1411 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1412 * bands (with channels, bitrates) are registered here.
1414 * @conf: &struct ieee80211_conf, device configuration, don't use.
1416 * @priv: pointer to private area that was allocated for driver use
1417 * along with this structure.
1419 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1421 * @extra_tx_headroom: headroom to reserve in each transmit skb
1422 * for use by the driver (e.g. for transmit headers.)
1424 * @channel_change_time: time (in microseconds) it takes to change channels.
1426 * @max_signal: Maximum value for signal (rssi) in RX information, used
1427 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1429 * @max_listen_interval: max listen interval in units of beacon interval
1432 * @queues: number of available hardware transmit queues for
1433 * data packets. WMM/QoS requires at least four, these
1434 * queues need to have configurable access parameters.
1436 * @rate_control_algorithm: rate control algorithm for this hardware.
1437 * If unset (NULL), the default algorithm will be used. Must be
1438 * set before calling ieee80211_register_hw().
1440 * @vif_data_size: size (in bytes) of the drv_priv data area
1441 * within &struct ieee80211_vif.
1442 * @sta_data_size: size (in bytes) of the drv_priv data area
1443 * within &struct ieee80211_sta.
1444 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1445 * within &struct ieee80211_chanctx_conf.
1447 * @max_rates: maximum number of alternate rate retry stages the hw
1449 * @max_report_rates: maximum number of alternate rate retry stages
1450 * the hw can report back.
1451 * @max_rate_tries: maximum number of tries for each stage
1453 * @napi_weight: weight used for NAPI polling. You must specify an
1454 * appropriate value here if a napi_poll operation is provided
1457 * @max_rx_aggregation_subframes: maximum buffer size (number of
1458 * sub-frames) to be used for A-MPDU block ack receiver
1460 * This is only relevant if the device has restrictions on the
1461 * number of subframes, if it relies on mac80211 to do reordering
1462 * it shouldn't be set.
1464 * @max_tx_aggregation_subframes: maximum number of subframes in an
1465 * aggregate an HT driver will transmit, used by the peer as a
1466 * hint to size its reorder buffer.
1468 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1469 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1471 * @radiotap_mcs_details: lists which MCS information can the HW
1472 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1473 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1474 * adding _BW is supported today.
1476 * @netdev_features: netdev features to be set in each netdev created
1477 * from this HW. Note only HW checksum features are currently
1478 * compatible with mac80211. Other feature bits will be rejected.
1480 struct ieee80211_hw {
1481 struct ieee80211_conf conf;
1482 struct wiphy *wiphy;
1483 const char *rate_control_algorithm;
1486 unsigned int extra_tx_headroom;
1487 int channel_change_time;
1490 int chanctx_data_size;
1493 u16 max_listen_interval;
1496 u8 max_report_rates;
1498 u8 max_rx_aggregation_subframes;
1499 u8 max_tx_aggregation_subframes;
1500 u8 offchannel_tx_hw_queue;
1501 u8 radiotap_mcs_details;
1502 netdev_features_t netdev_features;
1506 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1508 * @wiphy: the &struct wiphy which we want to query
1510 * mac80211 drivers can use this to get to their respective
1511 * &struct ieee80211_hw. Drivers wishing to get to their own private
1512 * structure can then access it via hw->priv. Note that mac802111 drivers should
1513 * not use wiphy_priv() to try to get their private driver structure as this
1514 * is already used internally by mac80211.
1516 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1519 * SET_IEEE80211_DEV - set device for 802.11 hardware
1521 * @hw: the &struct ieee80211_hw to set the device for
1522 * @dev: the &struct device of this 802.11 device
1524 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1526 set_wiphy_dev(hw->wiphy, dev);
1530 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1532 * @hw: the &struct ieee80211_hw to set the MAC address for
1533 * @addr: the address to set
1535 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1537 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1540 static inline struct ieee80211_rate *
1541 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1542 const struct ieee80211_tx_info *c)
1544 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1546 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1549 static inline struct ieee80211_rate *
1550 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1551 const struct ieee80211_tx_info *c)
1553 if (c->control.rts_cts_rate_idx < 0)
1555 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1558 static inline struct ieee80211_rate *
1559 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1560 const struct ieee80211_tx_info *c, int idx)
1562 if (c->control.rates[idx + 1].idx < 0)
1564 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1568 * ieee80211_free_txskb - free TX skb
1572 * Free a transmit skb. Use this funtion when some failure
1573 * to transmit happened and thus status cannot be reported.
1575 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1578 * DOC: Hardware crypto acceleration
1580 * mac80211 is capable of taking advantage of many hardware
1581 * acceleration designs for encryption and decryption operations.
1583 * The set_key() callback in the &struct ieee80211_ops for a given
1584 * device is called to enable hardware acceleration of encryption and
1585 * decryption. The callback takes a @sta parameter that will be NULL
1586 * for default keys or keys used for transmission only, or point to
1587 * the station information for the peer for individual keys.
1588 * Multiple transmission keys with the same key index may be used when
1589 * VLANs are configured for an access point.
1591 * When transmitting, the TX control data will use the @hw_key_idx
1592 * selected by the driver by modifying the &struct ieee80211_key_conf
1593 * pointed to by the @key parameter to the set_key() function.
1595 * The set_key() call for the %SET_KEY command should return 0 if
1596 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1597 * added; if you return 0 then hw_key_idx must be assigned to the
1598 * hardware key index, you are free to use the full u8 range.
1600 * When the cmd is %DISABLE_KEY then it must succeed.
1602 * Note that it is permissible to not decrypt a frame even if a key
1603 * for it has been uploaded to hardware, the stack will not make any
1604 * decision based on whether a key has been uploaded or not but rather
1605 * based on the receive flags.
1607 * The &struct ieee80211_key_conf structure pointed to by the @key
1608 * parameter is guaranteed to be valid until another call to set_key()
1609 * removes it, but it can only be used as a cookie to differentiate
1612 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1613 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1615 * The update_tkip_key() call updates the driver with the new phase 1 key.
1616 * This happens every time the iv16 wraps around (every 65536 packets). The
1617 * set_key() call will happen only once for each key (unless the AP did
1618 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1619 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1620 * handler is software decryption with wrap around of iv16.
1624 * DOC: Powersave support
1626 * mac80211 has support for various powersave implementations.
1628 * First, it can support hardware that handles all powersaving by itself,
1629 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1630 * flag. In that case, it will be told about the desired powersave mode
1631 * with the %IEEE80211_CONF_PS flag depending on the association status.
1632 * The hardware must take care of sending nullfunc frames when necessary,
1633 * i.e. when entering and leaving powersave mode. The hardware is required
1634 * to look at the AID in beacons and signal to the AP that it woke up when
1635 * it finds traffic directed to it.
1637 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1638 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1639 * with hardware wakeup and sleep states. Driver is responsible for waking
1640 * up the hardware before issuing commands to the hardware and putting it
1641 * back to sleep at appropriate times.
1643 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1644 * buffered multicast/broadcast frames after the beacon. Also it must be
1645 * possible to send frames and receive the acknowledment frame.
1647 * Other hardware designs cannot send nullfunc frames by themselves and also
1648 * need software support for parsing the TIM bitmap. This is also supported
1649 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1650 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1651 * required to pass up beacons. The hardware is still required to handle
1652 * waking up for multicast traffic; if it cannot the driver must handle that
1653 * as best as it can, mac80211 is too slow to do that.
1655 * Dynamic powersave is an extension to normal powersave in which the
1656 * hardware stays awake for a user-specified period of time after sending a
1657 * frame so that reply frames need not be buffered and therefore delayed to
1658 * the next wakeup. It's compromise of getting good enough latency when
1659 * there's data traffic and still saving significantly power in idle
1662 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1663 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1664 * flag and mac80211 will handle everything automatically. Additionally,
1665 * hardware having support for the dynamic PS feature may set the
1666 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1667 * dynamic PS mode itself. The driver needs to look at the
1668 * @dynamic_ps_timeout hardware configuration value and use it that value
1669 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1670 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1671 * enabled whenever user has enabled powersave.
1673 * Some hardware need to toggle a single shared antenna between WLAN and
1674 * Bluetooth to facilitate co-existence. These types of hardware set
1675 * limitations on the use of host controlled dynamic powersave whenever there
1676 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1677 * driver may request temporarily going into full power save, in order to
1678 * enable toggling the antenna between BT and WLAN. If the driver requests
1679 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1680 * temporarily set to zero until the driver re-enables dynamic powersave.
1682 * Driver informs U-APSD client support by enabling
1683 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1684 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1685 * Nullfunc frames and stay awake until the service period has ended. To
1686 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1687 * from that AC are transmitted with powersave enabled.
1689 * Note: U-APSD client mode is not yet supported with
1690 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1694 * DOC: Beacon filter support
1696 * Some hardware have beacon filter support to reduce host cpu wakeups
1697 * which will reduce system power consumption. It usually works so that
1698 * the firmware creates a checksum of the beacon but omits all constantly
1699 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1700 * beacon is forwarded to the host, otherwise it will be just dropped. That
1701 * way the host will only receive beacons where some relevant information
1702 * (for example ERP protection or WMM settings) have changed.
1704 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1705 * interface capability. The driver needs to enable beacon filter support
1706 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1707 * power save is enabled, the stack will not check for beacon loss and the
1708 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1710 * The time (or number of beacons missed) until the firmware notifies the
1711 * driver of a beacon loss event (which in turn causes the driver to call
1712 * ieee80211_beacon_loss()) should be configurable and will be controlled
1713 * by mac80211 and the roaming algorithm in the future.
1715 * Since there may be constantly changing information elements that nothing
1716 * in the software stack cares about, we will, in the future, have mac80211
1717 * tell the driver which information elements are interesting in the sense
1718 * that we want to see changes in them. This will include
1719 * - a list of information element IDs
1720 * - a list of OUIs for the vendor information element
1722 * Ideally, the hardware would filter out any beacons without changes in the
1723 * requested elements, but if it cannot support that it may, at the expense
1724 * of some efficiency, filter out only a subset. For example, if the device
1725 * doesn't support checking for OUIs it should pass up all changes in all
1726 * vendor information elements.
1728 * Note that change, for the sake of simplification, also includes information
1729 * elements appearing or disappearing from the beacon.
1731 * Some hardware supports an "ignore list" instead, just make sure nothing
1732 * that was requested is on the ignore list, and include commonly changing
1733 * information element IDs in the ignore list, for example 11 (BSS load) and
1734 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1735 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1736 * it could also include some currently unused IDs.
1739 * In addition to these capabilities, hardware should support notifying the
1740 * host of changes in the beacon RSSI. This is relevant to implement roaming
1741 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1742 * the received data packets). This can consist in notifying the host when
1743 * the RSSI changes significantly or when it drops below or rises above
1744 * configurable thresholds. In the future these thresholds will also be
1745 * configured by mac80211 (which gets them from userspace) to implement
1746 * them as the roaming algorithm requires.
1748 * If the hardware cannot implement this, the driver should ask it to
1749 * periodically pass beacon frames to the host so that software can do the
1750 * signal strength threshold checking.
1754 * DOC: Spatial multiplexing power save
1756 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1757 * power in an 802.11n implementation. For details on the mechanism
1758 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1759 * "11.2.3 SM power save".
1761 * The mac80211 implementation is capable of sending action frames
1762 * to update the AP about the station's SMPS mode, and will instruct
1763 * the driver to enter the specific mode. It will also announce the
1764 * requested SMPS mode during the association handshake. Hardware
1765 * support for this feature is required, and can be indicated by
1768 * The default mode will be "automatic", which nl80211/cfg80211
1769 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1770 * turned off otherwise.
1772 * To support this feature, the driver must set the appropriate
1773 * hardware support flags, and handle the SMPS flag to the config()
1774 * operation. It will then with this mechanism be instructed to
1775 * enter the requested SMPS mode while associated to an HT AP.
1779 * DOC: Frame filtering
1781 * mac80211 requires to see many management frames for proper
1782 * operation, and users may want to see many more frames when
1783 * in monitor mode. However, for best CPU usage and power consumption,
1784 * having as few frames as possible percolate through the stack is
1785 * desirable. Hence, the hardware should filter as much as possible.
1787 * To achieve this, mac80211 uses filter flags (see below) to tell
1788 * the driver's configure_filter() function which frames should be
1789 * passed to mac80211 and which should be filtered out.
1791 * Before configure_filter() is invoked, the prepare_multicast()
1792 * callback is invoked with the parameters @mc_count and @mc_list
1793 * for the combined multicast address list of all virtual interfaces.
1794 * It's use is optional, and it returns a u64 that is passed to
1795 * configure_filter(). Additionally, configure_filter() has the
1796 * arguments @changed_flags telling which flags were changed and
1797 * @total_flags with the new flag states.
1799 * If your device has no multicast address filters your driver will
1800 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1801 * parameter to see whether multicast frames should be accepted
1804 * All unsupported flags in @total_flags must be cleared.
1805 * Hardware does not support a flag if it is incapable of _passing_
1806 * the frame to the stack. Otherwise the driver must ignore
1807 * the flag, but not clear it.
1808 * You must _only_ clear the flag (announce no support for the
1809 * flag to mac80211) if you are not able to pass the packet type
1810 * to the stack (so the hardware always filters it).
1811 * So for example, you should clear @FIF_CONTROL, if your hardware
1812 * always filters control frames. If your hardware always passes
1813 * control frames to the kernel and is incapable of filtering them,
1814 * you do _not_ clear the @FIF_CONTROL flag.
1815 * This rule applies to all other FIF flags as well.
1819 * DOC: AP support for powersaving clients
1821 * In order to implement AP and P2P GO modes, mac80211 has support for
1822 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1823 * There currently is no support for sAPSD.
1825 * There is one assumption that mac80211 makes, namely that a client
1826 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1827 * Both are supported, and both can be used by the same client, but
1828 * they can't be used concurrently by the same client. This simplifies
1831 * The first thing to keep in mind is that there is a flag for complete
1832 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1833 * mac80211 expects the driver to handle most of the state machine for
1834 * powersaving clients and will ignore the PM bit in incoming frames.
1835 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1836 * stations' powersave transitions. In this mode, mac80211 also doesn't
1837 * handle PS-Poll/uAPSD.
1839 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1840 * PM bit in incoming frames for client powersave transitions. When a
1841 * station goes to sleep, we will stop transmitting to it. There is,
1842 * however, a race condition: a station might go to sleep while there is
1843 * data buffered on hardware queues. If the device has support for this
1844 * it will reject frames, and the driver should give the frames back to
1845 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1846 * cause mac80211 to retry the frame when the station wakes up. The
1847 * driver is also notified of powersave transitions by calling its
1848 * @sta_notify callback.
1850 * When the station is asleep, it has three choices: it can wake up,
1851 * it can PS-Poll, or it can possibly start a uAPSD service period.
1852 * Waking up is implemented by simply transmitting all buffered (and
1853 * filtered) frames to the station. This is the easiest case. When
1854 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1855 * will inform the driver of this with the @allow_buffered_frames
1856 * callback; this callback is optional. mac80211 will then transmit
1857 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1858 * on each frame. The last frame in the service period (or the only
1859 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1860 * indicate that it ends the service period; as this frame must have
1861 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1862 * When TX status is reported for this frame, the service period is
1863 * marked has having ended and a new one can be started by the peer.
1865 * Additionally, non-bufferable MMPDUs can also be transmitted by
1866 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1868 * Another race condition can happen on some devices like iwlwifi
1869 * when there are frames queued for the station and it wakes up
1870 * or polls; the frames that are already queued could end up being
1871 * transmitted first instead, causing reordering and/or wrong
1872 * processing of the EOSP. The cause is that allowing frames to be
1873 * transmitted to a certain station is out-of-band communication to
1874 * the device. To allow this problem to be solved, the driver can
1875 * call ieee80211_sta_block_awake() if frames are buffered when it
1876 * is notified that the station went to sleep. When all these frames
1877 * have been filtered (see above), it must call the function again
1878 * to indicate that the station is no longer blocked.
1880 * If the driver buffers frames in the driver for aggregation in any
1881 * way, it must use the ieee80211_sta_set_buffered() call when it is
1882 * notified of the station going to sleep to inform mac80211 of any
1883 * TIDs that have frames buffered. Note that when a station wakes up
1884 * this information is reset (hence the requirement to call it when
1885 * informed of the station going to sleep). Then, when a service
1886 * period starts for any reason, @release_buffered_frames is called
1887 * with the number of frames to be released and which TIDs they are
1888 * to come from. In this case, the driver is responsible for setting
1889 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1890 * to help the @more_data paramter is passed to tell the driver if
1891 * there is more data on other TIDs -- the TIDs to release frames
1892 * from are ignored since mac80211 doesn't know how many frames the
1893 * buffers for those TIDs contain.
1895 * If the driver also implement GO mode, where absence periods may
1896 * shorten service periods (or abort PS-Poll responses), it must
1897 * filter those response frames except in the case of frames that
1898 * are buffered in the driver -- those must remain buffered to avoid
1899 * reordering. Because it is possible that no frames are released
1900 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1901 * to indicate to mac80211 that the service period ended anyway.
1903 * Finally, if frames from multiple TIDs are released from mac80211
1904 * but the driver might reorder them, it must clear & set the flags
1905 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1906 * and also take care of the EOSP and MORE_DATA bits in the frame.
1907 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1911 * DOC: HW queue control
1913 * Before HW queue control was introduced, mac80211 only had a single static
1914 * assignment of per-interface AC software queues to hardware queues. This
1915 * was problematic for a few reasons:
1916 * 1) off-channel transmissions might get stuck behind other frames
1917 * 2) multiple virtual interfaces couldn't be handled correctly
1918 * 3) after-DTIM frames could get stuck behind other frames
1920 * To solve this, hardware typically uses multiple different queues for all
1921 * the different usages, and this needs to be propagated into mac80211 so it
1922 * won't have the same problem with the software queues.
1924 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1925 * flag that tells it that the driver implements its own queue control. To do
1926 * so, the driver will set up the various queues in each &struct ieee80211_vif
1927 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1928 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1929 * if necessary will queue the frame on the right software queue that mirrors
1930 * the hardware queue.
1931 * Additionally, the driver has to then use these HW queue IDs for the queue
1932 * management functions (ieee80211_stop_queue() et al.)
1934 * The driver is free to set up the queue mappings as needed, multiple virtual
1935 * interfaces may map to the same hardware queues if needed. The setup has to
1936 * happen during add_interface or change_interface callbacks. For example, a
1937 * driver supporting station+station and station+AP modes might decide to have
1938 * 10 hardware queues to handle different scenarios:
1940 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1941 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1942 * after-DTIM queue for AP: 8
1943 * off-channel queue: 9
1945 * It would then set up the hardware like this:
1946 * hw.offchannel_tx_hw_queue = 9
1948 * and the first virtual interface that is added as follows:
1949 * vif.hw_queue[IEEE80211_AC_VO] = 0
1950 * vif.hw_queue[IEEE80211_AC_VI] = 1
1951 * vif.hw_queue[IEEE80211_AC_BE] = 2
1952 * vif.hw_queue[IEEE80211_AC_BK] = 3
1953 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1954 * and the second virtual interface with 4-7.
1956 * If queue 6 gets full, for example, mac80211 would only stop the second
1957 * virtual interface's BE queue since virtual interface queues are per AC.
1959 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1960 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1961 * queue could potentially be shared since mac80211 will look at cab_queue when
1962 * a queue is stopped/woken even if the interface is not in AP mode.
1966 * enum ieee80211_filter_flags - hardware filter flags
1968 * These flags determine what the filter in hardware should be
1969 * programmed to let through and what should not be passed to the
1970 * stack. It is always safe to pass more frames than requested,
1971 * but this has negative impact on power consumption.
1973 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1974 * think of the BSS as your network segment and then this corresponds
1975 * to the regular ethernet device promiscuous mode.
1977 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1978 * by the user or if the hardware is not capable of filtering by
1979 * multicast address.
1981 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1982 * %RX_FLAG_FAILED_FCS_CRC for them)
1984 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1985 * the %RX_FLAG_FAILED_PLCP_CRC for them
1987 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1988 * to the hardware that it should not filter beacons or probe responses
1989 * by BSSID. Filtering them can greatly reduce the amount of processing
1990 * mac80211 needs to do and the amount of CPU wakeups, so you should
1991 * honour this flag if possible.
1993 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1994 * is not set then only those addressed to this station.
1996 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1998 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1999 * those addressed to this station.
2001 * @FIF_PROBE_REQ: pass probe request frames
2003 enum ieee80211_filter_flags {
2004 FIF_PROMISC_IN_BSS = 1<<0,
2005 FIF_ALLMULTI = 1<<1,
2007 FIF_PLCPFAIL = 1<<3,
2008 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2010 FIF_OTHER_BSS = 1<<6,
2012 FIF_PROBE_REQ = 1<<8,
2016 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2018 * These flags are used with the ampdu_action() callback in
2019 * &struct ieee80211_ops to indicate which action is needed.
2021 * Note that drivers MUST be able to deal with a TX aggregation
2022 * session being stopped even before they OK'ed starting it by
2023 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2024 * might receive the addBA frame and send a delBA right away!
2026 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
2027 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
2028 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
2029 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
2030 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2032 enum ieee80211_ampdu_mlme_action {
2033 IEEE80211_AMPDU_RX_START,
2034 IEEE80211_AMPDU_RX_STOP,
2035 IEEE80211_AMPDU_TX_START,
2036 IEEE80211_AMPDU_TX_STOP,
2037 IEEE80211_AMPDU_TX_OPERATIONAL,
2041 * enum ieee80211_frame_release_type - frame release reason
2042 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2043 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2044 * frame received on trigger-enabled AC
2046 enum ieee80211_frame_release_type {
2047 IEEE80211_FRAME_RELEASE_PSPOLL,
2048 IEEE80211_FRAME_RELEASE_UAPSD,
2052 * enum ieee80211_rate_control_changed - flags to indicate what changed
2054 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2055 * to this station changed.
2056 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2057 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2058 * changed (in IBSS mode) due to discovering more information about
2061 enum ieee80211_rate_control_changed {
2062 IEEE80211_RC_BW_CHANGED = BIT(0),
2063 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2064 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2068 * struct ieee80211_ops - callbacks from mac80211 to the driver
2070 * This structure contains various callbacks that the driver may
2071 * handle or, in some cases, must handle, for example to configure
2072 * the hardware to a new channel or to transmit a frame.
2074 * @tx: Handler that 802.11 module calls for each transmitted frame.
2075 * skb contains the buffer starting from the IEEE 802.11 header.
2076 * The low-level driver should send the frame out based on
2077 * configuration in the TX control data. This handler should,
2078 * preferably, never fail and stop queues appropriately.
2081 * @start: Called before the first netdevice attached to the hardware
2082 * is enabled. This should turn on the hardware and must turn on
2083 * frame reception (for possibly enabled monitor interfaces.)
2084 * Returns negative error codes, these may be seen in userspace,
2086 * When the device is started it should not have a MAC address
2087 * to avoid acknowledging frames before a non-monitor device
2089 * Must be implemented and can sleep.
2091 * @stop: Called after last netdevice attached to the hardware
2092 * is disabled. This should turn off the hardware (at least
2093 * it must turn off frame reception.)
2094 * May be called right after add_interface if that rejects
2095 * an interface. If you added any work onto the mac80211 workqueue
2096 * you should ensure to cancel it on this callback.
2097 * Must be implemented and can sleep.
2099 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2100 * stop transmitting and doing any other configuration, and then
2101 * ask the device to suspend. This is only invoked when WoWLAN is
2102 * configured, otherwise the device is deconfigured completely and
2103 * reconfigured at resume time.
2104 * The driver may also impose special conditions under which it
2105 * wants to use the "normal" suspend (deconfigure), say if it only
2106 * supports WoWLAN when the device is associated. In this case, it
2107 * must return 1 from this function.
2109 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2110 * now resuming its operation, after this the device must be fully
2111 * functional again. If this returns an error, the only way out is
2112 * to also unregister the device. If it returns 1, then mac80211
2113 * will also go through the regular complete restart on resume.
2115 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2116 * modified. The reason is that device_set_wakeup_enable() is
2117 * supposed to be called when the configuration changes, not only
2120 * @add_interface: Called when a netdevice attached to the hardware is
2121 * enabled. Because it is not called for monitor mode devices, @start
2122 * and @stop must be implemented.
2123 * The driver should perform any initialization it needs before
2124 * the device can be enabled. The initial configuration for the
2125 * interface is given in the conf parameter.
2126 * The callback may refuse to add an interface by returning a
2127 * negative error code (which will be seen in userspace.)
2128 * Must be implemented and can sleep.
2130 * @change_interface: Called when a netdevice changes type. This callback
2131 * is optional, but only if it is supported can interface types be
2132 * switched while the interface is UP. The callback may sleep.
2133 * Note that while an interface is being switched, it will not be
2134 * found by the interface iteration callbacks.
2136 * @remove_interface: Notifies a driver that an interface is going down.
2137 * The @stop callback is called after this if it is the last interface
2138 * and no monitor interfaces are present.
2139 * When all interfaces are removed, the MAC address in the hardware
2140 * must be cleared so the device no longer acknowledges packets,
2141 * the mac_addr member of the conf structure is, however, set to the
2142 * MAC address of the device going away.
2143 * Hence, this callback must be implemented. It can sleep.
2145 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2146 * function to change hardware configuration, e.g., channel.
2147 * This function should never fail but returns a negative error code
2148 * if it does. The callback can sleep.
2150 * @bss_info_changed: Handler for configuration requests related to BSS
2151 * parameters that may vary during BSS's lifespan, and may affect low
2152 * level driver (e.g. assoc/disassoc status, erp parameters).
2153 * This function should not be used if no BSS has been set, unless
2154 * for association indication. The @changed parameter indicates which
2155 * of the bss parameters has changed when a call is made. The callback
2158 * @prepare_multicast: Prepare for multicast filter configuration.
2159 * This callback is optional, and its return value is passed
2160 * to configure_filter(). This callback must be atomic.
2162 * @configure_filter: Configure the device's RX filter.
2163 * See the section "Frame filtering" for more information.
2164 * This callback must be implemented and can sleep.
2166 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2167 * must be set or cleared for a given STA. Must be atomic.
2169 * @set_key: See the section "Hardware crypto acceleration"
2170 * This callback is only called between add_interface and
2171 * remove_interface calls, i.e. while the given virtual interface
2173 * Returns a negative error code if the key can't be added.
2174 * The callback can sleep.
2176 * @update_tkip_key: See the section "Hardware crypto acceleration"
2177 * This callback will be called in the context of Rx. Called for drivers
2178 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2179 * The callback must be atomic.
2181 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2182 * host is suspended, it can assign this callback to retrieve the data
2183 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2184 * After rekeying was done it should (for example during resume) notify
2185 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2187 * @hw_scan: Ask the hardware to service the scan request, no need to start
2188 * the scan state machine in stack. The scan must honour the channel
2189 * configuration done by the regulatory agent in the wiphy's
2190 * registered bands. The hardware (or the driver) needs to make sure
2191 * that power save is disabled.
2192 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2193 * entire IEs after the SSID, so that drivers need not look at these
2194 * at all but just send them after the SSID -- mac80211 includes the
2195 * (extended) supported rates and HT information (where applicable).
2196 * When the scan finishes, ieee80211_scan_completed() must be called;
2197 * note that it also must be called when the scan cannot finish due to
2198 * any error unless this callback returned a negative error code.
2199 * The callback can sleep.
2201 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2202 * The driver should ask the hardware to cancel the scan (if possible),
2203 * but the scan will be completed only after the driver will call
2204 * ieee80211_scan_completed().
2205 * This callback is needed for wowlan, to prevent enqueueing a new
2206 * scan_work after the low-level driver was already suspended.
2207 * The callback can sleep.
2209 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2210 * specific intervals. The driver must call the
2211 * ieee80211_sched_scan_results() function whenever it finds results.
2212 * This process will continue until sched_scan_stop is called.
2214 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2216 * @sw_scan_start: Notifier function that is called just before a software scan
2217 * is started. Can be NULL, if the driver doesn't need this notification.
2218 * The callback can sleep.
2220 * @sw_scan_complete: Notifier function that is called just after a
2221 * software scan finished. Can be NULL, if the driver doesn't need
2222 * this notification.
2223 * The callback can sleep.
2225 * @get_stats: Return low-level statistics.
2226 * Returns zero if statistics are available.
2227 * The callback can sleep.
2229 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2230 * callback should be provided to read the TKIP transmit IVs (both IV32
2231 * and IV16) for the given key from hardware.
2232 * The callback must be atomic.
2234 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2235 * if the device does fragmentation by itself; if this callback is
2236 * implemented then the stack will not do fragmentation.
2237 * The callback can sleep.
2239 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2240 * The callback can sleep.
2242 * @sta_add: Notifies low level driver about addition of an associated station,
2243 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2245 * @sta_remove: Notifies low level driver about removal of an associated
2246 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2248 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2249 * when a station is added to mac80211's station list. This callback
2250 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2251 * conditional. This callback can sleep.
2253 * @sta_remove_debugfs: Remove the debugfs files which were added using
2254 * @sta_add_debugfs. This callback can sleep.
2256 * @sta_notify: Notifies low level driver about power state transition of an
2257 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2258 * in AP mode, this callback will not be called when the flag
2259 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2261 * @sta_state: Notifies low level driver about state transition of a
2262 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2263 * This callback is mutually exclusive with @sta_add/@sta_remove.
2264 * It must not fail for down transitions but may fail for transitions
2265 * up the list of states.
2266 * The callback can sleep.
2268 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2269 * used to transmit to the station. The changes are advertised with bits
2270 * from &enum ieee80211_rate_control_changed and the values are reflected
2271 * in the station data. This callback should only be used when the driver
2272 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2273 * otherwise the rate control algorithm is notified directly.
2276 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2277 * bursting) for a hardware TX queue.
2278 * Returns a negative error code on failure.
2279 * The callback can sleep.
2281 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2282 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2283 * required function.
2284 * The callback can sleep.
2286 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2287 * Currently, this is only used for IBSS mode debugging. Is not a
2288 * required function.
2289 * The callback can sleep.
2291 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2292 * with other STAs in the IBSS. This is only used in IBSS mode. This
2293 * function is optional if the firmware/hardware takes full care of
2294 * TSF synchronization.
2295 * The callback can sleep.
2297 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2298 * This is needed only for IBSS mode and the result of this function is
2299 * used to determine whether to reply to Probe Requests.
2300 * Returns non-zero if this device sent the last beacon.
2301 * The callback can sleep.
2303 * @ampdu_action: Perform a certain A-MPDU action
2304 * The RA/TID combination determines the destination and TID we want
2305 * the ampdu action to be performed for. The action is defined through
2306 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2307 * is the first frame we expect to perform the action on. Notice
2308 * that TX/RX_STOP can pass NULL for this parameter.
2309 * The @buf_size parameter is only valid when the action is set to
2310 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2311 * buffer size (number of subframes) for this session -- the driver
2312 * may neither send aggregates containing more subframes than this
2313 * nor send aggregates in a way that lost frames would exceed the
2314 * buffer size. If just limiting the aggregate size, this would be
2315 * possible with a buf_size of 8:
2317 * - RX: 2....7 (lost frame #1)
2319 * which is invalid since #1 was now re-transmitted well past the
2320 * buffer size of 8. Correct ways to retransmit #1 would be:
2321 * - TX: 1 or 18 or 81
2322 * Even "189" would be wrong since 1 could be lost again.
2324 * Returns a negative error code on failure.
2325 * The callback can sleep.
2327 * @get_survey: Return per-channel survey information
2329 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2330 * need to set wiphy->rfkill_poll to %true before registration,
2331 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2332 * The callback can sleep.
2334 * @set_coverage_class: Set slot time for given coverage class as specified
2335 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2336 * accordingly. This callback is not required and may sleep.
2338 * @testmode_cmd: Implement a cfg80211 test mode command.
2339 * The callback can sleep.
2340 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2342 * @flush: Flush all pending frames from the hardware queue, making sure
2343 * that the hardware queues are empty. If the parameter @drop is set
2344 * to %true, pending frames may be dropped. The callback can sleep.
2346 * @channel_switch: Drivers that need (or want) to offload the channel
2347 * switch operation for CSAs received from the AP may implement this
2348 * callback. They must then call ieee80211_chswitch_done() to indicate
2349 * completion of the channel switch.
2351 * @napi_poll: Poll Rx queue for incoming data frames.
2353 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2354 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2355 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2356 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2358 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2360 * @remain_on_channel: Starts an off-channel period on the given channel, must
2361 * call back to ieee80211_ready_on_channel() when on that channel. Note
2362 * that normal channel traffic is not stopped as this is intended for hw
2363 * offload. Frames to transmit on the off-channel channel are transmitted
2364 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2365 * duration (which will always be non-zero) expires, the driver must call
2366 * ieee80211_remain_on_channel_expired().
2367 * Note that this callback may be called while the device is in IDLE and
2368 * must be accepted in this case.
2369 * This callback may sleep.
2370 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2371 * aborted before it expires. This callback may sleep.
2373 * @set_ringparam: Set tx and rx ring sizes.
2375 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2377 * @tx_frames_pending: Check if there is any pending frame in the hardware
2378 * queues before entering power save.
2380 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2381 * when transmitting a frame. Currently only legacy rates are handled.
2382 * The callback can sleep.
2383 * @rssi_callback: Notify driver when the average RSSI goes above/below
2384 * thresholds that were registered previously. The callback can sleep.
2386 * @release_buffered_frames: Release buffered frames according to the given
2387 * parameters. In the case where the driver buffers some frames for
2388 * sleeping stations mac80211 will use this callback to tell the driver
2389 * to release some frames, either for PS-poll or uAPSD.
2390 * Note that if the @more_data paramter is %false the driver must check
2391 * if there are more frames on the given TIDs, and if there are more than
2392 * the frames being released then it must still set the more-data bit in
2393 * the frame. If the @more_data parameter is %true, then of course the
2394 * more-data bit must always be set.
2395 * The @tids parameter tells the driver which TIDs to release frames
2396 * from, for PS-poll it will always have only a single bit set.
2397 * In the case this is used for a PS-poll initiated release, the
2398 * @num_frames parameter will always be 1 so code can be shared. In
2399 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2400 * on the TX status (and must report TX status) so that the PS-poll
2401 * period is properly ended. This is used to avoid sending multiple
2402 * responses for a retried PS-poll frame.
2403 * In the case this is used for uAPSD, the @num_frames parameter may be
2404 * bigger than one, but the driver may send fewer frames (it must send
2405 * at least one, however). In this case it is also responsible for
2406 * setting the EOSP flag in the QoS header of the frames. Also, when the
2407 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2408 * on the last frame in the SP. Alternatively, it may call the function
2409 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2410 * This callback must be atomic.
2411 * @allow_buffered_frames: Prepare device to allow the given number of frames
2412 * to go out to the given station. The frames will be sent by mac80211
2413 * via the usual TX path after this call. The TX information for frames
2414 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2415 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2416 * frames from multiple TIDs are released and the driver might reorder
2417 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2418 * on the last frame and clear it on all others and also handle the EOSP
2419 * bit in the QoS header correctly. Alternatively, it can also call the
2420 * ieee80211_sta_eosp_irqsafe() function.
2421 * The @tids parameter is a bitmap and tells the driver which TIDs the
2422 * frames will be on; it will at most have two bits set.
2423 * This callback must be atomic.
2425 * @get_et_sset_count: Ethtool API to get string-set count.
2427 * @get_et_stats: Ethtool API to get a set of u64 stats.
2429 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2430 * and perhaps other supported types of ethtool data-sets.
2432 * @get_rssi: Get current signal strength in dBm, the function is optional
2435 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2436 * before associated. In multi-channel scenarios, a virtual interface is
2437 * bound to a channel before it is associated, but as it isn't associated
2438 * yet it need not necessarily be given airtime, in particular since any
2439 * transmission to a P2P GO needs to be synchronized against the GO's
2440 * powersave state. mac80211 will call this function before transmitting a
2441 * management frame prior to having successfully associated to allow the
2442 * driver to give it channel time for the transmission, to get a response
2443 * and to be able to synchronize with the GO.
2444 * The callback will be called before each transmission and upon return
2445 * mac80211 will transmit the frame right away.
2446 * The callback is optional and can (should!) sleep.
2448 * @add_chanctx: Notifies device driver about new channel context creation.
2449 * @remove_chanctx: Notifies device driver about channel context destruction.
2450 * @change_chanctx: Notifies device driver about channel context changes that
2451 * may happen when combining different virtual interfaces on the same
2452 * channel context with different settings
2453 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2454 * to vif. Possible use is for hw queue remapping.
2455 * @unassign_vif_chanctx: Notifies device driver about channel context being
2457 * @start_ap: Start operation on the AP interface, this is called after all the
2458 * information in bss_conf is set and beacon can be retrieved. A channel
2459 * context is bound before this is called. Note that if the driver uses
2460 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2461 * just "paused" for scanning/ROC, which is indicated by the beacon being
2462 * disabled/enabled via @bss_info_changed.
2463 * @stop_ap: Stop operation on the AP interface.
2465 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2466 * reconfiguration has completed. This can help the driver implement the
2467 * reconfiguration step. This callback may sleep.
2469 struct ieee80211_ops {
2470 void (*tx)(struct ieee80211_hw *hw,
2471 struct ieee80211_tx_control *control,
2472 struct sk_buff *skb);
2473 int (*start)(struct ieee80211_hw *hw);
2474 void (*stop)(struct ieee80211_hw *hw);
2476 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2477 int (*resume)(struct ieee80211_hw *hw);
2478 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2480 int (*add_interface)(struct ieee80211_hw *hw,
2481 struct ieee80211_vif *vif);
2482 int (*change_interface)(struct ieee80211_hw *hw,
2483 struct ieee80211_vif *vif,
2484 enum nl80211_iftype new_type, bool p2p);
2485 void (*remove_interface)(struct ieee80211_hw *hw,
2486 struct ieee80211_vif *vif);
2487 int (*config)(struct ieee80211_hw *hw, u32 changed);
2488 void (*bss_info_changed)(struct ieee80211_hw *hw,
2489 struct ieee80211_vif *vif,
2490 struct ieee80211_bss_conf *info,
2493 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2494 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2496 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2497 struct netdev_hw_addr_list *mc_list);
2498 void (*configure_filter)(struct ieee80211_hw *hw,
2499 unsigned int changed_flags,
2500 unsigned int *total_flags,
2502 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2504 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2505 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2506 struct ieee80211_key_conf *key);
2507 void (*update_tkip_key)(struct ieee80211_hw *hw,
2508 struct ieee80211_vif *vif,
2509 struct ieee80211_key_conf *conf,
2510 struct ieee80211_sta *sta,
2511 u32 iv32, u16 *phase1key);
2512 void (*set_rekey_data)(struct ieee80211_hw *hw,
2513 struct ieee80211_vif *vif,
2514 struct cfg80211_gtk_rekey_data *data);
2515 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2516 struct cfg80211_scan_request *req);
2517 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2518 struct ieee80211_vif *vif);
2519 int (*sched_scan_start)(struct ieee80211_hw *hw,
2520 struct ieee80211_vif *vif,
2521 struct cfg80211_sched_scan_request *req,
2522 struct ieee80211_sched_scan_ies *ies);
2523 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2524 struct ieee80211_vif *vif);
2525 void (*sw_scan_start)(struct ieee80211_hw *hw);
2526 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2527 int (*get_stats)(struct ieee80211_hw *hw,
2528 struct ieee80211_low_level_stats *stats);
2529 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2530 u32 *iv32, u16 *iv16);
2531 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2532 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2533 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2534 struct ieee80211_sta *sta);
2535 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2536 struct ieee80211_sta *sta);
2537 #ifdef CONFIG_MAC80211_DEBUGFS
2538 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2539 struct ieee80211_vif *vif,
2540 struct ieee80211_sta *sta,
2541 struct dentry *dir);
2542 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2543 struct ieee80211_vif *vif,
2544 struct ieee80211_sta *sta,
2545 struct dentry *dir);
2547 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2548 enum sta_notify_cmd, struct ieee80211_sta *sta);
2549 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2550 struct ieee80211_sta *sta,
2551 enum ieee80211_sta_state old_state,
2552 enum ieee80211_sta_state new_state);
2553 void (*sta_rc_update)(struct ieee80211_hw *hw,
2554 struct ieee80211_vif *vif,
2555 struct ieee80211_sta *sta,
2557 int (*conf_tx)(struct ieee80211_hw *hw,
2558 struct ieee80211_vif *vif, u16 ac,
2559 const struct ieee80211_tx_queue_params *params);
2560 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2561 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2563 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2564 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2565 int (*ampdu_action)(struct ieee80211_hw *hw,
2566 struct ieee80211_vif *vif,
2567 enum ieee80211_ampdu_mlme_action action,
2568 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2570 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2571 struct survey_info *survey);
2572 void (*rfkill_poll)(struct ieee80211_hw *hw);
2573 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2574 #ifdef CONFIG_NL80211_TESTMODE
2575 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2576 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2577 struct netlink_callback *cb,
2578 void *data, int len);
2580 void (*flush)(struct ieee80211_hw *hw, bool drop);
2581 void (*channel_switch)(struct ieee80211_hw *hw,
2582 struct ieee80211_channel_switch *ch_switch);
2583 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2584 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2585 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2587 int (*remain_on_channel)(struct ieee80211_hw *hw,
2588 struct ieee80211_vif *vif,
2589 struct ieee80211_channel *chan,
2591 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2592 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2593 void (*get_ringparam)(struct ieee80211_hw *hw,
2594 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2595 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2596 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2597 const struct cfg80211_bitrate_mask *mask);
2598 void (*rssi_callback)(struct ieee80211_hw *hw,
2599 enum ieee80211_rssi_event rssi_event);
2601 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2602 struct ieee80211_sta *sta,
2603 u16 tids, int num_frames,
2604 enum ieee80211_frame_release_type reason,
2606 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2607 struct ieee80211_sta *sta,
2608 u16 tids, int num_frames,
2609 enum ieee80211_frame_release_type reason,
2612 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2613 struct ieee80211_vif *vif, int sset);
2614 void (*get_et_stats)(struct ieee80211_hw *hw,
2615 struct ieee80211_vif *vif,
2616 struct ethtool_stats *stats, u64 *data);
2617 void (*get_et_strings)(struct ieee80211_hw *hw,
2618 struct ieee80211_vif *vif,
2619 u32 sset, u8 *data);
2620 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2621 struct ieee80211_sta *sta, s8 *rssi_dbm);
2623 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2624 struct ieee80211_vif *vif);
2626 int (*add_chanctx)(struct ieee80211_hw *hw,
2627 struct ieee80211_chanctx_conf *ctx);
2628 void (*remove_chanctx)(struct ieee80211_hw *hw,
2629 struct ieee80211_chanctx_conf *ctx);
2630 void (*change_chanctx)(struct ieee80211_hw *hw,
2631 struct ieee80211_chanctx_conf *ctx,
2633 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2634 struct ieee80211_vif *vif,
2635 struct ieee80211_chanctx_conf *ctx);
2636 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2637 struct ieee80211_vif *vif,
2638 struct ieee80211_chanctx_conf *ctx);
2640 void (*restart_complete)(struct ieee80211_hw *hw);
2644 * ieee80211_alloc_hw - Allocate a new hardware device
2646 * This must be called once for each hardware device. The returned pointer
2647 * must be used to refer to this device when calling other functions.
2648 * mac80211 allocates a private data area for the driver pointed to by
2649 * @priv in &struct ieee80211_hw, the size of this area is given as
2652 * @priv_data_len: length of private data
2653 * @ops: callbacks for this device
2655 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2656 const struct ieee80211_ops *ops);
2659 * ieee80211_register_hw - Register hardware device
2661 * You must call this function before any other functions in
2662 * mac80211. Note that before a hardware can be registered, you
2663 * need to fill the contained wiphy's information.
2665 * @hw: the device to register as returned by ieee80211_alloc_hw()
2667 int ieee80211_register_hw(struct ieee80211_hw *hw);
2670 * struct ieee80211_tpt_blink - throughput blink description
2671 * @throughput: throughput in Kbit/sec
2672 * @blink_time: blink time in milliseconds
2673 * (full cycle, ie. one off + one on period)
2675 struct ieee80211_tpt_blink {
2681 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2682 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2683 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2684 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2685 * interface is connected in some way, including being an AP
2687 enum ieee80211_tpt_led_trigger_flags {
2688 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2689 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2690 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2693 #ifdef CONFIG_MAC80211_LEDS
2694 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2695 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2696 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2697 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2698 extern char *__ieee80211_create_tpt_led_trigger(
2699 struct ieee80211_hw *hw, unsigned int flags,
2700 const struct ieee80211_tpt_blink *blink_table,
2701 unsigned int blink_table_len);
2704 * ieee80211_get_tx_led_name - get name of TX LED
2706 * mac80211 creates a transmit LED trigger for each wireless hardware
2707 * that can be used to drive LEDs if your driver registers a LED device.
2708 * This function returns the name (or %NULL if not configured for LEDs)
2709 * of the trigger so you can automatically link the LED device.
2711 * @hw: the hardware to get the LED trigger name for
2713 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2715 #ifdef CONFIG_MAC80211_LEDS
2716 return __ieee80211_get_tx_led_name(hw);
2723 * ieee80211_get_rx_led_name - get name of RX LED
2725 * mac80211 creates a receive LED trigger for each wireless hardware
2726 * that can be used to drive LEDs if your driver registers a LED device.
2727 * This function returns the name (or %NULL if not configured for LEDs)
2728 * of the trigger so you can automatically link the LED device.
2730 * @hw: the hardware to get the LED trigger name for
2732 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2734 #ifdef CONFIG_MAC80211_LEDS
2735 return __ieee80211_get_rx_led_name(hw);
2742 * ieee80211_get_assoc_led_name - get name of association LED
2744 * mac80211 creates a association LED trigger for each wireless hardware
2745 * that can be used to drive LEDs if your driver registers a LED device.
2746 * This function returns the name (or %NULL if not configured for LEDs)
2747 * of the trigger so you can automatically link the LED device.
2749 * @hw: the hardware to get the LED trigger name for
2751 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2753 #ifdef CONFIG_MAC80211_LEDS
2754 return __ieee80211_get_assoc_led_name(hw);
2761 * ieee80211_get_radio_led_name - get name of radio LED
2763 * mac80211 creates a radio change LED trigger for each wireless hardware
2764 * that can be used to drive LEDs if your driver registers a LED device.
2765 * This function returns the name (or %NULL if not configured for LEDs)
2766 * of the trigger so you can automatically link the LED device.
2768 * @hw: the hardware to get the LED trigger name for
2770 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2772 #ifdef CONFIG_MAC80211_LEDS
2773 return __ieee80211_get_radio_led_name(hw);
2780 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2781 * @hw: the hardware to create the trigger for
2782 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2783 * @blink_table: the blink table -- needs to be ordered by throughput
2784 * @blink_table_len: size of the blink table
2786 * This function returns %NULL (in case of error, or if no LED
2787 * triggers are configured) or the name of the new trigger.
2788 * This function must be called before ieee80211_register_hw().
2790 static inline char *
2791 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2792 const struct ieee80211_tpt_blink *blink_table,
2793 unsigned int blink_table_len)
2795 #ifdef CONFIG_MAC80211_LEDS
2796 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2804 * ieee80211_unregister_hw - Unregister a hardware device
2806 * This function instructs mac80211 to free allocated resources
2807 * and unregister netdevices from the networking subsystem.
2809 * @hw: the hardware to unregister
2811 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2814 * ieee80211_free_hw - free hardware descriptor
2816 * This function frees everything that was allocated, including the
2817 * private data for the driver. You must call ieee80211_unregister_hw()
2818 * before calling this function.
2820 * @hw: the hardware to free
2822 void ieee80211_free_hw(struct ieee80211_hw *hw);
2825 * ieee80211_restart_hw - restart hardware completely
2827 * Call this function when the hardware was restarted for some reason
2828 * (hardware error, ...) and the driver is unable to restore its state
2829 * by itself. mac80211 assumes that at this point the driver/hardware
2830 * is completely uninitialised and stopped, it starts the process by
2831 * calling the ->start() operation. The driver will need to reset all
2832 * internal state that it has prior to calling this function.
2834 * @hw: the hardware to restart
2836 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2838 /** ieee80211_napi_schedule - schedule NAPI poll
2840 * Use this function to schedule NAPI polling on a device.
2842 * @hw: the hardware to start polling
2844 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2846 /** ieee80211_napi_complete - complete NAPI polling
2848 * Use this function to finish NAPI polling on a device.
2850 * @hw: the hardware to stop polling
2852 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2855 * ieee80211_rx - receive frame
2857 * Use this function to hand received frames to mac80211. The receive
2858 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2859 * paged @skb is used, the driver is recommended to put the ieee80211
2860 * header of the frame on the linear part of the @skb to avoid memory
2861 * allocation and/or memcpy by the stack.
2863 * This function may not be called in IRQ context. Calls to this function
2864 * for a single hardware must be synchronized against each other. Calls to
2865 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2866 * mixed for a single hardware.
2868 * In process context use instead ieee80211_rx_ni().
2870 * @hw: the hardware this frame came in on
2871 * @skb: the buffer to receive, owned by mac80211 after this call
2873 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2876 * ieee80211_rx_irqsafe - receive frame
2878 * Like ieee80211_rx() but can be called in IRQ context
2879 * (internally defers to a tasklet.)
2881 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2882 * be mixed for a single hardware.
2884 * @hw: the hardware this frame came in on
2885 * @skb: the buffer to receive, owned by mac80211 after this call
2887 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2890 * ieee80211_rx_ni - receive frame (in process context)
2892 * Like ieee80211_rx() but can be called in process context
2893 * (internally disables bottom halves).
2895 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2896 * not be mixed for a single hardware.
2898 * @hw: the hardware this frame came in on
2899 * @skb: the buffer to receive, owned by mac80211 after this call
2901 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2902 struct sk_buff *skb)
2905 ieee80211_rx(hw, skb);
2910 * ieee80211_sta_ps_transition - PS transition for connected sta
2912 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2913 * flag set, use this function to inform mac80211 about a connected station
2914 * entering/leaving PS mode.
2916 * This function may not be called in IRQ context or with softirqs enabled.
2918 * Calls to this function for a single hardware must be synchronized against
2921 * The function returns -EINVAL when the requested PS mode is already set.
2923 * @sta: currently connected sta
2924 * @start: start or stop PS
2926 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2929 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2930 * (in process context)
2932 * Like ieee80211_sta_ps_transition() but can be called in process context
2933 * (internally disables bottom halves). Concurrent call restriction still
2936 * @sta: currently connected sta
2937 * @start: start or stop PS
2939 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2945 ret = ieee80211_sta_ps_transition(sta, start);
2952 * The TX headroom reserved by mac80211 for its own tx_status functions.
2953 * This is enough for the radiotap header.
2955 #define IEEE80211_TX_STATUS_HEADROOM 14
2958 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2959 * @sta: &struct ieee80211_sta pointer for the sleeping station
2960 * @tid: the TID that has buffered frames
2961 * @buffered: indicates whether or not frames are buffered for this TID
2963 * If a driver buffers frames for a powersave station instead of passing
2964 * them back to mac80211 for retransmission, the station may still need
2965 * to be told that there are buffered frames via the TIM bit.
2967 * This function informs mac80211 whether or not there are frames that are
2968 * buffered in the driver for a given TID; mac80211 can then use this data
2969 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2970 * call! Beware of the locking!)
2972 * If all frames are released to the station (due to PS-poll or uAPSD)
2973 * then the driver needs to inform mac80211 that there no longer are
2974 * frames buffered. However, when the station wakes up mac80211 assumes
2975 * that all buffered frames will be transmitted and clears this data,
2976 * drivers need to make sure they inform mac80211 about all buffered
2977 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2979 * Note that technically mac80211 only needs to know this per AC, not per
2980 * TID, but since driver buffering will inevitably happen per TID (since
2981 * it is related to aggregation) it is easier to make mac80211 map the
2982 * TID to the AC as required instead of keeping track in all drivers that
2985 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2986 u8 tid, bool buffered);
2989 * ieee80211_tx_status - transmit status callback
2991 * Call this function for all transmitted frames after they have been
2992 * transmitted. It is permissible to not call this function for
2993 * multicast frames but this can affect statistics.
2995 * This function may not be called in IRQ context. Calls to this function
2996 * for a single hardware must be synchronized against each other. Calls
2997 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2998 * may not be mixed for a single hardware.
3000 * @hw: the hardware the frame was transmitted by
3001 * @skb: the frame that was transmitted, owned by mac80211 after this call
3003 void ieee80211_tx_status(struct ieee80211_hw *hw,
3004 struct sk_buff *skb);
3007 * ieee80211_tx_status_ni - transmit status callback (in process context)
3009 * Like ieee80211_tx_status() but can be called in process context.
3011 * Calls to this function, ieee80211_tx_status() and
3012 * ieee80211_tx_status_irqsafe() may not be mixed
3013 * for a single hardware.
3015 * @hw: the hardware the frame was transmitted by
3016 * @skb: the frame that was transmitted, owned by mac80211 after this call
3018 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3019 struct sk_buff *skb)
3022 ieee80211_tx_status(hw, skb);
3027 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3029 * Like ieee80211_tx_status() but can be called in IRQ context
3030 * (internally defers to a tasklet.)
3032 * Calls to this function, ieee80211_tx_status() and
3033 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3035 * @hw: the hardware the frame was transmitted by
3036 * @skb: the frame that was transmitted, owned by mac80211 after this call
3038 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3039 struct sk_buff *skb);
3042 * ieee80211_report_low_ack - report non-responding station
3044 * When operating in AP-mode, call this function to report a non-responding
3047 * @sta: the non-responding connected sta
3048 * @num_packets: number of packets sent to @sta without a response
3050 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3053 * ieee80211_beacon_get_tim - beacon generation function
3054 * @hw: pointer obtained from ieee80211_alloc_hw().
3055 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3056 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3057 * Set to 0 if invalid (in non-AP modes).
3058 * @tim_length: pointer to variable that will receive the TIM IE length,
3059 * (including the ID and length bytes!).
3060 * Set to 0 if invalid (in non-AP modes).
3062 * If the driver implements beaconing modes, it must use this function to
3063 * obtain the beacon frame/template.
3065 * If the beacon frames are generated by the host system (i.e., not in
3066 * hardware/firmware), the driver uses this function to get each beacon
3067 * frame from mac80211 -- it is responsible for calling this function
3068 * before the beacon is needed (e.g. based on hardware interrupt).
3070 * If the beacon frames are generated by the device, then the driver
3071 * must use the returned beacon as the template and change the TIM IE
3072 * according to the current DTIM parameters/TIM bitmap.
3074 * The driver is responsible for freeing the returned skb.
3076 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3077 struct ieee80211_vif *vif,
3078 u16 *tim_offset, u16 *tim_length);
3081 * ieee80211_beacon_get - beacon generation function
3082 * @hw: pointer obtained from ieee80211_alloc_hw().
3083 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3085 * See ieee80211_beacon_get_tim().
3087 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3088 struct ieee80211_vif *vif)
3090 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3094 * ieee80211_proberesp_get - retrieve a Probe Response template
3095 * @hw: pointer obtained from ieee80211_alloc_hw().
3096 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3098 * Creates a Probe Response template which can, for example, be uploaded to
3099 * hardware. The destination address should be set by the caller.
3101 * Can only be called in AP mode.
3103 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3104 struct ieee80211_vif *vif);
3107 * ieee80211_pspoll_get - retrieve a PS Poll template
3108 * @hw: pointer obtained from ieee80211_alloc_hw().
3109 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3111 * Creates a PS Poll a template which can, for example, uploaded to
3112 * hardware. The template must be updated after association so that correct
3113 * AID, BSSID and MAC address is used.
3115 * Note: Caller (or hardware) is responsible for setting the
3116 * &IEEE80211_FCTL_PM bit.
3118 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3119 struct ieee80211_vif *vif);
3122 * ieee80211_nullfunc_get - retrieve a nullfunc template
3123 * @hw: pointer obtained from ieee80211_alloc_hw().
3124 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3126 * Creates a Nullfunc template which can, for example, uploaded to
3127 * hardware. The template must be updated after association so that correct
3128 * BSSID and address is used.
3130 * Note: Caller (or hardware) is responsible for setting the
3131 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3133 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3134 struct ieee80211_vif *vif);
3137 * ieee80211_probereq_get - retrieve a Probe Request template
3138 * @hw: pointer obtained from ieee80211_alloc_hw().
3139 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3140 * @ssid: SSID buffer
3141 * @ssid_len: length of SSID
3142 * @ie: buffer containing all IEs except SSID for the template
3143 * @ie_len: length of the IE buffer
3145 * Creates a Probe Request template which can, for example, be uploaded to
3148 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3149 struct ieee80211_vif *vif,
3150 const u8 *ssid, size_t ssid_len,
3151 const u8 *ie, size_t ie_len);
3154 * ieee80211_rts_get - RTS frame generation function
3155 * @hw: pointer obtained from ieee80211_alloc_hw().
3156 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3157 * @frame: pointer to the frame that is going to be protected by the RTS.
3158 * @frame_len: the frame length (in octets).
3159 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3160 * @rts: The buffer where to store the RTS frame.
3162 * If the RTS frames are generated by the host system (i.e., not in
3163 * hardware/firmware), the low-level driver uses this function to receive
3164 * the next RTS frame from the 802.11 code. The low-level is responsible
3165 * for calling this function before and RTS frame is needed.
3167 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3168 const void *frame, size_t frame_len,
3169 const struct ieee80211_tx_info *frame_txctl,
3170 struct ieee80211_rts *rts);
3173 * ieee80211_rts_duration - Get the duration field for an RTS frame
3174 * @hw: pointer obtained from ieee80211_alloc_hw().
3175 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3176 * @frame_len: the length of the frame that is going to be protected by the RTS.
3177 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3179 * If the RTS is generated in firmware, but the host system must provide
3180 * the duration field, the low-level driver uses this function to receive
3181 * the duration field value in little-endian byteorder.
3183 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3184 struct ieee80211_vif *vif, size_t frame_len,
3185 const struct ieee80211_tx_info *frame_txctl);
3188 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3189 * @hw: pointer obtained from ieee80211_alloc_hw().
3190 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3191 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3192 * @frame_len: the frame length (in octets).
3193 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3194 * @cts: The buffer where to store the CTS-to-self frame.
3196 * If the CTS-to-self frames are generated by the host system (i.e., not in
3197 * hardware/firmware), the low-level driver uses this function to receive
3198 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3199 * for calling this function before and CTS-to-self frame is needed.
3201 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3202 struct ieee80211_vif *vif,
3203 const void *frame, size_t frame_len,
3204 const struct ieee80211_tx_info *frame_txctl,
3205 struct ieee80211_cts *cts);
3208 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3209 * @hw: pointer obtained from ieee80211_alloc_hw().
3210 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3211 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3212 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3214 * If the CTS-to-self is generated in firmware, but the host system must provide
3215 * the duration field, the low-level driver uses this function to receive
3216 * the duration field value in little-endian byteorder.
3218 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3219 struct ieee80211_vif *vif,
3221 const struct ieee80211_tx_info *frame_txctl);
3224 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3225 * @hw: pointer obtained from ieee80211_alloc_hw().
3226 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3227 * @band: the band to calculate the frame duration on
3228 * @frame_len: the length of the frame.
3229 * @rate: the rate at which the frame is going to be transmitted.
3231 * Calculate the duration field of some generic frame, given its
3232 * length and transmission rate (in 100kbps).
3234 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3235 struct ieee80211_vif *vif,
3236 enum ieee80211_band band,
3238 struct ieee80211_rate *rate);
3241 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3242 * @hw: pointer as obtained from ieee80211_alloc_hw().
3243 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3245 * Function for accessing buffered broadcast and multicast frames. If
3246 * hardware/firmware does not implement buffering of broadcast/multicast
3247 * frames when power saving is used, 802.11 code buffers them in the host
3248 * memory. The low-level driver uses this function to fetch next buffered
3249 * frame. In most cases, this is used when generating beacon frame. This
3250 * function returns a pointer to the next buffered skb or NULL if no more
3251 * buffered frames are available.
3253 * Note: buffered frames are returned only after DTIM beacon frame was
3254 * generated with ieee80211_beacon_get() and the low-level driver must thus
3255 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3256 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3257 * does not need to check for DTIM beacons separately and should be able to
3258 * use common code for all beacons.
3261 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3264 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3266 * This function returns the TKIP phase 1 key for the given IV32.
3268 * @keyconf: the parameter passed with the set key
3269 * @iv32: IV32 to get the P1K for
3270 * @p1k: a buffer to which the key will be written, as 5 u16 values
3272 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3273 u32 iv32, u16 *p1k);
3276 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3278 * This function returns the TKIP phase 1 key for the IV32 taken
3279 * from the given packet.
3281 * @keyconf: the parameter passed with the set key
3282 * @skb: the packet to take the IV32 value from that will be encrypted
3284 * @p1k: a buffer to which the key will be written, as 5 u16 values
3286 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3287 struct sk_buff *skb, u16 *p1k)
3289 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3290 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3291 u32 iv32 = get_unaligned_le32(&data[4]);
3293 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3297 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3299 * This function returns the TKIP phase 1 key for the given IV32
3300 * and transmitter address.
3302 * @keyconf: the parameter passed with the set key
3303 * @ta: TA that will be used with the key
3304 * @iv32: IV32 to get the P1K for
3305 * @p1k: a buffer to which the key will be written, as 5 u16 values
3307 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3308 const u8 *ta, u32 iv32, u16 *p1k);
3311 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3313 * This function computes the TKIP RC4 key for the IV values
3316 * @keyconf: the parameter passed with the set key
3317 * @skb: the packet to take the IV32/IV16 values from that will be
3318 * encrypted with this key
3319 * @p2k: a buffer to which the key will be written, 16 bytes
3321 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3322 struct sk_buff *skb, u8 *p2k);
3325 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3327 * This function computes the two AES-CMAC sub-keys, based on the
3328 * previously installed master key.
3330 * @keyconf: the parameter passed with the set key
3331 * @k1: a buffer to be filled with the 1st sub-key
3332 * @k2: a buffer to be filled with the 2nd sub-key
3334 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3338 * struct ieee80211_key_seq - key sequence counter
3340 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3341 * @ccmp: PN data, most significant byte first (big endian,
3342 * reverse order than in packet)
3343 * @aes_cmac: PN data, most significant byte first (big endian,
3344 * reverse order than in packet)
3346 struct ieee80211_key_seq {
3362 * ieee80211_get_key_tx_seq - get key TX sequence counter
3364 * @keyconf: the parameter passed with the set key
3365 * @seq: buffer to receive the sequence data
3367 * This function allows a driver to retrieve the current TX IV/PN
3368 * for the given key. It must not be called if IV generation is
3369 * offloaded to the device.
3371 * Note that this function may only be called when no TX processing
3372 * can be done concurrently, for example when queues are stopped
3373 * and the stop has been synchronized.
3375 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3376 struct ieee80211_key_seq *seq);
3379 * ieee80211_get_key_rx_seq - get key RX sequence counter
3381 * @keyconf: the parameter passed with the set key
3382 * @tid: The TID, or -1 for the management frame value (CCMP only);
3383 * the value on TID 0 is also used for non-QoS frames. For
3384 * CMAC, only TID 0 is valid.
3385 * @seq: buffer to receive the sequence data
3387 * This function allows a driver to retrieve the current RX IV/PNs
3388 * for the given key. It must not be called if IV checking is done
3389 * by the device and not by mac80211.
3391 * Note that this function may only be called when no RX processing
3392 * can be done concurrently.
3394 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3395 int tid, struct ieee80211_key_seq *seq);
3398 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3399 * @vif: virtual interface the rekeying was done on
3400 * @bssid: The BSSID of the AP, for checking association
3401 * @replay_ctr: the new replay counter after GTK rekeying
3402 * @gfp: allocation flags
3404 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3405 const u8 *replay_ctr, gfp_t gfp);
3408 * ieee80211_wake_queue - wake specific queue
3409 * @hw: pointer as obtained from ieee80211_alloc_hw().
3410 * @queue: queue number (counted from zero).
3412 * Drivers should use this function instead of netif_wake_queue.
3414 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3417 * ieee80211_stop_queue - stop specific queue
3418 * @hw: pointer as obtained from ieee80211_alloc_hw().
3419 * @queue: queue number (counted from zero).
3421 * Drivers should use this function instead of netif_stop_queue.
3423 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3426 * ieee80211_queue_stopped - test status of the queue
3427 * @hw: pointer as obtained from ieee80211_alloc_hw().
3428 * @queue: queue number (counted from zero).
3430 * Drivers should use this function instead of netif_stop_queue.
3433 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3436 * ieee80211_stop_queues - stop all queues
3437 * @hw: pointer as obtained from ieee80211_alloc_hw().
3439 * Drivers should use this function instead of netif_stop_queue.
3441 void ieee80211_stop_queues(struct ieee80211_hw *hw);
3444 * ieee80211_wake_queues - wake all queues
3445 * @hw: pointer as obtained from ieee80211_alloc_hw().
3447 * Drivers should use this function instead of netif_wake_queue.
3449 void ieee80211_wake_queues(struct ieee80211_hw *hw);
3452 * ieee80211_scan_completed - completed hardware scan
3454 * When hardware scan offload is used (i.e. the hw_scan() callback is
3455 * assigned) this function needs to be called by the driver to notify
3456 * mac80211 that the scan finished. This function can be called from
3457 * any context, including hardirq context.
3459 * @hw: the hardware that finished the scan
3460 * @aborted: set to true if scan was aborted
3462 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3465 * ieee80211_sched_scan_results - got results from scheduled scan
3467 * When a scheduled scan is running, this function needs to be called by the
3468 * driver whenever there are new scan results available.
3470 * @hw: the hardware that is performing scheduled scans
3472 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3475 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3477 * When a scheduled scan is running, this function can be called by
3478 * the driver if it needs to stop the scan to perform another task.
3479 * Usual scenarios are drivers that cannot continue the scheduled scan
3480 * while associating, for instance.
3482 * @hw: the hardware that is performing scheduled scans
3484 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3487 * enum ieee80211_interface_iteration_flags - interface iteration flags
3488 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3489 * been added to the driver; However, note that during hardware
3490 * reconfiguration (after restart_hw) it will iterate over a new
3491 * interface and over all the existing interfaces even if they
3492 * haven't been re-added to the driver yet.
3493 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3494 * interfaces, even if they haven't been re-added to the driver yet.
3496 enum ieee80211_interface_iteration_flags {
3497 IEEE80211_IFACE_ITER_NORMAL = 0,
3498 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3502 * ieee80211_iterate_active_interfaces - iterate active interfaces
3504 * This function iterates over the interfaces associated with a given
3505 * hardware that are currently active and calls the callback for them.
3506 * This function allows the iterator function to sleep, when the iterator
3507 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3509 * Does not iterate over a new interface during add_interface().
3511 * @hw: the hardware struct of which the interfaces should be iterated over
3512 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3513 * @iterator: the iterator function to call
3514 * @data: first argument of the iterator function
3516 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3518 void (*iterator)(void *data, u8 *mac,
3519 struct ieee80211_vif *vif),
3523 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3525 * This function iterates over the interfaces associated with a given
3526 * hardware that are currently active and calls the callback for them.
3527 * This function requires the iterator callback function to be atomic,
3528 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3529 * Does not iterate over a new interface during add_interface().
3531 * @hw: the hardware struct of which the interfaces should be iterated over
3532 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3533 * @iterator: the iterator function to call, cannot sleep
3534 * @data: first argument of the iterator function
3536 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3538 void (*iterator)(void *data,
3540 struct ieee80211_vif *vif),
3544 * ieee80211_queue_work - add work onto the mac80211 workqueue
3546 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3547 * This helper ensures drivers are not queueing work when they should not be.
3549 * @hw: the hardware struct for the interface we are adding work for
3550 * @work: the work we want to add onto the mac80211 workqueue
3552 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3555 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3557 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3560 * @hw: the hardware struct for the interface we are adding work for
3561 * @dwork: delayable work to queue onto the mac80211 workqueue
3562 * @delay: number of jiffies to wait before queueing
3564 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3565 struct delayed_work *dwork,
3566 unsigned long delay);
3569 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3570 * @sta: the station for which to start a BA session
3571 * @tid: the TID to BA on.
3572 * @timeout: session timeout value (in TUs)
3574 * Return: success if addBA request was sent, failure otherwise
3576 * Although mac80211/low level driver/user space application can estimate
3577 * the need to start aggregation on a certain RA/TID, the session level
3578 * will be managed by the mac80211.
3580 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3584 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3585 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3586 * @ra: receiver address of the BA session recipient.
3587 * @tid: the TID to BA on.
3589 * This function must be called by low level driver once it has
3590 * finished with preparations for the BA session. It can be called
3593 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3597 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3598 * @sta: the station whose BA session to stop
3599 * @tid: the TID to stop BA.
3601 * Return: negative error if the TID is invalid, or no aggregation active
3603 * Although mac80211/low level driver/user space application can estimate
3604 * the need to stop aggregation on a certain RA/TID, the session level
3605 * will be managed by the mac80211.
3607 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3610 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3611 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3612 * @ra: receiver address of the BA session recipient.
3613 * @tid: the desired TID to BA on.
3615 * This function must be called by low level driver once it has
3616 * finished with preparations for the BA session tear down. It
3617 * can be called from any context.
3619 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3623 * ieee80211_find_sta - find a station
3625 * @vif: virtual interface to look for station on
3626 * @addr: station's address
3628 * This function must be called under RCU lock and the
3629 * resulting pointer is only valid under RCU lock as well.
3631 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3635 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3637 * @hw: pointer as obtained from ieee80211_alloc_hw()
3638 * @addr: remote station's address
3639 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3641 * This function must be called under RCU lock and the
3642 * resulting pointer is only valid under RCU lock as well.
3644 * NOTE: You may pass NULL for localaddr, but then you will just get
3645 * the first STA that matches the remote address 'addr'.
3646 * We can have multiple STA associated with multiple
3647 * logical stations (e.g. consider a station connecting to another
3648 * BSSID on the same AP hardware without disconnecting first).
3649 * In this case, the result of this method with localaddr NULL
3652 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3654 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3656 const u8 *localaddr);
3659 * ieee80211_sta_block_awake - block station from waking up
3661 * @pubsta: the station
3662 * @block: whether to block or unblock
3664 * Some devices require that all frames that are on the queues
3665 * for a specific station that went to sleep are flushed before
3666 * a poll response or frames after the station woke up can be
3667 * delivered to that it. Note that such frames must be rejected
3668 * by the driver as filtered, with the appropriate status flag.
3670 * This function allows implementing this mode in a race-free
3673 * To do this, a driver must keep track of the number of frames
3674 * still enqueued for a specific station. If this number is not
3675 * zero when the station goes to sleep, the driver must call
3676 * this function to force mac80211 to consider the station to
3677 * be asleep regardless of the station's actual state. Once the
3678 * number of outstanding frames reaches zero, the driver must
3679 * call this function again to unblock the station. That will
3680 * cause mac80211 to be able to send ps-poll responses, and if
3681 * the station queried in the meantime then frames will also
3682 * be sent out as a result of this. Additionally, the driver
3683 * will be notified that the station woke up some time after
3684 * it is unblocked, regardless of whether the station actually
3685 * woke up while blocked or not.
3687 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3688 struct ieee80211_sta *pubsta, bool block);
3691 * ieee80211_sta_eosp - notify mac80211 about end of SP
3692 * @pubsta: the station
3694 * When a device transmits frames in a way that it can't tell
3695 * mac80211 in the TX status about the EOSP, it must clear the
3696 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3697 * This applies for PS-Poll as well as uAPSD.
3699 * Note that there is no non-_irqsafe version right now as
3700 * it wasn't needed, but just like _tx_status() and _rx()
3701 * must not be mixed in irqsafe/non-irqsafe versions, this
3702 * function must not be mixed with those either. Use the
3703 * all irqsafe, or all non-irqsafe, don't mix! If you need
3704 * the non-irqsafe version of this, you need to add it.
3706 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3709 * ieee80211_iter_keys - iterate keys programmed into the device
3710 * @hw: pointer obtained from ieee80211_alloc_hw()
3711 * @vif: virtual interface to iterate, may be %NULL for all
3712 * @iter: iterator function that will be called for each key
3713 * @iter_data: custom data to pass to the iterator function
3715 * This function can be used to iterate all the keys known to
3716 * mac80211, even those that weren't previously programmed into
3717 * the device. This is intended for use in WoWLAN if the device
3718 * needs reprogramming of the keys during suspend. Note that due
3719 * to locking reasons, it is also only safe to call this at few
3720 * spots since it must hold the RTNL and be able to sleep.
3722 * The order in which the keys are iterated matches the order
3723 * in which they were originally installed and handed to the
3726 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3727 struct ieee80211_vif *vif,
3728 void (*iter)(struct ieee80211_hw *hw,
3729 struct ieee80211_vif *vif,
3730 struct ieee80211_sta *sta,
3731 struct ieee80211_key_conf *key,
3736 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
3737 * @hw: pointre obtained from ieee80211_alloc_hw().
3738 * @iter: iterator function
3739 * @iter_data: data passed to iterator function
3741 * Iterate all active channel contexts. This function is atomic and
3742 * doesn't acquire any locks internally that might be held in other
3743 * places while calling into the driver.
3745 * The iterator will not find a context that's being added (during
3746 * the driver callback to add it) but will find it while it's being
3749 void ieee80211_iter_chan_contexts_atomic(
3750 struct ieee80211_hw *hw,
3751 void (*iter)(struct ieee80211_hw *hw,
3752 struct ieee80211_chanctx_conf *chanctx_conf,
3757 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3758 * @hw: pointer obtained from ieee80211_alloc_hw().
3759 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3761 * Creates a Probe Request template which can, for example, be uploaded to
3762 * hardware. The template is filled with bssid, ssid and supported rate
3763 * information. This function must only be called from within the
3764 * .bss_info_changed callback function and only in managed mode. The function
3765 * is only useful when the interface is associated, otherwise it will return
3768 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3769 struct ieee80211_vif *vif);
3772 * ieee80211_beacon_loss - inform hardware does not receive beacons
3774 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3776 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3777 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3778 * hardware is not receiving beacons with this function.
3780 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3783 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3785 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3787 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3788 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3789 * needs to inform if the connection to the AP has been lost.
3791 * This function will cause immediate change to disassociated state,
3792 * without connection recovery attempts.
3794 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3797 * ieee80211_resume_disconnect - disconnect from AP after resume
3799 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3801 * Instructs mac80211 to disconnect from the AP after resume.
3802 * Drivers can use this after WoWLAN if they know that the
3803 * connection cannot be kept up, for example because keys were
3804 * used while the device was asleep but the replay counters or
3805 * similar cannot be retrieved from the device during resume.
3807 * Note that due to implementation issues, if the driver uses
3808 * the reconfiguration functionality during resume the interface
3809 * will still be added as associated first during resume and then
3810 * disconnect normally later.
3812 * This function can only be called from the resume callback and
3813 * the driver must not be holding any of its own locks while it
3814 * calls this function, or at least not any locks it needs in the
3815 * key configuration paths (if it supports HW crypto).
3817 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3820 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3822 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3824 * Some hardware require full power save to manage simultaneous BT traffic
3825 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3826 * burst of BT traffic. The hardware gets information of BT traffic via
3827 * hardware co-existence lines, and consequentially requests mac80211 to
3828 * (temporarily) enter full psm.
3829 * This function will only temporarily disable dynamic PS, not enable PSM if
3830 * it was not already enabled.
3831 * The driver must make sure to re-enable dynamic PS using
3832 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3835 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3838 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3840 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3842 * This function restores dynamic PS after being temporarily disabled via
3843 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3844 * be coupled with an eventual call to this function.
3847 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3850 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3851 * rssi threshold triggered
3853 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3854 * @rssi_event: the RSSI trigger event type
3855 * @gfp: context flags
3857 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3858 * monitoring is configured with an rssi threshold, the driver will inform
3859 * whenever the rssi level reaches the threshold.
3861 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3862 enum nl80211_cqm_rssi_threshold_event rssi_event,
3866 * ieee80211_chswitch_done - Complete channel switch process
3867 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3868 * @success: make the channel switch successful or not
3870 * Complete the channel switch post-process: set the new operational channel
3871 * and wake up the suspended queues.
3873 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3876 * ieee80211_request_smps - request SM PS transition
3877 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3878 * @smps_mode: new SM PS mode
3880 * This allows the driver to request an SM PS transition in managed
3881 * mode. This is useful when the driver has more information than
3882 * the stack about possible interference, for example by bluetooth.
3884 void ieee80211_request_smps(struct ieee80211_vif *vif,
3885 enum ieee80211_smps_mode smps_mode);
3888 * ieee80211_ready_on_channel - notification of remain-on-channel start
3889 * @hw: pointer as obtained from ieee80211_alloc_hw()
3891 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3894 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3895 * @hw: pointer as obtained from ieee80211_alloc_hw()
3897 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3900 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3902 * in order not to harm the system performance and user experience, the device
3903 * may request not to allow any rx ba session and tear down existing rx ba
3904 * sessions based on system constraints such as periodic BT activity that needs
3905 * to limit wlan activity (eg.sco or a2dp)."
3906 * in such cases, the intention is to limit the duration of the rx ppdu and
3907 * therefore prevent the peer device to use a-mpdu aggregation.
3909 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3910 * @ba_rx_bitmap: Bit map of open rx ba per tid
3911 * @addr: & to bssid mac address
3913 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3917 * ieee80211_send_bar - send a BlockAckReq frame
3919 * can be used to flush pending frames from the peer's aggregation reorder
3922 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3923 * @ra: the peer's destination address
3924 * @tid: the TID of the aggregation session
3925 * @ssn: the new starting sequence number for the receiver
3927 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3929 /* Rate control API */
3932 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3934 * @hw: The hardware the algorithm is invoked for.
3935 * @sband: The band this frame is being transmitted on.
3936 * @bss_conf: the current BSS configuration
3937 * @skb: the skb that will be transmitted, the control information in it needs
3939 * @reported_rate: The rate control algorithm can fill this in to indicate
3940 * which rate should be reported to userspace as the current rate and
3941 * used for rate calculations in the mesh network.
3942 * @rts: whether RTS will be used for this frame because it is longer than the
3944 * @short_preamble: whether mac80211 will request short-preamble transmission
3945 * if the selected rate supports it
3946 * @max_rate_idx: user-requested maximum (legacy) rate
3947 * (deprecated; this will be removed once drivers get updated to use
3949 * @rate_idx_mask: user-requested (legacy) rate mask
3950 * @rate_idx_mcs_mask: user-requested MCS rate mask
3951 * @bss: whether this frame is sent out in AP or IBSS mode
3953 struct ieee80211_tx_rate_control {
3954 struct ieee80211_hw *hw;
3955 struct ieee80211_supported_band *sband;
3956 struct ieee80211_bss_conf *bss_conf;
3957 struct sk_buff *skb;
3958 struct ieee80211_tx_rate reported_rate;
3959 bool rts, short_preamble;
3962 u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
3966 struct rate_control_ops {
3967 struct module *module;
3969 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3970 void (*free)(void *priv);
3972 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3973 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3974 struct ieee80211_sta *sta, void *priv_sta);
3975 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3976 struct ieee80211_sta *sta, void *priv_sta,
3978 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3981 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3982 struct ieee80211_sta *sta, void *priv_sta,
3983 struct sk_buff *skb);
3984 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3985 struct ieee80211_tx_rate_control *txrc);
3987 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3988 struct dentry *dir);
3989 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3992 static inline int rate_supported(struct ieee80211_sta *sta,
3993 enum ieee80211_band band,
3996 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4000 * rate_control_send_low - helper for drivers for management/no-ack frames
4002 * Rate control algorithms that agree to use the lowest rate to
4003 * send management frames and NO_ACK data with the respective hw
4004 * retries should use this in the beginning of their mac80211 get_rate
4005 * callback. If true is returned the rate control can simply return.
4006 * If false is returned we guarantee that sta and sta and priv_sta is
4009 * Rate control algorithms wishing to do more intelligent selection of
4010 * rate for multicast/broadcast frames may choose to not use this.
4012 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4013 * that this may be null.
4014 * @priv_sta: private rate control structure. This may be null.
4015 * @txrc: rate control information we sholud populate for mac80211.
4017 bool rate_control_send_low(struct ieee80211_sta *sta,
4019 struct ieee80211_tx_rate_control *txrc);
4023 rate_lowest_index(struct ieee80211_supported_band *sband,
4024 struct ieee80211_sta *sta)
4028 for (i = 0; i < sband->n_bitrates; i++)
4029 if (rate_supported(sta, sband->band, i))
4032 /* warn when we cannot find a rate. */
4035 /* and return 0 (the lowest index) */
4040 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4041 struct ieee80211_sta *sta)
4045 for (i = 0; i < sband->n_bitrates; i++)
4046 if (rate_supported(sta, sband->band, i))
4051 int ieee80211_rate_control_register(struct rate_control_ops *ops);
4052 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
4055 conf_is_ht20(struct ieee80211_conf *conf)
4057 return conf->channel_type == NL80211_CHAN_HT20;
4061 conf_is_ht40_minus(struct ieee80211_conf *conf)
4063 return conf->channel_type == NL80211_CHAN_HT40MINUS;
4067 conf_is_ht40_plus(struct ieee80211_conf *conf)
4069 return conf->channel_type == NL80211_CHAN_HT40PLUS;
4073 conf_is_ht40(struct ieee80211_conf *conf)
4075 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
4079 conf_is_ht(struct ieee80211_conf *conf)
4081 return conf->channel_type != NL80211_CHAN_NO_HT;
4084 static inline enum nl80211_iftype
4085 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4089 case NL80211_IFTYPE_STATION:
4090 return NL80211_IFTYPE_P2P_CLIENT;
4091 case NL80211_IFTYPE_AP:
4092 return NL80211_IFTYPE_P2P_GO;
4100 static inline enum nl80211_iftype
4101 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4103 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4106 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4108 int rssi_max_thold);
4110 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4113 * ieee80211_ave_rssi - report the average rssi for the specified interface
4115 * @vif: the specified virtual interface
4117 * This function return the average rssi value for the requested interface.
4118 * It assumes that the given vif is valid.
4120 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4122 #endif /* MAC80211_H */