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_bss_change - BSS change notification flags
149 * These flags are used with the bss_info_changed() callback
150 * to indicate which BSS parameter changed.
152 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
153 * also implies a change in the AID.
154 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
155 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
156 * @BSS_CHANGED_ERP_SLOT: slot timing changed
157 * @BSS_CHANGED_HT: 802.11n parameters changed
158 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
159 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
160 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
161 * reason (IBSS and managed mode)
162 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
163 * new beacon (beaconing modes)
164 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
165 * enabled/disabled (beaconing modes)
166 * @BSS_CHANGED_CQM: Connection quality monitor config changed
167 * @BSS_CHANGED_IBSS: IBSS join status changed
168 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
169 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
170 * that it is only ever disabled for station mode.
171 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
172 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
173 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
175 enum ieee80211_bss_change {
176 BSS_CHANGED_ASSOC = 1<<0,
177 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
178 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
179 BSS_CHANGED_ERP_SLOT = 1<<3,
180 BSS_CHANGED_HT = 1<<4,
181 BSS_CHANGED_BASIC_RATES = 1<<5,
182 BSS_CHANGED_BEACON_INT = 1<<6,
183 BSS_CHANGED_BSSID = 1<<7,
184 BSS_CHANGED_BEACON = 1<<8,
185 BSS_CHANGED_BEACON_ENABLED = 1<<9,
186 BSS_CHANGED_CQM = 1<<10,
187 BSS_CHANGED_IBSS = 1<<11,
188 BSS_CHANGED_ARP_FILTER = 1<<12,
189 BSS_CHANGED_QOS = 1<<13,
190 BSS_CHANGED_IDLE = 1<<14,
191 BSS_CHANGED_SSID = 1<<15,
192 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
194 /* when adding here, make sure to change ieee80211_reconfig */
198 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
199 * of addresses for an interface increase beyond this value, hardware ARP
200 * filtering will be disabled.
202 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
205 * enum ieee80211_rssi_event - RSSI threshold event
206 * An indicator for when RSSI goes below/above a certain threshold.
207 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
208 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
210 enum ieee80211_rssi_event {
216 * struct ieee80211_bss_conf - holds the BSS's changing parameters
218 * This structure keeps information about a BSS (and an association
219 * to that BSS) that can change during the lifetime of the BSS.
221 * @assoc: association status
222 * @ibss_joined: indicates whether this station is part of an IBSS
224 * @aid: association ID number, valid only when @assoc is true
225 * @use_cts_prot: use CTS protection
226 * @use_short_preamble: use 802.11b short preamble;
227 * if the hardware cannot handle this it must set the
228 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
229 * @use_short_slot: use short slot time (only relevant for ERP);
230 * if the hardware cannot handle this it must set the
231 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
232 * @dtim_period: num of beacons before the next DTIM, for beaconing,
233 * valid in station mode only while @assoc is true and if also
234 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
236 * @last_tsf: last beacon's/probe response's TSF timestamp (could be old
237 * as it may have been received during scanning long ago)
238 * @beacon_int: beacon interval
239 * @assoc_capability: capabilities taken from assoc resp
240 * @basic_rates: bitmap of basic rates, each bit stands for an
241 * index into the rate table configured by the driver in
243 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
244 * @bssid: The BSSID for this BSS
245 * @enable_beacon: whether beaconing should be enabled or not
246 * @channel_type: Channel type for this BSS -- the hardware might be
247 * configured for HT40+ while this BSS only uses no-HT, for
249 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
250 * This field is only valid when the channel type is one of the HT types.
251 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
253 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
254 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
255 * may filter ARP queries targeted for other addresses than listed here.
256 * The driver must allow ARP queries targeted for all address listed here
257 * to pass through. An empty list implies no ARP queries need to pass.
258 * @arp_addr_cnt: Number of addresses currently on the list.
259 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
260 * filter ARP queries based on the @arp_addr_list, if disabled, the
261 * hardware must not perform any ARP filtering. Note, that the filter will
262 * be enabled also in promiscuous mode.
263 * @qos: This is a QoS-enabled BSS.
264 * @idle: This interface is idle. There's also a global idle flag in the
265 * hardware config which may be more appropriate depending on what
266 * your driver/device needs to do.
267 * @ssid: The SSID of the current vif. Only valid in AP-mode.
268 * @ssid_len: Length of SSID given in @ssid.
269 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
271 struct ieee80211_bss_conf {
273 /* association related data */
274 bool assoc, ibss_joined;
276 /* erp related data */
278 bool use_short_preamble;
283 u16 assoc_capability;
286 int mcast_rate[IEEE80211_NUM_BANDS];
287 u16 ht_operation_mode;
290 enum nl80211_channel_type channel_type;
291 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
293 bool arp_filter_enabled;
296 u8 ssid[IEEE80211_MAX_SSID_LEN];
302 * enum mac80211_tx_control_flags - flags to describe transmission information/status
304 * These flags are used with the @flags member of &ieee80211_tx_info.
306 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
307 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
308 * number to this frame, taking care of not overwriting the fragment
309 * number and increasing the sequence number only when the
310 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
311 * assign sequence numbers to QoS-data frames but cannot do so correctly
312 * for non-QoS-data and management frames because beacons need them from
313 * that counter as well and mac80211 cannot guarantee proper sequencing.
314 * If this flag is set, the driver should instruct the hardware to
315 * assign a sequence number to the frame or assign one itself. Cf. IEEE
316 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
317 * beacons and always be clear for frames without a sequence number field.
318 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
319 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
321 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
322 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
323 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
324 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
325 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
326 * because the destination STA was in powersave mode. Note that to
327 * avoid race conditions, the filter must be set by the hardware or
328 * firmware upon receiving a frame that indicates that the station
329 * went to sleep (must be done on device to filter frames already on
330 * the queue) and may only be unset after mac80211 gives the OK for
331 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
332 * since only then is it guaranteed that no more frames are in the
334 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
335 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
336 * is for the whole aggregation.
337 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
338 * so consider using block ack request (BAR).
339 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
340 * set by rate control algorithms to indicate probe rate, will
341 * be cleared for fragmented frames (except on the last fragment)
342 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
343 * used to indicate that a pending frame requires TX processing before
344 * it can be sent out.
345 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
346 * used to indicate that a frame was already retried due to PS
347 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
348 * used to indicate frame should not be encrypted
349 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
350 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
351 * be sent although the station is in powersave mode.
352 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
353 * transmit function after the current frame, this can be used
354 * by drivers to kick the DMA queue only if unset or when the
356 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
357 * after TX status because the destination was asleep, it must not
358 * be modified again (no seqno assignment, crypto, etc.)
359 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
360 * MLME command (internal to mac80211 to figure out whether to send TX
361 * status to user space)
362 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
363 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
364 * frame and selects the maximum number of streams that it can use.
365 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
366 * the off-channel channel when a remain-on-channel offload is done
367 * in hardware -- normal packets still flow and are expected to be
368 * handled properly by the device.
369 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
370 * testing. It will be sent out with incorrect Michael MIC key to allow
371 * TKIP countermeasures to be tested.
372 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
373 * This flag is actually used for management frame especially for P2P
374 * frames not being sent at CCK rate in 2GHz band.
375 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
376 * when its status is reported the service period ends. For frames in
377 * an SP that mac80211 transmits, it is already set; for driver frames
378 * the driver may set this flag. It is also used to do the same for
380 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
381 * This flag is used to send nullfunc frame at minimum rate when
382 * the nullfunc is used for connection monitoring purpose.
383 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
384 * would be fragmented by size (this is optional, only used for
385 * monitor injection).
387 * Note: If you have to add new flags to the enumeration, then don't
388 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
390 enum mac80211_tx_control_flags {
391 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
392 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
393 IEEE80211_TX_CTL_NO_ACK = BIT(2),
394 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
395 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
396 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
397 IEEE80211_TX_CTL_AMPDU = BIT(6),
398 IEEE80211_TX_CTL_INJECTED = BIT(7),
399 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
400 IEEE80211_TX_STAT_ACK = BIT(9),
401 IEEE80211_TX_STAT_AMPDU = BIT(10),
402 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
403 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
404 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
405 IEEE80211_TX_INTFL_RETRIED = BIT(15),
406 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
407 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
408 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
409 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
410 /* hole at 20, use later */
411 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
412 IEEE80211_TX_CTL_LDPC = BIT(22),
413 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
414 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
415 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
416 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
417 IEEE80211_TX_STATUS_EOSP = BIT(28),
418 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
419 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
422 #define IEEE80211_TX_CTL_STBC_SHIFT 23
425 * This definition is used as a mask to clear all temporary flags, which are
426 * set by the tx handlers for each transmission attempt by the mac80211 stack.
428 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
429 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
430 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
431 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
432 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
433 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
434 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
435 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
438 * enum mac80211_rate_control_flags - per-rate flags set by the
439 * Rate Control algorithm.
441 * These flags are set by the Rate control algorithm for each rate during tx,
442 * in the @flags member of struct ieee80211_tx_rate.
444 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
445 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
446 * This is set if the current BSS requires ERP protection.
447 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
448 * @IEEE80211_TX_RC_MCS: HT rate.
449 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
451 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
452 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
453 * adjacent 20 MHz channels, if the current channel type is
454 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
455 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
457 enum mac80211_rate_control_flags {
458 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
459 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
460 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
462 /* rate index is an MCS rate number instead of an index */
463 IEEE80211_TX_RC_MCS = BIT(3),
464 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
465 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
466 IEEE80211_TX_RC_DUP_DATA = BIT(6),
467 IEEE80211_TX_RC_SHORT_GI = BIT(7),
471 /* there are 40 bytes if you don't need the rateset to be kept */
472 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
474 /* if you do need the rateset, then you have less space */
475 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
477 /* maximum number of rate stages */
478 #define IEEE80211_TX_MAX_RATES 5
481 * struct ieee80211_tx_rate - rate selection/status
483 * @idx: rate index to attempt to send with
484 * @flags: rate control flags (&enum mac80211_rate_control_flags)
485 * @count: number of tries in this rate before going to the next rate
487 * A value of -1 for @idx indicates an invalid rate and, if used
488 * in an array of retry rates, that no more rates should be tried.
490 * When used for transmit status reporting, the driver should
491 * always report the rate along with the flags it used.
493 * &struct ieee80211_tx_info contains an array of these structs
494 * in the control information, and it will be filled by the rate
495 * control algorithm according to what should be sent. For example,
496 * if this array contains, in the format { <idx>, <count> } the
498 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
499 * then this means that the frame should be transmitted
500 * up to twice at rate 3, up to twice at rate 2, and up to four
501 * times at rate 1 if it doesn't get acknowledged. Say it gets
502 * acknowledged by the peer after the fifth attempt, the status
503 * information should then contain
504 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
505 * since it was transmitted twice at rate 3, twice at rate 2
506 * and once at rate 1 after which we received an acknowledgement.
508 struct ieee80211_tx_rate {
515 * struct ieee80211_tx_info - skb transmit information
517 * This structure is placed in skb->cb for three uses:
518 * (1) mac80211 TX control - mac80211 tells the driver what to do
519 * (2) driver internal use (if applicable)
520 * (3) TX status information - driver tells mac80211 what happened
522 * The TX control's sta pointer is only valid during the ->tx call,
525 * @flags: transmit info flags, defined above
526 * @band: the band to transmit on (use for checking for races)
527 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
528 * @ack_frame_id: internal frame ID for TX status, used internally
529 * @control: union for control data
530 * @status: union for status data
531 * @driver_data: array of driver_data pointers
532 * @ampdu_ack_len: number of acked aggregated frames.
533 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
534 * @ampdu_len: number of aggregated frames.
535 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
536 * @ack_signal: signal strength of the ACK frame
538 struct ieee80211_tx_info {
539 /* common information */
552 struct ieee80211_tx_rate rates[
553 IEEE80211_TX_MAX_RATES];
556 /* only needed before rate control */
557 unsigned long jiffies;
559 /* NB: vif can be NULL for injected frames */
560 struct ieee80211_vif *vif;
561 struct ieee80211_key_conf *hw_key;
562 struct ieee80211_sta *sta;
565 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
573 struct ieee80211_tx_rate driver_rates[
574 IEEE80211_TX_MAX_RATES];
575 void *rate_driver_data[
576 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
579 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
584 * struct ieee80211_sched_scan_ies - scheduled scan IEs
586 * This structure is used to pass the appropriate IEs to be used in scheduled
587 * scans for all bands. It contains both the IEs passed from the userspace
588 * and the ones generated by mac80211.
590 * @ie: array with the IEs for each supported band
591 * @len: array with the total length of the IEs for each band
593 struct ieee80211_sched_scan_ies {
594 u8 *ie[IEEE80211_NUM_BANDS];
595 size_t len[IEEE80211_NUM_BANDS];
598 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
600 return (struct ieee80211_tx_info *)skb->cb;
603 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
605 return (struct ieee80211_rx_status *)skb->cb;
609 * ieee80211_tx_info_clear_status - clear TX status
611 * @info: The &struct ieee80211_tx_info to be cleared.
613 * When the driver passes an skb back to mac80211, it must report
614 * a number of things in TX status. This function clears everything
615 * in the TX status but the rate control information (it does clear
616 * the count since you need to fill that in anyway).
618 * NOTE: You can only use this function if you do NOT use
619 * info->driver_data! Use info->rate_driver_data
620 * instead if you need only the less space that allows.
623 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
627 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
628 offsetof(struct ieee80211_tx_info, control.rates));
629 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
630 offsetof(struct ieee80211_tx_info, driver_rates));
631 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
632 /* clear the rate counts */
633 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
634 info->status.rates[i].count = 0;
637 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
638 memset(&info->status.ampdu_ack_len, 0,
639 sizeof(struct ieee80211_tx_info) -
640 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
645 * enum mac80211_rx_flags - receive flags
647 * These flags are used with the @flag member of &struct ieee80211_rx_status.
648 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
649 * Use together with %RX_FLAG_MMIC_STRIPPED.
650 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
651 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
652 * verification has been done by the hardware.
653 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
654 * If this flag is set, the stack cannot do any replay detection
655 * hence the driver or hardware will have to do that.
656 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
658 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
660 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
661 * field) is valid and contains the time the first symbol of the MPDU
662 * was received. This is useful in monitor mode and for proper IBSS
664 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
665 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
666 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
667 * @RX_FLAG_SHORT_GI: Short guard interval was used
668 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
669 * Valid only for data frames (mainly A-MPDU)
670 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
671 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
672 * to hw.radiotap_mcs_details to advertise that fact
674 enum mac80211_rx_flags {
675 RX_FLAG_MMIC_ERROR = 1<<0,
676 RX_FLAG_DECRYPTED = 1<<1,
677 RX_FLAG_MMIC_STRIPPED = 1<<3,
678 RX_FLAG_IV_STRIPPED = 1<<4,
679 RX_FLAG_FAILED_FCS_CRC = 1<<5,
680 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
681 RX_FLAG_MACTIME_MPDU = 1<<7,
682 RX_FLAG_SHORTPRE = 1<<8,
684 RX_FLAG_40MHZ = 1<<10,
685 RX_FLAG_SHORT_GI = 1<<11,
686 RX_FLAG_NO_SIGNAL_VAL = 1<<12,
687 RX_FLAG_HT_GF = 1<<13,
691 * struct ieee80211_rx_status - receive status
693 * The low-level driver should provide this information (the subset
694 * supported by hardware) to the 802.11 code with each received
695 * frame, in the skb's control buffer (cb).
697 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
698 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
699 * @band: the active band when this frame was received
700 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
701 * @signal: signal strength when receiving this frame, either in dBm, in dB or
702 * unspecified depending on the hardware capabilities flags
703 * @IEEE80211_HW_SIGNAL_*
704 * @antenna: antenna used
705 * @rate_idx: index of data rate into band's supported rates or MCS index if
706 * HT rates are use (RX_FLAG_HT)
708 * @rx_flags: internal RX flags for mac80211
710 struct ieee80211_rx_status {
712 enum ieee80211_band band;
718 unsigned int rx_flags;
722 * enum ieee80211_conf_flags - configuration flags
724 * Flags to define PHY configuration options
726 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
727 * to determine for example whether to calculate timestamps for packets
728 * or not, do not use instead of filter flags!
729 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
730 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
731 * meaning that the hardware still wakes up for beacons, is able to
732 * transmit frames and receive the possible acknowledgment frames.
733 * Not to be confused with hardware specific wakeup/sleep states,
734 * driver is responsible for that. See the section "Powersave support"
736 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
737 * the driver should be prepared to handle configuration requests but
738 * may turn the device off as much as possible. Typically, this flag will
739 * be set when an interface is set UP but not associated or scanning, but
740 * it can also be unset in that case when monitor interfaces are active.
741 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
744 enum ieee80211_conf_flags {
745 IEEE80211_CONF_MONITOR = (1<<0),
746 IEEE80211_CONF_PS = (1<<1),
747 IEEE80211_CONF_IDLE = (1<<2),
748 IEEE80211_CONF_OFFCHANNEL = (1<<3),
753 * enum ieee80211_conf_changed - denotes which configuration changed
755 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
756 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
757 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
758 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
759 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
760 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
761 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
762 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
764 enum ieee80211_conf_changed {
765 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
766 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
767 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
768 IEEE80211_CONF_CHANGE_PS = BIT(4),
769 IEEE80211_CONF_CHANGE_POWER = BIT(5),
770 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
771 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
772 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
776 * enum ieee80211_smps_mode - spatial multiplexing power save mode
778 * @IEEE80211_SMPS_AUTOMATIC: automatic
779 * @IEEE80211_SMPS_OFF: off
780 * @IEEE80211_SMPS_STATIC: static
781 * @IEEE80211_SMPS_DYNAMIC: dynamic
782 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
784 enum ieee80211_smps_mode {
785 IEEE80211_SMPS_AUTOMATIC,
787 IEEE80211_SMPS_STATIC,
788 IEEE80211_SMPS_DYNAMIC,
791 IEEE80211_SMPS_NUM_MODES,
795 * struct ieee80211_conf - configuration of the device
797 * This struct indicates how the driver shall configure the hardware.
799 * @flags: configuration flags defined above
801 * @listen_interval: listen interval in units of beacon interval
802 * @max_sleep_period: the maximum number of beacon intervals to sleep for
803 * before checking the beacon for a TIM bit (managed mode only); this
804 * value will be only achievable between DTIM frames, the hardware
805 * needs to check for the multicast traffic bit in DTIM beacons.
806 * This variable is valid only when the CONF_PS flag is set.
807 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
808 * in power saving. Power saving will not be enabled until a beacon
809 * has been received and the DTIM period is known.
810 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
811 * powersave documentation below. This variable is valid only when
812 * the CONF_PS flag is set.
814 * @power_level: requested transmit power (in dBm)
816 * @channel: the channel to tune to
817 * @channel_type: the channel (HT) type
819 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
820 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
821 * but actually means the number of transmissions not the number of retries
822 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
823 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
824 * number of transmissions not the number of retries
826 * @smps_mode: spatial multiplexing powersave mode; note that
827 * %IEEE80211_SMPS_STATIC is used when the device is not
828 * configured for an HT channel
830 struct ieee80211_conf {
832 int power_level, dynamic_ps_timeout;
833 int max_sleep_period;
838 u8 long_frame_max_tx_count, short_frame_max_tx_count;
840 struct ieee80211_channel *channel;
841 enum nl80211_channel_type channel_type;
842 enum ieee80211_smps_mode smps_mode;
846 * struct ieee80211_channel_switch - holds the channel switch data
848 * The information provided in this structure is required for channel switch
851 * @timestamp: value in microseconds of the 64-bit Time Synchronization
852 * Function (TSF) timer when the frame containing the channel switch
853 * announcement was received. This is simply the rx.mactime parameter
854 * the driver passed into mac80211.
855 * @block_tx: Indicates whether transmission must be blocked before the
856 * scheduled channel switch, as indicated by the AP.
857 * @channel: the new channel to switch to
858 * @count: the number of TBTT's until the channel switch event
860 struct ieee80211_channel_switch {
863 struct ieee80211_channel *channel;
868 * enum ieee80211_vif_flags - virtual interface flags
870 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
871 * on this virtual interface to avoid unnecessary CPU wakeups
872 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
873 * monitoring on this virtual interface -- i.e. it can monitor
874 * connection quality related parameters, such as the RSSI level and
875 * provide notifications if configured trigger levels are reached.
877 enum ieee80211_vif_flags {
878 IEEE80211_VIF_BEACON_FILTER = BIT(0),
879 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
883 * struct ieee80211_vif - per-interface data
885 * Data in this structure is continually present for driver
886 * use during the life of a virtual interface.
888 * @type: type of this virtual interface
889 * @bss_conf: BSS configuration for this interface, either our own
890 * or the BSS we're associated to
891 * @addr: address of this interface
892 * @p2p: indicates whether this AP or STA interface is a p2p
893 * interface, i.e. a GO or p2p-sta respectively
894 * @driver_flags: flags/capabilities the driver has for this interface,
895 * these need to be set (or cleared) when the interface is added
896 * or, if supported by the driver, the interface type is changed
897 * at runtime, mac80211 will never touch this field
898 * @hw_queue: hardware queue for each AC
899 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
900 * @drv_priv: data area for driver use, will always be aligned to
903 struct ieee80211_vif {
904 enum nl80211_iftype type;
905 struct ieee80211_bss_conf bss_conf;
910 u8 hw_queue[IEEE80211_NUM_ACS];
915 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
918 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
920 #ifdef CONFIG_MAC80211_MESH
921 return vif->type == NL80211_IFTYPE_MESH_POINT;
927 * enum ieee80211_key_flags - key flags
929 * These flags are used for communication about keys between the driver
930 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
932 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
933 * that the STA this key will be used with could be using QoS.
934 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
935 * driver to indicate that it requires IV generation for this
937 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
938 * the driver for a TKIP key if it requires Michael MIC
939 * generation in software.
940 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
941 * that the key is pairwise rather then a shared key.
942 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
943 * CCMP key if it requires CCMP encryption of management frames (MFP) to
944 * be done in software.
945 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
946 * if space should be prepared for the IV, but the IV
947 * itself should not be generated. Do not set together with
948 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
950 enum ieee80211_key_flags {
951 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
952 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
953 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
954 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
955 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
956 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
960 * struct ieee80211_key_conf - key information
962 * This key information is given by mac80211 to the driver by
963 * the set_key() callback in &struct ieee80211_ops.
965 * @hw_key_idx: To be set by the driver, this is the key index the driver
966 * wants to be given when a frame is transmitted and needs to be
967 * encrypted in hardware.
968 * @cipher: The key's cipher suite selector.
969 * @flags: key flags, see &enum ieee80211_key_flags.
970 * @keyidx: the key index (0-3)
971 * @keylen: key material length
972 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
974 * - Temporal Encryption Key (128 bits)
975 * - Temporal Authenticator Tx MIC Key (64 bits)
976 * - Temporal Authenticator Rx MIC Key (64 bits)
977 * @icv_len: The ICV length for this key type
978 * @iv_len: The IV length for this key type
980 struct ieee80211_key_conf {
992 * enum set_key_cmd - key command
994 * Used with the set_key() callback in &struct ieee80211_ops, this
995 * indicates whether a key is being removed or added.
997 * @SET_KEY: a key is set
998 * @DISABLE_KEY: a key must be disabled
1001 SET_KEY, DISABLE_KEY,
1005 * enum ieee80211_sta_state - station state
1007 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1008 * this is a special state for add/remove transitions
1009 * @IEEE80211_STA_NONE: station exists without special state
1010 * @IEEE80211_STA_AUTH: station is authenticated
1011 * @IEEE80211_STA_ASSOC: station is associated
1012 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1014 enum ieee80211_sta_state {
1015 /* NOTE: These need to be ordered correctly! */
1016 IEEE80211_STA_NOTEXIST,
1019 IEEE80211_STA_ASSOC,
1020 IEEE80211_STA_AUTHORIZED,
1024 * struct ieee80211_sta - station table entry
1026 * A station table entry represents a station we are possibly
1027 * communicating with. Since stations are RCU-managed in
1028 * mac80211, any ieee80211_sta pointer you get access to must
1029 * either be protected by rcu_read_lock() explicitly or implicitly,
1030 * or you must take good care to not use such a pointer after a
1031 * call to your sta_remove callback that removed it.
1033 * @addr: MAC address
1034 * @aid: AID we assigned to the station if we're an AP
1035 * @supp_rates: Bitmap of supported rates (per band)
1036 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1037 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1038 * @drv_priv: data area for driver use, will always be aligned to
1039 * sizeof(void *), size is determined in hw information.
1040 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1041 * if wme is supported.
1042 * @max_sp: max Service Period. Only valid if wme is supported.
1044 struct ieee80211_sta {
1045 u32 supp_rates[IEEE80211_NUM_BANDS];
1048 struct ieee80211_sta_ht_cap ht_cap;
1054 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1058 * enum sta_notify_cmd - sta notify command
1060 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1061 * indicates if an associated station made a power state transition.
1063 * @STA_NOTIFY_SLEEP: a station is now sleeping
1064 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1066 enum sta_notify_cmd {
1067 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1071 * enum ieee80211_hw_flags - hardware flags
1073 * These flags are used to indicate hardware capabilities to
1074 * the stack. Generally, flags here should have their meaning
1075 * done in a way that the simplest hardware doesn't need setting
1076 * any particular flags. There are some exceptions to this rule,
1077 * however, so you are advised to review these flags carefully.
1079 * @IEEE80211_HW_HAS_RATE_CONTROL:
1080 * The hardware or firmware includes rate control, and cannot be
1081 * controlled by the stack. As such, no rate control algorithm
1082 * should be instantiated, and the TX rate reported to userspace
1083 * will be taken from the TX status instead of the rate control
1085 * Note that this requires that the driver implement a number of
1086 * callbacks so it has the correct information, it needs to have
1087 * the @set_rts_threshold callback and must look at the BSS config
1088 * @use_cts_prot for G/N protection, @use_short_slot for slot
1089 * timing in 2.4 GHz and @use_short_preamble for preambles for
1092 * @IEEE80211_HW_RX_INCLUDES_FCS:
1093 * Indicates that received frames passed to the stack include
1094 * the FCS at the end.
1096 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1097 * Some wireless LAN chipsets buffer broadcast/multicast frames
1098 * for power saving stations in the hardware/firmware and others
1099 * rely on the host system for such buffering. This option is used
1100 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1101 * multicast frames when there are power saving stations so that
1102 * the driver can fetch them with ieee80211_get_buffered_bc().
1104 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1105 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1107 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1108 * Hardware is not capable of receiving frames with short preamble on
1111 * @IEEE80211_HW_SIGNAL_UNSPEC:
1112 * Hardware can provide signal values but we don't know its units. We
1113 * expect values between 0 and @max_signal.
1114 * If possible please provide dB or dBm instead.
1116 * @IEEE80211_HW_SIGNAL_DBM:
1117 * Hardware gives signal values in dBm, decibel difference from
1118 * one milliwatt. This is the preferred method since it is standardized
1119 * between different devices. @max_signal does not need to be set.
1121 * @IEEE80211_HW_SPECTRUM_MGMT:
1122 * Hardware supports spectrum management defined in 802.11h
1123 * Measurement, Channel Switch, Quieting, TPC
1125 * @IEEE80211_HW_AMPDU_AGGREGATION:
1126 * Hardware supports 11n A-MPDU aggregation.
1128 * @IEEE80211_HW_SUPPORTS_PS:
1129 * Hardware has power save support (i.e. can go to sleep).
1131 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1132 * Hardware requires nullfunc frame handling in stack, implies
1133 * stack support for dynamic PS.
1135 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1136 * Hardware has support for dynamic PS.
1138 * @IEEE80211_HW_MFP_CAPABLE:
1139 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1141 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1142 * Hardware supports static spatial multiplexing powersave,
1143 * ie. can turn off all but one chain even on HT connections
1144 * that should be using more chains.
1146 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1147 * Hardware supports dynamic spatial multiplexing powersave,
1148 * ie. can turn off all but one chain and then wake the rest
1149 * up as required after, for example, rts/cts handshake.
1151 * @IEEE80211_HW_SUPPORTS_UAPSD:
1152 * Hardware supports Unscheduled Automatic Power Save Delivery
1153 * (U-APSD) in managed mode. The mode is configured with
1154 * conf_tx() operation.
1156 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1157 * Hardware can provide ack status reports of Tx frames to
1160 * @IEEE80211_HW_CONNECTION_MONITOR:
1161 * The hardware performs its own connection monitoring, including
1162 * periodic keep-alives to the AP and probing the AP on beacon loss.
1163 * When this flag is set, signaling beacon-loss will cause an immediate
1164 * change to disassociated state.
1166 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1167 * This device needs to know the DTIM period for the BSS before
1170 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1171 * per-station GTKs as used by IBSS RSN or during fast transition. If
1172 * the device doesn't support per-station GTKs, but can be asked not
1173 * to decrypt group addressed frames, then IBSS RSN support is still
1174 * possible but software crypto will be used. Advertise the wiphy flag
1175 * only in that case.
1177 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1178 * autonomously manages the PS status of connected stations. When
1179 * this flag is set mac80211 will not trigger PS mode for connected
1180 * stations based on the PM bit of incoming frames.
1181 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1182 * the PS mode of connected stations.
1184 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1185 * setup strictly in HW. mac80211 should not attempt to do this in
1188 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1189 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1192 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1193 * a virtual monitor interface when monitor interfaces are the only
1194 * active interfaces.
1196 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1197 * queue mapping in order to use different queues (not just one per AC)
1198 * for different virtual interfaces. See the doc section on HW queue
1199 * control for more details.
1201 enum ieee80211_hw_flags {
1202 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1203 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1204 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1205 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1206 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1207 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1208 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1209 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1210 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1211 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1212 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1213 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1214 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1215 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1216 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1217 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1218 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1219 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1220 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1221 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1222 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1223 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1224 IEEE80211_HW_AP_LINK_PS = 1<<22,
1225 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1226 IEEE80211_HW_SCAN_WHILE_IDLE = 1<<24,
1230 * struct ieee80211_hw - hardware information and state
1232 * This structure contains the configuration and hardware
1233 * information for an 802.11 PHY.
1235 * @wiphy: This points to the &struct wiphy allocated for this
1236 * 802.11 PHY. You must fill in the @perm_addr and @dev
1237 * members of this structure using SET_IEEE80211_DEV()
1238 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1239 * bands (with channels, bitrates) are registered here.
1241 * @conf: &struct ieee80211_conf, device configuration, don't use.
1243 * @priv: pointer to private area that was allocated for driver use
1244 * along with this structure.
1246 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1248 * @extra_tx_headroom: headroom to reserve in each transmit skb
1249 * for use by the driver (e.g. for transmit headers.)
1251 * @channel_change_time: time (in microseconds) it takes to change channels.
1253 * @max_signal: Maximum value for signal (rssi) in RX information, used
1254 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1256 * @max_listen_interval: max listen interval in units of beacon interval
1259 * @queues: number of available hardware transmit queues for
1260 * data packets. WMM/QoS requires at least four, these
1261 * queues need to have configurable access parameters.
1263 * @rate_control_algorithm: rate control algorithm for this hardware.
1264 * If unset (NULL), the default algorithm will be used. Must be
1265 * set before calling ieee80211_register_hw().
1267 * @vif_data_size: size (in bytes) of the drv_priv data area
1268 * within &struct ieee80211_vif.
1269 * @sta_data_size: size (in bytes) of the drv_priv data area
1270 * within &struct ieee80211_sta.
1272 * @max_rates: maximum number of alternate rate retry stages the hw
1274 * @max_report_rates: maximum number of alternate rate retry stages
1275 * the hw can report back.
1276 * @max_rate_tries: maximum number of tries for each stage
1278 * @napi_weight: weight used for NAPI polling. You must specify an
1279 * appropriate value here if a napi_poll operation is provided
1282 * @max_rx_aggregation_subframes: maximum buffer size (number of
1283 * sub-frames) to be used for A-MPDU block ack receiver
1285 * This is only relevant if the device has restrictions on the
1286 * number of subframes, if it relies on mac80211 to do reordering
1287 * it shouldn't be set.
1289 * @max_tx_aggregation_subframes: maximum number of subframes in an
1290 * aggregate an HT driver will transmit, used by the peer as a
1291 * hint to size its reorder buffer.
1293 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1294 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1296 * @radiotap_mcs_details: lists which MCS information can the HW
1297 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1298 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1299 * adding _BW is supported today.
1301 * @netdev_features: netdev features to be set in each netdev created
1302 * from this HW. Note only HW checksum features are currently
1303 * compatible with mac80211. Other feature bits will be rejected.
1305 struct ieee80211_hw {
1306 struct ieee80211_conf conf;
1307 struct wiphy *wiphy;
1308 const char *rate_control_algorithm;
1311 unsigned int extra_tx_headroom;
1312 int channel_change_time;
1317 u16 max_listen_interval;
1320 u8 max_report_rates;
1322 u8 max_rx_aggregation_subframes;
1323 u8 max_tx_aggregation_subframes;
1324 u8 offchannel_tx_hw_queue;
1325 u8 radiotap_mcs_details;
1326 netdev_features_t netdev_features;
1330 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1332 * @wiphy: the &struct wiphy which we want to query
1334 * mac80211 drivers can use this to get to their respective
1335 * &struct ieee80211_hw. Drivers wishing to get to their own private
1336 * structure can then access it via hw->priv. Note that mac802111 drivers should
1337 * not use wiphy_priv() to try to get their private driver structure as this
1338 * is already used internally by mac80211.
1340 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1343 * SET_IEEE80211_DEV - set device for 802.11 hardware
1345 * @hw: the &struct ieee80211_hw to set the device for
1346 * @dev: the &struct device of this 802.11 device
1348 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1350 set_wiphy_dev(hw->wiphy, dev);
1354 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1356 * @hw: the &struct ieee80211_hw to set the MAC address for
1357 * @addr: the address to set
1359 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1361 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1364 static inline struct ieee80211_rate *
1365 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1366 const struct ieee80211_tx_info *c)
1368 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1370 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1373 static inline struct ieee80211_rate *
1374 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1375 const struct ieee80211_tx_info *c)
1377 if (c->control.rts_cts_rate_idx < 0)
1379 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1382 static inline struct ieee80211_rate *
1383 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1384 const struct ieee80211_tx_info *c, int idx)
1386 if (c->control.rates[idx + 1].idx < 0)
1388 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1392 * ieee80211_free_txskb - free TX skb
1396 * Free a transmit skb. Use this funtion when some failure
1397 * to transmit happened and thus status cannot be reported.
1399 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1402 * DOC: Hardware crypto acceleration
1404 * mac80211 is capable of taking advantage of many hardware
1405 * acceleration designs for encryption and decryption operations.
1407 * The set_key() callback in the &struct ieee80211_ops for a given
1408 * device is called to enable hardware acceleration of encryption and
1409 * decryption. The callback takes a @sta parameter that will be NULL
1410 * for default keys or keys used for transmission only, or point to
1411 * the station information for the peer for individual keys.
1412 * Multiple transmission keys with the same key index may be used when
1413 * VLANs are configured for an access point.
1415 * When transmitting, the TX control data will use the @hw_key_idx
1416 * selected by the driver by modifying the &struct ieee80211_key_conf
1417 * pointed to by the @key parameter to the set_key() function.
1419 * The set_key() call for the %SET_KEY command should return 0 if
1420 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1421 * added; if you return 0 then hw_key_idx must be assigned to the
1422 * hardware key index, you are free to use the full u8 range.
1424 * When the cmd is %DISABLE_KEY then it must succeed.
1426 * Note that it is permissible to not decrypt a frame even if a key
1427 * for it has been uploaded to hardware, the stack will not make any
1428 * decision based on whether a key has been uploaded or not but rather
1429 * based on the receive flags.
1431 * The &struct ieee80211_key_conf structure pointed to by the @key
1432 * parameter is guaranteed to be valid until another call to set_key()
1433 * removes it, but it can only be used as a cookie to differentiate
1436 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1437 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1439 * The update_tkip_key() call updates the driver with the new phase 1 key.
1440 * This happens every time the iv16 wraps around (every 65536 packets). The
1441 * set_key() call will happen only once for each key (unless the AP did
1442 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1443 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1444 * handler is software decryption with wrap around of iv16.
1448 * DOC: Powersave support
1450 * mac80211 has support for various powersave implementations.
1452 * First, it can support hardware that handles all powersaving by itself,
1453 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1454 * flag. In that case, it will be told about the desired powersave mode
1455 * with the %IEEE80211_CONF_PS flag depending on the association status.
1456 * The hardware must take care of sending nullfunc frames when necessary,
1457 * i.e. when entering and leaving powersave mode. The hardware is required
1458 * to look at the AID in beacons and signal to the AP that it woke up when
1459 * it finds traffic directed to it.
1461 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1462 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1463 * with hardware wakeup and sleep states. Driver is responsible for waking
1464 * up the hardware before issuing commands to the hardware and putting it
1465 * back to sleep at appropriate times.
1467 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1468 * buffered multicast/broadcast frames after the beacon. Also it must be
1469 * possible to send frames and receive the acknowledment frame.
1471 * Other hardware designs cannot send nullfunc frames by themselves and also
1472 * need software support for parsing the TIM bitmap. This is also supported
1473 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1474 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1475 * required to pass up beacons. The hardware is still required to handle
1476 * waking up for multicast traffic; if it cannot the driver must handle that
1477 * as best as it can, mac80211 is too slow to do that.
1479 * Dynamic powersave is an extension to normal powersave in which the
1480 * hardware stays awake for a user-specified period of time after sending a
1481 * frame so that reply frames need not be buffered and therefore delayed to
1482 * the next wakeup. It's compromise of getting good enough latency when
1483 * there's data traffic and still saving significantly power in idle
1486 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1487 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1488 * flag and mac80211 will handle everything automatically. Additionally,
1489 * hardware having support for the dynamic PS feature may set the
1490 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1491 * dynamic PS mode itself. The driver needs to look at the
1492 * @dynamic_ps_timeout hardware configuration value and use it that value
1493 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1494 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1495 * enabled whenever user has enabled powersave.
1497 * Some hardware need to toggle a single shared antenna between WLAN and
1498 * Bluetooth to facilitate co-existence. These types of hardware set
1499 * limitations on the use of host controlled dynamic powersave whenever there
1500 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1501 * driver may request temporarily going into full power save, in order to
1502 * enable toggling the antenna between BT and WLAN. If the driver requests
1503 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1504 * temporarily set to zero until the driver re-enables dynamic powersave.
1506 * Driver informs U-APSD client support by enabling
1507 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1508 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1509 * Nullfunc frames and stay awake until the service period has ended. To
1510 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1511 * from that AC are transmitted with powersave enabled.
1513 * Note: U-APSD client mode is not yet supported with
1514 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1518 * DOC: Beacon filter support
1520 * Some hardware have beacon filter support to reduce host cpu wakeups
1521 * which will reduce system power consumption. It usually works so that
1522 * the firmware creates a checksum of the beacon but omits all constantly
1523 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1524 * beacon is forwarded to the host, otherwise it will be just dropped. That
1525 * way the host will only receive beacons where some relevant information
1526 * (for example ERP protection or WMM settings) have changed.
1528 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1529 * interface capability. The driver needs to enable beacon filter support
1530 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1531 * power save is enabled, the stack will not check for beacon loss and the
1532 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1534 * The time (or number of beacons missed) until the firmware notifies the
1535 * driver of a beacon loss event (which in turn causes the driver to call
1536 * ieee80211_beacon_loss()) should be configurable and will be controlled
1537 * by mac80211 and the roaming algorithm in the future.
1539 * Since there may be constantly changing information elements that nothing
1540 * in the software stack cares about, we will, in the future, have mac80211
1541 * tell the driver which information elements are interesting in the sense
1542 * that we want to see changes in them. This will include
1543 * - a list of information element IDs
1544 * - a list of OUIs for the vendor information element
1546 * Ideally, the hardware would filter out any beacons without changes in the
1547 * requested elements, but if it cannot support that it may, at the expense
1548 * of some efficiency, filter out only a subset. For example, if the device
1549 * doesn't support checking for OUIs it should pass up all changes in all
1550 * vendor information elements.
1552 * Note that change, for the sake of simplification, also includes information
1553 * elements appearing or disappearing from the beacon.
1555 * Some hardware supports an "ignore list" instead, just make sure nothing
1556 * that was requested is on the ignore list, and include commonly changing
1557 * information element IDs in the ignore list, for example 11 (BSS load) and
1558 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1559 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1560 * it could also include some currently unused IDs.
1563 * In addition to these capabilities, hardware should support notifying the
1564 * host of changes in the beacon RSSI. This is relevant to implement roaming
1565 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1566 * the received data packets). This can consist in notifying the host when
1567 * the RSSI changes significantly or when it drops below or rises above
1568 * configurable thresholds. In the future these thresholds will also be
1569 * configured by mac80211 (which gets them from userspace) to implement
1570 * them as the roaming algorithm requires.
1572 * If the hardware cannot implement this, the driver should ask it to
1573 * periodically pass beacon frames to the host so that software can do the
1574 * signal strength threshold checking.
1578 * DOC: Spatial multiplexing power save
1580 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1581 * power in an 802.11n implementation. For details on the mechanism
1582 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1583 * "11.2.3 SM power save".
1585 * The mac80211 implementation is capable of sending action frames
1586 * to update the AP about the station's SMPS mode, and will instruct
1587 * the driver to enter the specific mode. It will also announce the
1588 * requested SMPS mode during the association handshake. Hardware
1589 * support for this feature is required, and can be indicated by
1592 * The default mode will be "automatic", which nl80211/cfg80211
1593 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1594 * turned off otherwise.
1596 * To support this feature, the driver must set the appropriate
1597 * hardware support flags, and handle the SMPS flag to the config()
1598 * operation. It will then with this mechanism be instructed to
1599 * enter the requested SMPS mode while associated to an HT AP.
1603 * DOC: Frame filtering
1605 * mac80211 requires to see many management frames for proper
1606 * operation, and users may want to see many more frames when
1607 * in monitor mode. However, for best CPU usage and power consumption,
1608 * having as few frames as possible percolate through the stack is
1609 * desirable. Hence, the hardware should filter as much as possible.
1611 * To achieve this, mac80211 uses filter flags (see below) to tell
1612 * the driver's configure_filter() function which frames should be
1613 * passed to mac80211 and which should be filtered out.
1615 * Before configure_filter() is invoked, the prepare_multicast()
1616 * callback is invoked with the parameters @mc_count and @mc_list
1617 * for the combined multicast address list of all virtual interfaces.
1618 * It's use is optional, and it returns a u64 that is passed to
1619 * configure_filter(). Additionally, configure_filter() has the
1620 * arguments @changed_flags telling which flags were changed and
1621 * @total_flags with the new flag states.
1623 * If your device has no multicast address filters your driver will
1624 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1625 * parameter to see whether multicast frames should be accepted
1628 * All unsupported flags in @total_flags must be cleared.
1629 * Hardware does not support a flag if it is incapable of _passing_
1630 * the frame to the stack. Otherwise the driver must ignore
1631 * the flag, but not clear it.
1632 * You must _only_ clear the flag (announce no support for the
1633 * flag to mac80211) if you are not able to pass the packet type
1634 * to the stack (so the hardware always filters it).
1635 * So for example, you should clear @FIF_CONTROL, if your hardware
1636 * always filters control frames. If your hardware always passes
1637 * control frames to the kernel and is incapable of filtering them,
1638 * you do _not_ clear the @FIF_CONTROL flag.
1639 * This rule applies to all other FIF flags as well.
1643 * DOC: AP support for powersaving clients
1645 * In order to implement AP and P2P GO modes, mac80211 has support for
1646 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1647 * There currently is no support for sAPSD.
1649 * There is one assumption that mac80211 makes, namely that a client
1650 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1651 * Both are supported, and both can be used by the same client, but
1652 * they can't be used concurrently by the same client. This simplifies
1655 * The first thing to keep in mind is that there is a flag for complete
1656 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1657 * mac80211 expects the driver to handle most of the state machine for
1658 * powersaving clients and will ignore the PM bit in incoming frames.
1659 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1660 * stations' powersave transitions. In this mode, mac80211 also doesn't
1661 * handle PS-Poll/uAPSD.
1663 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1664 * PM bit in incoming frames for client powersave transitions. When a
1665 * station goes to sleep, we will stop transmitting to it. There is,
1666 * however, a race condition: a station might go to sleep while there is
1667 * data buffered on hardware queues. If the device has support for this
1668 * it will reject frames, and the driver should give the frames back to
1669 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1670 * cause mac80211 to retry the frame when the station wakes up. The
1671 * driver is also notified of powersave transitions by calling its
1672 * @sta_notify callback.
1674 * When the station is asleep, it has three choices: it can wake up,
1675 * it can PS-Poll, or it can possibly start a uAPSD service period.
1676 * Waking up is implemented by simply transmitting all buffered (and
1677 * filtered) frames to the station. This is the easiest case. When
1678 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1679 * will inform the driver of this with the @allow_buffered_frames
1680 * callback; this callback is optional. mac80211 will then transmit
1681 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1682 * on each frame. The last frame in the service period (or the only
1683 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1684 * indicate that it ends the service period; as this frame must have
1685 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1686 * When TX status is reported for this frame, the service period is
1687 * marked has having ended and a new one can be started by the peer.
1689 * Additionally, non-bufferable MMPDUs can also be transmitted by
1690 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1692 * Another race condition can happen on some devices like iwlwifi
1693 * when there are frames queued for the station and it wakes up
1694 * or polls; the frames that are already queued could end up being
1695 * transmitted first instead, causing reordering and/or wrong
1696 * processing of the EOSP. The cause is that allowing frames to be
1697 * transmitted to a certain station is out-of-band communication to
1698 * the device. To allow this problem to be solved, the driver can
1699 * call ieee80211_sta_block_awake() if frames are buffered when it
1700 * is notified that the station went to sleep. When all these frames
1701 * have been filtered (see above), it must call the function again
1702 * to indicate that the station is no longer blocked.
1704 * If the driver buffers frames in the driver for aggregation in any
1705 * way, it must use the ieee80211_sta_set_buffered() call when it is
1706 * notified of the station going to sleep to inform mac80211 of any
1707 * TIDs that have frames buffered. Note that when a station wakes up
1708 * this information is reset (hence the requirement to call it when
1709 * informed of the station going to sleep). Then, when a service
1710 * period starts for any reason, @release_buffered_frames is called
1711 * with the number of frames to be released and which TIDs they are
1712 * to come from. In this case, the driver is responsible for setting
1713 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1714 * to help the @more_data paramter is passed to tell the driver if
1715 * there is more data on other TIDs -- the TIDs to release frames
1716 * from are ignored since mac80211 doesn't know how many frames the
1717 * buffers for those TIDs contain.
1719 * If the driver also implement GO mode, where absence periods may
1720 * shorten service periods (or abort PS-Poll responses), it must
1721 * filter those response frames except in the case of frames that
1722 * are buffered in the driver -- those must remain buffered to avoid
1723 * reordering. Because it is possible that no frames are released
1724 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1725 * to indicate to mac80211 that the service period ended anyway.
1727 * Finally, if frames from multiple TIDs are released from mac80211
1728 * but the driver might reorder them, it must clear & set the flags
1729 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1730 * and also take care of the EOSP and MORE_DATA bits in the frame.
1731 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1735 * DOC: HW queue control
1737 * Before HW queue control was introduced, mac80211 only had a single static
1738 * assignment of per-interface AC software queues to hardware queues. This
1739 * was problematic for a few reasons:
1740 * 1) off-channel transmissions might get stuck behind other frames
1741 * 2) multiple virtual interfaces couldn't be handled correctly
1742 * 3) after-DTIM frames could get stuck behind other frames
1744 * To solve this, hardware typically uses multiple different queues for all
1745 * the different usages, and this needs to be propagated into mac80211 so it
1746 * won't have the same problem with the software queues.
1748 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1749 * flag that tells it that the driver implements its own queue control. To do
1750 * so, the driver will set up the various queues in each &struct ieee80211_vif
1751 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1752 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1753 * if necessary will queue the frame on the right software queue that mirrors
1754 * the hardware queue.
1755 * Additionally, the driver has to then use these HW queue IDs for the queue
1756 * management functions (ieee80211_stop_queue() et al.)
1758 * The driver is free to set up the queue mappings as needed, multiple virtual
1759 * interfaces may map to the same hardware queues if needed. The setup has to
1760 * happen during add_interface or change_interface callbacks. For example, a
1761 * driver supporting station+station and station+AP modes might decide to have
1762 * 10 hardware queues to handle different scenarios:
1764 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1765 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1766 * after-DTIM queue for AP: 8
1767 * off-channel queue: 9
1769 * It would then set up the hardware like this:
1770 * hw.offchannel_tx_hw_queue = 9
1772 * and the first virtual interface that is added as follows:
1773 * vif.hw_queue[IEEE80211_AC_VO] = 0
1774 * vif.hw_queue[IEEE80211_AC_VI] = 1
1775 * vif.hw_queue[IEEE80211_AC_BE] = 2
1776 * vif.hw_queue[IEEE80211_AC_BK] = 3
1777 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1778 * and the second virtual interface with 4-7.
1780 * If queue 6 gets full, for example, mac80211 would only stop the second
1781 * virtual interface's BE queue since virtual interface queues are per AC.
1783 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1784 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1785 * queue could potentially be shared since mac80211 will look at cab_queue when
1786 * a queue is stopped/woken even if the interface is not in AP mode.
1790 * enum ieee80211_filter_flags - hardware filter flags
1792 * These flags determine what the filter in hardware should be
1793 * programmed to let through and what should not be passed to the
1794 * stack. It is always safe to pass more frames than requested,
1795 * but this has negative impact on power consumption.
1797 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1798 * think of the BSS as your network segment and then this corresponds
1799 * to the regular ethernet device promiscuous mode.
1801 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1802 * by the user or if the hardware is not capable of filtering by
1803 * multicast address.
1805 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1806 * %RX_FLAG_FAILED_FCS_CRC for them)
1808 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1809 * the %RX_FLAG_FAILED_PLCP_CRC for them
1811 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1812 * to the hardware that it should not filter beacons or probe responses
1813 * by BSSID. Filtering them can greatly reduce the amount of processing
1814 * mac80211 needs to do and the amount of CPU wakeups, so you should
1815 * honour this flag if possible.
1817 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1818 * is not set then only those addressed to this station.
1820 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1822 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1823 * those addressed to this station.
1825 * @FIF_PROBE_REQ: pass probe request frames
1827 enum ieee80211_filter_flags {
1828 FIF_PROMISC_IN_BSS = 1<<0,
1829 FIF_ALLMULTI = 1<<1,
1831 FIF_PLCPFAIL = 1<<3,
1832 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1834 FIF_OTHER_BSS = 1<<6,
1836 FIF_PROBE_REQ = 1<<8,
1840 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1842 * These flags are used with the ampdu_action() callback in
1843 * &struct ieee80211_ops to indicate which action is needed.
1845 * Note that drivers MUST be able to deal with a TX aggregation
1846 * session being stopped even before they OK'ed starting it by
1847 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1848 * might receive the addBA frame and send a delBA right away!
1850 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1851 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1852 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1853 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1854 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1856 enum ieee80211_ampdu_mlme_action {
1857 IEEE80211_AMPDU_RX_START,
1858 IEEE80211_AMPDU_RX_STOP,
1859 IEEE80211_AMPDU_TX_START,
1860 IEEE80211_AMPDU_TX_STOP,
1861 IEEE80211_AMPDU_TX_OPERATIONAL,
1865 * enum ieee80211_frame_release_type - frame release reason
1866 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1867 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1868 * frame received on trigger-enabled AC
1870 enum ieee80211_frame_release_type {
1871 IEEE80211_FRAME_RELEASE_PSPOLL,
1872 IEEE80211_FRAME_RELEASE_UAPSD,
1876 * enum ieee80211_rate_control_changed - flags to indicate what changed
1878 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
1879 * to this station changed.
1880 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
1882 enum ieee80211_rate_control_changed {
1883 IEEE80211_RC_BW_CHANGED = BIT(0),
1884 IEEE80211_RC_SMPS_CHANGED = BIT(1),
1888 * struct ieee80211_ops - callbacks from mac80211 to the driver
1890 * This structure contains various callbacks that the driver may
1891 * handle or, in some cases, must handle, for example to configure
1892 * the hardware to a new channel or to transmit a frame.
1894 * @tx: Handler that 802.11 module calls for each transmitted frame.
1895 * skb contains the buffer starting from the IEEE 802.11 header.
1896 * The low-level driver should send the frame out based on
1897 * configuration in the TX control data. This handler should,
1898 * preferably, never fail and stop queues appropriately.
1899 * This must be implemented if @tx_frags is not.
1902 * @tx_frags: Called to transmit multiple fragments of a single MSDU.
1903 * This handler must consume all fragments, sending out some of
1904 * them only is useless and it can't ask for some of them to be
1905 * queued again. If the frame is not fragmented the queue has a
1906 * single SKB only. To avoid issues with the networking stack
1907 * when TX status is reported the frames should be removed from
1909 * If this is used, the tx_info @vif and @sta pointers will be
1910 * invalid -- you must not use them in that case.
1911 * This must be implemented if @tx isn't.
1914 * @start: Called before the first netdevice attached to the hardware
1915 * is enabled. This should turn on the hardware and must turn on
1916 * frame reception (for possibly enabled monitor interfaces.)
1917 * Returns negative error codes, these may be seen in userspace,
1919 * When the device is started it should not have a MAC address
1920 * to avoid acknowledging frames before a non-monitor device
1922 * Must be implemented and can sleep.
1924 * @stop: Called after last netdevice attached to the hardware
1925 * is disabled. This should turn off the hardware (at least
1926 * it must turn off frame reception.)
1927 * May be called right after add_interface if that rejects
1928 * an interface. If you added any work onto the mac80211 workqueue
1929 * you should ensure to cancel it on this callback.
1930 * Must be implemented and can sleep.
1932 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1933 * stop transmitting and doing any other configuration, and then
1934 * ask the device to suspend. This is only invoked when WoWLAN is
1935 * configured, otherwise the device is deconfigured completely and
1936 * reconfigured at resume time.
1937 * The driver may also impose special conditions under which it
1938 * wants to use the "normal" suspend (deconfigure), say if it only
1939 * supports WoWLAN when the device is associated. In this case, it
1940 * must return 1 from this function.
1942 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1943 * now resuming its operation, after this the device must be fully
1944 * functional again. If this returns an error, the only way out is
1945 * to also unregister the device. If it returns 1, then mac80211
1946 * will also go through the regular complete restart on resume.
1948 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
1949 * modified. The reason is that device_set_wakeup_enable() is
1950 * supposed to be called when the configuration changes, not only
1953 * @add_interface: Called when a netdevice attached to the hardware is
1954 * enabled. Because it is not called for monitor mode devices, @start
1955 * and @stop must be implemented.
1956 * The driver should perform any initialization it needs before
1957 * the device can be enabled. The initial configuration for the
1958 * interface is given in the conf parameter.
1959 * The callback may refuse to add an interface by returning a
1960 * negative error code (which will be seen in userspace.)
1961 * Must be implemented and can sleep.
1963 * @change_interface: Called when a netdevice changes type. This callback
1964 * is optional, but only if it is supported can interface types be
1965 * switched while the interface is UP. The callback may sleep.
1966 * Note that while an interface is being switched, it will not be
1967 * found by the interface iteration callbacks.
1969 * @remove_interface: Notifies a driver that an interface is going down.
1970 * The @stop callback is called after this if it is the last interface
1971 * and no monitor interfaces are present.
1972 * When all interfaces are removed, the MAC address in the hardware
1973 * must be cleared so the device no longer acknowledges packets,
1974 * the mac_addr member of the conf structure is, however, set to the
1975 * MAC address of the device going away.
1976 * Hence, this callback must be implemented. It can sleep.
1978 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1979 * function to change hardware configuration, e.g., channel.
1980 * This function should never fail but returns a negative error code
1981 * if it does. The callback can sleep.
1983 * @bss_info_changed: Handler for configuration requests related to BSS
1984 * parameters that may vary during BSS's lifespan, and may affect low
1985 * level driver (e.g. assoc/disassoc status, erp parameters).
1986 * This function should not be used if no BSS has been set, unless
1987 * for association indication. The @changed parameter indicates which
1988 * of the bss parameters has changed when a call is made. The callback
1991 * @prepare_multicast: Prepare for multicast filter configuration.
1992 * This callback is optional, and its return value is passed
1993 * to configure_filter(). This callback must be atomic.
1995 * @configure_filter: Configure the device's RX filter.
1996 * See the section "Frame filtering" for more information.
1997 * This callback must be implemented and can sleep.
1999 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2000 * must be set or cleared for a given STA. Must be atomic.
2002 * @set_key: See the section "Hardware crypto acceleration"
2003 * This callback is only called between add_interface and
2004 * remove_interface calls, i.e. while the given virtual interface
2006 * Returns a negative error code if the key can't be added.
2007 * The callback can sleep.
2009 * @update_tkip_key: See the section "Hardware crypto acceleration"
2010 * This callback will be called in the context of Rx. Called for drivers
2011 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2012 * The callback must be atomic.
2014 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2015 * host is suspended, it can assign this callback to retrieve the data
2016 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2017 * After rekeying was done it should (for example during resume) notify
2018 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2020 * @hw_scan: Ask the hardware to service the scan request, no need to start
2021 * the scan state machine in stack. The scan must honour the channel
2022 * configuration done by the regulatory agent in the wiphy's
2023 * registered bands. The hardware (or the driver) needs to make sure
2024 * that power save is disabled.
2025 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2026 * entire IEs after the SSID, so that drivers need not look at these
2027 * at all but just send them after the SSID -- mac80211 includes the
2028 * (extended) supported rates and HT information (where applicable).
2029 * When the scan finishes, ieee80211_scan_completed() must be called;
2030 * note that it also must be called when the scan cannot finish due to
2031 * any error unless this callback returned a negative error code.
2032 * The callback can sleep.
2034 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2035 * The driver should ask the hardware to cancel the scan (if possible),
2036 * but the scan will be completed only after the driver will call
2037 * ieee80211_scan_completed().
2038 * This callback is needed for wowlan, to prevent enqueueing a new
2039 * scan_work after the low-level driver was already suspended.
2040 * The callback can sleep.
2042 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2043 * specific intervals. The driver must call the
2044 * ieee80211_sched_scan_results() function whenever it finds results.
2045 * This process will continue until sched_scan_stop is called.
2047 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2049 * @sw_scan_start: Notifier function that is called just before a software scan
2050 * is started. Can be NULL, if the driver doesn't need this notification.
2051 * The callback can sleep.
2053 * @sw_scan_complete: Notifier function that is called just after a
2054 * software scan finished. Can be NULL, if the driver doesn't need
2055 * this notification.
2056 * The callback can sleep.
2058 * @get_stats: Return low-level statistics.
2059 * Returns zero if statistics are available.
2060 * The callback can sleep.
2062 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2063 * callback should be provided to read the TKIP transmit IVs (both IV32
2064 * and IV16) for the given key from hardware.
2065 * The callback must be atomic.
2067 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2068 * if the device does fragmentation by itself; if this callback is
2069 * implemented then the stack will not do fragmentation.
2070 * The callback can sleep.
2072 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2073 * The callback can sleep.
2075 * @sta_add: Notifies low level driver about addition of an associated station,
2076 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2078 * @sta_remove: Notifies low level driver about removal of an associated
2079 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2081 * @sta_notify: Notifies low level driver about power state transition of an
2082 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2083 * in AP mode, this callback will not be called when the flag
2084 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2086 * @sta_state: Notifies low level driver about state transition of a
2087 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2088 * This callback is mutually exclusive with @sta_add/@sta_remove.
2089 * It must not fail for down transitions but may fail for transitions
2090 * up the list of states.
2091 * The callback can sleep.
2093 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2094 * used to transmit to the station. The changes are advertised with bits
2095 * from &enum ieee80211_rate_control_changed and the values are reflected
2096 * in the station data. This callback should only be used when the driver
2097 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2098 * otherwise the rate control algorithm is notified directly.
2101 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2102 * bursting) for a hardware TX queue.
2103 * Returns a negative error code on failure.
2104 * The callback can sleep.
2106 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2107 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2108 * required function.
2109 * The callback can sleep.
2111 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2112 * Currently, this is only used for IBSS mode debugging. Is not a
2113 * required function.
2114 * The callback can sleep.
2116 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2117 * with other STAs in the IBSS. This is only used in IBSS mode. This
2118 * function is optional if the firmware/hardware takes full care of
2119 * TSF synchronization.
2120 * The callback can sleep.
2122 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2123 * This is needed only for IBSS mode and the result of this function is
2124 * used to determine whether to reply to Probe Requests.
2125 * Returns non-zero if this device sent the last beacon.
2126 * The callback can sleep.
2128 * @ampdu_action: Perform a certain A-MPDU action
2129 * The RA/TID combination determines the destination and TID we want
2130 * the ampdu action to be performed for. The action is defined through
2131 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2132 * is the first frame we expect to perform the action on. Notice
2133 * that TX/RX_STOP can pass NULL for this parameter.
2134 * The @buf_size parameter is only valid when the action is set to
2135 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2136 * buffer size (number of subframes) for this session -- the driver
2137 * may neither send aggregates containing more subframes than this
2138 * nor send aggregates in a way that lost frames would exceed the
2139 * buffer size. If just limiting the aggregate size, this would be
2140 * possible with a buf_size of 8:
2142 * - RX: 2....7 (lost frame #1)
2144 * which is invalid since #1 was now re-transmitted well past the
2145 * buffer size of 8. Correct ways to retransmit #1 would be:
2146 * - TX: 1 or 18 or 81
2147 * Even "189" would be wrong since 1 could be lost again.
2149 * Returns a negative error code on failure.
2150 * The callback can sleep.
2152 * @get_survey: Return per-channel survey information
2154 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2155 * need to set wiphy->rfkill_poll to %true before registration,
2156 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2157 * The callback can sleep.
2159 * @set_coverage_class: Set slot time for given coverage class as specified
2160 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2161 * accordingly. This callback is not required and may sleep.
2163 * @testmode_cmd: Implement a cfg80211 test mode command.
2164 * The callback can sleep.
2165 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2167 * @flush: Flush all pending frames from the hardware queue, making sure
2168 * that the hardware queues are empty. If the parameter @drop is set
2169 * to %true, pending frames may be dropped. The callback can sleep.
2171 * @channel_switch: Drivers that need (or want) to offload the channel
2172 * switch operation for CSAs received from the AP may implement this
2173 * callback. They must then call ieee80211_chswitch_done() to indicate
2174 * completion of the channel switch.
2176 * @napi_poll: Poll Rx queue for incoming data frames.
2178 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2179 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2180 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2181 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2183 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2185 * @remain_on_channel: Starts an off-channel period on the given channel, must
2186 * call back to ieee80211_ready_on_channel() when on that channel. Note
2187 * that normal channel traffic is not stopped as this is intended for hw
2188 * offload. Frames to transmit on the off-channel channel are transmitted
2189 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2190 * duration (which will always be non-zero) expires, the driver must call
2191 * ieee80211_remain_on_channel_expired().
2192 * Note that this callback may be called while the device is in IDLE and
2193 * must be accepted in this case.
2194 * This callback may sleep.
2195 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2196 * aborted before it expires. This callback may sleep.
2198 * @set_ringparam: Set tx and rx ring sizes.
2200 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2202 * @tx_frames_pending: Check if there is any pending frame in the hardware
2203 * queues before entering power save.
2205 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2206 * when transmitting a frame. Currently only legacy rates are handled.
2207 * The callback can sleep.
2208 * @rssi_callback: Notify driver when the average RSSI goes above/below
2209 * thresholds that were registered previously. The callback can sleep.
2211 * @release_buffered_frames: Release buffered frames according to the given
2212 * parameters. In the case where the driver buffers some frames for
2213 * sleeping stations mac80211 will use this callback to tell the driver
2214 * to release some frames, either for PS-poll or uAPSD.
2215 * Note that if the @more_data paramter is %false the driver must check
2216 * if there are more frames on the given TIDs, and if there are more than
2217 * the frames being released then it must still set the more-data bit in
2218 * the frame. If the @more_data parameter is %true, then of course the
2219 * more-data bit must always be set.
2220 * The @tids parameter tells the driver which TIDs to release frames
2221 * from, for PS-poll it will always have only a single bit set.
2222 * In the case this is used for a PS-poll initiated release, the
2223 * @num_frames parameter will always be 1 so code can be shared. In
2224 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2225 * on the TX status (and must report TX status) so that the PS-poll
2226 * period is properly ended. This is used to avoid sending multiple
2227 * responses for a retried PS-poll frame.
2228 * In the case this is used for uAPSD, the @num_frames parameter may be
2229 * bigger than one, but the driver may send fewer frames (it must send
2230 * at least one, however). In this case it is also responsible for
2231 * setting the EOSP flag in the QoS header of the frames. Also, when the
2232 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2233 * on the last frame in the SP. Alternatively, it may call the function
2234 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2235 * This callback must be atomic.
2236 * @allow_buffered_frames: Prepare device to allow the given number of frames
2237 * to go out to the given station. The frames will be sent by mac80211
2238 * via the usual TX path after this call. The TX information for frames
2239 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2240 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2241 * frames from multiple TIDs are released and the driver might reorder
2242 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2243 * on the last frame and clear it on all others and also handle the EOSP
2244 * bit in the QoS header correctly. Alternatively, it can also call the
2245 * ieee80211_sta_eosp_irqsafe() function.
2246 * The @tids parameter is a bitmap and tells the driver which TIDs the
2247 * frames will be on; it will at most have two bits set.
2248 * This callback must be atomic.
2250 * @get_et_sset_count: Ethtool API to get string-set count.
2252 * @get_et_stats: Ethtool API to get a set of u64 stats.
2254 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2255 * and perhaps other supported types of ethtool data-sets.
2257 * @get_rssi: Get current signal strength in dBm, the function is optional
2261 struct ieee80211_ops {
2262 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
2263 void (*tx_frags)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2264 struct ieee80211_sta *sta, struct sk_buff_head *skbs);
2265 int (*start)(struct ieee80211_hw *hw);
2266 void (*stop)(struct ieee80211_hw *hw);
2268 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2269 int (*resume)(struct ieee80211_hw *hw);
2270 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2272 int (*add_interface)(struct ieee80211_hw *hw,
2273 struct ieee80211_vif *vif);
2274 int (*change_interface)(struct ieee80211_hw *hw,
2275 struct ieee80211_vif *vif,
2276 enum nl80211_iftype new_type, bool p2p);
2277 void (*remove_interface)(struct ieee80211_hw *hw,
2278 struct ieee80211_vif *vif);
2279 int (*config)(struct ieee80211_hw *hw, u32 changed);
2280 void (*bss_info_changed)(struct ieee80211_hw *hw,
2281 struct ieee80211_vif *vif,
2282 struct ieee80211_bss_conf *info,
2285 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2286 struct netdev_hw_addr_list *mc_list);
2287 void (*configure_filter)(struct ieee80211_hw *hw,
2288 unsigned int changed_flags,
2289 unsigned int *total_flags,
2291 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2293 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2294 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2295 struct ieee80211_key_conf *key);
2296 void (*update_tkip_key)(struct ieee80211_hw *hw,
2297 struct ieee80211_vif *vif,
2298 struct ieee80211_key_conf *conf,
2299 struct ieee80211_sta *sta,
2300 u32 iv32, u16 *phase1key);
2301 void (*set_rekey_data)(struct ieee80211_hw *hw,
2302 struct ieee80211_vif *vif,
2303 struct cfg80211_gtk_rekey_data *data);
2304 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2305 struct cfg80211_scan_request *req);
2306 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2307 struct ieee80211_vif *vif);
2308 int (*sched_scan_start)(struct ieee80211_hw *hw,
2309 struct ieee80211_vif *vif,
2310 struct cfg80211_sched_scan_request *req,
2311 struct ieee80211_sched_scan_ies *ies);
2312 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2313 struct ieee80211_vif *vif);
2314 void (*sw_scan_start)(struct ieee80211_hw *hw);
2315 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2316 int (*get_stats)(struct ieee80211_hw *hw,
2317 struct ieee80211_low_level_stats *stats);
2318 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2319 u32 *iv32, u16 *iv16);
2320 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2321 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2322 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2323 struct ieee80211_sta *sta);
2324 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2325 struct ieee80211_sta *sta);
2326 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2327 enum sta_notify_cmd, struct ieee80211_sta *sta);
2328 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2329 struct ieee80211_sta *sta,
2330 enum ieee80211_sta_state old_state,
2331 enum ieee80211_sta_state new_state);
2332 void (*sta_rc_update)(struct ieee80211_hw *hw,
2333 struct ieee80211_vif *vif,
2334 struct ieee80211_sta *sta,
2336 int (*conf_tx)(struct ieee80211_hw *hw,
2337 struct ieee80211_vif *vif, u16 ac,
2338 const struct ieee80211_tx_queue_params *params);
2339 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2340 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2342 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2343 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2344 int (*ampdu_action)(struct ieee80211_hw *hw,
2345 struct ieee80211_vif *vif,
2346 enum ieee80211_ampdu_mlme_action action,
2347 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2349 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2350 struct survey_info *survey);
2351 void (*rfkill_poll)(struct ieee80211_hw *hw);
2352 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2353 #ifdef CONFIG_NL80211_TESTMODE
2354 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2355 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2356 struct netlink_callback *cb,
2357 void *data, int len);
2359 void (*flush)(struct ieee80211_hw *hw, bool drop);
2360 void (*channel_switch)(struct ieee80211_hw *hw,
2361 struct ieee80211_channel_switch *ch_switch);
2362 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2363 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2364 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2366 int (*remain_on_channel)(struct ieee80211_hw *hw,
2367 struct ieee80211_channel *chan,
2368 enum nl80211_channel_type channel_type,
2370 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2371 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2372 void (*get_ringparam)(struct ieee80211_hw *hw,
2373 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2374 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2375 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2376 const struct cfg80211_bitrate_mask *mask);
2377 void (*rssi_callback)(struct ieee80211_hw *hw,
2378 enum ieee80211_rssi_event rssi_event);
2380 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2381 struct ieee80211_sta *sta,
2382 u16 tids, int num_frames,
2383 enum ieee80211_frame_release_type reason,
2385 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2386 struct ieee80211_sta *sta,
2387 u16 tids, int num_frames,
2388 enum ieee80211_frame_release_type reason,
2391 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2392 struct ieee80211_vif *vif, int sset);
2393 void (*get_et_stats)(struct ieee80211_hw *hw,
2394 struct ieee80211_vif *vif,
2395 struct ethtool_stats *stats, u64 *data);
2396 void (*get_et_strings)(struct ieee80211_hw *hw,
2397 struct ieee80211_vif *vif,
2398 u32 sset, u8 *data);
2399 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2400 struct ieee80211_sta *sta, s8 *rssi_dbm);
2404 * ieee80211_alloc_hw - Allocate a new hardware device
2406 * This must be called once for each hardware device. The returned pointer
2407 * must be used to refer to this device when calling other functions.
2408 * mac80211 allocates a private data area for the driver pointed to by
2409 * @priv in &struct ieee80211_hw, the size of this area is given as
2412 * @priv_data_len: length of private data
2413 * @ops: callbacks for this device
2415 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2416 const struct ieee80211_ops *ops);
2419 * ieee80211_register_hw - Register hardware device
2421 * You must call this function before any other functions in
2422 * mac80211. Note that before a hardware can be registered, you
2423 * need to fill the contained wiphy's information.
2425 * @hw: the device to register as returned by ieee80211_alloc_hw()
2427 int ieee80211_register_hw(struct ieee80211_hw *hw);
2430 * struct ieee80211_tpt_blink - throughput blink description
2431 * @throughput: throughput in Kbit/sec
2432 * @blink_time: blink time in milliseconds
2433 * (full cycle, ie. one off + one on period)
2435 struct ieee80211_tpt_blink {
2441 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2442 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2443 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2444 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2445 * interface is connected in some way, including being an AP
2447 enum ieee80211_tpt_led_trigger_flags {
2448 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2449 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2450 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2453 #ifdef CONFIG_MAC80211_LEDS
2454 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2455 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2456 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2457 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2458 extern char *__ieee80211_create_tpt_led_trigger(
2459 struct ieee80211_hw *hw, unsigned int flags,
2460 const struct ieee80211_tpt_blink *blink_table,
2461 unsigned int blink_table_len);
2464 * ieee80211_get_tx_led_name - get name of TX LED
2466 * mac80211 creates a transmit LED trigger for each wireless hardware
2467 * that can be used to drive LEDs if your driver registers a LED device.
2468 * This function returns the name (or %NULL if not configured for LEDs)
2469 * of the trigger so you can automatically link the LED device.
2471 * @hw: the hardware to get the LED trigger name for
2473 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2475 #ifdef CONFIG_MAC80211_LEDS
2476 return __ieee80211_get_tx_led_name(hw);
2483 * ieee80211_get_rx_led_name - get name of RX LED
2485 * mac80211 creates a receive LED trigger for each wireless hardware
2486 * that can be used to drive LEDs if your driver registers a LED device.
2487 * This function returns the name (or %NULL if not configured for LEDs)
2488 * of the trigger so you can automatically link the LED device.
2490 * @hw: the hardware to get the LED trigger name for
2492 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2494 #ifdef CONFIG_MAC80211_LEDS
2495 return __ieee80211_get_rx_led_name(hw);
2502 * ieee80211_get_assoc_led_name - get name of association LED
2504 * mac80211 creates a association LED trigger for each wireless hardware
2505 * that can be used to drive LEDs if your driver registers a LED device.
2506 * This function returns the name (or %NULL if not configured for LEDs)
2507 * of the trigger so you can automatically link the LED device.
2509 * @hw: the hardware to get the LED trigger name for
2511 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2513 #ifdef CONFIG_MAC80211_LEDS
2514 return __ieee80211_get_assoc_led_name(hw);
2521 * ieee80211_get_radio_led_name - get name of radio LED
2523 * mac80211 creates a radio change LED trigger for each wireless hardware
2524 * that can be used to drive LEDs if your driver registers a LED device.
2525 * This function returns the name (or %NULL if not configured for LEDs)
2526 * of the trigger so you can automatically link the LED device.
2528 * @hw: the hardware to get the LED trigger name for
2530 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2532 #ifdef CONFIG_MAC80211_LEDS
2533 return __ieee80211_get_radio_led_name(hw);
2540 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2541 * @hw: the hardware to create the trigger for
2542 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2543 * @blink_table: the blink table -- needs to be ordered by throughput
2544 * @blink_table_len: size of the blink table
2546 * This function returns %NULL (in case of error, or if no LED
2547 * triggers are configured) or the name of the new trigger.
2548 * This function must be called before ieee80211_register_hw().
2550 static inline char *
2551 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2552 const struct ieee80211_tpt_blink *blink_table,
2553 unsigned int blink_table_len)
2555 #ifdef CONFIG_MAC80211_LEDS
2556 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2564 * ieee80211_unregister_hw - Unregister a hardware device
2566 * This function instructs mac80211 to free allocated resources
2567 * and unregister netdevices from the networking subsystem.
2569 * @hw: the hardware to unregister
2571 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2574 * ieee80211_free_hw - free hardware descriptor
2576 * This function frees everything that was allocated, including the
2577 * private data for the driver. You must call ieee80211_unregister_hw()
2578 * before calling this function.
2580 * @hw: the hardware to free
2582 void ieee80211_free_hw(struct ieee80211_hw *hw);
2585 * ieee80211_restart_hw - restart hardware completely
2587 * Call this function when the hardware was restarted for some reason
2588 * (hardware error, ...) and the driver is unable to restore its state
2589 * by itself. mac80211 assumes that at this point the driver/hardware
2590 * is completely uninitialised and stopped, it starts the process by
2591 * calling the ->start() operation. The driver will need to reset all
2592 * internal state that it has prior to calling this function.
2594 * @hw: the hardware to restart
2596 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2598 /** ieee80211_napi_schedule - schedule NAPI poll
2600 * Use this function to schedule NAPI polling on a device.
2602 * @hw: the hardware to start polling
2604 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2606 /** ieee80211_napi_complete - complete NAPI polling
2608 * Use this function to finish NAPI polling on a device.
2610 * @hw: the hardware to stop polling
2612 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2615 * ieee80211_rx - receive frame
2617 * Use this function to hand received frames to mac80211. The receive
2618 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2619 * paged @skb is used, the driver is recommended to put the ieee80211
2620 * header of the frame on the linear part of the @skb to avoid memory
2621 * allocation and/or memcpy by the stack.
2623 * This function may not be called in IRQ context. Calls to this function
2624 * for a single hardware must be synchronized against each other. Calls to
2625 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2626 * mixed for a single hardware.
2628 * In process context use instead ieee80211_rx_ni().
2630 * @hw: the hardware this frame came in on
2631 * @skb: the buffer to receive, owned by mac80211 after this call
2633 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2636 * ieee80211_rx_irqsafe - receive frame
2638 * Like ieee80211_rx() but can be called in IRQ context
2639 * (internally defers to a tasklet.)
2641 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2642 * be mixed for a single hardware.
2644 * @hw: the hardware this frame came in on
2645 * @skb: the buffer to receive, owned by mac80211 after this call
2647 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2650 * ieee80211_rx_ni - receive frame (in process context)
2652 * Like ieee80211_rx() but can be called in process context
2653 * (internally disables bottom halves).
2655 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2656 * not be mixed for a single hardware.
2658 * @hw: the hardware this frame came in on
2659 * @skb: the buffer to receive, owned by mac80211 after this call
2661 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2662 struct sk_buff *skb)
2665 ieee80211_rx(hw, skb);
2670 * ieee80211_sta_ps_transition - PS transition for connected sta
2672 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2673 * flag set, use this function to inform mac80211 about a connected station
2674 * entering/leaving PS mode.
2676 * This function may not be called in IRQ context or with softirqs enabled.
2678 * Calls to this function for a single hardware must be synchronized against
2681 * The function returns -EINVAL when the requested PS mode is already set.
2683 * @sta: currently connected sta
2684 * @start: start or stop PS
2686 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2689 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2690 * (in process context)
2692 * Like ieee80211_sta_ps_transition() but can be called in process context
2693 * (internally disables bottom halves). Concurrent call restriction still
2696 * @sta: currently connected sta
2697 * @start: start or stop PS
2699 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2705 ret = ieee80211_sta_ps_transition(sta, start);
2712 * The TX headroom reserved by mac80211 for its own tx_status functions.
2713 * This is enough for the radiotap header.
2715 #define IEEE80211_TX_STATUS_HEADROOM 14
2718 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2719 * @sta: &struct ieee80211_sta pointer for the sleeping station
2720 * @tid: the TID that has buffered frames
2721 * @buffered: indicates whether or not frames are buffered for this TID
2723 * If a driver buffers frames for a powersave station instead of passing
2724 * them back to mac80211 for retransmission, the station may still need
2725 * to be told that there are buffered frames via the TIM bit.
2727 * This function informs mac80211 whether or not there are frames that are
2728 * buffered in the driver for a given TID; mac80211 can then use this data
2729 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2730 * call! Beware of the locking!)
2732 * If all frames are released to the station (due to PS-poll or uAPSD)
2733 * then the driver needs to inform mac80211 that there no longer are
2734 * frames buffered. However, when the station wakes up mac80211 assumes
2735 * that all buffered frames will be transmitted and clears this data,
2736 * drivers need to make sure they inform mac80211 about all buffered
2737 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2739 * Note that technically mac80211 only needs to know this per AC, not per
2740 * TID, but since driver buffering will inevitably happen per TID (since
2741 * it is related to aggregation) it is easier to make mac80211 map the
2742 * TID to the AC as required instead of keeping track in all drivers that
2745 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2746 u8 tid, bool buffered);
2749 * ieee80211_tx_status - transmit status callback
2751 * Call this function for all transmitted frames after they have been
2752 * transmitted. It is permissible to not call this function for
2753 * multicast frames but this can affect statistics.
2755 * This function may not be called in IRQ context. Calls to this function
2756 * for a single hardware must be synchronized against each other. Calls
2757 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2758 * may not be mixed for a single hardware.
2760 * @hw: the hardware the frame was transmitted by
2761 * @skb: the frame that was transmitted, owned by mac80211 after this call
2763 void ieee80211_tx_status(struct ieee80211_hw *hw,
2764 struct sk_buff *skb);
2767 * ieee80211_tx_status_ni - transmit status callback (in process context)
2769 * Like ieee80211_tx_status() but can be called in process context.
2771 * Calls to this function, ieee80211_tx_status() and
2772 * ieee80211_tx_status_irqsafe() may not be mixed
2773 * for a single hardware.
2775 * @hw: the hardware the frame was transmitted by
2776 * @skb: the frame that was transmitted, owned by mac80211 after this call
2778 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2779 struct sk_buff *skb)
2782 ieee80211_tx_status(hw, skb);
2787 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2789 * Like ieee80211_tx_status() but can be called in IRQ context
2790 * (internally defers to a tasklet.)
2792 * Calls to this function, ieee80211_tx_status() and
2793 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2795 * @hw: the hardware the frame was transmitted by
2796 * @skb: the frame that was transmitted, owned by mac80211 after this call
2798 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2799 struct sk_buff *skb);
2802 * ieee80211_report_low_ack - report non-responding station
2804 * When operating in AP-mode, call this function to report a non-responding
2807 * @sta: the non-responding connected sta
2808 * @num_packets: number of packets sent to @sta without a response
2810 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2813 * ieee80211_beacon_get_tim - beacon generation function
2814 * @hw: pointer obtained from ieee80211_alloc_hw().
2815 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2816 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2817 * Set to 0 if invalid (in non-AP modes).
2818 * @tim_length: pointer to variable that will receive the TIM IE length,
2819 * (including the ID and length bytes!).
2820 * Set to 0 if invalid (in non-AP modes).
2822 * If the driver implements beaconing modes, it must use this function to
2823 * obtain the beacon frame/template.
2825 * If the beacon frames are generated by the host system (i.e., not in
2826 * hardware/firmware), the driver uses this function to get each beacon
2827 * frame from mac80211 -- it is responsible for calling this function
2828 * before the beacon is needed (e.g. based on hardware interrupt).
2830 * If the beacon frames are generated by the device, then the driver
2831 * must use the returned beacon as the template and change the TIM IE
2832 * according to the current DTIM parameters/TIM bitmap.
2834 * The driver is responsible for freeing the returned skb.
2836 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2837 struct ieee80211_vif *vif,
2838 u16 *tim_offset, u16 *tim_length);
2841 * ieee80211_beacon_get - beacon generation function
2842 * @hw: pointer obtained from ieee80211_alloc_hw().
2843 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2845 * See ieee80211_beacon_get_tim().
2847 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2848 struct ieee80211_vif *vif)
2850 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2854 * ieee80211_proberesp_get - retrieve a Probe Response template
2855 * @hw: pointer obtained from ieee80211_alloc_hw().
2856 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2858 * Creates a Probe Response template which can, for example, be uploaded to
2859 * hardware. The destination address should be set by the caller.
2861 * Can only be called in AP mode.
2863 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
2864 struct ieee80211_vif *vif);
2867 * ieee80211_pspoll_get - retrieve a PS Poll template
2868 * @hw: pointer obtained from ieee80211_alloc_hw().
2869 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2871 * Creates a PS Poll a template which can, for example, uploaded to
2872 * hardware. The template must be updated after association so that correct
2873 * AID, BSSID and MAC address is used.
2875 * Note: Caller (or hardware) is responsible for setting the
2876 * &IEEE80211_FCTL_PM bit.
2878 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2879 struct ieee80211_vif *vif);
2882 * ieee80211_nullfunc_get - retrieve a nullfunc template
2883 * @hw: pointer obtained from ieee80211_alloc_hw().
2884 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2886 * Creates a Nullfunc template which can, for example, uploaded to
2887 * hardware. The template must be updated after association so that correct
2888 * BSSID and address is used.
2890 * Note: Caller (or hardware) is responsible for setting the
2891 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2893 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2894 struct ieee80211_vif *vif);
2897 * ieee80211_probereq_get - retrieve a Probe Request template
2898 * @hw: pointer obtained from ieee80211_alloc_hw().
2899 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2900 * @ssid: SSID buffer
2901 * @ssid_len: length of SSID
2902 * @ie: buffer containing all IEs except SSID for the template
2903 * @ie_len: length of the IE buffer
2905 * Creates a Probe Request template which can, for example, be uploaded to
2908 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2909 struct ieee80211_vif *vif,
2910 const u8 *ssid, size_t ssid_len,
2911 const u8 *ie, size_t ie_len);
2914 * ieee80211_rts_get - RTS frame generation function
2915 * @hw: pointer obtained from ieee80211_alloc_hw().
2916 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2917 * @frame: pointer to the frame that is going to be protected by the RTS.
2918 * @frame_len: the frame length (in octets).
2919 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2920 * @rts: The buffer where to store the RTS frame.
2922 * If the RTS frames are generated by the host system (i.e., not in
2923 * hardware/firmware), the low-level driver uses this function to receive
2924 * the next RTS frame from the 802.11 code. The low-level is responsible
2925 * for calling this function before and RTS frame is needed.
2927 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2928 const void *frame, size_t frame_len,
2929 const struct ieee80211_tx_info *frame_txctl,
2930 struct ieee80211_rts *rts);
2933 * ieee80211_rts_duration - Get the duration field for an RTS frame
2934 * @hw: pointer obtained from ieee80211_alloc_hw().
2935 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2936 * @frame_len: the length of the frame that is going to be protected by the RTS.
2937 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2939 * If the RTS is generated in firmware, but the host system must provide
2940 * the duration field, the low-level driver uses this function to receive
2941 * the duration field value in little-endian byteorder.
2943 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2944 struct ieee80211_vif *vif, size_t frame_len,
2945 const struct ieee80211_tx_info *frame_txctl);
2948 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2949 * @hw: pointer obtained from ieee80211_alloc_hw().
2950 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2951 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2952 * @frame_len: the frame length (in octets).
2953 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2954 * @cts: The buffer where to store the CTS-to-self frame.
2956 * If the CTS-to-self frames are generated by the host system (i.e., not in
2957 * hardware/firmware), the low-level driver uses this function to receive
2958 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2959 * for calling this function before and CTS-to-self frame is needed.
2961 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2962 struct ieee80211_vif *vif,
2963 const void *frame, size_t frame_len,
2964 const struct ieee80211_tx_info *frame_txctl,
2965 struct ieee80211_cts *cts);
2968 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2969 * @hw: pointer obtained from ieee80211_alloc_hw().
2970 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2971 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2972 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2974 * If the CTS-to-self is generated in firmware, but the host system must provide
2975 * the duration field, the low-level driver uses this function to receive
2976 * the duration field value in little-endian byteorder.
2978 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2979 struct ieee80211_vif *vif,
2981 const struct ieee80211_tx_info *frame_txctl);
2984 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2985 * @hw: pointer obtained from ieee80211_alloc_hw().
2986 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2987 * @band: the band to calculate the frame duration on
2988 * @frame_len: the length of the frame.
2989 * @rate: the rate at which the frame is going to be transmitted.
2991 * Calculate the duration field of some generic frame, given its
2992 * length and transmission rate (in 100kbps).
2994 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2995 struct ieee80211_vif *vif,
2996 enum ieee80211_band band,
2998 struct ieee80211_rate *rate);
3001 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3002 * @hw: pointer as obtained from ieee80211_alloc_hw().
3003 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3005 * Function for accessing buffered broadcast and multicast frames. If
3006 * hardware/firmware does not implement buffering of broadcast/multicast
3007 * frames when power saving is used, 802.11 code buffers them in the host
3008 * memory. The low-level driver uses this function to fetch next buffered
3009 * frame. In most cases, this is used when generating beacon frame. This
3010 * function returns a pointer to the next buffered skb or NULL if no more
3011 * buffered frames are available.
3013 * Note: buffered frames are returned only after DTIM beacon frame was
3014 * generated with ieee80211_beacon_get() and the low-level driver must thus
3015 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3016 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3017 * does not need to check for DTIM beacons separately and should be able to
3018 * use common code for all beacons.
3021 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3024 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3026 * This function returns the TKIP phase 1 key for the given IV32.
3028 * @keyconf: the parameter passed with the set key
3029 * @iv32: IV32 to get the P1K for
3030 * @p1k: a buffer to which the key will be written, as 5 u16 values
3032 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3033 u32 iv32, u16 *p1k);
3036 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3038 * This function returns the TKIP phase 1 key for the IV32 taken
3039 * from the given packet.
3041 * @keyconf: the parameter passed with the set key
3042 * @skb: the packet to take the IV32 value from that will be encrypted
3044 * @p1k: a buffer to which the key will be written, as 5 u16 values
3046 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3047 struct sk_buff *skb, u16 *p1k)
3049 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3050 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3051 u32 iv32 = get_unaligned_le32(&data[4]);
3053 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3057 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3059 * This function returns the TKIP phase 1 key for the given IV32
3060 * and transmitter address.
3062 * @keyconf: the parameter passed with the set key
3063 * @ta: TA that will be used with the key
3064 * @iv32: IV32 to get the P1K for
3065 * @p1k: a buffer to which the key will be written, as 5 u16 values
3067 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3068 const u8 *ta, u32 iv32, u16 *p1k);
3071 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3073 * This function computes the TKIP RC4 key for the IV values
3076 * @keyconf: the parameter passed with the set key
3077 * @skb: the packet to take the IV32/IV16 values from that will be
3078 * encrypted with this key
3079 * @p2k: a buffer to which the key will be written, 16 bytes
3081 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3082 struct sk_buff *skb, u8 *p2k);
3085 * struct ieee80211_key_seq - key sequence counter
3087 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3088 * @ccmp: PN data, most significant byte first (big endian,
3089 * reverse order than in packet)
3090 * @aes_cmac: PN data, most significant byte first (big endian,
3091 * reverse order than in packet)
3093 struct ieee80211_key_seq {
3109 * ieee80211_get_key_tx_seq - get key TX sequence counter
3111 * @keyconf: the parameter passed with the set key
3112 * @seq: buffer to receive the sequence data
3114 * This function allows a driver to retrieve the current TX IV/PN
3115 * for the given key. It must not be called if IV generation is
3116 * offloaded to the device.
3118 * Note that this function may only be called when no TX processing
3119 * can be done concurrently, for example when queues are stopped
3120 * and the stop has been synchronized.
3122 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3123 struct ieee80211_key_seq *seq);
3126 * ieee80211_get_key_rx_seq - get key RX sequence counter
3128 * @keyconf: the parameter passed with the set key
3129 * @tid: The TID, or -1 for the management frame value (CCMP only);
3130 * the value on TID 0 is also used for non-QoS frames. For
3131 * CMAC, only TID 0 is valid.
3132 * @seq: buffer to receive the sequence data
3134 * This function allows a driver to retrieve the current RX IV/PNs
3135 * for the given key. It must not be called if IV checking is done
3136 * by the device and not by mac80211.
3138 * Note that this function may only be called when no RX processing
3139 * can be done concurrently.
3141 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3142 int tid, struct ieee80211_key_seq *seq);
3145 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3146 * @vif: virtual interface the rekeying was done on
3147 * @bssid: The BSSID of the AP, for checking association
3148 * @replay_ctr: the new replay counter after GTK rekeying
3149 * @gfp: allocation flags
3151 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3152 const u8 *replay_ctr, gfp_t gfp);
3155 * ieee80211_wake_queue - wake specific queue
3156 * @hw: pointer as obtained from ieee80211_alloc_hw().
3157 * @queue: queue number (counted from zero).
3159 * Drivers should use this function instead of netif_wake_queue.
3161 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3164 * ieee80211_stop_queue - stop specific queue
3165 * @hw: pointer as obtained from ieee80211_alloc_hw().
3166 * @queue: queue number (counted from zero).
3168 * Drivers should use this function instead of netif_stop_queue.
3170 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3173 * ieee80211_queue_stopped - test status of the queue
3174 * @hw: pointer as obtained from ieee80211_alloc_hw().
3175 * @queue: queue number (counted from zero).
3177 * Drivers should use this function instead of netif_stop_queue.
3180 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3183 * ieee80211_stop_queues - stop all queues
3184 * @hw: pointer as obtained from ieee80211_alloc_hw().
3186 * Drivers should use this function instead of netif_stop_queue.
3188 void ieee80211_stop_queues(struct ieee80211_hw *hw);
3191 * ieee80211_wake_queues - wake all queues
3192 * @hw: pointer as obtained from ieee80211_alloc_hw().
3194 * Drivers should use this function instead of netif_wake_queue.
3196 void ieee80211_wake_queues(struct ieee80211_hw *hw);
3199 * ieee80211_scan_completed - completed hardware scan
3201 * When hardware scan offload is used (i.e. the hw_scan() callback is
3202 * assigned) this function needs to be called by the driver to notify
3203 * mac80211 that the scan finished. This function can be called from
3204 * any context, including hardirq context.
3206 * @hw: the hardware that finished the scan
3207 * @aborted: set to true if scan was aborted
3209 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3212 * ieee80211_sched_scan_results - got results from scheduled scan
3214 * When a scheduled scan is running, this function needs to be called by the
3215 * driver whenever there are new scan results available.
3217 * @hw: the hardware that is performing scheduled scans
3219 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3222 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3224 * When a scheduled scan is running, this function can be called by
3225 * the driver if it needs to stop the scan to perform another task.
3226 * Usual scenarios are drivers that cannot continue the scheduled scan
3227 * while associating, for instance.
3229 * @hw: the hardware that is performing scheduled scans
3231 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3234 * ieee80211_iterate_active_interfaces - iterate active interfaces
3236 * This function iterates over the interfaces associated with a given
3237 * hardware that are currently active and calls the callback for them.
3238 * This function allows the iterator function to sleep, when the iterator
3239 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3241 * Does not iterate over a new interface during add_interface()
3243 * @hw: the hardware struct of which the interfaces should be iterated over
3244 * @iterator: the iterator function to call
3245 * @data: first argument of the iterator function
3247 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3248 void (*iterator)(void *data, u8 *mac,
3249 struct ieee80211_vif *vif),
3253 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3255 * This function iterates over the interfaces associated with a given
3256 * hardware that are currently active and calls the callback for them.
3257 * This function requires the iterator callback function to be atomic,
3258 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3259 * Does not iterate over a new interface during add_interface()
3261 * @hw: the hardware struct of which the interfaces should be iterated over
3262 * @iterator: the iterator function to call, cannot sleep
3263 * @data: first argument of the iterator function
3265 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3266 void (*iterator)(void *data,
3268 struct ieee80211_vif *vif),
3272 * ieee80211_queue_work - add work onto the mac80211 workqueue
3274 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3275 * This helper ensures drivers are not queueing work when they should not be.
3277 * @hw: the hardware struct for the interface we are adding work for
3278 * @work: the work we want to add onto the mac80211 workqueue
3280 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3283 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3285 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3288 * @hw: the hardware struct for the interface we are adding work for
3289 * @dwork: delayable work to queue onto the mac80211 workqueue
3290 * @delay: number of jiffies to wait before queueing
3292 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3293 struct delayed_work *dwork,
3294 unsigned long delay);
3297 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3298 * @sta: the station for which to start a BA session
3299 * @tid: the TID to BA on.
3300 * @timeout: session timeout value (in TUs)
3302 * Return: success if addBA request was sent, failure otherwise
3304 * Although mac80211/low level driver/user space application can estimate
3305 * the need to start aggregation on a certain RA/TID, the session level
3306 * will be managed by the mac80211.
3308 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3312 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3313 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3314 * @ra: receiver address of the BA session recipient.
3315 * @tid: the TID to BA on.
3317 * This function must be called by low level driver once it has
3318 * finished with preparations for the BA session. It can be called
3321 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3325 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3326 * @sta: the station whose BA session to stop
3327 * @tid: the TID to stop BA.
3329 * Return: negative error if the TID is invalid, or no aggregation active
3331 * Although mac80211/low level driver/user space application can estimate
3332 * the need to stop aggregation on a certain RA/TID, the session level
3333 * will be managed by the mac80211.
3335 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3338 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3339 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3340 * @ra: receiver address of the BA session recipient.
3341 * @tid: the desired TID to BA on.
3343 * This function must be called by low level driver once it has
3344 * finished with preparations for the BA session tear down. It
3345 * can be called from any context.
3347 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3351 * ieee80211_find_sta - find a station
3353 * @vif: virtual interface to look for station on
3354 * @addr: station's address
3356 * This function must be called under RCU lock and the
3357 * resulting pointer is only valid under RCU lock as well.
3359 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3363 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3365 * @hw: pointer as obtained from ieee80211_alloc_hw()
3366 * @addr: remote station's address
3367 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3369 * This function must be called under RCU lock and the
3370 * resulting pointer is only valid under RCU lock as well.
3372 * NOTE: You may pass NULL for localaddr, but then you will just get
3373 * the first STA that matches the remote address 'addr'.
3374 * We can have multiple STA associated with multiple
3375 * logical stations (e.g. consider a station connecting to another
3376 * BSSID on the same AP hardware without disconnecting first).
3377 * In this case, the result of this method with localaddr NULL
3380 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3382 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3384 const u8 *localaddr);
3387 * ieee80211_sta_block_awake - block station from waking up
3389 * @pubsta: the station
3390 * @block: whether to block or unblock
3392 * Some devices require that all frames that are on the queues
3393 * for a specific station that went to sleep are flushed before
3394 * a poll response or frames after the station woke up can be
3395 * delivered to that it. Note that such frames must be rejected
3396 * by the driver as filtered, with the appropriate status flag.
3398 * This function allows implementing this mode in a race-free
3401 * To do this, a driver must keep track of the number of frames
3402 * still enqueued for a specific station. If this number is not
3403 * zero when the station goes to sleep, the driver must call
3404 * this function to force mac80211 to consider the station to
3405 * be asleep regardless of the station's actual state. Once the
3406 * number of outstanding frames reaches zero, the driver must
3407 * call this function again to unblock the station. That will
3408 * cause mac80211 to be able to send ps-poll responses, and if
3409 * the station queried in the meantime then frames will also
3410 * be sent out as a result of this. Additionally, the driver
3411 * will be notified that the station woke up some time after
3412 * it is unblocked, regardless of whether the station actually
3413 * woke up while blocked or not.
3415 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3416 struct ieee80211_sta *pubsta, bool block);
3419 * ieee80211_sta_eosp - notify mac80211 about end of SP
3420 * @pubsta: the station
3422 * When a device transmits frames in a way that it can't tell
3423 * mac80211 in the TX status about the EOSP, it must clear the
3424 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3425 * This applies for PS-Poll as well as uAPSD.
3427 * Note that there is no non-_irqsafe version right now as
3428 * it wasn't needed, but just like _tx_status() and _rx()
3429 * must not be mixed in irqsafe/non-irqsafe versions, this
3430 * function must not be mixed with those either. Use the
3431 * all irqsafe, or all non-irqsafe, don't mix! If you need
3432 * the non-irqsafe version of this, you need to add it.
3434 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3437 * ieee80211_iter_keys - iterate keys programmed into the device
3438 * @hw: pointer obtained from ieee80211_alloc_hw()
3439 * @vif: virtual interface to iterate, may be %NULL for all
3440 * @iter: iterator function that will be called for each key
3441 * @iter_data: custom data to pass to the iterator function
3443 * This function can be used to iterate all the keys known to
3444 * mac80211, even those that weren't previously programmed into
3445 * the device. This is intended for use in WoWLAN if the device
3446 * needs reprogramming of the keys during suspend. Note that due
3447 * to locking reasons, it is also only safe to call this at few
3448 * spots since it must hold the RTNL and be able to sleep.
3450 * The order in which the keys are iterated matches the order
3451 * in which they were originally installed and handed to the
3454 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3455 struct ieee80211_vif *vif,
3456 void (*iter)(struct ieee80211_hw *hw,
3457 struct ieee80211_vif *vif,
3458 struct ieee80211_sta *sta,
3459 struct ieee80211_key_conf *key,
3464 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3465 * @hw: pointer obtained from ieee80211_alloc_hw().
3466 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3468 * Creates a Probe Request template which can, for example, be uploaded to
3469 * hardware. The template is filled with bssid, ssid and supported rate
3470 * information. This function must only be called from within the
3471 * .bss_info_changed callback function and only in managed mode. The function
3472 * is only useful when the interface is associated, otherwise it will return
3475 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3476 struct ieee80211_vif *vif);
3479 * ieee80211_beacon_loss - inform hardware does not receive beacons
3481 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3483 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3484 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3485 * hardware is not receiving beacons with this function.
3487 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3490 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3492 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3494 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3495 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3496 * needs to inform if the connection to the AP has been lost.
3498 * This function will cause immediate change to disassociated state,
3499 * without connection recovery attempts.
3501 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3504 * ieee80211_resume_disconnect - disconnect from AP after resume
3506 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3508 * Instructs mac80211 to disconnect from the AP after resume.
3509 * Drivers can use this after WoWLAN if they know that the
3510 * connection cannot be kept up, for example because keys were
3511 * used while the device was asleep but the replay counters or
3512 * similar cannot be retrieved from the device during resume.
3514 * Note that due to implementation issues, if the driver uses
3515 * the reconfiguration functionality during resume the interface
3516 * will still be added as associated first during resume and then
3517 * disconnect normally later.
3519 * This function can only be called from the resume callback and
3520 * the driver must not be holding any of its own locks while it
3521 * calls this function, or at least not any locks it needs in the
3522 * key configuration paths (if it supports HW crypto).
3524 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3527 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3529 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3531 * Some hardware require full power save to manage simultaneous BT traffic
3532 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3533 * burst of BT traffic. The hardware gets information of BT traffic via
3534 * hardware co-existence lines, and consequentially requests mac80211 to
3535 * (temporarily) enter full psm.
3536 * This function will only temporarily disable dynamic PS, not enable PSM if
3537 * it was not already enabled.
3538 * The driver must make sure to re-enable dynamic PS using
3539 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3542 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3545 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3547 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3549 * This function restores dynamic PS after being temporarily disabled via
3550 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3551 * be coupled with an eventual call to this function.
3554 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3557 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3558 * rssi threshold triggered
3560 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3561 * @rssi_event: the RSSI trigger event type
3562 * @gfp: context flags
3564 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3565 * monitoring is configured with an rssi threshold, the driver will inform
3566 * whenever the rssi level reaches the threshold.
3568 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3569 enum nl80211_cqm_rssi_threshold_event rssi_event,
3573 * ieee80211_chswitch_done - Complete channel switch process
3574 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3575 * @success: make the channel switch successful or not
3577 * Complete the channel switch post-process: set the new operational channel
3578 * and wake up the suspended queues.
3580 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3583 * ieee80211_request_smps - request SM PS transition
3584 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3585 * @smps_mode: new SM PS mode
3587 * This allows the driver to request an SM PS transition in managed
3588 * mode. This is useful when the driver has more information than
3589 * the stack about possible interference, for example by bluetooth.
3591 void ieee80211_request_smps(struct ieee80211_vif *vif,
3592 enum ieee80211_smps_mode smps_mode);
3595 * ieee80211_key_removed - disable hw acceleration for key
3596 * @key_conf: The key hw acceleration should be disabled for
3598 * This allows drivers to indicate that the given key has been
3599 * removed from hardware acceleration, due to a new key that
3600 * was added. Don't use this if the key can continue to be used
3601 * for TX, if the key restriction is on RX only it is permitted
3602 * to keep the key for TX only and not call this function.
3604 * Due to locking constraints, it may only be called during
3605 * @set_key. This function must be allowed to sleep, and the
3606 * key it tries to disable may still be used until it returns.
3608 void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3611 * ieee80211_ready_on_channel - notification of remain-on-channel start
3612 * @hw: pointer as obtained from ieee80211_alloc_hw()
3614 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3617 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3618 * @hw: pointer as obtained from ieee80211_alloc_hw()
3620 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3623 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3625 * in order not to harm the system performance and user experience, the device
3626 * may request not to allow any rx ba session and tear down existing rx ba
3627 * sessions based on system constraints such as periodic BT activity that needs
3628 * to limit wlan activity (eg.sco or a2dp)."
3629 * in such cases, the intention is to limit the duration of the rx ppdu and
3630 * therefore prevent the peer device to use a-mpdu aggregation.
3632 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3633 * @ba_rx_bitmap: Bit map of open rx ba per tid
3634 * @addr: & to bssid mac address
3636 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3640 * ieee80211_send_bar - send a BlockAckReq frame
3642 * can be used to flush pending frames from the peer's aggregation reorder
3645 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3646 * @ra: the peer's destination address
3647 * @tid: the TID of the aggregation session
3648 * @ssn: the new starting sequence number for the receiver
3650 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3652 /* Rate control API */
3655 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3657 * @hw: The hardware the algorithm is invoked for.
3658 * @sband: The band this frame is being transmitted on.
3659 * @bss_conf: the current BSS configuration
3660 * @skb: the skb that will be transmitted, the control information in it needs
3662 * @reported_rate: The rate control algorithm can fill this in to indicate
3663 * which rate should be reported to userspace as the current rate and
3664 * used for rate calculations in the mesh network.
3665 * @rts: whether RTS will be used for this frame because it is longer than the
3667 * @short_preamble: whether mac80211 will request short-preamble transmission
3668 * if the selected rate supports it
3669 * @max_rate_idx: user-requested maximum (legacy) rate
3670 * (deprecated; this will be removed once drivers get updated to use
3672 * @rate_idx_mask: user-requested (legacy) rate mask
3673 * @rate_idx_mcs_mask: user-requested MCS rate mask
3674 * @bss: whether this frame is sent out in AP or IBSS mode
3676 struct ieee80211_tx_rate_control {
3677 struct ieee80211_hw *hw;
3678 struct ieee80211_supported_band *sband;
3679 struct ieee80211_bss_conf *bss_conf;
3680 struct sk_buff *skb;
3681 struct ieee80211_tx_rate reported_rate;
3682 bool rts, short_preamble;
3685 u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
3689 struct rate_control_ops {
3690 struct module *module;
3692 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3693 void (*free)(void *priv);
3695 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3696 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3697 struct ieee80211_sta *sta, void *priv_sta);
3698 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3699 struct ieee80211_sta *sta, void *priv_sta,
3701 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3704 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3705 struct ieee80211_sta *sta, void *priv_sta,
3706 struct sk_buff *skb);
3707 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3708 struct ieee80211_tx_rate_control *txrc);
3710 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3711 struct dentry *dir);
3712 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3715 static inline int rate_supported(struct ieee80211_sta *sta,
3716 enum ieee80211_band band,
3719 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3723 * rate_control_send_low - helper for drivers for management/no-ack frames
3725 * Rate control algorithms that agree to use the lowest rate to
3726 * send management frames and NO_ACK data with the respective hw
3727 * retries should use this in the beginning of their mac80211 get_rate
3728 * callback. If true is returned the rate control can simply return.
3729 * If false is returned we guarantee that sta and sta and priv_sta is
3732 * Rate control algorithms wishing to do more intelligent selection of
3733 * rate for multicast/broadcast frames may choose to not use this.
3735 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3736 * that this may be null.
3737 * @priv_sta: private rate control structure. This may be null.
3738 * @txrc: rate control information we sholud populate for mac80211.
3740 bool rate_control_send_low(struct ieee80211_sta *sta,
3742 struct ieee80211_tx_rate_control *txrc);
3746 rate_lowest_index(struct ieee80211_supported_band *sband,
3747 struct ieee80211_sta *sta)
3751 for (i = 0; i < sband->n_bitrates; i++)
3752 if (rate_supported(sta, sband->band, i))
3755 /* warn when we cannot find a rate. */
3758 /* and return 0 (the lowest index) */
3763 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3764 struct ieee80211_sta *sta)
3768 for (i = 0; i < sband->n_bitrates; i++)
3769 if (rate_supported(sta, sband->band, i))
3774 int ieee80211_rate_control_register(struct rate_control_ops *ops);
3775 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3778 conf_is_ht20(struct ieee80211_conf *conf)
3780 return conf->channel_type == NL80211_CHAN_HT20;
3784 conf_is_ht40_minus(struct ieee80211_conf *conf)
3786 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3790 conf_is_ht40_plus(struct ieee80211_conf *conf)
3792 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3796 conf_is_ht40(struct ieee80211_conf *conf)
3798 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3802 conf_is_ht(struct ieee80211_conf *conf)
3804 return conf->channel_type != NL80211_CHAN_NO_HT;
3807 static inline enum nl80211_iftype
3808 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3812 case NL80211_IFTYPE_STATION:
3813 return NL80211_IFTYPE_P2P_CLIENT;
3814 case NL80211_IFTYPE_AP:
3815 return NL80211_IFTYPE_P2P_GO;
3823 static inline enum nl80211_iftype
3824 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3826 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3829 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3831 int rssi_max_thold);
3833 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3836 * ieee80211_ave_rssi - report the average rssi for the specified interface
3838 * @vif: the specified virtual interface
3840 * This function return the average rssi value for the requested interface.
3841 * It assumes that the given vif is valid.
3843 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
3845 #endif /* MAC80211_H */