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_CHANNEL_TYPE: The channel type was changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 enum ieee80211_chanctx_change {
152 IEEE80211_CHANCTX_CHANGE_CHANNEL_TYPE = 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 * @channel: the channel to tune to
163 * @channel_type: the channel (HT) type
164 * @rx_chains_static: The number of RX chains that must always be
165 * active on the channel to receive MIMO transmissions
166 * @rx_chains_dynamic: The number of RX chains that must be enabled
167 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
168 * this will always be >= @rx_chains_always.
169 * @drv_priv: data area for driver use, will always be aligned to
170 * sizeof(void *), size is determined in hw information.
172 struct ieee80211_chanctx_conf {
173 struct ieee80211_channel *channel;
174 enum nl80211_channel_type channel_type;
176 u8 rx_chains_static, rx_chains_dynamic;
178 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
182 * enum ieee80211_bss_change - BSS change notification flags
184 * These flags are used with the bss_info_changed() callback
185 * to indicate which BSS parameter changed.
187 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
188 * also implies a change in the AID.
189 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
190 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
191 * @BSS_CHANGED_ERP_SLOT: slot timing changed
192 * @BSS_CHANGED_HT: 802.11n parameters changed
193 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
194 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
195 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
196 * reason (IBSS and managed mode)
197 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
198 * new beacon (beaconing modes)
199 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
200 * enabled/disabled (beaconing modes)
201 * @BSS_CHANGED_CQM: Connection quality monitor config changed
202 * @BSS_CHANGED_IBSS: IBSS join status changed
203 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
204 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
205 * that it is only ever disabled for station mode.
206 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
207 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
208 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
209 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
211 enum ieee80211_bss_change {
212 BSS_CHANGED_ASSOC = 1<<0,
213 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
214 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
215 BSS_CHANGED_ERP_SLOT = 1<<3,
216 BSS_CHANGED_HT = 1<<4,
217 BSS_CHANGED_BASIC_RATES = 1<<5,
218 BSS_CHANGED_BEACON_INT = 1<<6,
219 BSS_CHANGED_BSSID = 1<<7,
220 BSS_CHANGED_BEACON = 1<<8,
221 BSS_CHANGED_BEACON_ENABLED = 1<<9,
222 BSS_CHANGED_CQM = 1<<10,
223 BSS_CHANGED_IBSS = 1<<11,
224 BSS_CHANGED_ARP_FILTER = 1<<12,
225 BSS_CHANGED_QOS = 1<<13,
226 BSS_CHANGED_IDLE = 1<<14,
227 BSS_CHANGED_SSID = 1<<15,
228 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
229 BSS_CHANGED_PS = 1<<17,
231 /* when adding here, make sure to change ieee80211_reconfig */
235 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
236 * of addresses for an interface increase beyond this value, hardware ARP
237 * filtering will be disabled.
239 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
242 * enum ieee80211_rssi_event - RSSI threshold event
243 * An indicator for when RSSI goes below/above a certain threshold.
244 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
245 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
247 enum ieee80211_rssi_event {
253 * struct ieee80211_bss_conf - holds the BSS's changing parameters
255 * This structure keeps information about a BSS (and an association
256 * to that BSS) that can change during the lifetime of the BSS.
258 * @assoc: association status
259 * @ibss_joined: indicates whether this station is part of an IBSS
261 * @ibss_creator: indicates if a new IBSS network is being created
262 * @aid: association ID number, valid only when @assoc is true
263 * @use_cts_prot: use CTS protection
264 * @use_short_preamble: use 802.11b short preamble;
265 * if the hardware cannot handle this it must set the
266 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
267 * @use_short_slot: use short slot time (only relevant for ERP);
268 * if the hardware cannot handle this it must set the
269 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
270 * @dtim_period: num of beacons before the next DTIM, for beaconing,
271 * valid in station mode only while @assoc is true and if also
272 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
274 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
275 * as it may have been received during scanning long ago)
276 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
277 * the driver/device can use this to calculate synchronisation
278 * @beacon_int: beacon interval
279 * @assoc_capability: capabilities taken from assoc resp
280 * @basic_rates: bitmap of basic rates, each bit stands for an
281 * index into the rate table configured by the driver in
283 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
284 * @bssid: The BSSID for this BSS
285 * @enable_beacon: whether beaconing should be enabled or not
286 * @channel_type: Channel type for this BSS -- the hardware might be
287 * configured for HT40+ while this BSS only uses no-HT, for
289 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
290 * This field is only valid when the channel type is one of the HT types.
291 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
293 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
294 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
295 * may filter ARP queries targeted for other addresses than listed here.
296 * The driver must allow ARP queries targeted for all address listed here
297 * to pass through. An empty list implies no ARP queries need to pass.
298 * @arp_addr_cnt: Number of addresses currently on the list.
299 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
300 * filter ARP queries based on the @arp_addr_list, if disabled, the
301 * hardware must not perform any ARP filtering. Note, that the filter will
302 * be enabled also in promiscuous mode.
303 * @qos: This is a QoS-enabled BSS.
304 * @idle: This interface is idle. There's also a global idle flag in the
305 * hardware config which may be more appropriate depending on what
306 * your driver/device needs to do.
307 * @ps: power-save mode (STA only). This flag is NOT affected by
308 * offchannel/dynamic_ps operations.
309 * @ssid: The SSID of the current vif. Only valid in AP-mode.
310 * @ssid_len: Length of SSID given in @ssid.
311 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
313 struct ieee80211_bss_conf {
315 /* association related data */
316 bool assoc, ibss_joined;
319 /* erp related data */
321 bool use_short_preamble;
326 u16 assoc_capability;
330 int mcast_rate[IEEE80211_NUM_BANDS];
331 u16 ht_operation_mode;
334 enum nl80211_channel_type channel_type;
335 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
337 bool arp_filter_enabled;
341 u8 ssid[IEEE80211_MAX_SSID_LEN];
347 * enum mac80211_tx_control_flags - flags to describe transmission information/status
349 * These flags are used with the @flags member of &ieee80211_tx_info.
351 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
352 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
353 * number to this frame, taking care of not overwriting the fragment
354 * number and increasing the sequence number only when the
355 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
356 * assign sequence numbers to QoS-data frames but cannot do so correctly
357 * for non-QoS-data and management frames because beacons need them from
358 * that counter as well and mac80211 cannot guarantee proper sequencing.
359 * If this flag is set, the driver should instruct the hardware to
360 * assign a sequence number to the frame or assign one itself. Cf. IEEE
361 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
362 * beacons and always be clear for frames without a sequence number field.
363 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
364 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
366 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
367 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
368 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
369 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
370 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
371 * because the destination STA was in powersave mode. Note that to
372 * avoid race conditions, the filter must be set by the hardware or
373 * firmware upon receiving a frame that indicates that the station
374 * went to sleep (must be done on device to filter frames already on
375 * the queue) and may only be unset after mac80211 gives the OK for
376 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
377 * since only then is it guaranteed that no more frames are in the
379 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
380 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
381 * is for the whole aggregation.
382 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
383 * so consider using block ack request (BAR).
384 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
385 * set by rate control algorithms to indicate probe rate, will
386 * be cleared for fragmented frames (except on the last fragment)
387 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
388 * used to indicate that a pending frame requires TX processing before
389 * it can be sent out.
390 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
391 * used to indicate that a frame was already retried due to PS
392 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
393 * used to indicate frame should not be encrypted
394 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
395 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
396 * be sent although the station is in powersave mode.
397 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
398 * transmit function after the current frame, this can be used
399 * by drivers to kick the DMA queue only if unset or when the
401 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
402 * after TX status because the destination was asleep, it must not
403 * be modified again (no seqno assignment, crypto, etc.)
404 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
405 * MLME command (internal to mac80211 to figure out whether to send TX
406 * status to user space)
407 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
408 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
409 * frame and selects the maximum number of streams that it can use.
410 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
411 * the off-channel channel when a remain-on-channel offload is done
412 * in hardware -- normal packets still flow and are expected to be
413 * handled properly by the device.
414 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
415 * testing. It will be sent out with incorrect Michael MIC key to allow
416 * TKIP countermeasures to be tested.
417 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
418 * This flag is actually used for management frame especially for P2P
419 * frames not being sent at CCK rate in 2GHz band.
420 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
421 * when its status is reported the service period ends. For frames in
422 * an SP that mac80211 transmits, it is already set; for driver frames
423 * the driver may set this flag. It is also used to do the same for
425 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
426 * This flag is used to send nullfunc frame at minimum rate when
427 * the nullfunc is used for connection monitoring purpose.
428 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
429 * would be fragmented by size (this is optional, only used for
430 * monitor injection).
432 * Note: If you have to add new flags to the enumeration, then don't
433 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
435 enum mac80211_tx_control_flags {
436 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
437 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
438 IEEE80211_TX_CTL_NO_ACK = BIT(2),
439 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
440 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
441 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
442 IEEE80211_TX_CTL_AMPDU = BIT(6),
443 IEEE80211_TX_CTL_INJECTED = BIT(7),
444 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
445 IEEE80211_TX_STAT_ACK = BIT(9),
446 IEEE80211_TX_STAT_AMPDU = BIT(10),
447 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
448 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
449 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
450 IEEE80211_TX_INTFL_RETRIED = BIT(15),
451 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
452 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
453 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
454 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
455 /* hole at 20, use later */
456 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
457 IEEE80211_TX_CTL_LDPC = BIT(22),
458 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
459 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
460 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
461 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
462 IEEE80211_TX_STATUS_EOSP = BIT(28),
463 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
464 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
467 #define IEEE80211_TX_CTL_STBC_SHIFT 23
470 * This definition is used as a mask to clear all temporary flags, which are
471 * set by the tx handlers for each transmission attempt by the mac80211 stack.
473 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
474 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
475 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
476 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
477 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
478 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
479 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
480 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
483 * enum mac80211_rate_control_flags - per-rate flags set by the
484 * Rate Control algorithm.
486 * These flags are set by the Rate control algorithm for each rate during tx,
487 * in the @flags member of struct ieee80211_tx_rate.
489 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
490 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
491 * This is set if the current BSS requires ERP protection.
492 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
493 * @IEEE80211_TX_RC_MCS: HT rate.
494 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
496 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
497 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
498 * adjacent 20 MHz channels, if the current channel type is
499 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
500 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
502 enum mac80211_rate_control_flags {
503 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
504 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
505 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
507 /* rate index is an MCS rate number instead of an index */
508 IEEE80211_TX_RC_MCS = BIT(3),
509 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
510 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
511 IEEE80211_TX_RC_DUP_DATA = BIT(6),
512 IEEE80211_TX_RC_SHORT_GI = BIT(7),
516 /* there are 40 bytes if you don't need the rateset to be kept */
517 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
519 /* if you do need the rateset, then you have less space */
520 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
522 /* maximum number of rate stages */
523 #define IEEE80211_TX_MAX_RATES 4
526 * struct ieee80211_tx_rate - rate selection/status
528 * @idx: rate index to attempt to send with
529 * @flags: rate control flags (&enum mac80211_rate_control_flags)
530 * @count: number of tries in this rate before going to the next rate
532 * A value of -1 for @idx indicates an invalid rate and, if used
533 * in an array of retry rates, that no more rates should be tried.
535 * When used for transmit status reporting, the driver should
536 * always report the rate along with the flags it used.
538 * &struct ieee80211_tx_info contains an array of these structs
539 * in the control information, and it will be filled by the rate
540 * control algorithm according to what should be sent. For example,
541 * if this array contains, in the format { <idx>, <count> } the
543 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
544 * then this means that the frame should be transmitted
545 * up to twice at rate 3, up to twice at rate 2, and up to four
546 * times at rate 1 if it doesn't get acknowledged. Say it gets
547 * acknowledged by the peer after the fifth attempt, the status
548 * information should then contain
549 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
550 * since it was transmitted twice at rate 3, twice at rate 2
551 * and once at rate 1 after which we received an acknowledgement.
553 struct ieee80211_tx_rate {
560 * struct ieee80211_tx_info - skb transmit information
562 * This structure is placed in skb->cb for three uses:
563 * (1) mac80211 TX control - mac80211 tells the driver what to do
564 * (2) driver internal use (if applicable)
565 * (3) TX status information - driver tells mac80211 what happened
567 * @flags: transmit info flags, defined above
568 * @band: the band to transmit on (use for checking for races)
569 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
570 * @ack_frame_id: internal frame ID for TX status, used internally
571 * @control: union for control data
572 * @status: union for status data
573 * @driver_data: array of driver_data pointers
574 * @ampdu_ack_len: number of acked aggregated frames.
575 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
576 * @ampdu_len: number of aggregated frames.
577 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
578 * @ack_signal: signal strength of the ACK frame
580 struct ieee80211_tx_info {
581 /* common information */
594 struct ieee80211_tx_rate rates[
595 IEEE80211_TX_MAX_RATES];
599 /* only needed before rate control */
600 unsigned long jiffies;
602 /* NB: vif can be NULL for injected frames */
603 struct ieee80211_vif *vif;
604 struct ieee80211_key_conf *hw_key;
608 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
616 struct ieee80211_tx_rate driver_rates[
617 IEEE80211_TX_MAX_RATES];
618 void *rate_driver_data[
619 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
622 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
627 * struct ieee80211_sched_scan_ies - scheduled scan IEs
629 * This structure is used to pass the appropriate IEs to be used in scheduled
630 * scans for all bands. It contains both the IEs passed from the userspace
631 * and the ones generated by mac80211.
633 * @ie: array with the IEs for each supported band
634 * @len: array with the total length of the IEs for each band
636 struct ieee80211_sched_scan_ies {
637 u8 *ie[IEEE80211_NUM_BANDS];
638 size_t len[IEEE80211_NUM_BANDS];
641 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
643 return (struct ieee80211_tx_info *)skb->cb;
646 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
648 return (struct ieee80211_rx_status *)skb->cb;
652 * ieee80211_tx_info_clear_status - clear TX status
654 * @info: The &struct ieee80211_tx_info to be cleared.
656 * When the driver passes an skb back to mac80211, it must report
657 * a number of things in TX status. This function clears everything
658 * in the TX status but the rate control information (it does clear
659 * the count since you need to fill that in anyway).
661 * NOTE: You can only use this function if you do NOT use
662 * info->driver_data! Use info->rate_driver_data
663 * instead if you need only the less space that allows.
666 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
670 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
671 offsetof(struct ieee80211_tx_info, control.rates));
672 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
673 offsetof(struct ieee80211_tx_info, driver_rates));
674 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
675 /* clear the rate counts */
676 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
677 info->status.rates[i].count = 0;
680 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
681 memset(&info->status.ampdu_ack_len, 0,
682 sizeof(struct ieee80211_tx_info) -
683 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
688 * enum mac80211_rx_flags - receive flags
690 * These flags are used with the @flag member of &struct ieee80211_rx_status.
691 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
692 * Use together with %RX_FLAG_MMIC_STRIPPED.
693 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
694 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
695 * verification has been done by the hardware.
696 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
697 * If this flag is set, the stack cannot do any replay detection
698 * hence the driver or hardware will have to do that.
699 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
701 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
703 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
704 * field) is valid and contains the time the first symbol of the MPDU
705 * was received. This is useful in monitor mode and for proper IBSS
707 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
708 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
709 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
710 * @RX_FLAG_SHORT_GI: Short guard interval was used
711 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
712 * Valid only for data frames (mainly A-MPDU)
713 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
714 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
715 * to hw.radiotap_mcs_details to advertise that fact
716 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
717 * number (@ampdu_reference) must be populated and be a distinct number for
719 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
720 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
721 * monitoring purposes only
722 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
723 * subframes of a single A-MPDU
724 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
725 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
727 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
728 * is stored in the @ampdu_delimiter_crc field)
730 enum mac80211_rx_flags {
731 RX_FLAG_MMIC_ERROR = BIT(0),
732 RX_FLAG_DECRYPTED = BIT(1),
733 RX_FLAG_MMIC_STRIPPED = BIT(3),
734 RX_FLAG_IV_STRIPPED = BIT(4),
735 RX_FLAG_FAILED_FCS_CRC = BIT(5),
736 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
737 RX_FLAG_MACTIME_MPDU = BIT(7),
738 RX_FLAG_SHORTPRE = BIT(8),
740 RX_FLAG_40MHZ = BIT(10),
741 RX_FLAG_SHORT_GI = BIT(11),
742 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
743 RX_FLAG_HT_GF = BIT(13),
744 RX_FLAG_AMPDU_DETAILS = BIT(14),
745 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
746 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
747 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
748 RX_FLAG_AMPDU_IS_LAST = BIT(18),
749 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
750 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
754 * struct ieee80211_rx_status - receive status
756 * The low-level driver should provide this information (the subset
757 * supported by hardware) to the 802.11 code with each received
758 * frame, in the skb's control buffer (cb).
760 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
761 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
762 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
763 * it but can store it and pass it back to the driver for synchronisation
764 * @band: the active band when this frame was received
765 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
766 * @signal: signal strength when receiving this frame, either in dBm, in dB or
767 * unspecified depending on the hardware capabilities flags
768 * @IEEE80211_HW_SIGNAL_*
769 * @antenna: antenna used
770 * @rate_idx: index of data rate into band's supported rates or MCS index if
771 * HT rates are use (RX_FLAG_HT)
773 * @rx_flags: internal RX flags for mac80211
774 * @ampdu_reference: A-MPDU reference number, must be a different value for
775 * each A-MPDU but the same for each subframe within one A-MPDU
776 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
778 struct ieee80211_rx_status {
780 u32 device_timestamp;
789 u8 ampdu_delimiter_crc;
793 * enum ieee80211_conf_flags - configuration flags
795 * Flags to define PHY configuration options
797 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
798 * to determine for example whether to calculate timestamps for packets
799 * or not, do not use instead of filter flags!
800 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
801 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
802 * meaning that the hardware still wakes up for beacons, is able to
803 * transmit frames and receive the possible acknowledgment frames.
804 * Not to be confused with hardware specific wakeup/sleep states,
805 * driver is responsible for that. See the section "Powersave support"
807 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
808 * the driver should be prepared to handle configuration requests but
809 * may turn the device off as much as possible. Typically, this flag will
810 * be set when an interface is set UP but not associated or scanning, but
811 * it can also be unset in that case when monitor interfaces are active.
812 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
815 enum ieee80211_conf_flags {
816 IEEE80211_CONF_MONITOR = (1<<0),
817 IEEE80211_CONF_PS = (1<<1),
818 IEEE80211_CONF_IDLE = (1<<2),
819 IEEE80211_CONF_OFFCHANNEL = (1<<3),
824 * enum ieee80211_conf_changed - denotes which configuration changed
826 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
827 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
828 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
829 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
830 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
831 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
832 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
833 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
834 * Note that this is only valid if channel contexts are not used,
835 * otherwise each channel context has the number of chains listed.
837 enum ieee80211_conf_changed {
838 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
839 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
840 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
841 IEEE80211_CONF_CHANGE_PS = BIT(4),
842 IEEE80211_CONF_CHANGE_POWER = BIT(5),
843 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
844 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
845 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
849 * enum ieee80211_smps_mode - spatial multiplexing power save mode
851 * @IEEE80211_SMPS_AUTOMATIC: automatic
852 * @IEEE80211_SMPS_OFF: off
853 * @IEEE80211_SMPS_STATIC: static
854 * @IEEE80211_SMPS_DYNAMIC: dynamic
855 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
857 enum ieee80211_smps_mode {
858 IEEE80211_SMPS_AUTOMATIC,
860 IEEE80211_SMPS_STATIC,
861 IEEE80211_SMPS_DYNAMIC,
864 IEEE80211_SMPS_NUM_MODES,
868 * struct ieee80211_conf - configuration of the device
870 * This struct indicates how the driver shall configure the hardware.
872 * @flags: configuration flags defined above
874 * @listen_interval: listen interval in units of beacon interval
875 * @max_sleep_period: the maximum number of beacon intervals to sleep for
876 * before checking the beacon for a TIM bit (managed mode only); this
877 * value will be only achievable between DTIM frames, the hardware
878 * needs to check for the multicast traffic bit in DTIM beacons.
879 * This variable is valid only when the CONF_PS flag is set.
880 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
881 * in power saving. Power saving will not be enabled until a beacon
882 * has been received and the DTIM period is known.
883 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
884 * powersave documentation below. This variable is valid only when
885 * the CONF_PS flag is set.
887 * @power_level: requested transmit power (in dBm)
889 * @channel: the channel to tune to
890 * @channel_type: the channel (HT) type
892 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
893 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
894 * but actually means the number of transmissions not the number of retries
895 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
896 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
897 * number of transmissions not the number of retries
899 * @smps_mode: spatial multiplexing powersave mode; note that
900 * %IEEE80211_SMPS_STATIC is used when the device is not
901 * configured for an HT channel.
902 * Note that this is only valid if channel contexts are not used,
903 * otherwise each channel context has the number of chains listed.
905 struct ieee80211_conf {
907 int power_level, dynamic_ps_timeout;
908 int max_sleep_period;
913 u8 long_frame_max_tx_count, short_frame_max_tx_count;
915 struct ieee80211_channel *channel;
916 enum nl80211_channel_type channel_type;
917 enum ieee80211_smps_mode smps_mode;
921 * struct ieee80211_channel_switch - holds the channel switch data
923 * The information provided in this structure is required for channel switch
926 * @timestamp: value in microseconds of the 64-bit Time Synchronization
927 * Function (TSF) timer when the frame containing the channel switch
928 * announcement was received. This is simply the rx.mactime parameter
929 * the driver passed into mac80211.
930 * @block_tx: Indicates whether transmission must be blocked before the
931 * scheduled channel switch, as indicated by the AP.
932 * @channel: the new channel to switch to
933 * @count: the number of TBTT's until the channel switch event
935 struct ieee80211_channel_switch {
938 struct ieee80211_channel *channel;
943 * enum ieee80211_vif_flags - virtual interface flags
945 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
946 * on this virtual interface to avoid unnecessary CPU wakeups
947 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
948 * monitoring on this virtual interface -- i.e. it can monitor
949 * connection quality related parameters, such as the RSSI level and
950 * provide notifications if configured trigger levels are reached.
952 enum ieee80211_vif_flags {
953 IEEE80211_VIF_BEACON_FILTER = BIT(0),
954 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
958 * struct ieee80211_vif - per-interface data
960 * Data in this structure is continually present for driver
961 * use during the life of a virtual interface.
963 * @type: type of this virtual interface
964 * @bss_conf: BSS configuration for this interface, either our own
965 * or the BSS we're associated to
966 * @addr: address of this interface
967 * @p2p: indicates whether this AP or STA interface is a p2p
968 * interface, i.e. a GO or p2p-sta respectively
969 * @driver_flags: flags/capabilities the driver has for this interface,
970 * these need to be set (or cleared) when the interface is added
971 * or, if supported by the driver, the interface type is changed
972 * at runtime, mac80211 will never touch this field
973 * @hw_queue: hardware queue for each AC
974 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
975 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
976 * when it is not assigned. This pointer is RCU-protected due to the TX
977 * path needing to access it; even though the netdev carrier will always
978 * be off when it is %NULL there can still be races and packets could be
979 * processed after it switches back to %NULL.
980 * @drv_priv: data area for driver use, will always be aligned to
983 struct ieee80211_vif {
984 enum nl80211_iftype type;
985 struct ieee80211_bss_conf bss_conf;
990 u8 hw_queue[IEEE80211_NUM_ACS];
992 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
997 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1000 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1002 #ifdef CONFIG_MAC80211_MESH
1003 return vif->type == NL80211_IFTYPE_MESH_POINT;
1009 * enum ieee80211_key_flags - key flags
1011 * These flags are used for communication about keys between the driver
1012 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1014 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
1015 * that the STA this key will be used with could be using QoS.
1016 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1017 * driver to indicate that it requires IV generation for this
1019 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1020 * the driver for a TKIP key if it requires Michael MIC
1021 * generation in software.
1022 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1023 * that the key is pairwise rather then a shared key.
1024 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1025 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1026 * be done in software.
1027 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1028 * if space should be prepared for the IV, but the IV
1029 * itself should not be generated. Do not set together with
1030 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1031 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1032 * management frames. The flag can help drivers that have a hardware
1033 * crypto implementation that doesn't deal with management frames
1034 * properly by allowing them to not upload the keys to hardware and
1035 * fall back to software crypto. Note that this flag deals only with
1036 * RX, if your crypto engine can't deal with TX you can also set the
1037 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1039 enum ieee80211_key_flags {
1040 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
1041 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1042 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1043 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
1044 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
1045 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1046 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
1050 * struct ieee80211_key_conf - key information
1052 * This key information is given by mac80211 to the driver by
1053 * the set_key() callback in &struct ieee80211_ops.
1055 * @hw_key_idx: To be set by the driver, this is the key index the driver
1056 * wants to be given when a frame is transmitted and needs to be
1057 * encrypted in hardware.
1058 * @cipher: The key's cipher suite selector.
1059 * @flags: key flags, see &enum ieee80211_key_flags.
1060 * @keyidx: the key index (0-3)
1061 * @keylen: key material length
1062 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1064 * - Temporal Encryption Key (128 bits)
1065 * - Temporal Authenticator Tx MIC Key (64 bits)
1066 * - Temporal Authenticator Rx MIC Key (64 bits)
1067 * @icv_len: The ICV length for this key type
1068 * @iv_len: The IV length for this key type
1070 struct ieee80211_key_conf {
1082 * enum set_key_cmd - key command
1084 * Used with the set_key() callback in &struct ieee80211_ops, this
1085 * indicates whether a key is being removed or added.
1087 * @SET_KEY: a key is set
1088 * @DISABLE_KEY: a key must be disabled
1091 SET_KEY, DISABLE_KEY,
1095 * enum ieee80211_sta_state - station state
1097 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1098 * this is a special state for add/remove transitions
1099 * @IEEE80211_STA_NONE: station exists without special state
1100 * @IEEE80211_STA_AUTH: station is authenticated
1101 * @IEEE80211_STA_ASSOC: station is associated
1102 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1104 enum ieee80211_sta_state {
1105 /* NOTE: These need to be ordered correctly! */
1106 IEEE80211_STA_NOTEXIST,
1109 IEEE80211_STA_ASSOC,
1110 IEEE80211_STA_AUTHORIZED,
1114 * struct ieee80211_sta - station table entry
1116 * A station table entry represents a station we are possibly
1117 * communicating with. Since stations are RCU-managed in
1118 * mac80211, any ieee80211_sta pointer you get access to must
1119 * either be protected by rcu_read_lock() explicitly or implicitly,
1120 * or you must take good care to not use such a pointer after a
1121 * call to your sta_remove callback that removed it.
1123 * @addr: MAC address
1124 * @aid: AID we assigned to the station if we're an AP
1125 * @supp_rates: Bitmap of supported rates (per band)
1126 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1127 * @vht_cap: VHT capabilities of this STA; Not restricting any capabilities
1128 * of remote STA. Taking as is.
1129 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1130 * @drv_priv: data area for driver use, will always be aligned to
1131 * sizeof(void *), size is determined in hw information.
1132 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1133 * if wme is supported.
1134 * @max_sp: max Service Period. Only valid if wme is supported.
1136 struct ieee80211_sta {
1137 u32 supp_rates[IEEE80211_NUM_BANDS];
1140 struct ieee80211_sta_ht_cap ht_cap;
1141 struct ieee80211_sta_vht_cap vht_cap;
1147 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1151 * enum sta_notify_cmd - sta notify command
1153 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1154 * indicates if an associated station made a power state transition.
1156 * @STA_NOTIFY_SLEEP: a station is now sleeping
1157 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1159 enum sta_notify_cmd {
1160 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1164 * struct ieee80211_tx_control - TX control data
1166 * @sta: station table entry, this sta pointer may be NULL and
1167 * it is not allowed to copy the pointer, due to RCU.
1169 struct ieee80211_tx_control {
1170 struct ieee80211_sta *sta;
1174 * enum ieee80211_hw_flags - hardware flags
1176 * These flags are used to indicate hardware capabilities to
1177 * the stack. Generally, flags here should have their meaning
1178 * done in a way that the simplest hardware doesn't need setting
1179 * any particular flags. There are some exceptions to this rule,
1180 * however, so you are advised to review these flags carefully.
1182 * @IEEE80211_HW_HAS_RATE_CONTROL:
1183 * The hardware or firmware includes rate control, and cannot be
1184 * controlled by the stack. As such, no rate control algorithm
1185 * should be instantiated, and the TX rate reported to userspace
1186 * will be taken from the TX status instead of the rate control
1188 * Note that this requires that the driver implement a number of
1189 * callbacks so it has the correct information, it needs to have
1190 * the @set_rts_threshold callback and must look at the BSS config
1191 * @use_cts_prot for G/N protection, @use_short_slot for slot
1192 * timing in 2.4 GHz and @use_short_preamble for preambles for
1195 * @IEEE80211_HW_RX_INCLUDES_FCS:
1196 * Indicates that received frames passed to the stack include
1197 * the FCS at the end.
1199 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1200 * Some wireless LAN chipsets buffer broadcast/multicast frames
1201 * for power saving stations in the hardware/firmware and others
1202 * rely on the host system for such buffering. This option is used
1203 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1204 * multicast frames when there are power saving stations so that
1205 * the driver can fetch them with ieee80211_get_buffered_bc().
1207 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1208 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1210 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1211 * Hardware is not capable of receiving frames with short preamble on
1214 * @IEEE80211_HW_SIGNAL_UNSPEC:
1215 * Hardware can provide signal values but we don't know its units. We
1216 * expect values between 0 and @max_signal.
1217 * If possible please provide dB or dBm instead.
1219 * @IEEE80211_HW_SIGNAL_DBM:
1220 * Hardware gives signal values in dBm, decibel difference from
1221 * one milliwatt. This is the preferred method since it is standardized
1222 * between different devices. @max_signal does not need to be set.
1224 * @IEEE80211_HW_SPECTRUM_MGMT:
1225 * Hardware supports spectrum management defined in 802.11h
1226 * Measurement, Channel Switch, Quieting, TPC
1228 * @IEEE80211_HW_AMPDU_AGGREGATION:
1229 * Hardware supports 11n A-MPDU aggregation.
1231 * @IEEE80211_HW_SUPPORTS_PS:
1232 * Hardware has power save support (i.e. can go to sleep).
1234 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1235 * Hardware requires nullfunc frame handling in stack, implies
1236 * stack support for dynamic PS.
1238 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1239 * Hardware has support for dynamic PS.
1241 * @IEEE80211_HW_MFP_CAPABLE:
1242 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1244 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1245 * Hardware supports static spatial multiplexing powersave,
1246 * ie. can turn off all but one chain even on HT connections
1247 * that should be using more chains.
1249 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1250 * Hardware supports dynamic spatial multiplexing powersave,
1251 * ie. can turn off all but one chain and then wake the rest
1252 * up as required after, for example, rts/cts handshake.
1254 * @IEEE80211_HW_SUPPORTS_UAPSD:
1255 * Hardware supports Unscheduled Automatic Power Save Delivery
1256 * (U-APSD) in managed mode. The mode is configured with
1257 * conf_tx() operation.
1259 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1260 * Hardware can provide ack status reports of Tx frames to
1263 * @IEEE80211_HW_CONNECTION_MONITOR:
1264 * The hardware performs its own connection monitoring, including
1265 * periodic keep-alives to the AP and probing the AP on beacon loss.
1266 * When this flag is set, signaling beacon-loss will cause an immediate
1267 * change to disassociated state.
1269 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1270 * This device needs to know the DTIM period for the BSS before
1273 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1274 * per-station GTKs as used by IBSS RSN or during fast transition. If
1275 * the device doesn't support per-station GTKs, but can be asked not
1276 * to decrypt group addressed frames, then IBSS RSN support is still
1277 * possible but software crypto will be used. Advertise the wiphy flag
1278 * only in that case.
1280 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1281 * autonomously manages the PS status of connected stations. When
1282 * this flag is set mac80211 will not trigger PS mode for connected
1283 * stations based on the PM bit of incoming frames.
1284 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1285 * the PS mode of connected stations.
1287 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1288 * setup strictly in HW. mac80211 should not attempt to do this in
1291 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1292 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1295 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1296 * a virtual monitor interface when monitor interfaces are the only
1297 * active interfaces.
1299 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1300 * queue mapping in order to use different queues (not just one per AC)
1301 * for different virtual interfaces. See the doc section on HW queue
1302 * control for more details.
1304 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1305 * P2P Interface. This will be honoured even if more than one interface
1308 enum ieee80211_hw_flags {
1309 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1310 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1311 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1312 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1313 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1314 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1315 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1316 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1317 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1318 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1319 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1320 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1321 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1322 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1323 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1324 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1325 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1326 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1327 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1328 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1329 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1330 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1331 IEEE80211_HW_AP_LINK_PS = 1<<22,
1332 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1333 IEEE80211_HW_SCAN_WHILE_IDLE = 1<<24,
1334 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1338 * struct ieee80211_hw - hardware information and state
1340 * This structure contains the configuration and hardware
1341 * information for an 802.11 PHY.
1343 * @wiphy: This points to the &struct wiphy allocated for this
1344 * 802.11 PHY. You must fill in the @perm_addr and @dev
1345 * members of this structure using SET_IEEE80211_DEV()
1346 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1347 * bands (with channels, bitrates) are registered here.
1349 * @conf: &struct ieee80211_conf, device configuration, don't use.
1351 * @priv: pointer to private area that was allocated for driver use
1352 * along with this structure.
1354 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1356 * @extra_tx_headroom: headroom to reserve in each transmit skb
1357 * for use by the driver (e.g. for transmit headers.)
1359 * @channel_change_time: time (in microseconds) it takes to change channels.
1361 * @max_signal: Maximum value for signal (rssi) in RX information, used
1362 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1364 * @max_listen_interval: max listen interval in units of beacon interval
1367 * @queues: number of available hardware transmit queues for
1368 * data packets. WMM/QoS requires at least four, these
1369 * queues need to have configurable access parameters.
1371 * @rate_control_algorithm: rate control algorithm for this hardware.
1372 * If unset (NULL), the default algorithm will be used. Must be
1373 * set before calling ieee80211_register_hw().
1375 * @vif_data_size: size (in bytes) of the drv_priv data area
1376 * within &struct ieee80211_vif.
1377 * @sta_data_size: size (in bytes) of the drv_priv data area
1378 * within &struct ieee80211_sta.
1379 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1380 * within &struct ieee80211_chanctx_conf.
1382 * @max_rates: maximum number of alternate rate retry stages the hw
1384 * @max_report_rates: maximum number of alternate rate retry stages
1385 * the hw can report back.
1386 * @max_rate_tries: maximum number of tries for each stage
1388 * @napi_weight: weight used for NAPI polling. You must specify an
1389 * appropriate value here if a napi_poll operation is provided
1392 * @max_rx_aggregation_subframes: maximum buffer size (number of
1393 * sub-frames) to be used for A-MPDU block ack receiver
1395 * This is only relevant if the device has restrictions on the
1396 * number of subframes, if it relies on mac80211 to do reordering
1397 * it shouldn't be set.
1399 * @max_tx_aggregation_subframes: maximum number of subframes in an
1400 * aggregate an HT driver will transmit, used by the peer as a
1401 * hint to size its reorder buffer.
1403 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1404 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1406 * @radiotap_mcs_details: lists which MCS information can the HW
1407 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1408 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1409 * adding _BW is supported today.
1411 * @netdev_features: netdev features to be set in each netdev created
1412 * from this HW. Note only HW checksum features are currently
1413 * compatible with mac80211. Other feature bits will be rejected.
1415 struct ieee80211_hw {
1416 struct ieee80211_conf conf;
1417 struct wiphy *wiphy;
1418 const char *rate_control_algorithm;
1421 unsigned int extra_tx_headroom;
1422 int channel_change_time;
1425 int chanctx_data_size;
1428 u16 max_listen_interval;
1431 u8 max_report_rates;
1433 u8 max_rx_aggregation_subframes;
1434 u8 max_tx_aggregation_subframes;
1435 u8 offchannel_tx_hw_queue;
1436 u8 radiotap_mcs_details;
1437 netdev_features_t netdev_features;
1441 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1443 * @wiphy: the &struct wiphy which we want to query
1445 * mac80211 drivers can use this to get to their respective
1446 * &struct ieee80211_hw. Drivers wishing to get to their own private
1447 * structure can then access it via hw->priv. Note that mac802111 drivers should
1448 * not use wiphy_priv() to try to get their private driver structure as this
1449 * is already used internally by mac80211.
1451 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1454 * SET_IEEE80211_DEV - set device for 802.11 hardware
1456 * @hw: the &struct ieee80211_hw to set the device for
1457 * @dev: the &struct device of this 802.11 device
1459 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1461 set_wiphy_dev(hw->wiphy, dev);
1465 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1467 * @hw: the &struct ieee80211_hw to set the MAC address for
1468 * @addr: the address to set
1470 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1472 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1475 static inline struct ieee80211_rate *
1476 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1477 const struct ieee80211_tx_info *c)
1479 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1481 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1484 static inline struct ieee80211_rate *
1485 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1486 const struct ieee80211_tx_info *c)
1488 if (c->control.rts_cts_rate_idx < 0)
1490 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1493 static inline struct ieee80211_rate *
1494 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1495 const struct ieee80211_tx_info *c, int idx)
1497 if (c->control.rates[idx + 1].idx < 0)
1499 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1503 * ieee80211_free_txskb - free TX skb
1507 * Free a transmit skb. Use this funtion when some failure
1508 * to transmit happened and thus status cannot be reported.
1510 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1513 * DOC: Hardware crypto acceleration
1515 * mac80211 is capable of taking advantage of many hardware
1516 * acceleration designs for encryption and decryption operations.
1518 * The set_key() callback in the &struct ieee80211_ops for a given
1519 * device is called to enable hardware acceleration of encryption and
1520 * decryption. The callback takes a @sta parameter that will be NULL
1521 * for default keys or keys used for transmission only, or point to
1522 * the station information for the peer for individual keys.
1523 * Multiple transmission keys with the same key index may be used when
1524 * VLANs are configured for an access point.
1526 * When transmitting, the TX control data will use the @hw_key_idx
1527 * selected by the driver by modifying the &struct ieee80211_key_conf
1528 * pointed to by the @key parameter to the set_key() function.
1530 * The set_key() call for the %SET_KEY command should return 0 if
1531 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1532 * added; if you return 0 then hw_key_idx must be assigned to the
1533 * hardware key index, you are free to use the full u8 range.
1535 * When the cmd is %DISABLE_KEY then it must succeed.
1537 * Note that it is permissible to not decrypt a frame even if a key
1538 * for it has been uploaded to hardware, the stack will not make any
1539 * decision based on whether a key has been uploaded or not but rather
1540 * based on the receive flags.
1542 * The &struct ieee80211_key_conf structure pointed to by the @key
1543 * parameter is guaranteed to be valid until another call to set_key()
1544 * removes it, but it can only be used as a cookie to differentiate
1547 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1548 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1550 * The update_tkip_key() call updates the driver with the new phase 1 key.
1551 * This happens every time the iv16 wraps around (every 65536 packets). The
1552 * set_key() call will happen only once for each key (unless the AP did
1553 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1554 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1555 * handler is software decryption with wrap around of iv16.
1559 * DOC: Powersave support
1561 * mac80211 has support for various powersave implementations.
1563 * First, it can support hardware that handles all powersaving by itself,
1564 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1565 * flag. In that case, it will be told about the desired powersave mode
1566 * with the %IEEE80211_CONF_PS flag depending on the association status.
1567 * The hardware must take care of sending nullfunc frames when necessary,
1568 * i.e. when entering and leaving powersave mode. The hardware is required
1569 * to look at the AID in beacons and signal to the AP that it woke up when
1570 * it finds traffic directed to it.
1572 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1573 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1574 * with hardware wakeup and sleep states. Driver is responsible for waking
1575 * up the hardware before issuing commands to the hardware and putting it
1576 * back to sleep at appropriate times.
1578 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1579 * buffered multicast/broadcast frames after the beacon. Also it must be
1580 * possible to send frames and receive the acknowledment frame.
1582 * Other hardware designs cannot send nullfunc frames by themselves and also
1583 * need software support for parsing the TIM bitmap. This is also supported
1584 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1585 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1586 * required to pass up beacons. The hardware is still required to handle
1587 * waking up for multicast traffic; if it cannot the driver must handle that
1588 * as best as it can, mac80211 is too slow to do that.
1590 * Dynamic powersave is an extension to normal powersave in which the
1591 * hardware stays awake for a user-specified period of time after sending a
1592 * frame so that reply frames need not be buffered and therefore delayed to
1593 * the next wakeup. It's compromise of getting good enough latency when
1594 * there's data traffic and still saving significantly power in idle
1597 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1598 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1599 * flag and mac80211 will handle everything automatically. Additionally,
1600 * hardware having support for the dynamic PS feature may set the
1601 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1602 * dynamic PS mode itself. The driver needs to look at the
1603 * @dynamic_ps_timeout hardware configuration value and use it that value
1604 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1605 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1606 * enabled whenever user has enabled powersave.
1608 * Some hardware need to toggle a single shared antenna between WLAN and
1609 * Bluetooth to facilitate co-existence. These types of hardware set
1610 * limitations on the use of host controlled dynamic powersave whenever there
1611 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1612 * driver may request temporarily going into full power save, in order to
1613 * enable toggling the antenna between BT and WLAN. If the driver requests
1614 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1615 * temporarily set to zero until the driver re-enables dynamic powersave.
1617 * Driver informs U-APSD client support by enabling
1618 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1619 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1620 * Nullfunc frames and stay awake until the service period has ended. To
1621 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1622 * from that AC are transmitted with powersave enabled.
1624 * Note: U-APSD client mode is not yet supported with
1625 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1629 * DOC: Beacon filter support
1631 * Some hardware have beacon filter support to reduce host cpu wakeups
1632 * which will reduce system power consumption. It usually works so that
1633 * the firmware creates a checksum of the beacon but omits all constantly
1634 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1635 * beacon is forwarded to the host, otherwise it will be just dropped. That
1636 * way the host will only receive beacons where some relevant information
1637 * (for example ERP protection or WMM settings) have changed.
1639 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1640 * interface capability. The driver needs to enable beacon filter support
1641 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1642 * power save is enabled, the stack will not check for beacon loss and the
1643 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1645 * The time (or number of beacons missed) until the firmware notifies the
1646 * driver of a beacon loss event (which in turn causes the driver to call
1647 * ieee80211_beacon_loss()) should be configurable and will be controlled
1648 * by mac80211 and the roaming algorithm in the future.
1650 * Since there may be constantly changing information elements that nothing
1651 * in the software stack cares about, we will, in the future, have mac80211
1652 * tell the driver which information elements are interesting in the sense
1653 * that we want to see changes in them. This will include
1654 * - a list of information element IDs
1655 * - a list of OUIs for the vendor information element
1657 * Ideally, the hardware would filter out any beacons without changes in the
1658 * requested elements, but if it cannot support that it may, at the expense
1659 * of some efficiency, filter out only a subset. For example, if the device
1660 * doesn't support checking for OUIs it should pass up all changes in all
1661 * vendor information elements.
1663 * Note that change, for the sake of simplification, also includes information
1664 * elements appearing or disappearing from the beacon.
1666 * Some hardware supports an "ignore list" instead, just make sure nothing
1667 * that was requested is on the ignore list, and include commonly changing
1668 * information element IDs in the ignore list, for example 11 (BSS load) and
1669 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1670 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1671 * it could also include some currently unused IDs.
1674 * In addition to these capabilities, hardware should support notifying the
1675 * host of changes in the beacon RSSI. This is relevant to implement roaming
1676 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1677 * the received data packets). This can consist in notifying the host when
1678 * the RSSI changes significantly or when it drops below or rises above
1679 * configurable thresholds. In the future these thresholds will also be
1680 * configured by mac80211 (which gets them from userspace) to implement
1681 * them as the roaming algorithm requires.
1683 * If the hardware cannot implement this, the driver should ask it to
1684 * periodically pass beacon frames to the host so that software can do the
1685 * signal strength threshold checking.
1689 * DOC: Spatial multiplexing power save
1691 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1692 * power in an 802.11n implementation. For details on the mechanism
1693 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1694 * "11.2.3 SM power save".
1696 * The mac80211 implementation is capable of sending action frames
1697 * to update the AP about the station's SMPS mode, and will instruct
1698 * the driver to enter the specific mode. It will also announce the
1699 * requested SMPS mode during the association handshake. Hardware
1700 * support for this feature is required, and can be indicated by
1703 * The default mode will be "automatic", which nl80211/cfg80211
1704 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1705 * turned off otherwise.
1707 * To support this feature, the driver must set the appropriate
1708 * hardware support flags, and handle the SMPS flag to the config()
1709 * operation. It will then with this mechanism be instructed to
1710 * enter the requested SMPS mode while associated to an HT AP.
1714 * DOC: Frame filtering
1716 * mac80211 requires to see many management frames for proper
1717 * operation, and users may want to see many more frames when
1718 * in monitor mode. However, for best CPU usage and power consumption,
1719 * having as few frames as possible percolate through the stack is
1720 * desirable. Hence, the hardware should filter as much as possible.
1722 * To achieve this, mac80211 uses filter flags (see below) to tell
1723 * the driver's configure_filter() function which frames should be
1724 * passed to mac80211 and which should be filtered out.
1726 * Before configure_filter() is invoked, the prepare_multicast()
1727 * callback is invoked with the parameters @mc_count and @mc_list
1728 * for the combined multicast address list of all virtual interfaces.
1729 * It's use is optional, and it returns a u64 that is passed to
1730 * configure_filter(). Additionally, configure_filter() has the
1731 * arguments @changed_flags telling which flags were changed and
1732 * @total_flags with the new flag states.
1734 * If your device has no multicast address filters your driver will
1735 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1736 * parameter to see whether multicast frames should be accepted
1739 * All unsupported flags in @total_flags must be cleared.
1740 * Hardware does not support a flag if it is incapable of _passing_
1741 * the frame to the stack. Otherwise the driver must ignore
1742 * the flag, but not clear it.
1743 * You must _only_ clear the flag (announce no support for the
1744 * flag to mac80211) if you are not able to pass the packet type
1745 * to the stack (so the hardware always filters it).
1746 * So for example, you should clear @FIF_CONTROL, if your hardware
1747 * always filters control frames. If your hardware always passes
1748 * control frames to the kernel and is incapable of filtering them,
1749 * you do _not_ clear the @FIF_CONTROL flag.
1750 * This rule applies to all other FIF flags as well.
1754 * DOC: AP support for powersaving clients
1756 * In order to implement AP and P2P GO modes, mac80211 has support for
1757 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1758 * There currently is no support for sAPSD.
1760 * There is one assumption that mac80211 makes, namely that a client
1761 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1762 * Both are supported, and both can be used by the same client, but
1763 * they can't be used concurrently by the same client. This simplifies
1766 * The first thing to keep in mind is that there is a flag for complete
1767 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1768 * mac80211 expects the driver to handle most of the state machine for
1769 * powersaving clients and will ignore the PM bit in incoming frames.
1770 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1771 * stations' powersave transitions. In this mode, mac80211 also doesn't
1772 * handle PS-Poll/uAPSD.
1774 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1775 * PM bit in incoming frames for client powersave transitions. When a
1776 * station goes to sleep, we will stop transmitting to it. There is,
1777 * however, a race condition: a station might go to sleep while there is
1778 * data buffered on hardware queues. If the device has support for this
1779 * it will reject frames, and the driver should give the frames back to
1780 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1781 * cause mac80211 to retry the frame when the station wakes up. The
1782 * driver is also notified of powersave transitions by calling its
1783 * @sta_notify callback.
1785 * When the station is asleep, it has three choices: it can wake up,
1786 * it can PS-Poll, or it can possibly start a uAPSD service period.
1787 * Waking up is implemented by simply transmitting all buffered (and
1788 * filtered) frames to the station. This is the easiest case. When
1789 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1790 * will inform the driver of this with the @allow_buffered_frames
1791 * callback; this callback is optional. mac80211 will then transmit
1792 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1793 * on each frame. The last frame in the service period (or the only
1794 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1795 * indicate that it ends the service period; as this frame must have
1796 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1797 * When TX status is reported for this frame, the service period is
1798 * marked has having ended and a new one can be started by the peer.
1800 * Additionally, non-bufferable MMPDUs can also be transmitted by
1801 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1803 * Another race condition can happen on some devices like iwlwifi
1804 * when there are frames queued for the station and it wakes up
1805 * or polls; the frames that are already queued could end up being
1806 * transmitted first instead, causing reordering and/or wrong
1807 * processing of the EOSP. The cause is that allowing frames to be
1808 * transmitted to a certain station is out-of-band communication to
1809 * the device. To allow this problem to be solved, the driver can
1810 * call ieee80211_sta_block_awake() if frames are buffered when it
1811 * is notified that the station went to sleep. When all these frames
1812 * have been filtered (see above), it must call the function again
1813 * to indicate that the station is no longer blocked.
1815 * If the driver buffers frames in the driver for aggregation in any
1816 * way, it must use the ieee80211_sta_set_buffered() call when it is
1817 * notified of the station going to sleep to inform mac80211 of any
1818 * TIDs that have frames buffered. Note that when a station wakes up
1819 * this information is reset (hence the requirement to call it when
1820 * informed of the station going to sleep). Then, when a service
1821 * period starts for any reason, @release_buffered_frames is called
1822 * with the number of frames to be released and which TIDs they are
1823 * to come from. In this case, the driver is responsible for setting
1824 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1825 * to help the @more_data paramter is passed to tell the driver if
1826 * there is more data on other TIDs -- the TIDs to release frames
1827 * from are ignored since mac80211 doesn't know how many frames the
1828 * buffers for those TIDs contain.
1830 * If the driver also implement GO mode, where absence periods may
1831 * shorten service periods (or abort PS-Poll responses), it must
1832 * filter those response frames except in the case of frames that
1833 * are buffered in the driver -- those must remain buffered to avoid
1834 * reordering. Because it is possible that no frames are released
1835 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1836 * to indicate to mac80211 that the service period ended anyway.
1838 * Finally, if frames from multiple TIDs are released from mac80211
1839 * but the driver might reorder them, it must clear & set the flags
1840 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1841 * and also take care of the EOSP and MORE_DATA bits in the frame.
1842 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1846 * DOC: HW queue control
1848 * Before HW queue control was introduced, mac80211 only had a single static
1849 * assignment of per-interface AC software queues to hardware queues. This
1850 * was problematic for a few reasons:
1851 * 1) off-channel transmissions might get stuck behind other frames
1852 * 2) multiple virtual interfaces couldn't be handled correctly
1853 * 3) after-DTIM frames could get stuck behind other frames
1855 * To solve this, hardware typically uses multiple different queues for all
1856 * the different usages, and this needs to be propagated into mac80211 so it
1857 * won't have the same problem with the software queues.
1859 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1860 * flag that tells it that the driver implements its own queue control. To do
1861 * so, the driver will set up the various queues in each &struct ieee80211_vif
1862 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1863 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1864 * if necessary will queue the frame on the right software queue that mirrors
1865 * the hardware queue.
1866 * Additionally, the driver has to then use these HW queue IDs for the queue
1867 * management functions (ieee80211_stop_queue() et al.)
1869 * The driver is free to set up the queue mappings as needed, multiple virtual
1870 * interfaces may map to the same hardware queues if needed. The setup has to
1871 * happen during add_interface or change_interface callbacks. For example, a
1872 * driver supporting station+station and station+AP modes might decide to have
1873 * 10 hardware queues to handle different scenarios:
1875 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1876 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1877 * after-DTIM queue for AP: 8
1878 * off-channel queue: 9
1880 * It would then set up the hardware like this:
1881 * hw.offchannel_tx_hw_queue = 9
1883 * and the first virtual interface that is added as follows:
1884 * vif.hw_queue[IEEE80211_AC_VO] = 0
1885 * vif.hw_queue[IEEE80211_AC_VI] = 1
1886 * vif.hw_queue[IEEE80211_AC_BE] = 2
1887 * vif.hw_queue[IEEE80211_AC_BK] = 3
1888 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1889 * and the second virtual interface with 4-7.
1891 * If queue 6 gets full, for example, mac80211 would only stop the second
1892 * virtual interface's BE queue since virtual interface queues are per AC.
1894 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1895 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1896 * queue could potentially be shared since mac80211 will look at cab_queue when
1897 * a queue is stopped/woken even if the interface is not in AP mode.
1901 * enum ieee80211_filter_flags - hardware filter flags
1903 * These flags determine what the filter in hardware should be
1904 * programmed to let through and what should not be passed to the
1905 * stack. It is always safe to pass more frames than requested,
1906 * but this has negative impact on power consumption.
1908 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1909 * think of the BSS as your network segment and then this corresponds
1910 * to the regular ethernet device promiscuous mode.
1912 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1913 * by the user or if the hardware is not capable of filtering by
1914 * multicast address.
1916 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1917 * %RX_FLAG_FAILED_FCS_CRC for them)
1919 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1920 * the %RX_FLAG_FAILED_PLCP_CRC for them
1922 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1923 * to the hardware that it should not filter beacons or probe responses
1924 * by BSSID. Filtering them can greatly reduce the amount of processing
1925 * mac80211 needs to do and the amount of CPU wakeups, so you should
1926 * honour this flag if possible.
1928 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1929 * is not set then only those addressed to this station.
1931 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1933 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1934 * those addressed to this station.
1936 * @FIF_PROBE_REQ: pass probe request frames
1938 enum ieee80211_filter_flags {
1939 FIF_PROMISC_IN_BSS = 1<<0,
1940 FIF_ALLMULTI = 1<<1,
1942 FIF_PLCPFAIL = 1<<3,
1943 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1945 FIF_OTHER_BSS = 1<<6,
1947 FIF_PROBE_REQ = 1<<8,
1951 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1953 * These flags are used with the ampdu_action() callback in
1954 * &struct ieee80211_ops to indicate which action is needed.
1956 * Note that drivers MUST be able to deal with a TX aggregation
1957 * session being stopped even before they OK'ed starting it by
1958 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1959 * might receive the addBA frame and send a delBA right away!
1961 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1962 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1963 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1964 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1965 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1967 enum ieee80211_ampdu_mlme_action {
1968 IEEE80211_AMPDU_RX_START,
1969 IEEE80211_AMPDU_RX_STOP,
1970 IEEE80211_AMPDU_TX_START,
1971 IEEE80211_AMPDU_TX_STOP,
1972 IEEE80211_AMPDU_TX_OPERATIONAL,
1976 * enum ieee80211_frame_release_type - frame release reason
1977 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1978 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1979 * frame received on trigger-enabled AC
1981 enum ieee80211_frame_release_type {
1982 IEEE80211_FRAME_RELEASE_PSPOLL,
1983 IEEE80211_FRAME_RELEASE_UAPSD,
1987 * enum ieee80211_rate_control_changed - flags to indicate what changed
1989 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
1990 * to this station changed.
1991 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
1992 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
1993 * changed (in IBSS mode) due to discovering more information about
1996 enum ieee80211_rate_control_changed {
1997 IEEE80211_RC_BW_CHANGED = BIT(0),
1998 IEEE80211_RC_SMPS_CHANGED = BIT(1),
1999 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2003 * struct ieee80211_ops - callbacks from mac80211 to the driver
2005 * This structure contains various callbacks that the driver may
2006 * handle or, in some cases, must handle, for example to configure
2007 * the hardware to a new channel or to transmit a frame.
2009 * @tx: Handler that 802.11 module calls for each transmitted frame.
2010 * skb contains the buffer starting from the IEEE 802.11 header.
2011 * The low-level driver should send the frame out based on
2012 * configuration in the TX control data. This handler should,
2013 * preferably, never fail and stop queues appropriately.
2016 * @start: Called before the first netdevice attached to the hardware
2017 * is enabled. This should turn on the hardware and must turn on
2018 * frame reception (for possibly enabled monitor interfaces.)
2019 * Returns negative error codes, these may be seen in userspace,
2021 * When the device is started it should not have a MAC address
2022 * to avoid acknowledging frames before a non-monitor device
2024 * Must be implemented and can sleep.
2026 * @stop: Called after last netdevice attached to the hardware
2027 * is disabled. This should turn off the hardware (at least
2028 * it must turn off frame reception.)
2029 * May be called right after add_interface if that rejects
2030 * an interface. If you added any work onto the mac80211 workqueue
2031 * you should ensure to cancel it on this callback.
2032 * Must be implemented and can sleep.
2034 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2035 * stop transmitting and doing any other configuration, and then
2036 * ask the device to suspend. This is only invoked when WoWLAN is
2037 * configured, otherwise the device is deconfigured completely and
2038 * reconfigured at resume time.
2039 * The driver may also impose special conditions under which it
2040 * wants to use the "normal" suspend (deconfigure), say if it only
2041 * supports WoWLAN when the device is associated. In this case, it
2042 * must return 1 from this function.
2044 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2045 * now resuming its operation, after this the device must be fully
2046 * functional again. If this returns an error, the only way out is
2047 * to also unregister the device. If it returns 1, then mac80211
2048 * will also go through the regular complete restart on resume.
2050 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2051 * modified. The reason is that device_set_wakeup_enable() is
2052 * supposed to be called when the configuration changes, not only
2055 * @add_interface: Called when a netdevice attached to the hardware is
2056 * enabled. Because it is not called for monitor mode devices, @start
2057 * and @stop must be implemented.
2058 * The driver should perform any initialization it needs before
2059 * the device can be enabled. The initial configuration for the
2060 * interface is given in the conf parameter.
2061 * The callback may refuse to add an interface by returning a
2062 * negative error code (which will be seen in userspace.)
2063 * Must be implemented and can sleep.
2065 * @change_interface: Called when a netdevice changes type. This callback
2066 * is optional, but only if it is supported can interface types be
2067 * switched while the interface is UP. The callback may sleep.
2068 * Note that while an interface is being switched, it will not be
2069 * found by the interface iteration callbacks.
2071 * @remove_interface: Notifies a driver that an interface is going down.
2072 * The @stop callback is called after this if it is the last interface
2073 * and no monitor interfaces are present.
2074 * When all interfaces are removed, the MAC address in the hardware
2075 * must be cleared so the device no longer acknowledges packets,
2076 * the mac_addr member of the conf structure is, however, set to the
2077 * MAC address of the device going away.
2078 * Hence, this callback must be implemented. It can sleep.
2080 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2081 * function to change hardware configuration, e.g., channel.
2082 * This function should never fail but returns a negative error code
2083 * if it does. The callback can sleep.
2085 * @bss_info_changed: Handler for configuration requests related to BSS
2086 * parameters that may vary during BSS's lifespan, and may affect low
2087 * level driver (e.g. assoc/disassoc status, erp parameters).
2088 * This function should not be used if no BSS has been set, unless
2089 * for association indication. The @changed parameter indicates which
2090 * of the bss parameters has changed when a call is made. The callback
2093 * @prepare_multicast: Prepare for multicast filter configuration.
2094 * This callback is optional, and its return value is passed
2095 * to configure_filter(). This callback must be atomic.
2097 * @configure_filter: Configure the device's RX filter.
2098 * See the section "Frame filtering" for more information.
2099 * This callback must be implemented and can sleep.
2101 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2102 * must be set or cleared for a given STA. Must be atomic.
2104 * @set_key: See the section "Hardware crypto acceleration"
2105 * This callback is only called between add_interface and
2106 * remove_interface calls, i.e. while the given virtual interface
2108 * Returns a negative error code if the key can't be added.
2109 * The callback can sleep.
2111 * @update_tkip_key: See the section "Hardware crypto acceleration"
2112 * This callback will be called in the context of Rx. Called for drivers
2113 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2114 * The callback must be atomic.
2116 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2117 * host is suspended, it can assign this callback to retrieve the data
2118 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2119 * After rekeying was done it should (for example during resume) notify
2120 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2122 * @hw_scan: Ask the hardware to service the scan request, no need to start
2123 * the scan state machine in stack. The scan must honour the channel
2124 * configuration done by the regulatory agent in the wiphy's
2125 * registered bands. The hardware (or the driver) needs to make sure
2126 * that power save is disabled.
2127 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2128 * entire IEs after the SSID, so that drivers need not look at these
2129 * at all but just send them after the SSID -- mac80211 includes the
2130 * (extended) supported rates and HT information (where applicable).
2131 * When the scan finishes, ieee80211_scan_completed() must be called;
2132 * note that it also must be called when the scan cannot finish due to
2133 * any error unless this callback returned a negative error code.
2134 * The callback can sleep.
2136 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2137 * The driver should ask the hardware to cancel the scan (if possible),
2138 * but the scan will be completed only after the driver will call
2139 * ieee80211_scan_completed().
2140 * This callback is needed for wowlan, to prevent enqueueing a new
2141 * scan_work after the low-level driver was already suspended.
2142 * The callback can sleep.
2144 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2145 * specific intervals. The driver must call the
2146 * ieee80211_sched_scan_results() function whenever it finds results.
2147 * This process will continue until sched_scan_stop is called.
2149 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2151 * @sw_scan_start: Notifier function that is called just before a software scan
2152 * is started. Can be NULL, if the driver doesn't need this notification.
2153 * The callback can sleep.
2155 * @sw_scan_complete: Notifier function that is called just after a
2156 * software scan finished. Can be NULL, if the driver doesn't need
2157 * this notification.
2158 * The callback can sleep.
2160 * @get_stats: Return low-level statistics.
2161 * Returns zero if statistics are available.
2162 * The callback can sleep.
2164 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2165 * callback should be provided to read the TKIP transmit IVs (both IV32
2166 * and IV16) for the given key from hardware.
2167 * The callback must be atomic.
2169 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2170 * if the device does fragmentation by itself; if this callback is
2171 * implemented then the stack will not do fragmentation.
2172 * The callback can sleep.
2174 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2175 * The callback can sleep.
2177 * @sta_add: Notifies low level driver about addition of an associated station,
2178 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2180 * @sta_remove: Notifies low level driver about removal of an associated
2181 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2183 * @sta_notify: Notifies low level driver about power state transition of an
2184 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2185 * in AP mode, this callback will not be called when the flag
2186 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2188 * @sta_state: Notifies low level driver about state transition of a
2189 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2190 * This callback is mutually exclusive with @sta_add/@sta_remove.
2191 * It must not fail for down transitions but may fail for transitions
2192 * up the list of states.
2193 * The callback can sleep.
2195 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2196 * used to transmit to the station. The changes are advertised with bits
2197 * from &enum ieee80211_rate_control_changed and the values are reflected
2198 * in the station data. This callback should only be used when the driver
2199 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2200 * otherwise the rate control algorithm is notified directly.
2203 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2204 * bursting) for a hardware TX queue.
2205 * Returns a negative error code on failure.
2206 * The callback can sleep.
2208 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2209 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2210 * required function.
2211 * The callback can sleep.
2213 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2214 * Currently, this is only used for IBSS mode debugging. Is not a
2215 * required function.
2216 * The callback can sleep.
2218 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2219 * with other STAs in the IBSS. This is only used in IBSS mode. This
2220 * function is optional if the firmware/hardware takes full care of
2221 * TSF synchronization.
2222 * The callback can sleep.
2224 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2225 * This is needed only for IBSS mode and the result of this function is
2226 * used to determine whether to reply to Probe Requests.
2227 * Returns non-zero if this device sent the last beacon.
2228 * The callback can sleep.
2230 * @ampdu_action: Perform a certain A-MPDU action
2231 * The RA/TID combination determines the destination and TID we want
2232 * the ampdu action to be performed for. The action is defined through
2233 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2234 * is the first frame we expect to perform the action on. Notice
2235 * that TX/RX_STOP can pass NULL for this parameter.
2236 * The @buf_size parameter is only valid when the action is set to
2237 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2238 * buffer size (number of subframes) for this session -- the driver
2239 * may neither send aggregates containing more subframes than this
2240 * nor send aggregates in a way that lost frames would exceed the
2241 * buffer size. If just limiting the aggregate size, this would be
2242 * possible with a buf_size of 8:
2244 * - RX: 2....7 (lost frame #1)
2246 * which is invalid since #1 was now re-transmitted well past the
2247 * buffer size of 8. Correct ways to retransmit #1 would be:
2248 * - TX: 1 or 18 or 81
2249 * Even "189" would be wrong since 1 could be lost again.
2251 * Returns a negative error code on failure.
2252 * The callback can sleep.
2254 * @get_survey: Return per-channel survey information
2256 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2257 * need to set wiphy->rfkill_poll to %true before registration,
2258 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2259 * The callback can sleep.
2261 * @set_coverage_class: Set slot time for given coverage class as specified
2262 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2263 * accordingly. This callback is not required and may sleep.
2265 * @testmode_cmd: Implement a cfg80211 test mode command.
2266 * The callback can sleep.
2267 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2269 * @flush: Flush all pending frames from the hardware queue, making sure
2270 * that the hardware queues are empty. If the parameter @drop is set
2271 * to %true, pending frames may be dropped. The callback can sleep.
2273 * @channel_switch: Drivers that need (or want) to offload the channel
2274 * switch operation for CSAs received from the AP may implement this
2275 * callback. They must then call ieee80211_chswitch_done() to indicate
2276 * completion of the channel switch.
2278 * @napi_poll: Poll Rx queue for incoming data frames.
2280 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2281 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2282 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2283 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2285 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2287 * @remain_on_channel: Starts an off-channel period on the given channel, must
2288 * call back to ieee80211_ready_on_channel() when on that channel. Note
2289 * that normal channel traffic is not stopped as this is intended for hw
2290 * offload. Frames to transmit on the off-channel channel are transmitted
2291 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2292 * duration (which will always be non-zero) expires, the driver must call
2293 * ieee80211_remain_on_channel_expired().
2294 * Note that this callback may be called while the device is in IDLE and
2295 * must be accepted in this case.
2296 * This callback may sleep.
2297 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2298 * aborted before it expires. This callback may sleep.
2300 * @set_ringparam: Set tx and rx ring sizes.
2302 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2304 * @tx_frames_pending: Check if there is any pending frame in the hardware
2305 * queues before entering power save.
2307 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2308 * when transmitting a frame. Currently only legacy rates are handled.
2309 * The callback can sleep.
2310 * @rssi_callback: Notify driver when the average RSSI goes above/below
2311 * thresholds that were registered previously. The callback can sleep.
2313 * @release_buffered_frames: Release buffered frames according to the given
2314 * parameters. In the case where the driver buffers some frames for
2315 * sleeping stations mac80211 will use this callback to tell the driver
2316 * to release some frames, either for PS-poll or uAPSD.
2317 * Note that if the @more_data paramter is %false the driver must check
2318 * if there are more frames on the given TIDs, and if there are more than
2319 * the frames being released then it must still set the more-data bit in
2320 * the frame. If the @more_data parameter is %true, then of course the
2321 * more-data bit must always be set.
2322 * The @tids parameter tells the driver which TIDs to release frames
2323 * from, for PS-poll it will always have only a single bit set.
2324 * In the case this is used for a PS-poll initiated release, the
2325 * @num_frames parameter will always be 1 so code can be shared. In
2326 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2327 * on the TX status (and must report TX status) so that the PS-poll
2328 * period is properly ended. This is used to avoid sending multiple
2329 * responses for a retried PS-poll frame.
2330 * In the case this is used for uAPSD, the @num_frames parameter may be
2331 * bigger than one, but the driver may send fewer frames (it must send
2332 * at least one, however). In this case it is also responsible for
2333 * setting the EOSP flag in the QoS header of the frames. Also, when the
2334 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2335 * on the last frame in the SP. Alternatively, it may call the function
2336 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2337 * This callback must be atomic.
2338 * @allow_buffered_frames: Prepare device to allow the given number of frames
2339 * to go out to the given station. The frames will be sent by mac80211
2340 * via the usual TX path after this call. The TX information for frames
2341 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2342 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2343 * frames from multiple TIDs are released and the driver might reorder
2344 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2345 * on the last frame and clear it on all others and also handle the EOSP
2346 * bit in the QoS header correctly. Alternatively, it can also call the
2347 * ieee80211_sta_eosp_irqsafe() function.
2348 * The @tids parameter is a bitmap and tells the driver which TIDs the
2349 * frames will be on; it will at most have two bits set.
2350 * This callback must be atomic.
2352 * @get_et_sset_count: Ethtool API to get string-set count.
2354 * @get_et_stats: Ethtool API to get a set of u64 stats.
2356 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2357 * and perhaps other supported types of ethtool data-sets.
2359 * @get_rssi: Get current signal strength in dBm, the function is optional
2362 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2363 * before associated. In multi-channel scenarios, a virtual interface is
2364 * bound to a channel before it is associated, but as it isn't associated
2365 * yet it need not necessarily be given airtime, in particular since any
2366 * transmission to a P2P GO needs to be synchronized against the GO's
2367 * powersave state. mac80211 will call this function before transmitting a
2368 * management frame prior to having successfully associated to allow the
2369 * driver to give it channel time for the transmission, to get a response
2370 * and to be able to synchronize with the GO.
2371 * The callback will be called before each transmission and upon return
2372 * mac80211 will transmit the frame right away.
2373 * The callback is optional and can (should!) sleep.
2375 * @add_chanctx: Notifies device driver about new channel context creation.
2376 * @remove_chanctx: Notifies device driver about channel context destruction.
2377 * @change_chanctx: Notifies device driver about channel context changes that
2378 * may happen when combining different virtual interfaces on the same
2379 * channel context with different settings
2380 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2381 * to vif. Possible use is for hw queue remapping.
2382 * @unassign_vif_chanctx: Notifies device driver about channel context being
2384 * @start_ap: Start operation on the AP interface, this is called after all the
2385 * information in bss_conf is set and beacon can be retrieved. A channel
2386 * context is bound before this is called. Note that if the driver uses
2387 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2388 * just "paused" for scanning/ROC, which is indicated by the beacon being
2389 * disabled/enabled via @bss_info_changed.
2390 * @stop_ap: Stop operation on the AP interface.
2392 struct ieee80211_ops {
2393 void (*tx)(struct ieee80211_hw *hw,
2394 struct ieee80211_tx_control *control,
2395 struct sk_buff *skb);
2396 int (*start)(struct ieee80211_hw *hw);
2397 void (*stop)(struct ieee80211_hw *hw);
2399 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2400 int (*resume)(struct ieee80211_hw *hw);
2401 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2403 int (*add_interface)(struct ieee80211_hw *hw,
2404 struct ieee80211_vif *vif);
2405 int (*change_interface)(struct ieee80211_hw *hw,
2406 struct ieee80211_vif *vif,
2407 enum nl80211_iftype new_type, bool p2p);
2408 void (*remove_interface)(struct ieee80211_hw *hw,
2409 struct ieee80211_vif *vif);
2410 int (*config)(struct ieee80211_hw *hw, u32 changed);
2411 void (*bss_info_changed)(struct ieee80211_hw *hw,
2412 struct ieee80211_vif *vif,
2413 struct ieee80211_bss_conf *info,
2416 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2417 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2419 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2420 struct netdev_hw_addr_list *mc_list);
2421 void (*configure_filter)(struct ieee80211_hw *hw,
2422 unsigned int changed_flags,
2423 unsigned int *total_flags,
2425 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2427 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2428 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2429 struct ieee80211_key_conf *key);
2430 void (*update_tkip_key)(struct ieee80211_hw *hw,
2431 struct ieee80211_vif *vif,
2432 struct ieee80211_key_conf *conf,
2433 struct ieee80211_sta *sta,
2434 u32 iv32, u16 *phase1key);
2435 void (*set_rekey_data)(struct ieee80211_hw *hw,
2436 struct ieee80211_vif *vif,
2437 struct cfg80211_gtk_rekey_data *data);
2438 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2439 struct cfg80211_scan_request *req);
2440 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2441 struct ieee80211_vif *vif);
2442 int (*sched_scan_start)(struct ieee80211_hw *hw,
2443 struct ieee80211_vif *vif,
2444 struct cfg80211_sched_scan_request *req,
2445 struct ieee80211_sched_scan_ies *ies);
2446 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2447 struct ieee80211_vif *vif);
2448 void (*sw_scan_start)(struct ieee80211_hw *hw);
2449 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2450 int (*get_stats)(struct ieee80211_hw *hw,
2451 struct ieee80211_low_level_stats *stats);
2452 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2453 u32 *iv32, u16 *iv16);
2454 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2455 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2456 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2457 struct ieee80211_sta *sta);
2458 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2459 struct ieee80211_sta *sta);
2460 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2461 enum sta_notify_cmd, struct ieee80211_sta *sta);
2462 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2463 struct ieee80211_sta *sta,
2464 enum ieee80211_sta_state old_state,
2465 enum ieee80211_sta_state new_state);
2466 void (*sta_rc_update)(struct ieee80211_hw *hw,
2467 struct ieee80211_vif *vif,
2468 struct ieee80211_sta *sta,
2470 int (*conf_tx)(struct ieee80211_hw *hw,
2471 struct ieee80211_vif *vif, u16 ac,
2472 const struct ieee80211_tx_queue_params *params);
2473 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2474 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2476 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2477 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2478 int (*ampdu_action)(struct ieee80211_hw *hw,
2479 struct ieee80211_vif *vif,
2480 enum ieee80211_ampdu_mlme_action action,
2481 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2483 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2484 struct survey_info *survey);
2485 void (*rfkill_poll)(struct ieee80211_hw *hw);
2486 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2487 #ifdef CONFIG_NL80211_TESTMODE
2488 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2489 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2490 struct netlink_callback *cb,
2491 void *data, int len);
2493 void (*flush)(struct ieee80211_hw *hw, bool drop);
2494 void (*channel_switch)(struct ieee80211_hw *hw,
2495 struct ieee80211_channel_switch *ch_switch);
2496 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2497 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2498 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2500 int (*remain_on_channel)(struct ieee80211_hw *hw,
2501 struct ieee80211_channel *chan,
2502 enum nl80211_channel_type channel_type,
2504 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2505 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2506 void (*get_ringparam)(struct ieee80211_hw *hw,
2507 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2508 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2509 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2510 const struct cfg80211_bitrate_mask *mask);
2511 void (*rssi_callback)(struct ieee80211_hw *hw,
2512 enum ieee80211_rssi_event rssi_event);
2514 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2515 struct ieee80211_sta *sta,
2516 u16 tids, int num_frames,
2517 enum ieee80211_frame_release_type reason,
2519 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2520 struct ieee80211_sta *sta,
2521 u16 tids, int num_frames,
2522 enum ieee80211_frame_release_type reason,
2525 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2526 struct ieee80211_vif *vif, int sset);
2527 void (*get_et_stats)(struct ieee80211_hw *hw,
2528 struct ieee80211_vif *vif,
2529 struct ethtool_stats *stats, u64 *data);
2530 void (*get_et_strings)(struct ieee80211_hw *hw,
2531 struct ieee80211_vif *vif,
2532 u32 sset, u8 *data);
2533 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2534 struct ieee80211_sta *sta, s8 *rssi_dbm);
2536 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2537 struct ieee80211_vif *vif);
2539 int (*add_chanctx)(struct ieee80211_hw *hw,
2540 struct ieee80211_chanctx_conf *ctx);
2541 void (*remove_chanctx)(struct ieee80211_hw *hw,
2542 struct ieee80211_chanctx_conf *ctx);
2543 void (*change_chanctx)(struct ieee80211_hw *hw,
2544 struct ieee80211_chanctx_conf *ctx,
2546 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2547 struct ieee80211_vif *vif,
2548 struct ieee80211_chanctx_conf *ctx);
2549 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2550 struct ieee80211_vif *vif,
2551 struct ieee80211_chanctx_conf *ctx);
2555 * ieee80211_alloc_hw - Allocate a new hardware device
2557 * This must be called once for each hardware device. The returned pointer
2558 * must be used to refer to this device when calling other functions.
2559 * mac80211 allocates a private data area for the driver pointed to by
2560 * @priv in &struct ieee80211_hw, the size of this area is given as
2563 * @priv_data_len: length of private data
2564 * @ops: callbacks for this device
2566 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2567 const struct ieee80211_ops *ops);
2570 * ieee80211_register_hw - Register hardware device
2572 * You must call this function before any other functions in
2573 * mac80211. Note that before a hardware can be registered, you
2574 * need to fill the contained wiphy's information.
2576 * @hw: the device to register as returned by ieee80211_alloc_hw()
2578 int ieee80211_register_hw(struct ieee80211_hw *hw);
2581 * struct ieee80211_tpt_blink - throughput blink description
2582 * @throughput: throughput in Kbit/sec
2583 * @blink_time: blink time in milliseconds
2584 * (full cycle, ie. one off + one on period)
2586 struct ieee80211_tpt_blink {
2592 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2593 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2594 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2595 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2596 * interface is connected in some way, including being an AP
2598 enum ieee80211_tpt_led_trigger_flags {
2599 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2600 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2601 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2604 #ifdef CONFIG_MAC80211_LEDS
2605 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2606 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2607 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2608 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2609 extern char *__ieee80211_create_tpt_led_trigger(
2610 struct ieee80211_hw *hw, unsigned int flags,
2611 const struct ieee80211_tpt_blink *blink_table,
2612 unsigned int blink_table_len);
2615 * ieee80211_get_tx_led_name - get name of TX LED
2617 * mac80211 creates a transmit LED trigger for each wireless hardware
2618 * that can be used to drive LEDs if your driver registers a LED device.
2619 * This function returns the name (or %NULL if not configured for LEDs)
2620 * of the trigger so you can automatically link the LED device.
2622 * @hw: the hardware to get the LED trigger name for
2624 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2626 #ifdef CONFIG_MAC80211_LEDS
2627 return __ieee80211_get_tx_led_name(hw);
2634 * ieee80211_get_rx_led_name - get name of RX LED
2636 * mac80211 creates a receive LED trigger for each wireless hardware
2637 * that can be used to drive LEDs if your driver registers a LED device.
2638 * This function returns the name (or %NULL if not configured for LEDs)
2639 * of the trigger so you can automatically link the LED device.
2641 * @hw: the hardware to get the LED trigger name for
2643 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2645 #ifdef CONFIG_MAC80211_LEDS
2646 return __ieee80211_get_rx_led_name(hw);
2653 * ieee80211_get_assoc_led_name - get name of association LED
2655 * mac80211 creates a association LED trigger for each wireless hardware
2656 * that can be used to drive LEDs if your driver registers a LED device.
2657 * This function returns the name (or %NULL if not configured for LEDs)
2658 * of the trigger so you can automatically link the LED device.
2660 * @hw: the hardware to get the LED trigger name for
2662 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2664 #ifdef CONFIG_MAC80211_LEDS
2665 return __ieee80211_get_assoc_led_name(hw);
2672 * ieee80211_get_radio_led_name - get name of radio LED
2674 * mac80211 creates a radio change LED trigger for each wireless hardware
2675 * that can be used to drive LEDs if your driver registers a LED device.
2676 * This function returns the name (or %NULL if not configured for LEDs)
2677 * of the trigger so you can automatically link the LED device.
2679 * @hw: the hardware to get the LED trigger name for
2681 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2683 #ifdef CONFIG_MAC80211_LEDS
2684 return __ieee80211_get_radio_led_name(hw);
2691 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2692 * @hw: the hardware to create the trigger for
2693 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2694 * @blink_table: the blink table -- needs to be ordered by throughput
2695 * @blink_table_len: size of the blink table
2697 * This function returns %NULL (in case of error, or if no LED
2698 * triggers are configured) or the name of the new trigger.
2699 * This function must be called before ieee80211_register_hw().
2701 static inline char *
2702 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2703 const struct ieee80211_tpt_blink *blink_table,
2704 unsigned int blink_table_len)
2706 #ifdef CONFIG_MAC80211_LEDS
2707 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2715 * ieee80211_unregister_hw - Unregister a hardware device
2717 * This function instructs mac80211 to free allocated resources
2718 * and unregister netdevices from the networking subsystem.
2720 * @hw: the hardware to unregister
2722 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2725 * ieee80211_free_hw - free hardware descriptor
2727 * This function frees everything that was allocated, including the
2728 * private data for the driver. You must call ieee80211_unregister_hw()
2729 * before calling this function.
2731 * @hw: the hardware to free
2733 void ieee80211_free_hw(struct ieee80211_hw *hw);
2736 * ieee80211_restart_hw - restart hardware completely
2738 * Call this function when the hardware was restarted for some reason
2739 * (hardware error, ...) and the driver is unable to restore its state
2740 * by itself. mac80211 assumes that at this point the driver/hardware
2741 * is completely uninitialised and stopped, it starts the process by
2742 * calling the ->start() operation. The driver will need to reset all
2743 * internal state that it has prior to calling this function.
2745 * @hw: the hardware to restart
2747 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2749 /** ieee80211_napi_schedule - schedule NAPI poll
2751 * Use this function to schedule NAPI polling on a device.
2753 * @hw: the hardware to start polling
2755 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2757 /** ieee80211_napi_complete - complete NAPI polling
2759 * Use this function to finish NAPI polling on a device.
2761 * @hw: the hardware to stop polling
2763 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2766 * ieee80211_rx - receive frame
2768 * Use this function to hand received frames to mac80211. The receive
2769 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2770 * paged @skb is used, the driver is recommended to put the ieee80211
2771 * header of the frame on the linear part of the @skb to avoid memory
2772 * allocation and/or memcpy by the stack.
2774 * This function may not be called in IRQ context. Calls to this function
2775 * for a single hardware must be synchronized against each other. Calls to
2776 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2777 * mixed for a single hardware.
2779 * In process context use instead ieee80211_rx_ni().
2781 * @hw: the hardware this frame came in on
2782 * @skb: the buffer to receive, owned by mac80211 after this call
2784 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2787 * ieee80211_rx_irqsafe - receive frame
2789 * Like ieee80211_rx() but can be called in IRQ context
2790 * (internally defers to a tasklet.)
2792 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2793 * be mixed for a single hardware.
2795 * @hw: the hardware this frame came in on
2796 * @skb: the buffer to receive, owned by mac80211 after this call
2798 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2801 * ieee80211_rx_ni - receive frame (in process context)
2803 * Like ieee80211_rx() but can be called in process context
2804 * (internally disables bottom halves).
2806 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2807 * not be mixed for a single hardware.
2809 * @hw: the hardware this frame came in on
2810 * @skb: the buffer to receive, owned by mac80211 after this call
2812 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2813 struct sk_buff *skb)
2816 ieee80211_rx(hw, skb);
2821 * ieee80211_sta_ps_transition - PS transition for connected sta
2823 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2824 * flag set, use this function to inform mac80211 about a connected station
2825 * entering/leaving PS mode.
2827 * This function may not be called in IRQ context or with softirqs enabled.
2829 * Calls to this function for a single hardware must be synchronized against
2832 * The function returns -EINVAL when the requested PS mode is already set.
2834 * @sta: currently connected sta
2835 * @start: start or stop PS
2837 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2840 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2841 * (in process context)
2843 * Like ieee80211_sta_ps_transition() but can be called in process context
2844 * (internally disables bottom halves). Concurrent call restriction still
2847 * @sta: currently connected sta
2848 * @start: start or stop PS
2850 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2856 ret = ieee80211_sta_ps_transition(sta, start);
2863 * The TX headroom reserved by mac80211 for its own tx_status functions.
2864 * This is enough for the radiotap header.
2866 #define IEEE80211_TX_STATUS_HEADROOM 14
2869 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2870 * @sta: &struct ieee80211_sta pointer for the sleeping station
2871 * @tid: the TID that has buffered frames
2872 * @buffered: indicates whether or not frames are buffered for this TID
2874 * If a driver buffers frames for a powersave station instead of passing
2875 * them back to mac80211 for retransmission, the station may still need
2876 * to be told that there are buffered frames via the TIM bit.
2878 * This function informs mac80211 whether or not there are frames that are
2879 * buffered in the driver for a given TID; mac80211 can then use this data
2880 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2881 * call! Beware of the locking!)
2883 * If all frames are released to the station (due to PS-poll or uAPSD)
2884 * then the driver needs to inform mac80211 that there no longer are
2885 * frames buffered. However, when the station wakes up mac80211 assumes
2886 * that all buffered frames will be transmitted and clears this data,
2887 * drivers need to make sure they inform mac80211 about all buffered
2888 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2890 * Note that technically mac80211 only needs to know this per AC, not per
2891 * TID, but since driver buffering will inevitably happen per TID (since
2892 * it is related to aggregation) it is easier to make mac80211 map the
2893 * TID to the AC as required instead of keeping track in all drivers that
2896 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2897 u8 tid, bool buffered);
2900 * ieee80211_tx_status - transmit status callback
2902 * Call this function for all transmitted frames after they have been
2903 * transmitted. It is permissible to not call this function for
2904 * multicast frames but this can affect statistics.
2906 * This function may not be called in IRQ context. Calls to this function
2907 * for a single hardware must be synchronized against each other. Calls
2908 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2909 * may not be mixed for a single hardware.
2911 * @hw: the hardware the frame was transmitted by
2912 * @skb: the frame that was transmitted, owned by mac80211 after this call
2914 void ieee80211_tx_status(struct ieee80211_hw *hw,
2915 struct sk_buff *skb);
2918 * ieee80211_tx_status_ni - transmit status callback (in process context)
2920 * Like ieee80211_tx_status() but can be called in process context.
2922 * Calls to this function, ieee80211_tx_status() and
2923 * ieee80211_tx_status_irqsafe() may not be mixed
2924 * for a single hardware.
2926 * @hw: the hardware the frame was transmitted by
2927 * @skb: the frame that was transmitted, owned by mac80211 after this call
2929 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2930 struct sk_buff *skb)
2933 ieee80211_tx_status(hw, skb);
2938 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2940 * Like ieee80211_tx_status() but can be called in IRQ context
2941 * (internally defers to a tasklet.)
2943 * Calls to this function, ieee80211_tx_status() and
2944 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2946 * @hw: the hardware the frame was transmitted by
2947 * @skb: the frame that was transmitted, owned by mac80211 after this call
2949 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2950 struct sk_buff *skb);
2953 * ieee80211_report_low_ack - report non-responding station
2955 * When operating in AP-mode, call this function to report a non-responding
2958 * @sta: the non-responding connected sta
2959 * @num_packets: number of packets sent to @sta without a response
2961 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2964 * ieee80211_beacon_get_tim - beacon generation function
2965 * @hw: pointer obtained from ieee80211_alloc_hw().
2966 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2967 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2968 * Set to 0 if invalid (in non-AP modes).
2969 * @tim_length: pointer to variable that will receive the TIM IE length,
2970 * (including the ID and length bytes!).
2971 * Set to 0 if invalid (in non-AP modes).
2973 * If the driver implements beaconing modes, it must use this function to
2974 * obtain the beacon frame/template.
2976 * If the beacon frames are generated by the host system (i.e., not in
2977 * hardware/firmware), the driver uses this function to get each beacon
2978 * frame from mac80211 -- it is responsible for calling this function
2979 * before the beacon is needed (e.g. based on hardware interrupt).
2981 * If the beacon frames are generated by the device, then the driver
2982 * must use the returned beacon as the template and change the TIM IE
2983 * according to the current DTIM parameters/TIM bitmap.
2985 * The driver is responsible for freeing the returned skb.
2987 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2988 struct ieee80211_vif *vif,
2989 u16 *tim_offset, u16 *tim_length);
2992 * ieee80211_beacon_get - beacon generation function
2993 * @hw: pointer obtained from ieee80211_alloc_hw().
2994 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2996 * See ieee80211_beacon_get_tim().
2998 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2999 struct ieee80211_vif *vif)
3001 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3005 * ieee80211_proberesp_get - retrieve a Probe Response template
3006 * @hw: pointer obtained from ieee80211_alloc_hw().
3007 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3009 * Creates a Probe Response template which can, for example, be uploaded to
3010 * hardware. The destination address should be set by the caller.
3012 * Can only be called in AP mode.
3014 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3015 struct ieee80211_vif *vif);
3018 * ieee80211_pspoll_get - retrieve a PS Poll template
3019 * @hw: pointer obtained from ieee80211_alloc_hw().
3020 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3022 * Creates a PS Poll a template which can, for example, uploaded to
3023 * hardware. The template must be updated after association so that correct
3024 * AID, BSSID and MAC address is used.
3026 * Note: Caller (or hardware) is responsible for setting the
3027 * &IEEE80211_FCTL_PM bit.
3029 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3030 struct ieee80211_vif *vif);
3033 * ieee80211_nullfunc_get - retrieve a nullfunc template
3034 * @hw: pointer obtained from ieee80211_alloc_hw().
3035 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3037 * Creates a Nullfunc template which can, for example, uploaded to
3038 * hardware. The template must be updated after association so that correct
3039 * BSSID and address is used.
3041 * Note: Caller (or hardware) is responsible for setting the
3042 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3044 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3045 struct ieee80211_vif *vif);
3048 * ieee80211_probereq_get - retrieve a Probe Request template
3049 * @hw: pointer obtained from ieee80211_alloc_hw().
3050 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3051 * @ssid: SSID buffer
3052 * @ssid_len: length of SSID
3053 * @ie: buffer containing all IEs except SSID for the template
3054 * @ie_len: length of the IE buffer
3056 * Creates a Probe Request template which can, for example, be uploaded to
3059 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3060 struct ieee80211_vif *vif,
3061 const u8 *ssid, size_t ssid_len,
3062 const u8 *ie, size_t ie_len);
3065 * ieee80211_rts_get - RTS frame generation function
3066 * @hw: pointer obtained from ieee80211_alloc_hw().
3067 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3068 * @frame: pointer to the frame that is going to be protected by the RTS.
3069 * @frame_len: the frame length (in octets).
3070 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3071 * @rts: The buffer where to store the RTS frame.
3073 * If the RTS frames are generated by the host system (i.e., not in
3074 * hardware/firmware), the low-level driver uses this function to receive
3075 * the next RTS frame from the 802.11 code. The low-level is responsible
3076 * for calling this function before and RTS frame is needed.
3078 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3079 const void *frame, size_t frame_len,
3080 const struct ieee80211_tx_info *frame_txctl,
3081 struct ieee80211_rts *rts);
3084 * ieee80211_rts_duration - Get the duration field for an RTS frame
3085 * @hw: pointer obtained from ieee80211_alloc_hw().
3086 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3087 * @frame_len: the length of the frame that is going to be protected by the RTS.
3088 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3090 * If the RTS is generated in firmware, but the host system must provide
3091 * the duration field, the low-level driver uses this function to receive
3092 * the duration field value in little-endian byteorder.
3094 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3095 struct ieee80211_vif *vif, size_t frame_len,
3096 const struct ieee80211_tx_info *frame_txctl);
3099 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3100 * @hw: pointer obtained from ieee80211_alloc_hw().
3101 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3102 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3103 * @frame_len: the frame length (in octets).
3104 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3105 * @cts: The buffer where to store the CTS-to-self frame.
3107 * If the CTS-to-self frames are generated by the host system (i.e., not in
3108 * hardware/firmware), the low-level driver uses this function to receive
3109 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3110 * for calling this function before and CTS-to-self frame is needed.
3112 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3113 struct ieee80211_vif *vif,
3114 const void *frame, size_t frame_len,
3115 const struct ieee80211_tx_info *frame_txctl,
3116 struct ieee80211_cts *cts);
3119 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3120 * @hw: pointer obtained from ieee80211_alloc_hw().
3121 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3122 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3123 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3125 * If the CTS-to-self is generated in firmware, but the host system must provide
3126 * the duration field, the low-level driver uses this function to receive
3127 * the duration field value in little-endian byteorder.
3129 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3130 struct ieee80211_vif *vif,
3132 const struct ieee80211_tx_info *frame_txctl);
3135 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3136 * @hw: pointer obtained from ieee80211_alloc_hw().
3137 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3138 * @band: the band to calculate the frame duration on
3139 * @frame_len: the length of the frame.
3140 * @rate: the rate at which the frame is going to be transmitted.
3142 * Calculate the duration field of some generic frame, given its
3143 * length and transmission rate (in 100kbps).
3145 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3146 struct ieee80211_vif *vif,
3147 enum ieee80211_band band,
3149 struct ieee80211_rate *rate);
3152 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3153 * @hw: pointer as obtained from ieee80211_alloc_hw().
3154 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3156 * Function for accessing buffered broadcast and multicast frames. If
3157 * hardware/firmware does not implement buffering of broadcast/multicast
3158 * frames when power saving is used, 802.11 code buffers them in the host
3159 * memory. The low-level driver uses this function to fetch next buffered
3160 * frame. In most cases, this is used when generating beacon frame. This
3161 * function returns a pointer to the next buffered skb or NULL if no more
3162 * buffered frames are available.
3164 * Note: buffered frames are returned only after DTIM beacon frame was
3165 * generated with ieee80211_beacon_get() and the low-level driver must thus
3166 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3167 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3168 * does not need to check for DTIM beacons separately and should be able to
3169 * use common code for all beacons.
3172 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3175 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3177 * This function returns the TKIP phase 1 key for the given IV32.
3179 * @keyconf: the parameter passed with the set key
3180 * @iv32: IV32 to get the P1K for
3181 * @p1k: a buffer to which the key will be written, as 5 u16 values
3183 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3184 u32 iv32, u16 *p1k);
3187 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3189 * This function returns the TKIP phase 1 key for the IV32 taken
3190 * from the given packet.
3192 * @keyconf: the parameter passed with the set key
3193 * @skb: the packet to take the IV32 value from that will be encrypted
3195 * @p1k: a buffer to which the key will be written, as 5 u16 values
3197 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3198 struct sk_buff *skb, u16 *p1k)
3200 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3201 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3202 u32 iv32 = get_unaligned_le32(&data[4]);
3204 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3208 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3210 * This function returns the TKIP phase 1 key for the given IV32
3211 * and transmitter address.
3213 * @keyconf: the parameter passed with the set key
3214 * @ta: TA that will be used with the key
3215 * @iv32: IV32 to get the P1K for
3216 * @p1k: a buffer to which the key will be written, as 5 u16 values
3218 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3219 const u8 *ta, u32 iv32, u16 *p1k);
3222 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3224 * This function computes the TKIP RC4 key for the IV values
3227 * @keyconf: the parameter passed with the set key
3228 * @skb: the packet to take the IV32/IV16 values from that will be
3229 * encrypted with this key
3230 * @p2k: a buffer to which the key will be written, 16 bytes
3232 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3233 struct sk_buff *skb, u8 *p2k);
3236 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3238 * This function computes the two AES-CMAC sub-keys, based on the
3239 * previously installed master key.
3241 * @keyconf: the parameter passed with the set key
3242 * @k1: a buffer to be filled with the 1st sub-key
3243 * @k2: a buffer to be filled with the 2nd sub-key
3245 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3249 * struct ieee80211_key_seq - key sequence counter
3251 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3252 * @ccmp: PN data, most significant byte first (big endian,
3253 * reverse order than in packet)
3254 * @aes_cmac: PN data, most significant byte first (big endian,
3255 * reverse order than in packet)
3257 struct ieee80211_key_seq {
3273 * ieee80211_get_key_tx_seq - get key TX sequence counter
3275 * @keyconf: the parameter passed with the set key
3276 * @seq: buffer to receive the sequence data
3278 * This function allows a driver to retrieve the current TX IV/PN
3279 * for the given key. It must not be called if IV generation is
3280 * offloaded to the device.
3282 * Note that this function may only be called when no TX processing
3283 * can be done concurrently, for example when queues are stopped
3284 * and the stop has been synchronized.
3286 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3287 struct ieee80211_key_seq *seq);
3290 * ieee80211_get_key_rx_seq - get key RX sequence counter
3292 * @keyconf: the parameter passed with the set key
3293 * @tid: The TID, or -1 for the management frame value (CCMP only);
3294 * the value on TID 0 is also used for non-QoS frames. For
3295 * CMAC, only TID 0 is valid.
3296 * @seq: buffer to receive the sequence data
3298 * This function allows a driver to retrieve the current RX IV/PNs
3299 * for the given key. It must not be called if IV checking is done
3300 * by the device and not by mac80211.
3302 * Note that this function may only be called when no RX processing
3303 * can be done concurrently.
3305 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3306 int tid, struct ieee80211_key_seq *seq);
3309 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3310 * @vif: virtual interface the rekeying was done on
3311 * @bssid: The BSSID of the AP, for checking association
3312 * @replay_ctr: the new replay counter after GTK rekeying
3313 * @gfp: allocation flags
3315 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3316 const u8 *replay_ctr, gfp_t gfp);
3319 * ieee80211_wake_queue - wake specific queue
3320 * @hw: pointer as obtained from ieee80211_alloc_hw().
3321 * @queue: queue number (counted from zero).
3323 * Drivers should use this function instead of netif_wake_queue.
3325 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3328 * ieee80211_stop_queue - stop specific queue
3329 * @hw: pointer as obtained from ieee80211_alloc_hw().
3330 * @queue: queue number (counted from zero).
3332 * Drivers should use this function instead of netif_stop_queue.
3334 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3337 * ieee80211_queue_stopped - test status of the queue
3338 * @hw: pointer as obtained from ieee80211_alloc_hw().
3339 * @queue: queue number (counted from zero).
3341 * Drivers should use this function instead of netif_stop_queue.
3344 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3347 * ieee80211_stop_queues - stop all queues
3348 * @hw: pointer as obtained from ieee80211_alloc_hw().
3350 * Drivers should use this function instead of netif_stop_queue.
3352 void ieee80211_stop_queues(struct ieee80211_hw *hw);
3355 * ieee80211_wake_queues - wake all queues
3356 * @hw: pointer as obtained from ieee80211_alloc_hw().
3358 * Drivers should use this function instead of netif_wake_queue.
3360 void ieee80211_wake_queues(struct ieee80211_hw *hw);
3363 * ieee80211_scan_completed - completed hardware scan
3365 * When hardware scan offload is used (i.e. the hw_scan() callback is
3366 * assigned) this function needs to be called by the driver to notify
3367 * mac80211 that the scan finished. This function can be called from
3368 * any context, including hardirq context.
3370 * @hw: the hardware that finished the scan
3371 * @aborted: set to true if scan was aborted
3373 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3376 * ieee80211_sched_scan_results - got results from scheduled scan
3378 * When a scheduled scan is running, this function needs to be called by the
3379 * driver whenever there are new scan results available.
3381 * @hw: the hardware that is performing scheduled scans
3383 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3386 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3388 * When a scheduled scan is running, this function can be called by
3389 * the driver if it needs to stop the scan to perform another task.
3390 * Usual scenarios are drivers that cannot continue the scheduled scan
3391 * while associating, for instance.
3393 * @hw: the hardware that is performing scheduled scans
3395 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3398 * ieee80211_iterate_active_interfaces - iterate active interfaces
3400 * This function iterates over the interfaces associated with a given
3401 * hardware that are currently active and calls the callback for them.
3402 * This function allows the iterator function to sleep, when the iterator
3403 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3405 * Does not iterate over a new interface during add_interface()
3407 * @hw: the hardware struct of which the interfaces should be iterated over
3408 * @iterator: the iterator function to call
3409 * @data: first argument of the iterator function
3411 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3412 void (*iterator)(void *data, u8 *mac,
3413 struct ieee80211_vif *vif),
3417 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3419 * This function iterates over the interfaces associated with a given
3420 * hardware that are currently active and calls the callback for them.
3421 * This function requires the iterator callback function to be atomic,
3422 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3423 * Does not iterate over a new interface during add_interface()
3425 * @hw: the hardware struct of which the interfaces should be iterated over
3426 * @iterator: the iterator function to call, cannot sleep
3427 * @data: first argument of the iterator function
3429 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3430 void (*iterator)(void *data,
3432 struct ieee80211_vif *vif),
3436 * ieee80211_queue_work - add work onto the mac80211 workqueue
3438 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3439 * This helper ensures drivers are not queueing work when they should not be.
3441 * @hw: the hardware struct for the interface we are adding work for
3442 * @work: the work we want to add onto the mac80211 workqueue
3444 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3447 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3449 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3452 * @hw: the hardware struct for the interface we are adding work for
3453 * @dwork: delayable work to queue onto the mac80211 workqueue
3454 * @delay: number of jiffies to wait before queueing
3456 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3457 struct delayed_work *dwork,
3458 unsigned long delay);
3461 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3462 * @sta: the station for which to start a BA session
3463 * @tid: the TID to BA on.
3464 * @timeout: session timeout value (in TUs)
3466 * Return: success if addBA request was sent, failure otherwise
3468 * Although mac80211/low level driver/user space application can estimate
3469 * the need to start aggregation on a certain RA/TID, the session level
3470 * will be managed by the mac80211.
3472 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3476 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3477 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3478 * @ra: receiver address of the BA session recipient.
3479 * @tid: the TID to BA on.
3481 * This function must be called by low level driver once it has
3482 * finished with preparations for the BA session. It can be called
3485 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3489 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3490 * @sta: the station whose BA session to stop
3491 * @tid: the TID to stop BA.
3493 * Return: negative error if the TID is invalid, or no aggregation active
3495 * Although mac80211/low level driver/user space application can estimate
3496 * the need to stop aggregation on a certain RA/TID, the session level
3497 * will be managed by the mac80211.
3499 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3502 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3503 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3504 * @ra: receiver address of the BA session recipient.
3505 * @tid: the desired TID to BA on.
3507 * This function must be called by low level driver once it has
3508 * finished with preparations for the BA session tear down. It
3509 * can be called from any context.
3511 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3515 * ieee80211_find_sta - find a station
3517 * @vif: virtual interface to look for station on
3518 * @addr: station's address
3520 * This function must be called under RCU lock and the
3521 * resulting pointer is only valid under RCU lock as well.
3523 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3527 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3529 * @hw: pointer as obtained from ieee80211_alloc_hw()
3530 * @addr: remote station's address
3531 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3533 * This function must be called under RCU lock and the
3534 * resulting pointer is only valid under RCU lock as well.
3536 * NOTE: You may pass NULL for localaddr, but then you will just get
3537 * the first STA that matches the remote address 'addr'.
3538 * We can have multiple STA associated with multiple
3539 * logical stations (e.g. consider a station connecting to another
3540 * BSSID on the same AP hardware without disconnecting first).
3541 * In this case, the result of this method with localaddr NULL
3544 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3546 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3548 const u8 *localaddr);
3551 * ieee80211_sta_block_awake - block station from waking up
3553 * @pubsta: the station
3554 * @block: whether to block or unblock
3556 * Some devices require that all frames that are on the queues
3557 * for a specific station that went to sleep are flushed before
3558 * a poll response or frames after the station woke up can be
3559 * delivered to that it. Note that such frames must be rejected
3560 * by the driver as filtered, with the appropriate status flag.
3562 * This function allows implementing this mode in a race-free
3565 * To do this, a driver must keep track of the number of frames
3566 * still enqueued for a specific station. If this number is not
3567 * zero when the station goes to sleep, the driver must call
3568 * this function to force mac80211 to consider the station to
3569 * be asleep regardless of the station's actual state. Once the
3570 * number of outstanding frames reaches zero, the driver must
3571 * call this function again to unblock the station. That will
3572 * cause mac80211 to be able to send ps-poll responses, and if
3573 * the station queried in the meantime then frames will also
3574 * be sent out as a result of this. Additionally, the driver
3575 * will be notified that the station woke up some time after
3576 * it is unblocked, regardless of whether the station actually
3577 * woke up while blocked or not.
3579 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3580 struct ieee80211_sta *pubsta, bool block);
3583 * ieee80211_sta_eosp - notify mac80211 about end of SP
3584 * @pubsta: the station
3586 * When a device transmits frames in a way that it can't tell
3587 * mac80211 in the TX status about the EOSP, it must clear the
3588 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3589 * This applies for PS-Poll as well as uAPSD.
3591 * Note that there is no non-_irqsafe version right now as
3592 * it wasn't needed, but just like _tx_status() and _rx()
3593 * must not be mixed in irqsafe/non-irqsafe versions, this
3594 * function must not be mixed with those either. Use the
3595 * all irqsafe, or all non-irqsafe, don't mix! If you need
3596 * the non-irqsafe version of this, you need to add it.
3598 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3601 * ieee80211_iter_keys - iterate keys programmed into the device
3602 * @hw: pointer obtained from ieee80211_alloc_hw()
3603 * @vif: virtual interface to iterate, may be %NULL for all
3604 * @iter: iterator function that will be called for each key
3605 * @iter_data: custom data to pass to the iterator function
3607 * This function can be used to iterate all the keys known to
3608 * mac80211, even those that weren't previously programmed into
3609 * the device. This is intended for use in WoWLAN if the device
3610 * needs reprogramming of the keys during suspend. Note that due
3611 * to locking reasons, it is also only safe to call this at few
3612 * spots since it must hold the RTNL and be able to sleep.
3614 * The order in which the keys are iterated matches the order
3615 * in which they were originally installed and handed to the
3618 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3619 struct ieee80211_vif *vif,
3620 void (*iter)(struct ieee80211_hw *hw,
3621 struct ieee80211_vif *vif,
3622 struct ieee80211_sta *sta,
3623 struct ieee80211_key_conf *key,
3628 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
3629 * @hw: pointre obtained from ieee80211_alloc_hw().
3630 * @iter: iterator function
3631 * @iter_data: data passed to iterator function
3633 * Iterate all active channel contexts. This function is atomic and
3634 * doesn't acquire any locks internally that might be held in other
3635 * places while calling into the driver.
3637 * The iterator will not find a context that's being added (during
3638 * the driver callback to add it) but will find it while it's being
3641 void ieee80211_iter_chan_contexts_atomic(
3642 struct ieee80211_hw *hw,
3643 void (*iter)(struct ieee80211_hw *hw,
3644 struct ieee80211_chanctx_conf *chanctx_conf,
3649 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3650 * @hw: pointer obtained from ieee80211_alloc_hw().
3651 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3653 * Creates a Probe Request template which can, for example, be uploaded to
3654 * hardware. The template is filled with bssid, ssid and supported rate
3655 * information. This function must only be called from within the
3656 * .bss_info_changed callback function and only in managed mode. The function
3657 * is only useful when the interface is associated, otherwise it will return
3660 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3661 struct ieee80211_vif *vif);
3664 * ieee80211_beacon_loss - inform hardware does not receive beacons
3666 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3668 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3669 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3670 * hardware is not receiving beacons with this function.
3672 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3675 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3677 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3679 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3680 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3681 * needs to inform if the connection to the AP has been lost.
3683 * This function will cause immediate change to disassociated state,
3684 * without connection recovery attempts.
3686 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3689 * ieee80211_resume_disconnect - disconnect from AP after resume
3691 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3693 * Instructs mac80211 to disconnect from the AP after resume.
3694 * Drivers can use this after WoWLAN if they know that the
3695 * connection cannot be kept up, for example because keys were
3696 * used while the device was asleep but the replay counters or
3697 * similar cannot be retrieved from the device during resume.
3699 * Note that due to implementation issues, if the driver uses
3700 * the reconfiguration functionality during resume the interface
3701 * will still be added as associated first during resume and then
3702 * disconnect normally later.
3704 * This function can only be called from the resume callback and
3705 * the driver must not be holding any of its own locks while it
3706 * calls this function, or at least not any locks it needs in the
3707 * key configuration paths (if it supports HW crypto).
3709 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3712 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3714 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3716 * Some hardware require full power save to manage simultaneous BT traffic
3717 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3718 * burst of BT traffic. The hardware gets information of BT traffic via
3719 * hardware co-existence lines, and consequentially requests mac80211 to
3720 * (temporarily) enter full psm.
3721 * This function will only temporarily disable dynamic PS, not enable PSM if
3722 * it was not already enabled.
3723 * The driver must make sure to re-enable dynamic PS using
3724 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3727 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3730 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3732 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3734 * This function restores dynamic PS after being temporarily disabled via
3735 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3736 * be coupled with an eventual call to this function.
3739 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3742 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3743 * rssi threshold triggered
3745 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3746 * @rssi_event: the RSSI trigger event type
3747 * @gfp: context flags
3749 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3750 * monitoring is configured with an rssi threshold, the driver will inform
3751 * whenever the rssi level reaches the threshold.
3753 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3754 enum nl80211_cqm_rssi_threshold_event rssi_event,
3758 * ieee80211_chswitch_done - Complete channel switch process
3759 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3760 * @success: make the channel switch successful or not
3762 * Complete the channel switch post-process: set the new operational channel
3763 * and wake up the suspended queues.
3765 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3768 * ieee80211_request_smps - request SM PS transition
3769 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3770 * @smps_mode: new SM PS mode
3772 * This allows the driver to request an SM PS transition in managed
3773 * mode. This is useful when the driver has more information than
3774 * the stack about possible interference, for example by bluetooth.
3776 void ieee80211_request_smps(struct ieee80211_vif *vif,
3777 enum ieee80211_smps_mode smps_mode);
3780 * ieee80211_ready_on_channel - notification of remain-on-channel start
3781 * @hw: pointer as obtained from ieee80211_alloc_hw()
3783 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3786 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3787 * @hw: pointer as obtained from ieee80211_alloc_hw()
3789 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3792 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3794 * in order not to harm the system performance and user experience, the device
3795 * may request not to allow any rx ba session and tear down existing rx ba
3796 * sessions based on system constraints such as periodic BT activity that needs
3797 * to limit wlan activity (eg.sco or a2dp)."
3798 * in such cases, the intention is to limit the duration of the rx ppdu and
3799 * therefore prevent the peer device to use a-mpdu aggregation.
3801 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3802 * @ba_rx_bitmap: Bit map of open rx ba per tid
3803 * @addr: & to bssid mac address
3805 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3809 * ieee80211_send_bar - send a BlockAckReq frame
3811 * can be used to flush pending frames from the peer's aggregation reorder
3814 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3815 * @ra: the peer's destination address
3816 * @tid: the TID of the aggregation session
3817 * @ssn: the new starting sequence number for the receiver
3819 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3821 /* Rate control API */
3824 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3826 * @hw: The hardware the algorithm is invoked for.
3827 * @sband: The band this frame is being transmitted on.
3828 * @bss_conf: the current BSS configuration
3829 * @skb: the skb that will be transmitted, the control information in it needs
3831 * @reported_rate: The rate control algorithm can fill this in to indicate
3832 * which rate should be reported to userspace as the current rate and
3833 * used for rate calculations in the mesh network.
3834 * @rts: whether RTS will be used for this frame because it is longer than the
3836 * @short_preamble: whether mac80211 will request short-preamble transmission
3837 * if the selected rate supports it
3838 * @max_rate_idx: user-requested maximum (legacy) rate
3839 * (deprecated; this will be removed once drivers get updated to use
3841 * @rate_idx_mask: user-requested (legacy) rate mask
3842 * @rate_idx_mcs_mask: user-requested MCS rate mask
3843 * @bss: whether this frame is sent out in AP or IBSS mode
3845 struct ieee80211_tx_rate_control {
3846 struct ieee80211_hw *hw;
3847 struct ieee80211_supported_band *sband;
3848 struct ieee80211_bss_conf *bss_conf;
3849 struct sk_buff *skb;
3850 struct ieee80211_tx_rate reported_rate;
3851 bool rts, short_preamble;
3854 u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
3858 struct rate_control_ops {
3859 struct module *module;
3861 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3862 void (*free)(void *priv);
3864 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3865 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3866 struct ieee80211_sta *sta, void *priv_sta);
3867 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3868 struct ieee80211_sta *sta, void *priv_sta,
3870 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3873 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3874 struct ieee80211_sta *sta, void *priv_sta,
3875 struct sk_buff *skb);
3876 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3877 struct ieee80211_tx_rate_control *txrc);
3879 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3880 struct dentry *dir);
3881 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3884 static inline int rate_supported(struct ieee80211_sta *sta,
3885 enum ieee80211_band band,
3888 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3892 * rate_control_send_low - helper for drivers for management/no-ack frames
3894 * Rate control algorithms that agree to use the lowest rate to
3895 * send management frames and NO_ACK data with the respective hw
3896 * retries should use this in the beginning of their mac80211 get_rate
3897 * callback. If true is returned the rate control can simply return.
3898 * If false is returned we guarantee that sta and sta and priv_sta is
3901 * Rate control algorithms wishing to do more intelligent selection of
3902 * rate for multicast/broadcast frames may choose to not use this.
3904 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3905 * that this may be null.
3906 * @priv_sta: private rate control structure. This may be null.
3907 * @txrc: rate control information we sholud populate for mac80211.
3909 bool rate_control_send_low(struct ieee80211_sta *sta,
3911 struct ieee80211_tx_rate_control *txrc);
3915 rate_lowest_index(struct ieee80211_supported_band *sband,
3916 struct ieee80211_sta *sta)
3920 for (i = 0; i < sband->n_bitrates; i++)
3921 if (rate_supported(sta, sband->band, i))
3924 /* warn when we cannot find a rate. */
3927 /* and return 0 (the lowest index) */
3932 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3933 struct ieee80211_sta *sta)
3937 for (i = 0; i < sband->n_bitrates; i++)
3938 if (rate_supported(sta, sband->band, i))
3943 int ieee80211_rate_control_register(struct rate_control_ops *ops);
3944 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3947 conf_is_ht20(struct ieee80211_conf *conf)
3949 return conf->channel_type == NL80211_CHAN_HT20;
3953 conf_is_ht40_minus(struct ieee80211_conf *conf)
3955 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3959 conf_is_ht40_plus(struct ieee80211_conf *conf)
3961 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3965 conf_is_ht40(struct ieee80211_conf *conf)
3967 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3971 conf_is_ht(struct ieee80211_conf *conf)
3973 return conf->channel_type != NL80211_CHAN_NO_HT;
3976 static inline enum nl80211_iftype
3977 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3981 case NL80211_IFTYPE_STATION:
3982 return NL80211_IFTYPE_P2P_CLIENT;
3983 case NL80211_IFTYPE_AP:
3984 return NL80211_IFTYPE_P2P_GO;
3992 static inline enum nl80211_iftype
3993 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3995 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3998 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4000 int rssi_max_thold);
4002 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4005 * ieee80211_ave_rssi - report the average rssi for the specified interface
4007 * @vif: the specified virtual interface
4009 * This function return the average rssi value for the requested interface.
4010 * It assumes that the given vif is valid.
4012 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4014 #endif /* MAC80211_H */