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/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/device.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.
91 * enum ieee80211_max_queues - maximum number of queues
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 enum ieee80211_max_queues {
96 IEEE80211_MAX_QUEUES = 4,
100 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101 * @IEEE80211_AC_VO: voice
102 * @IEEE80211_AC_VI: video
103 * @IEEE80211_AC_BE: best effort
104 * @IEEE80211_AC_BK: background
106 enum ieee80211_ac_numbers {
112 #define IEEE80211_NUM_ACS 4
115 * struct ieee80211_tx_queue_params - transmit queue configuration
117 * The information provided in this structure is required for QoS
118 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
120 * @aifs: arbitration interframe space [0..255]
121 * @cw_min: minimum contention window [a value of the form
122 * 2^n-1 in the range 1..32767]
123 * @cw_max: maximum contention window [like @cw_min]
124 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
125 * @uapsd: is U-APSD mode enabled for the queue
127 struct ieee80211_tx_queue_params {
135 struct ieee80211_low_level_stats {
136 unsigned int dot11ACKFailureCount;
137 unsigned int dot11RTSFailureCount;
138 unsigned int dot11FCSErrorCount;
139 unsigned int dot11RTSSuccessCount;
143 * enum ieee80211_bss_change - BSS change notification flags
145 * These flags are used with the bss_info_changed() callback
146 * to indicate which BSS parameter changed.
148 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
149 * also implies a change in the AID.
150 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
151 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
152 * @BSS_CHANGED_ERP_SLOT: slot timing changed
153 * @BSS_CHANGED_HT: 802.11n parameters changed
154 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
155 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
156 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
157 * reason (IBSS and managed mode)
158 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
159 * new beacon (beaconing modes)
160 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
161 * enabled/disabled (beaconing modes)
162 * @BSS_CHANGED_CQM: Connection quality monitor config changed
163 * @BSS_CHANGED_IBSS: IBSS join status changed
164 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
165 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
166 * that it is only ever disabled for station mode.
167 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
168 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
170 enum ieee80211_bss_change {
171 BSS_CHANGED_ASSOC = 1<<0,
172 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
173 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
174 BSS_CHANGED_ERP_SLOT = 1<<3,
175 BSS_CHANGED_HT = 1<<4,
176 BSS_CHANGED_BASIC_RATES = 1<<5,
177 BSS_CHANGED_BEACON_INT = 1<<6,
178 BSS_CHANGED_BSSID = 1<<7,
179 BSS_CHANGED_BEACON = 1<<8,
180 BSS_CHANGED_BEACON_ENABLED = 1<<9,
181 BSS_CHANGED_CQM = 1<<10,
182 BSS_CHANGED_IBSS = 1<<11,
183 BSS_CHANGED_ARP_FILTER = 1<<12,
184 BSS_CHANGED_QOS = 1<<13,
185 BSS_CHANGED_IDLE = 1<<14,
186 BSS_CHANGED_SSID = 1<<15,
188 /* when adding here, make sure to change ieee80211_reconfig */
192 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
193 * of addresses for an interface increase beyond this value, hardware ARP
194 * filtering will be disabled.
196 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
199 * enum ieee80211_rssi_event - RSSI threshold event
200 * An indicator for when RSSI goes below/above a certain threshold.
201 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
202 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
204 enum ieee80211_rssi_event {
210 * struct ieee80211_bss_conf - holds the BSS's changing parameters
212 * This structure keeps information about a BSS (and an association
213 * to that BSS) that can change during the lifetime of the BSS.
215 * @assoc: association status
216 * @ibss_joined: indicates whether this station is part of an IBSS
218 * @aid: association ID number, valid only when @assoc is true
219 * @use_cts_prot: use CTS protection
220 * @use_short_preamble: use 802.11b short preamble;
221 * if the hardware cannot handle this it must set the
222 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
223 * @use_short_slot: use short slot time (only relevant for ERP);
224 * if the hardware cannot handle this it must set the
225 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
226 * @dtim_period: num of beacons before the next DTIM, for beaconing,
227 * valid in station mode only while @assoc is true and if also
228 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
230 * @timestamp: beacon timestamp
231 * @beacon_int: beacon interval
232 * @assoc_capability: capabilities taken from assoc resp
233 * @basic_rates: bitmap of basic rates, each bit stands for an
234 * index into the rate table configured by the driver in
236 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
237 * @bssid: The BSSID for this BSS
238 * @enable_beacon: whether beaconing should be enabled or not
239 * @channel_type: Channel type for this BSS -- the hardware might be
240 * configured for HT40+ while this BSS only uses no-HT, for
242 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
243 * This field is only valid when the channel type is one of the HT types.
244 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
246 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
247 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
248 * may filter ARP queries targeted for other addresses than listed here.
249 * The driver must allow ARP queries targeted for all address listed here
250 * to pass through. An empty list implies no ARP queries need to pass.
251 * @arp_addr_cnt: Number of addresses currently on the list.
252 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
253 * filter ARP queries based on the @arp_addr_list, if disabled, the
254 * hardware must not perform any ARP filtering. Note, that the filter will
255 * be enabled also in promiscuous mode.
256 * @qos: This is a QoS-enabled BSS.
257 * @idle: This interface is idle. There's also a global idle flag in the
258 * hardware config which may be more appropriate depending on what
259 * your driver/device needs to do.
260 * @ssid: The SSID of the current vif. Only valid in AP-mode.
261 * @ssid_len: Length of SSID given in @ssid.
262 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
264 struct ieee80211_bss_conf {
266 /* association related data */
267 bool assoc, ibss_joined;
269 /* erp related data */
271 bool use_short_preamble;
276 u16 assoc_capability;
279 int mcast_rate[IEEE80211_NUM_BANDS];
280 u16 ht_operation_mode;
283 enum nl80211_channel_type channel_type;
284 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
286 bool arp_filter_enabled;
289 u8 ssid[IEEE80211_MAX_SSID_LEN];
295 * enum mac80211_tx_control_flags - flags to describe transmission information/status
297 * These flags are used with the @flags member of &ieee80211_tx_info.
299 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
300 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
301 * number to this frame, taking care of not overwriting the fragment
302 * number and increasing the sequence number only when the
303 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
304 * assign sequence numbers to QoS-data frames but cannot do so correctly
305 * for non-QoS-data and management frames because beacons need them from
306 * that counter as well and mac80211 cannot guarantee proper sequencing.
307 * If this flag is set, the driver should instruct the hardware to
308 * assign a sequence number to the frame or assign one itself. Cf. IEEE
309 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
310 * beacons and always be clear for frames without a sequence number field.
311 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
312 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
314 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
315 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
316 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
317 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
318 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
319 * because the destination STA was in powersave mode. Note that to
320 * avoid race conditions, the filter must be set by the hardware or
321 * firmware upon receiving a frame that indicates that the station
322 * went to sleep (must be done on device to filter frames already on
323 * the queue) and may only be unset after mac80211 gives the OK for
324 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
325 * since only then is it guaranteed that no more frames are in the
327 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
328 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
329 * is for the whole aggregation.
330 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
331 * so consider using block ack request (BAR).
332 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
333 * set by rate control algorithms to indicate probe rate, will
334 * be cleared for fragmented frames (except on the last fragment)
335 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
336 * used to indicate that a pending frame requires TX processing before
337 * it can be sent out.
338 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
339 * used to indicate that a frame was already retried due to PS
340 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
341 * used to indicate frame should not be encrypted
342 * @IEEE80211_TX_CTL_POLL_RESPONSE: This frame is a response to a poll
343 * frame (PS-Poll or uAPSD) and should be sent although the station
344 * is in powersave mode.
345 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
346 * transmit function after the current frame, this can be used
347 * by drivers to kick the DMA queue only if unset or when the
349 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
350 * after TX status because the destination was asleep, it must not
351 * be modified again (no seqno assignment, crypto, etc.)
352 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
353 * has a radiotap header at skb->data.
354 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
355 * MLME command (internal to mac80211 to figure out whether to send TX
356 * status to user space)
357 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
358 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
359 * frame and selects the maximum number of streams that it can use.
360 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
361 * the off-channel channel when a remain-on-channel offload is done
362 * in hardware -- normal packets still flow and are expected to be
363 * handled properly by the device.
364 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
365 * testing. It will be sent out with incorrect Michael MIC key to allow
366 * TKIP countermeasures to be tested.
367 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
368 * This flag is actually used for management frame especially for P2P
369 * frames not being sent at CCK rate in 2GHz band.
370 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
371 * when its status is reported the service period ends. For frames in
372 * an SP that mac80211 transmits, it is already set; for driver frames
373 * the driver may set this flag. It is also used to do the same for
376 * Note: If you have to add new flags to the enumeration, then don't
377 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
379 enum mac80211_tx_control_flags {
380 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
381 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
382 IEEE80211_TX_CTL_NO_ACK = BIT(2),
383 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
384 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
385 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
386 IEEE80211_TX_CTL_AMPDU = BIT(6),
387 IEEE80211_TX_CTL_INJECTED = BIT(7),
388 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
389 IEEE80211_TX_STAT_ACK = BIT(9),
390 IEEE80211_TX_STAT_AMPDU = BIT(10),
391 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
392 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
393 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
394 IEEE80211_TX_INTFL_RETRIED = BIT(15),
395 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
396 IEEE80211_TX_CTL_POLL_RESPONSE = BIT(17),
397 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
398 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
399 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
400 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
401 IEEE80211_TX_CTL_LDPC = BIT(22),
402 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
403 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
404 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
405 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
406 IEEE80211_TX_STATUS_EOSP = BIT(28),
409 #define IEEE80211_TX_CTL_STBC_SHIFT 23
412 * This definition is used as a mask to clear all temporary flags, which are
413 * set by the tx handlers for each transmission attempt by the mac80211 stack.
415 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
416 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
417 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
418 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
419 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
420 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_POLL_RESPONSE | \
421 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
422 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
425 * enum mac80211_rate_control_flags - per-rate flags set by the
426 * Rate Control algorithm.
428 * These flags are set by the Rate control algorithm for each rate during tx,
429 * in the @flags member of struct ieee80211_tx_rate.
431 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
432 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
433 * This is set if the current BSS requires ERP protection.
434 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
435 * @IEEE80211_TX_RC_MCS: HT rate.
436 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
438 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
439 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
440 * adjacent 20 MHz channels, if the current channel type is
441 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
442 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
444 enum mac80211_rate_control_flags {
445 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
446 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
447 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
449 /* rate index is an MCS rate number instead of an index */
450 IEEE80211_TX_RC_MCS = BIT(3),
451 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
452 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
453 IEEE80211_TX_RC_DUP_DATA = BIT(6),
454 IEEE80211_TX_RC_SHORT_GI = BIT(7),
458 /* there are 40 bytes if you don't need the rateset to be kept */
459 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
461 /* if you do need the rateset, then you have less space */
462 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
464 /* maximum number of rate stages */
465 #define IEEE80211_TX_MAX_RATES 5
468 * struct ieee80211_tx_rate - rate selection/status
470 * @idx: rate index to attempt to send with
471 * @flags: rate control flags (&enum mac80211_rate_control_flags)
472 * @count: number of tries in this rate before going to the next rate
474 * A value of -1 for @idx indicates an invalid rate and, if used
475 * in an array of retry rates, that no more rates should be tried.
477 * When used for transmit status reporting, the driver should
478 * always report the rate along with the flags it used.
480 * &struct ieee80211_tx_info contains an array of these structs
481 * in the control information, and it will be filled by the rate
482 * control algorithm according to what should be sent. For example,
483 * if this array contains, in the format { <idx>, <count> } the
485 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
486 * then this means that the frame should be transmitted
487 * up to twice at rate 3, up to twice at rate 2, and up to four
488 * times at rate 1 if it doesn't get acknowledged. Say it gets
489 * acknowledged by the peer after the fifth attempt, the status
490 * information should then contain
491 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
492 * since it was transmitted twice at rate 3, twice at rate 2
493 * and once at rate 1 after which we received an acknowledgement.
495 struct ieee80211_tx_rate {
502 * struct ieee80211_tx_info - skb transmit information
504 * This structure is placed in skb->cb for three uses:
505 * (1) mac80211 TX control - mac80211 tells the driver what to do
506 * (2) driver internal use (if applicable)
507 * (3) TX status information - driver tells mac80211 what happened
509 * The TX control's sta pointer is only valid during the ->tx call,
512 * @flags: transmit info flags, defined above
513 * @band: the band to transmit on (use for checking for races)
514 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
515 * @pad: padding, ignore
516 * @control: union for control data
517 * @status: union for status data
518 * @driver_data: array of driver_data pointers
519 * @ampdu_ack_len: number of acked aggregated frames.
520 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
521 * @ampdu_len: number of aggregated frames.
522 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
523 * @ack_signal: signal strength of the ACK frame
525 struct ieee80211_tx_info {
526 /* common information */
540 struct ieee80211_tx_rate rates[
541 IEEE80211_TX_MAX_RATES];
544 /* only needed before rate control */
545 unsigned long jiffies;
547 /* NB: vif can be NULL for injected frames */
548 struct ieee80211_vif *vif;
549 struct ieee80211_key_conf *hw_key;
550 struct ieee80211_sta *sta;
553 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
560 struct ieee80211_tx_rate driver_rates[
561 IEEE80211_TX_MAX_RATES];
562 void *rate_driver_data[
563 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
566 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
571 * struct ieee80211_sched_scan_ies - scheduled scan IEs
573 * This structure is used to pass the appropriate IEs to be used in scheduled
574 * scans for all bands. It contains both the IEs passed from the userspace
575 * and the ones generated by mac80211.
577 * @ie: array with the IEs for each supported band
578 * @len: array with the total length of the IEs for each band
580 struct ieee80211_sched_scan_ies {
581 u8 *ie[IEEE80211_NUM_BANDS];
582 size_t len[IEEE80211_NUM_BANDS];
585 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
587 return (struct ieee80211_tx_info *)skb->cb;
590 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
592 return (struct ieee80211_rx_status *)skb->cb;
596 * ieee80211_tx_info_clear_status - clear TX status
598 * @info: The &struct ieee80211_tx_info to be cleared.
600 * When the driver passes an skb back to mac80211, it must report
601 * a number of things in TX status. This function clears everything
602 * in the TX status but the rate control information (it does clear
603 * the count since you need to fill that in anyway).
605 * NOTE: You can only use this function if you do NOT use
606 * info->driver_data! Use info->rate_driver_data
607 * instead if you need only the less space that allows.
610 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
614 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
615 offsetof(struct ieee80211_tx_info, control.rates));
616 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
617 offsetof(struct ieee80211_tx_info, driver_rates));
618 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
619 /* clear the rate counts */
620 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
621 info->status.rates[i].count = 0;
624 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
625 memset(&info->status.ampdu_ack_len, 0,
626 sizeof(struct ieee80211_tx_info) -
627 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
632 * enum mac80211_rx_flags - receive flags
634 * These flags are used with the @flag member of &struct ieee80211_rx_status.
635 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
636 * Use together with %RX_FLAG_MMIC_STRIPPED.
637 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
638 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
639 * verification has been done by the hardware.
640 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
641 * If this flag is set, the stack cannot do any replay detection
642 * hence the driver or hardware will have to do that.
643 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
645 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
647 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
648 * field) is valid and contains the time the first symbol of the MPDU
649 * was received. This is useful in monitor mode and for proper IBSS
651 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
652 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
653 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
654 * @RX_FLAG_SHORT_GI: Short guard interval was used
656 enum mac80211_rx_flags {
657 RX_FLAG_MMIC_ERROR = 1<<0,
658 RX_FLAG_DECRYPTED = 1<<1,
659 RX_FLAG_MMIC_STRIPPED = 1<<3,
660 RX_FLAG_IV_STRIPPED = 1<<4,
661 RX_FLAG_FAILED_FCS_CRC = 1<<5,
662 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
663 RX_FLAG_MACTIME_MPDU = 1<<7,
664 RX_FLAG_SHORTPRE = 1<<8,
666 RX_FLAG_40MHZ = 1<<10,
667 RX_FLAG_SHORT_GI = 1<<11,
671 * struct ieee80211_rx_status - receive status
673 * The low-level driver should provide this information (the subset
674 * supported by hardware) to the 802.11 code with each received
675 * frame, in the skb's control buffer (cb).
677 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
678 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
679 * @band: the active band when this frame was received
680 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
681 * @signal: signal strength when receiving this frame, either in dBm, in dB or
682 * unspecified depending on the hardware capabilities flags
683 * @IEEE80211_HW_SIGNAL_*
684 * @antenna: antenna used
685 * @rate_idx: index of data rate into band's supported rates or MCS index if
686 * HT rates are use (RX_FLAG_HT)
688 * @rx_flags: internal RX flags for mac80211
690 struct ieee80211_rx_status {
692 enum ieee80211_band band;
698 unsigned int rx_flags;
702 * enum ieee80211_conf_flags - configuration flags
704 * Flags to define PHY configuration options
706 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
707 * to determine for example whether to calculate timestamps for packets
708 * or not, do not use instead of filter flags!
709 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
710 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
711 * meaning that the hardware still wakes up for beacons, is able to
712 * transmit frames and receive the possible acknowledgment frames.
713 * Not to be confused with hardware specific wakeup/sleep states,
714 * driver is responsible for that. See the section "Powersave support"
716 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
717 * the driver should be prepared to handle configuration requests but
718 * may turn the device off as much as possible. Typically, this flag will
719 * be set when an interface is set UP but not associated or scanning, but
720 * it can also be unset in that case when monitor interfaces are active.
721 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
724 enum ieee80211_conf_flags {
725 IEEE80211_CONF_MONITOR = (1<<0),
726 IEEE80211_CONF_PS = (1<<1),
727 IEEE80211_CONF_IDLE = (1<<2),
728 IEEE80211_CONF_OFFCHANNEL = (1<<3),
733 * enum ieee80211_conf_changed - denotes which configuration changed
735 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
736 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
737 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
738 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
739 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
740 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
741 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
742 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
744 enum ieee80211_conf_changed {
745 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
746 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
747 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
748 IEEE80211_CONF_CHANGE_PS = BIT(4),
749 IEEE80211_CONF_CHANGE_POWER = BIT(5),
750 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
751 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
752 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
756 * enum ieee80211_smps_mode - spatial multiplexing power save mode
758 * @IEEE80211_SMPS_AUTOMATIC: automatic
759 * @IEEE80211_SMPS_OFF: off
760 * @IEEE80211_SMPS_STATIC: static
761 * @IEEE80211_SMPS_DYNAMIC: dynamic
762 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
764 enum ieee80211_smps_mode {
765 IEEE80211_SMPS_AUTOMATIC,
767 IEEE80211_SMPS_STATIC,
768 IEEE80211_SMPS_DYNAMIC,
771 IEEE80211_SMPS_NUM_MODES,
775 * struct ieee80211_conf - configuration of the device
777 * This struct indicates how the driver shall configure the hardware.
779 * @flags: configuration flags defined above
781 * @listen_interval: listen interval in units of beacon interval
782 * @max_sleep_period: the maximum number of beacon intervals to sleep for
783 * before checking the beacon for a TIM bit (managed mode only); this
784 * value will be only achievable between DTIM frames, the hardware
785 * needs to check for the multicast traffic bit in DTIM beacons.
786 * This variable is valid only when the CONF_PS flag is set.
787 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
788 * in power saving. Power saving will not be enabled until a beacon
789 * has been received and the DTIM period is known.
790 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
791 * powersave documentation below. This variable is valid only when
792 * the CONF_PS flag is set.
794 * @power_level: requested transmit power (in dBm)
796 * @channel: the channel to tune to
797 * @channel_type: the channel (HT) type
799 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
800 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
801 * but actually means the number of transmissions not the number of retries
802 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
803 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
804 * number of transmissions not the number of retries
806 * @smps_mode: spatial multiplexing powersave mode; note that
807 * %IEEE80211_SMPS_STATIC is used when the device is not
808 * configured for an HT channel
810 struct ieee80211_conf {
812 int power_level, dynamic_ps_timeout;
813 int max_sleep_period;
818 u8 long_frame_max_tx_count, short_frame_max_tx_count;
820 struct ieee80211_channel *channel;
821 enum nl80211_channel_type channel_type;
822 enum ieee80211_smps_mode smps_mode;
826 * struct ieee80211_channel_switch - holds the channel switch data
828 * The information provided in this structure is required for channel switch
831 * @timestamp: value in microseconds of the 64-bit Time Synchronization
832 * Function (TSF) timer when the frame containing the channel switch
833 * announcement was received. This is simply the rx.mactime parameter
834 * the driver passed into mac80211.
835 * @block_tx: Indicates whether transmission must be blocked before the
836 * scheduled channel switch, as indicated by the AP.
837 * @channel: the new channel to switch to
838 * @count: the number of TBTT's until the channel switch event
840 struct ieee80211_channel_switch {
843 struct ieee80211_channel *channel;
848 * struct ieee80211_vif - per-interface data
850 * Data in this structure is continually present for driver
851 * use during the life of a virtual interface.
853 * @type: type of this virtual interface
854 * @bss_conf: BSS configuration for this interface, either our own
855 * or the BSS we're associated to
856 * @addr: address of this interface
857 * @p2p: indicates whether this AP or STA interface is a p2p
858 * interface, i.e. a GO or p2p-sta respectively
859 * @drv_priv: data area for driver use, will always be aligned to
862 struct ieee80211_vif {
863 enum nl80211_iftype type;
864 struct ieee80211_bss_conf bss_conf;
868 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
871 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
873 #ifdef CONFIG_MAC80211_MESH
874 return vif->type == NL80211_IFTYPE_MESH_POINT;
880 * enum ieee80211_key_flags - key flags
882 * These flags are used for communication about keys between the driver
883 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
885 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
886 * that the STA this key will be used with could be using QoS.
887 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
888 * driver to indicate that it requires IV generation for this
890 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
891 * the driver for a TKIP key if it requires Michael MIC
892 * generation in software.
893 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
894 * that the key is pairwise rather then a shared key.
895 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
896 * CCMP key if it requires CCMP encryption of management frames (MFP) to
897 * be done in software.
899 enum ieee80211_key_flags {
900 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
901 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
902 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
903 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
904 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
908 * struct ieee80211_key_conf - key information
910 * This key information is given by mac80211 to the driver by
911 * the set_key() callback in &struct ieee80211_ops.
913 * @hw_key_idx: To be set by the driver, this is the key index the driver
914 * wants to be given when a frame is transmitted and needs to be
915 * encrypted in hardware.
916 * @cipher: The key's cipher suite selector.
917 * @flags: key flags, see &enum ieee80211_key_flags.
918 * @keyidx: the key index (0-3)
919 * @keylen: key material length
920 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
922 * - Temporal Encryption Key (128 bits)
923 * - Temporal Authenticator Tx MIC Key (64 bits)
924 * - Temporal Authenticator Rx MIC Key (64 bits)
925 * @icv_len: The ICV length for this key type
926 * @iv_len: The IV length for this key type
928 struct ieee80211_key_conf {
940 * enum set_key_cmd - key command
942 * Used with the set_key() callback in &struct ieee80211_ops, this
943 * indicates whether a key is being removed or added.
945 * @SET_KEY: a key is set
946 * @DISABLE_KEY: a key must be disabled
949 SET_KEY, DISABLE_KEY,
953 * struct ieee80211_sta - station table entry
955 * A station table entry represents a station we are possibly
956 * communicating with. Since stations are RCU-managed in
957 * mac80211, any ieee80211_sta pointer you get access to must
958 * either be protected by rcu_read_lock() explicitly or implicitly,
959 * or you must take good care to not use such a pointer after a
960 * call to your sta_remove callback that removed it.
963 * @aid: AID we assigned to the station if we're an AP
964 * @supp_rates: Bitmap of supported rates (per band)
965 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
966 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
967 * @drv_priv: data area for driver use, will always be aligned to
968 * sizeof(void *), size is determined in hw information.
969 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
970 * if wme is supported.
971 * @max_sp: max Service Period. Only valid if wme is supported.
973 struct ieee80211_sta {
974 u32 supp_rates[IEEE80211_NUM_BANDS];
977 struct ieee80211_sta_ht_cap ht_cap;
983 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
987 * enum sta_notify_cmd - sta notify command
989 * Used with the sta_notify() callback in &struct ieee80211_ops, this
990 * indicates if an associated station made a power state transition.
992 * @STA_NOTIFY_SLEEP: a station is now sleeping
993 * @STA_NOTIFY_AWAKE: a sleeping station woke up
995 enum sta_notify_cmd {
996 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1000 * enum ieee80211_hw_flags - hardware flags
1002 * These flags are used to indicate hardware capabilities to
1003 * the stack. Generally, flags here should have their meaning
1004 * done in a way that the simplest hardware doesn't need setting
1005 * any particular flags. There are some exceptions to this rule,
1006 * however, so you are advised to review these flags carefully.
1008 * @IEEE80211_HW_HAS_RATE_CONTROL:
1009 * The hardware or firmware includes rate control, and cannot be
1010 * controlled by the stack. As such, no rate control algorithm
1011 * should be instantiated, and the TX rate reported to userspace
1012 * will be taken from the TX status instead of the rate control
1014 * Note that this requires that the driver implement a number of
1015 * callbacks so it has the correct information, it needs to have
1016 * the @set_rts_threshold callback and must look at the BSS config
1017 * @use_cts_prot for G/N protection, @use_short_slot for slot
1018 * timing in 2.4 GHz and @use_short_preamble for preambles for
1021 * @IEEE80211_HW_RX_INCLUDES_FCS:
1022 * Indicates that received frames passed to the stack include
1023 * the FCS at the end.
1025 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1026 * Some wireless LAN chipsets buffer broadcast/multicast frames
1027 * for power saving stations in the hardware/firmware and others
1028 * rely on the host system for such buffering. This option is used
1029 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1030 * multicast frames when there are power saving stations so that
1031 * the driver can fetch them with ieee80211_get_buffered_bc().
1033 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1034 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1036 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1037 * Hardware is not capable of receiving frames with short preamble on
1040 * @IEEE80211_HW_SIGNAL_UNSPEC:
1041 * Hardware can provide signal values but we don't know its units. We
1042 * expect values between 0 and @max_signal.
1043 * If possible please provide dB or dBm instead.
1045 * @IEEE80211_HW_SIGNAL_DBM:
1046 * Hardware gives signal values in dBm, decibel difference from
1047 * one milliwatt. This is the preferred method since it is standardized
1048 * between different devices. @max_signal does not need to be set.
1050 * @IEEE80211_HW_SPECTRUM_MGMT:
1051 * Hardware supports spectrum management defined in 802.11h
1052 * Measurement, Channel Switch, Quieting, TPC
1054 * @IEEE80211_HW_AMPDU_AGGREGATION:
1055 * Hardware supports 11n A-MPDU aggregation.
1057 * @IEEE80211_HW_SUPPORTS_PS:
1058 * Hardware has power save support (i.e. can go to sleep).
1060 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1061 * Hardware requires nullfunc frame handling in stack, implies
1062 * stack support for dynamic PS.
1064 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1065 * Hardware has support for dynamic PS.
1067 * @IEEE80211_HW_MFP_CAPABLE:
1068 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1070 * @IEEE80211_HW_BEACON_FILTER:
1071 * Hardware supports dropping of irrelevant beacon frames to
1072 * avoid waking up cpu.
1074 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1075 * Hardware supports static spatial multiplexing powersave,
1076 * ie. can turn off all but one chain even on HT connections
1077 * that should be using more chains.
1079 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1080 * Hardware supports dynamic spatial multiplexing powersave,
1081 * ie. can turn off all but one chain and then wake the rest
1082 * up as required after, for example, rts/cts handshake.
1084 * @IEEE80211_HW_SUPPORTS_UAPSD:
1085 * Hardware supports Unscheduled Automatic Power Save Delivery
1086 * (U-APSD) in managed mode. The mode is configured with
1087 * conf_tx() operation.
1089 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1090 * Hardware can provide ack status reports of Tx frames to
1093 * @IEEE80211_HW_CONNECTION_MONITOR:
1094 * The hardware performs its own connection monitoring, including
1095 * periodic keep-alives to the AP and probing the AP on beacon loss.
1096 * When this flag is set, signaling beacon-loss will cause an immediate
1097 * change to disassociated state.
1099 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1100 * Hardware can do connection quality monitoring - i.e. it can monitor
1101 * connection quality related parameters, such as the RSSI level and
1102 * provide notifications if configured trigger levels are reached.
1104 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1105 * This device needs to know the DTIM period for the BSS before
1108 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1109 * per-station GTKs as used by IBSS RSN or during fast transition. If
1110 * the device doesn't support per-station GTKs, but can be asked not
1111 * to decrypt group addressed frames, then IBSS RSN support is still
1112 * possible but software crypto will be used. Advertise the wiphy flag
1113 * only in that case.
1115 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1116 * autonomously manages the PS status of connected stations. When
1117 * this flag is set mac80211 will not trigger PS mode for connected
1118 * stations based on the PM bit of incoming frames.
1119 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1120 * the PS mode of connected stations.
1122 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1123 * setup strictly in HW. mac80211 should not attempt to do this in
1126 enum ieee80211_hw_flags {
1127 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1128 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1129 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1130 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1131 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1132 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1133 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1134 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1135 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1136 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1137 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1138 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1139 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1140 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1141 IEEE80211_HW_BEACON_FILTER = 1<<14,
1142 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1143 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1144 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1145 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1146 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1147 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1148 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1149 IEEE80211_HW_AP_LINK_PS = 1<<22,
1150 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1154 * struct ieee80211_hw - hardware information and state
1156 * This structure contains the configuration and hardware
1157 * information for an 802.11 PHY.
1159 * @wiphy: This points to the &struct wiphy allocated for this
1160 * 802.11 PHY. You must fill in the @perm_addr and @dev
1161 * members of this structure using SET_IEEE80211_DEV()
1162 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1163 * bands (with channels, bitrates) are registered here.
1165 * @conf: &struct ieee80211_conf, device configuration, don't use.
1167 * @priv: pointer to private area that was allocated for driver use
1168 * along with this structure.
1170 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1172 * @extra_tx_headroom: headroom to reserve in each transmit skb
1173 * for use by the driver (e.g. for transmit headers.)
1175 * @channel_change_time: time (in microseconds) it takes to change channels.
1177 * @max_signal: Maximum value for signal (rssi) in RX information, used
1178 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1180 * @max_listen_interval: max listen interval in units of beacon interval
1183 * @queues: number of available hardware transmit queues for
1184 * data packets. WMM/QoS requires at least four, these
1185 * queues need to have configurable access parameters.
1187 * @rate_control_algorithm: rate control algorithm for this hardware.
1188 * If unset (NULL), the default algorithm will be used. Must be
1189 * set before calling ieee80211_register_hw().
1191 * @vif_data_size: size (in bytes) of the drv_priv data area
1192 * within &struct ieee80211_vif.
1193 * @sta_data_size: size (in bytes) of the drv_priv data area
1194 * within &struct ieee80211_sta.
1196 * @max_rates: maximum number of alternate rate retry stages the hw
1198 * @max_report_rates: maximum number of alternate rate retry stages
1199 * the hw can report back.
1200 * @max_rate_tries: maximum number of tries for each stage
1202 * @napi_weight: weight used for NAPI polling. You must specify an
1203 * appropriate value here if a napi_poll operation is provided
1206 * @max_rx_aggregation_subframes: maximum buffer size (number of
1207 * sub-frames) to be used for A-MPDU block ack receiver
1209 * This is only relevant if the device has restrictions on the
1210 * number of subframes, if it relies on mac80211 to do reordering
1211 * it shouldn't be set.
1213 * @max_tx_aggregation_subframes: maximum number of subframes in an
1214 * aggregate an HT driver will transmit, used by the peer as a
1215 * hint to size its reorder buffer.
1217 struct ieee80211_hw {
1218 struct ieee80211_conf conf;
1219 struct wiphy *wiphy;
1220 const char *rate_control_algorithm;
1223 unsigned int extra_tx_headroom;
1224 int channel_change_time;
1229 u16 max_listen_interval;
1232 u8 max_report_rates;
1234 u8 max_rx_aggregation_subframes;
1235 u8 max_tx_aggregation_subframes;
1239 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1241 * @wiphy: the &struct wiphy which we want to query
1243 * mac80211 drivers can use this to get to their respective
1244 * &struct ieee80211_hw. Drivers wishing to get to their own private
1245 * structure can then access it via hw->priv. Note that mac802111 drivers should
1246 * not use wiphy_priv() to try to get their private driver structure as this
1247 * is already used internally by mac80211.
1249 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1252 * SET_IEEE80211_DEV - set device for 802.11 hardware
1254 * @hw: the &struct ieee80211_hw to set the device for
1255 * @dev: the &struct device of this 802.11 device
1257 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1259 set_wiphy_dev(hw->wiphy, dev);
1263 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1265 * @hw: the &struct ieee80211_hw to set the MAC address for
1266 * @addr: the address to set
1268 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1270 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1273 static inline struct ieee80211_rate *
1274 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1275 const struct ieee80211_tx_info *c)
1277 if (WARN_ON(c->control.rates[0].idx < 0))
1279 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1282 static inline struct ieee80211_rate *
1283 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1284 const struct ieee80211_tx_info *c)
1286 if (c->control.rts_cts_rate_idx < 0)
1288 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1291 static inline struct ieee80211_rate *
1292 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1293 const struct ieee80211_tx_info *c, int idx)
1295 if (c->control.rates[idx + 1].idx < 0)
1297 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1301 * DOC: Hardware crypto acceleration
1303 * mac80211 is capable of taking advantage of many hardware
1304 * acceleration designs for encryption and decryption operations.
1306 * The set_key() callback in the &struct ieee80211_ops for a given
1307 * device is called to enable hardware acceleration of encryption and
1308 * decryption. The callback takes a @sta parameter that will be NULL
1309 * for default keys or keys used for transmission only, or point to
1310 * the station information for the peer for individual keys.
1311 * Multiple transmission keys with the same key index may be used when
1312 * VLANs are configured for an access point.
1314 * When transmitting, the TX control data will use the @hw_key_idx
1315 * selected by the driver by modifying the &struct ieee80211_key_conf
1316 * pointed to by the @key parameter to the set_key() function.
1318 * The set_key() call for the %SET_KEY command should return 0 if
1319 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1320 * added; if you return 0 then hw_key_idx must be assigned to the
1321 * hardware key index, you are free to use the full u8 range.
1323 * When the cmd is %DISABLE_KEY then it must succeed.
1325 * Note that it is permissible to not decrypt a frame even if a key
1326 * for it has been uploaded to hardware, the stack will not make any
1327 * decision based on whether a key has been uploaded or not but rather
1328 * based on the receive flags.
1330 * The &struct ieee80211_key_conf structure pointed to by the @key
1331 * parameter is guaranteed to be valid until another call to set_key()
1332 * removes it, but it can only be used as a cookie to differentiate
1335 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1336 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1338 * The update_tkip_key() call updates the driver with the new phase 1 key.
1339 * This happens every time the iv16 wraps around (every 65536 packets). The
1340 * set_key() call will happen only once for each key (unless the AP did
1341 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1342 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1343 * handler is software decryption with wrap around of iv16.
1347 * DOC: Powersave support
1349 * mac80211 has support for various powersave implementations.
1351 * First, it can support hardware that handles all powersaving by itself,
1352 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1353 * flag. In that case, it will be told about the desired powersave mode
1354 * with the %IEEE80211_CONF_PS flag depending on the association status.
1355 * The hardware must take care of sending nullfunc frames when necessary,
1356 * i.e. when entering and leaving powersave mode. The hardware is required
1357 * to look at the AID in beacons and signal to the AP that it woke up when
1358 * it finds traffic directed to it.
1360 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1361 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1362 * with hardware wakeup and sleep states. Driver is responsible for waking
1363 * up the hardware before issuing commands to the hardware and putting it
1364 * back to sleep at appropriate times.
1366 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1367 * buffered multicast/broadcast frames after the beacon. Also it must be
1368 * possible to send frames and receive the acknowledment frame.
1370 * Other hardware designs cannot send nullfunc frames by themselves and also
1371 * need software support for parsing the TIM bitmap. This is also supported
1372 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1373 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1374 * required to pass up beacons. The hardware is still required to handle
1375 * waking up for multicast traffic; if it cannot the driver must handle that
1376 * as best as it can, mac80211 is too slow to do that.
1378 * Dynamic powersave is an extension to normal powersave in which the
1379 * hardware stays awake for a user-specified period of time after sending a
1380 * frame so that reply frames need not be buffered and therefore delayed to
1381 * the next wakeup. It's compromise of getting good enough latency when
1382 * there's data traffic and still saving significantly power in idle
1385 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1386 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1387 * flag and mac80211 will handle everything automatically. Additionally,
1388 * hardware having support for the dynamic PS feature may set the
1389 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1390 * dynamic PS mode itself. The driver needs to look at the
1391 * @dynamic_ps_timeout hardware configuration value and use it that value
1392 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1393 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1394 * enabled whenever user has enabled powersave.
1396 * Some hardware need to toggle a single shared antenna between WLAN and
1397 * Bluetooth to facilitate co-existence. These types of hardware set
1398 * limitations on the use of host controlled dynamic powersave whenever there
1399 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1400 * driver may request temporarily going into full power save, in order to
1401 * enable toggling the antenna between BT and WLAN. If the driver requests
1402 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1403 * temporarily set to zero until the driver re-enables dynamic powersave.
1405 * Driver informs U-APSD client support by enabling
1406 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1407 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1408 * Nullfunc frames and stay awake until the service period has ended. To
1409 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1410 * from that AC are transmitted with powersave enabled.
1412 * Note: U-APSD client mode is not yet supported with
1413 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1417 * DOC: Beacon filter support
1419 * Some hardware have beacon filter support to reduce host cpu wakeups
1420 * which will reduce system power consumption. It usuallly works so that
1421 * the firmware creates a checksum of the beacon but omits all constantly
1422 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1423 * beacon is forwarded to the host, otherwise it will be just dropped. That
1424 * way the host will only receive beacons where some relevant information
1425 * (for example ERP protection or WMM settings) have changed.
1427 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1428 * hardware capability. The driver needs to enable beacon filter support
1429 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1430 * power save is enabled, the stack will not check for beacon loss and the
1431 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1433 * The time (or number of beacons missed) until the firmware notifies the
1434 * driver of a beacon loss event (which in turn causes the driver to call
1435 * ieee80211_beacon_loss()) should be configurable and will be controlled
1436 * by mac80211 and the roaming algorithm in the future.
1438 * Since there may be constantly changing information elements that nothing
1439 * in the software stack cares about, we will, in the future, have mac80211
1440 * tell the driver which information elements are interesting in the sense
1441 * that we want to see changes in them. This will include
1442 * - a list of information element IDs
1443 * - a list of OUIs for the vendor information element
1445 * Ideally, the hardware would filter out any beacons without changes in the
1446 * requested elements, but if it cannot support that it may, at the expense
1447 * of some efficiency, filter out only a subset. For example, if the device
1448 * doesn't support checking for OUIs it should pass up all changes in all
1449 * vendor information elements.
1451 * Note that change, for the sake of simplification, also includes information
1452 * elements appearing or disappearing from the beacon.
1454 * Some hardware supports an "ignore list" instead, just make sure nothing
1455 * that was requested is on the ignore list, and include commonly changing
1456 * information element IDs in the ignore list, for example 11 (BSS load) and
1457 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1458 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1459 * it could also include some currently unused IDs.
1462 * In addition to these capabilities, hardware should support notifying the
1463 * host of changes in the beacon RSSI. This is relevant to implement roaming
1464 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1465 * the received data packets). This can consist in notifying the host when
1466 * the RSSI changes significantly or when it drops below or rises above
1467 * configurable thresholds. In the future these thresholds will also be
1468 * configured by mac80211 (which gets them from userspace) to implement
1469 * them as the roaming algorithm requires.
1471 * If the hardware cannot implement this, the driver should ask it to
1472 * periodically pass beacon frames to the host so that software can do the
1473 * signal strength threshold checking.
1477 * DOC: Spatial multiplexing power save
1479 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1480 * power in an 802.11n implementation. For details on the mechanism
1481 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1482 * "11.2.3 SM power save".
1484 * The mac80211 implementation is capable of sending action frames
1485 * to update the AP about the station's SMPS mode, and will instruct
1486 * the driver to enter the specific mode. It will also announce the
1487 * requested SMPS mode during the association handshake. Hardware
1488 * support for this feature is required, and can be indicated by
1491 * The default mode will be "automatic", which nl80211/cfg80211
1492 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1493 * turned off otherwise.
1495 * To support this feature, the driver must set the appropriate
1496 * hardware support flags, and handle the SMPS flag to the config()
1497 * operation. It will then with this mechanism be instructed to
1498 * enter the requested SMPS mode while associated to an HT AP.
1502 * DOC: Frame filtering
1504 * mac80211 requires to see many management frames for proper
1505 * operation, and users may want to see many more frames when
1506 * in monitor mode. However, for best CPU usage and power consumption,
1507 * having as few frames as possible percolate through the stack is
1508 * desirable. Hence, the hardware should filter as much as possible.
1510 * To achieve this, mac80211 uses filter flags (see below) to tell
1511 * the driver's configure_filter() function which frames should be
1512 * passed to mac80211 and which should be filtered out.
1514 * Before configure_filter() is invoked, the prepare_multicast()
1515 * callback is invoked with the parameters @mc_count and @mc_list
1516 * for the combined multicast address list of all virtual interfaces.
1517 * It's use is optional, and it returns a u64 that is passed to
1518 * configure_filter(). Additionally, configure_filter() has the
1519 * arguments @changed_flags telling which flags were changed and
1520 * @total_flags with the new flag states.
1522 * If your device has no multicast address filters your driver will
1523 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1524 * parameter to see whether multicast frames should be accepted
1527 * All unsupported flags in @total_flags must be cleared.
1528 * Hardware does not support a flag if it is incapable of _passing_
1529 * the frame to the stack. Otherwise the driver must ignore
1530 * the flag, but not clear it.
1531 * You must _only_ clear the flag (announce no support for the
1532 * flag to mac80211) if you are not able to pass the packet type
1533 * to the stack (so the hardware always filters it).
1534 * So for example, you should clear @FIF_CONTROL, if your hardware
1535 * always filters control frames. If your hardware always passes
1536 * control frames to the kernel and is incapable of filtering them,
1537 * you do _not_ clear the @FIF_CONTROL flag.
1538 * This rule applies to all other FIF flags as well.
1542 * enum ieee80211_filter_flags - hardware filter flags
1544 * These flags determine what the filter in hardware should be
1545 * programmed to let through and what should not be passed to the
1546 * stack. It is always safe to pass more frames than requested,
1547 * but this has negative impact on power consumption.
1549 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1550 * think of the BSS as your network segment and then this corresponds
1551 * to the regular ethernet device promiscuous mode.
1553 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1554 * by the user or if the hardware is not capable of filtering by
1555 * multicast address.
1557 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1558 * %RX_FLAG_FAILED_FCS_CRC for them)
1560 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1561 * the %RX_FLAG_FAILED_PLCP_CRC for them
1563 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1564 * to the hardware that it should not filter beacons or probe responses
1565 * by BSSID. Filtering them can greatly reduce the amount of processing
1566 * mac80211 needs to do and the amount of CPU wakeups, so you should
1567 * honour this flag if possible.
1569 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1570 * is not set then only those addressed to this station.
1572 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1574 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1575 * those addressed to this station.
1577 * @FIF_PROBE_REQ: pass probe request frames
1579 enum ieee80211_filter_flags {
1580 FIF_PROMISC_IN_BSS = 1<<0,
1581 FIF_ALLMULTI = 1<<1,
1583 FIF_PLCPFAIL = 1<<3,
1584 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1586 FIF_OTHER_BSS = 1<<6,
1588 FIF_PROBE_REQ = 1<<8,
1592 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1594 * These flags are used with the ampdu_action() callback in
1595 * &struct ieee80211_ops to indicate which action is needed.
1597 * Note that drivers MUST be able to deal with a TX aggregation
1598 * session being stopped even before they OK'ed starting it by
1599 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1600 * might receive the addBA frame and send a delBA right away!
1602 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1603 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1604 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1605 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1606 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1608 enum ieee80211_ampdu_mlme_action {
1609 IEEE80211_AMPDU_RX_START,
1610 IEEE80211_AMPDU_RX_STOP,
1611 IEEE80211_AMPDU_TX_START,
1612 IEEE80211_AMPDU_TX_STOP,
1613 IEEE80211_AMPDU_TX_OPERATIONAL,
1617 * enum ieee80211_tx_sync_type - TX sync type
1618 * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1619 * (and possibly also before direct probe)
1620 * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1621 * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1622 * (not implemented yet)
1624 enum ieee80211_tx_sync_type {
1625 IEEE80211_TX_SYNC_AUTH,
1626 IEEE80211_TX_SYNC_ASSOC,
1627 IEEE80211_TX_SYNC_ACTION,
1631 * enum ieee80211_frame_release_type - frame release reason
1632 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1633 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1634 * frame received on trigger-enabled AC
1636 enum ieee80211_frame_release_type {
1637 IEEE80211_FRAME_RELEASE_PSPOLL,
1638 IEEE80211_FRAME_RELEASE_UAPSD,
1642 * struct ieee80211_ops - callbacks from mac80211 to the driver
1644 * This structure contains various callbacks that the driver may
1645 * handle or, in some cases, must handle, for example to configure
1646 * the hardware to a new channel or to transmit a frame.
1648 * @tx: Handler that 802.11 module calls for each transmitted frame.
1649 * skb contains the buffer starting from the IEEE 802.11 header.
1650 * The low-level driver should send the frame out based on
1651 * configuration in the TX control data. This handler should,
1652 * preferably, never fail and stop queues appropriately, more
1653 * importantly, however, it must never fail for A-MPDU-queues.
1654 * This function should return NETDEV_TX_OK except in very
1656 * Must be implemented and atomic.
1658 * @start: Called before the first netdevice attached to the hardware
1659 * is enabled. This should turn on the hardware and must turn on
1660 * frame reception (for possibly enabled monitor interfaces.)
1661 * Returns negative error codes, these may be seen in userspace,
1663 * When the device is started it should not have a MAC address
1664 * to avoid acknowledging frames before a non-monitor device
1666 * Must be implemented and can sleep.
1668 * @stop: Called after last netdevice attached to the hardware
1669 * is disabled. This should turn off the hardware (at least
1670 * it must turn off frame reception.)
1671 * May be called right after add_interface if that rejects
1672 * an interface. If you added any work onto the mac80211 workqueue
1673 * you should ensure to cancel it on this callback.
1674 * Must be implemented and can sleep.
1676 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1677 * stop transmitting and doing any other configuration, and then
1678 * ask the device to suspend. This is only invoked when WoWLAN is
1679 * configured, otherwise the device is deconfigured completely and
1680 * reconfigured at resume time.
1681 * The driver may also impose special conditions under which it
1682 * wants to use the "normal" suspend (deconfigure), say if it only
1683 * supports WoWLAN when the device is associated. In this case, it
1684 * must return 1 from this function.
1686 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1687 * now resuming its operation, after this the device must be fully
1688 * functional again. If this returns an error, the only way out is
1689 * to also unregister the device. If it returns 1, then mac80211
1690 * will also go through the regular complete restart on resume.
1692 * @add_interface: Called when a netdevice attached to the hardware is
1693 * enabled. Because it is not called for monitor mode devices, @start
1694 * and @stop must be implemented.
1695 * The driver should perform any initialization it needs before
1696 * the device can be enabled. The initial configuration for the
1697 * interface is given in the conf parameter.
1698 * The callback may refuse to add an interface by returning a
1699 * negative error code (which will be seen in userspace.)
1700 * Must be implemented and can sleep.
1702 * @change_interface: Called when a netdevice changes type. This callback
1703 * is optional, but only if it is supported can interface types be
1704 * switched while the interface is UP. The callback may sleep.
1705 * Note that while an interface is being switched, it will not be
1706 * found by the interface iteration callbacks.
1708 * @remove_interface: Notifies a driver that an interface is going down.
1709 * The @stop callback is called after this if it is the last interface
1710 * and no monitor interfaces are present.
1711 * When all interfaces are removed, the MAC address in the hardware
1712 * must be cleared so the device no longer acknowledges packets,
1713 * the mac_addr member of the conf structure is, however, set to the
1714 * MAC address of the device going away.
1715 * Hence, this callback must be implemented. It can sleep.
1717 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1718 * function to change hardware configuration, e.g., channel.
1719 * This function should never fail but returns a negative error code
1720 * if it does. The callback can sleep.
1722 * @bss_info_changed: Handler for configuration requests related to BSS
1723 * parameters that may vary during BSS's lifespan, and may affect low
1724 * level driver (e.g. assoc/disassoc status, erp parameters).
1725 * This function should not be used if no BSS has been set, unless
1726 * for association indication. The @changed parameter indicates which
1727 * of the bss parameters has changed when a call is made. The callback
1730 * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1731 * driver should sync with the GO's powersaving so the device doesn't
1732 * transmit the frame while the GO is asleep. In the regular AP case
1733 * it may be used by drivers for devices implementing other restrictions
1734 * on talking to APs, e.g. due to regulatory enforcement or just HW
1736 * This function is called for every authentication, association and
1737 * action frame separately since applications might attempt to auth
1738 * with multiple APs before chosing one to associate to. If it returns
1739 * an error, the corresponding authentication, association or frame
1740 * transmission is aborted and reported as having failed. It is always
1741 * called after tuning to the correct channel.
1742 * The callback might be called multiple times before @finish_tx_sync
1743 * (but @finish_tx_sync will be called once for each) but in practice
1744 * this is unlikely to happen. It can also refuse in that case if the
1745 * driver cannot handle that situation.
1746 * This callback can sleep.
1747 * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1748 * an error. This callback can sleep.
1750 * @prepare_multicast: Prepare for multicast filter configuration.
1751 * This callback is optional, and its return value is passed
1752 * to configure_filter(). This callback must be atomic.
1754 * @configure_filter: Configure the device's RX filter.
1755 * See the section "Frame filtering" for more information.
1756 * This callback must be implemented and can sleep.
1758 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1759 * must be set or cleared for a given STA. Must be atomic.
1761 * @set_key: See the section "Hardware crypto acceleration"
1762 * This callback is only called between add_interface and
1763 * remove_interface calls, i.e. while the given virtual interface
1765 * Returns a negative error code if the key can't be added.
1766 * The callback can sleep.
1768 * @update_tkip_key: See the section "Hardware crypto acceleration"
1769 * This callback will be called in the context of Rx. Called for drivers
1770 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1771 * The callback must be atomic.
1773 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1774 * host is suspended, it can assign this callback to retrieve the data
1775 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1776 * After rekeying was done it should (for example during resume) notify
1777 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1779 * @hw_scan: Ask the hardware to service the scan request, no need to start
1780 * the scan state machine in stack. The scan must honour the channel
1781 * configuration done by the regulatory agent in the wiphy's
1782 * registered bands. The hardware (or the driver) needs to make sure
1783 * that power save is disabled.
1784 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1785 * entire IEs after the SSID, so that drivers need not look at these
1786 * at all but just send them after the SSID -- mac80211 includes the
1787 * (extended) supported rates and HT information (where applicable).
1788 * When the scan finishes, ieee80211_scan_completed() must be called;
1789 * note that it also must be called when the scan cannot finish due to
1790 * any error unless this callback returned a negative error code.
1791 * The callback can sleep.
1793 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1794 * The driver should ask the hardware to cancel the scan (if possible),
1795 * but the scan will be completed only after the driver will call
1796 * ieee80211_scan_completed().
1797 * This callback is needed for wowlan, to prevent enqueueing a new
1798 * scan_work after the low-level driver was already suspended.
1799 * The callback can sleep.
1801 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1802 * specific intervals. The driver must call the
1803 * ieee80211_sched_scan_results() function whenever it finds results.
1804 * This process will continue until sched_scan_stop is called.
1806 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1808 * @sw_scan_start: Notifier function that is called just before a software scan
1809 * is started. Can be NULL, if the driver doesn't need this notification.
1810 * The callback can sleep.
1812 * @sw_scan_complete: Notifier function that is called just after a
1813 * software scan finished. Can be NULL, if the driver doesn't need
1814 * this notification.
1815 * The callback can sleep.
1817 * @get_stats: Return low-level statistics.
1818 * Returns zero if statistics are available.
1819 * The callback can sleep.
1821 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1822 * callback should be provided to read the TKIP transmit IVs (both IV32
1823 * and IV16) for the given key from hardware.
1824 * The callback must be atomic.
1826 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1827 * if the device does fragmentation by itself; if this callback is
1828 * implemented then the stack will not do fragmentation.
1829 * The callback can sleep.
1831 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1832 * The callback can sleep.
1834 * @sta_add: Notifies low level driver about addition of an associated station,
1835 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1837 * @sta_remove: Notifies low level driver about removal of an associated
1838 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1840 * @sta_notify: Notifies low level driver about power state transition of an
1841 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1842 * in AP mode, this callback will not be called when the flag
1843 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1845 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1846 * bursting) for a hardware TX queue.
1847 * Returns a negative error code on failure.
1848 * The callback can sleep.
1850 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1851 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1852 * required function.
1853 * The callback can sleep.
1855 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1856 * Currently, this is only used for IBSS mode debugging. Is not a
1857 * required function.
1858 * The callback can sleep.
1860 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1861 * with other STAs in the IBSS. This is only used in IBSS mode. This
1862 * function is optional if the firmware/hardware takes full care of
1863 * TSF synchronization.
1864 * The callback can sleep.
1866 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1867 * This is needed only for IBSS mode and the result of this function is
1868 * used to determine whether to reply to Probe Requests.
1869 * Returns non-zero if this device sent the last beacon.
1870 * The callback can sleep.
1872 * @ampdu_action: Perform a certain A-MPDU action
1873 * The RA/TID combination determines the destination and TID we want
1874 * the ampdu action to be performed for. The action is defined through
1875 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1876 * is the first frame we expect to perform the action on. Notice
1877 * that TX/RX_STOP can pass NULL for this parameter.
1878 * The @buf_size parameter is only valid when the action is set to
1879 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1880 * buffer size (number of subframes) for this session -- the driver
1881 * may neither send aggregates containing more subframes than this
1882 * nor send aggregates in a way that lost frames would exceed the
1883 * buffer size. If just limiting the aggregate size, this would be
1884 * possible with a buf_size of 8:
1886 * - RX: 2....7 (lost frame #1)
1888 * which is invalid since #1 was now re-transmitted well past the
1889 * buffer size of 8. Correct ways to retransmit #1 would be:
1890 * - TX: 1 or 18 or 81
1891 * Even "189" would be wrong since 1 could be lost again.
1893 * Returns a negative error code on failure.
1894 * The callback can sleep.
1896 * @get_survey: Return per-channel survey information
1898 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1899 * need to set wiphy->rfkill_poll to %true before registration,
1900 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1901 * The callback can sleep.
1903 * @set_coverage_class: Set slot time for given coverage class as specified
1904 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1905 * accordingly. This callback is not required and may sleep.
1907 * @testmode_cmd: Implement a cfg80211 test mode command.
1908 * The callback can sleep.
1909 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
1911 * @flush: Flush all pending frames from the hardware queue, making sure
1912 * that the hardware queues are empty. If the parameter @drop is set
1913 * to %true, pending frames may be dropped. The callback can sleep.
1915 * @channel_switch: Drivers that need (or want) to offload the channel
1916 * switch operation for CSAs received from the AP may implement this
1917 * callback. They must then call ieee80211_chswitch_done() to indicate
1918 * completion of the channel switch.
1920 * @napi_poll: Poll Rx queue for incoming data frames.
1922 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1923 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1924 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1925 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1927 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1929 * @remain_on_channel: Starts an off-channel period on the given channel, must
1930 * call back to ieee80211_ready_on_channel() when on that channel. Note
1931 * that normal channel traffic is not stopped as this is intended for hw
1932 * offload. Frames to transmit on the off-channel channel are transmitted
1933 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1934 * duration (which will always be non-zero) expires, the driver must call
1935 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1936 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1937 * aborted before it expires. This callback may sleep.
1939 * @set_ringparam: Set tx and rx ring sizes.
1941 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1943 * @tx_frames_pending: Check if there is any pending frame in the hardware
1944 * queues before entering power save.
1946 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1947 * when transmitting a frame. Currently only legacy rates are handled.
1948 * The callback can sleep.
1949 * @rssi_callback: Notify driver when the average RSSI goes above/below
1950 * thresholds that were registered previously. The callback can sleep.
1952 * @release_buffered_frames: Release buffered frames according to the given
1953 * parameters. In the case where the driver buffers some frames for
1954 * sleeping stations mac80211 will use this callback to tell the driver
1955 * to release some frames, either for PS-poll or uAPSD.
1956 * Note that if the @more_data paramter is %false the driver must check
1957 * if there are more frames on the given TIDs, and if there are more than
1958 * the frames being released then it must still set the more-data bit in
1959 * the frame. If the @more_data parameter is %true, then of course the
1960 * more-data bit must always be set.
1961 * The @tids parameter tells the driver which TIDs to release frames
1962 * from, for PS-poll it will always have only a single bit set.
1963 * In the case this is used for a PS-poll initiated release, the
1964 * @num_frames parameter will always be 1 so code can be shared. In
1965 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
1966 * on the TX status (and must report TX status) so that the PS-poll
1967 * period is properly ended. This is used to avoid sending multiple
1968 * responses for a retried PS-poll frame.
1969 * In the case this is used for uAPSD, the @num_frames parameter may be
1970 * bigger than one, but the driver may send fewer frames (it must send
1971 * at least one, however). In this case it is also responsible for
1972 * setting the EOSP flag in the QoS header of the frames. Also, when the
1973 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
1974 * on the last frame in the SP.
1975 * This callback must be atomic.
1976 * @allow_buffered_frames: Prepare device to allow the given number of frames
1977 * to go out to the given station. The frames will be sent by mac80211
1978 * via the usual TX path after this call. The TX information for frames
1979 * released will also have the %IEEE80211_TX_CTL_POLL_RESPONSE flag set
1980 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
1981 * frames from multiple TIDs are released and the driver might reorder
1982 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
1983 * on the last frame and clear it on all others and also handle the EOSP
1984 * bit in the QoS header correctly.
1985 * The @tids parameter is a bitmap and tells the driver which TIDs the
1986 * frames will be on; it will at most have two bits set.
1987 * This callback must be atomic.
1989 struct ieee80211_ops {
1990 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1991 int (*start)(struct ieee80211_hw *hw);
1992 void (*stop)(struct ieee80211_hw *hw);
1994 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
1995 int (*resume)(struct ieee80211_hw *hw);
1997 int (*add_interface)(struct ieee80211_hw *hw,
1998 struct ieee80211_vif *vif);
1999 int (*change_interface)(struct ieee80211_hw *hw,
2000 struct ieee80211_vif *vif,
2001 enum nl80211_iftype new_type, bool p2p);
2002 void (*remove_interface)(struct ieee80211_hw *hw,
2003 struct ieee80211_vif *vif);
2004 int (*config)(struct ieee80211_hw *hw, u32 changed);
2005 void (*bss_info_changed)(struct ieee80211_hw *hw,
2006 struct ieee80211_vif *vif,
2007 struct ieee80211_bss_conf *info,
2010 int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2011 const u8 *bssid, enum ieee80211_tx_sync_type type);
2012 void (*finish_tx_sync)(struct ieee80211_hw *hw,
2013 struct ieee80211_vif *vif,
2015 enum ieee80211_tx_sync_type type);
2017 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2018 struct netdev_hw_addr_list *mc_list);
2019 void (*configure_filter)(struct ieee80211_hw *hw,
2020 unsigned int changed_flags,
2021 unsigned int *total_flags,
2023 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2025 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2026 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2027 struct ieee80211_key_conf *key);
2028 void (*update_tkip_key)(struct ieee80211_hw *hw,
2029 struct ieee80211_vif *vif,
2030 struct ieee80211_key_conf *conf,
2031 struct ieee80211_sta *sta,
2032 u32 iv32, u16 *phase1key);
2033 void (*set_rekey_data)(struct ieee80211_hw *hw,
2034 struct ieee80211_vif *vif,
2035 struct cfg80211_gtk_rekey_data *data);
2036 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2037 struct cfg80211_scan_request *req);
2038 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2039 struct ieee80211_vif *vif);
2040 int (*sched_scan_start)(struct ieee80211_hw *hw,
2041 struct ieee80211_vif *vif,
2042 struct cfg80211_sched_scan_request *req,
2043 struct ieee80211_sched_scan_ies *ies);
2044 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2045 struct ieee80211_vif *vif);
2046 void (*sw_scan_start)(struct ieee80211_hw *hw);
2047 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2048 int (*get_stats)(struct ieee80211_hw *hw,
2049 struct ieee80211_low_level_stats *stats);
2050 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2051 u32 *iv32, u16 *iv16);
2052 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2053 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2054 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2055 struct ieee80211_sta *sta);
2056 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2057 struct ieee80211_sta *sta);
2058 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2059 enum sta_notify_cmd, struct ieee80211_sta *sta);
2060 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
2061 const struct ieee80211_tx_queue_params *params);
2062 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2063 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2065 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2066 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2067 int (*ampdu_action)(struct ieee80211_hw *hw,
2068 struct ieee80211_vif *vif,
2069 enum ieee80211_ampdu_mlme_action action,
2070 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2072 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2073 struct survey_info *survey);
2074 void (*rfkill_poll)(struct ieee80211_hw *hw);
2075 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2076 #ifdef CONFIG_NL80211_TESTMODE
2077 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2078 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2079 struct netlink_callback *cb,
2080 void *data, int len);
2082 void (*flush)(struct ieee80211_hw *hw, bool drop);
2083 void (*channel_switch)(struct ieee80211_hw *hw,
2084 struct ieee80211_channel_switch *ch_switch);
2085 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2086 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2087 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2089 int (*remain_on_channel)(struct ieee80211_hw *hw,
2090 struct ieee80211_channel *chan,
2091 enum nl80211_channel_type channel_type,
2093 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2094 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2095 void (*get_ringparam)(struct ieee80211_hw *hw,
2096 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2097 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2098 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2099 const struct cfg80211_bitrate_mask *mask);
2100 void (*rssi_callback)(struct ieee80211_hw *hw,
2101 enum ieee80211_rssi_event rssi_event);
2103 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2104 struct ieee80211_sta *sta,
2105 u16 tids, int num_frames,
2106 enum ieee80211_frame_release_type reason,
2108 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2109 struct ieee80211_sta *sta,
2110 u16 tids, int num_frames,
2111 enum ieee80211_frame_release_type reason,
2116 * ieee80211_alloc_hw - Allocate a new hardware device
2118 * This must be called once for each hardware device. The returned pointer
2119 * must be used to refer to this device when calling other functions.
2120 * mac80211 allocates a private data area for the driver pointed to by
2121 * @priv in &struct ieee80211_hw, the size of this area is given as
2124 * @priv_data_len: length of private data
2125 * @ops: callbacks for this device
2127 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2128 const struct ieee80211_ops *ops);
2131 * ieee80211_register_hw - Register hardware device
2133 * You must call this function before any other functions in
2134 * mac80211. Note that before a hardware can be registered, you
2135 * need to fill the contained wiphy's information.
2137 * @hw: the device to register as returned by ieee80211_alloc_hw()
2139 int ieee80211_register_hw(struct ieee80211_hw *hw);
2142 * struct ieee80211_tpt_blink - throughput blink description
2143 * @throughput: throughput in Kbit/sec
2144 * @blink_time: blink time in milliseconds
2145 * (full cycle, ie. one off + one on period)
2147 struct ieee80211_tpt_blink {
2153 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2154 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2155 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2156 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2157 * interface is connected in some way, including being an AP
2159 enum ieee80211_tpt_led_trigger_flags {
2160 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2161 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2162 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2165 #ifdef CONFIG_MAC80211_LEDS
2166 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2167 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2168 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2169 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2170 extern char *__ieee80211_create_tpt_led_trigger(
2171 struct ieee80211_hw *hw, unsigned int flags,
2172 const struct ieee80211_tpt_blink *blink_table,
2173 unsigned int blink_table_len);
2176 * ieee80211_get_tx_led_name - get name of TX LED
2178 * mac80211 creates a transmit LED trigger for each wireless hardware
2179 * that can be used to drive LEDs if your driver registers a LED device.
2180 * This function returns the name (or %NULL if not configured for LEDs)
2181 * of the trigger so you can automatically link the LED device.
2183 * @hw: the hardware to get the LED trigger name for
2185 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2187 #ifdef CONFIG_MAC80211_LEDS
2188 return __ieee80211_get_tx_led_name(hw);
2195 * ieee80211_get_rx_led_name - get name of RX LED
2197 * mac80211 creates a receive LED trigger for each wireless hardware
2198 * that can be used to drive LEDs if your driver registers a LED device.
2199 * This function returns the name (or %NULL if not configured for LEDs)
2200 * of the trigger so you can automatically link the LED device.
2202 * @hw: the hardware to get the LED trigger name for
2204 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2206 #ifdef CONFIG_MAC80211_LEDS
2207 return __ieee80211_get_rx_led_name(hw);
2214 * ieee80211_get_assoc_led_name - get name of association LED
2216 * mac80211 creates a association LED trigger for each wireless hardware
2217 * that can be used to drive LEDs if your driver registers a LED device.
2218 * This function returns the name (or %NULL if not configured for LEDs)
2219 * of the trigger so you can automatically link the LED device.
2221 * @hw: the hardware to get the LED trigger name for
2223 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2225 #ifdef CONFIG_MAC80211_LEDS
2226 return __ieee80211_get_assoc_led_name(hw);
2233 * ieee80211_get_radio_led_name - get name of radio LED
2235 * mac80211 creates a radio change LED trigger for each wireless hardware
2236 * that can be used to drive LEDs if your driver registers a LED device.
2237 * This function returns the name (or %NULL if not configured for LEDs)
2238 * of the trigger so you can automatically link the LED device.
2240 * @hw: the hardware to get the LED trigger name for
2242 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2244 #ifdef CONFIG_MAC80211_LEDS
2245 return __ieee80211_get_radio_led_name(hw);
2252 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2253 * @hw: the hardware to create the trigger for
2254 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2255 * @blink_table: the blink table -- needs to be ordered by throughput
2256 * @blink_table_len: size of the blink table
2258 * This function returns %NULL (in case of error, or if no LED
2259 * triggers are configured) or the name of the new trigger.
2260 * This function must be called before ieee80211_register_hw().
2262 static inline char *
2263 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2264 const struct ieee80211_tpt_blink *blink_table,
2265 unsigned int blink_table_len)
2267 #ifdef CONFIG_MAC80211_LEDS
2268 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2276 * ieee80211_unregister_hw - Unregister a hardware device
2278 * This function instructs mac80211 to free allocated resources
2279 * and unregister netdevices from the networking subsystem.
2281 * @hw: the hardware to unregister
2283 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2286 * ieee80211_free_hw - free hardware descriptor
2288 * This function frees everything that was allocated, including the
2289 * private data for the driver. You must call ieee80211_unregister_hw()
2290 * before calling this function.
2292 * @hw: the hardware to free
2294 void ieee80211_free_hw(struct ieee80211_hw *hw);
2297 * ieee80211_restart_hw - restart hardware completely
2299 * Call this function when the hardware was restarted for some reason
2300 * (hardware error, ...) and the driver is unable to restore its state
2301 * by itself. mac80211 assumes that at this point the driver/hardware
2302 * is completely uninitialised and stopped, it starts the process by
2303 * calling the ->start() operation. The driver will need to reset all
2304 * internal state that it has prior to calling this function.
2306 * @hw: the hardware to restart
2308 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2310 /** ieee80211_napi_schedule - schedule NAPI poll
2312 * Use this function to schedule NAPI polling on a device.
2314 * @hw: the hardware to start polling
2316 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2318 /** ieee80211_napi_complete - complete NAPI polling
2320 * Use this function to finish NAPI polling on a device.
2322 * @hw: the hardware to stop polling
2324 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2327 * ieee80211_rx - receive frame
2329 * Use this function to hand received frames to mac80211. The receive
2330 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2331 * paged @skb is used, the driver is recommended to put the ieee80211
2332 * header of the frame on the linear part of the @skb to avoid memory
2333 * allocation and/or memcpy by the stack.
2335 * This function may not be called in IRQ context. Calls to this function
2336 * for a single hardware must be synchronized against each other. Calls to
2337 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2338 * mixed for a single hardware.
2340 * In process context use instead ieee80211_rx_ni().
2342 * @hw: the hardware this frame came in on
2343 * @skb: the buffer to receive, owned by mac80211 after this call
2345 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2348 * ieee80211_rx_irqsafe - receive frame
2350 * Like ieee80211_rx() but can be called in IRQ context
2351 * (internally defers to a tasklet.)
2353 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2354 * be mixed for a single hardware.
2356 * @hw: the hardware this frame came in on
2357 * @skb: the buffer to receive, owned by mac80211 after this call
2359 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2362 * ieee80211_rx_ni - receive frame (in process context)
2364 * Like ieee80211_rx() but can be called in process context
2365 * (internally disables bottom halves).
2367 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2368 * not be mixed for a single hardware.
2370 * @hw: the hardware this frame came in on
2371 * @skb: the buffer to receive, owned by mac80211 after this call
2373 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2374 struct sk_buff *skb)
2377 ieee80211_rx(hw, skb);
2382 * ieee80211_sta_ps_transition - PS transition for connected sta
2384 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2385 * flag set, use this function to inform mac80211 about a connected station
2386 * entering/leaving PS mode.
2388 * This function may not be called in IRQ context or with softirqs enabled.
2390 * Calls to this function for a single hardware must be synchronized against
2393 * The function returns -EINVAL when the requested PS mode is already set.
2395 * @sta: currently connected sta
2396 * @start: start or stop PS
2398 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2401 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2402 * (in process context)
2404 * Like ieee80211_sta_ps_transition() but can be called in process context
2405 * (internally disables bottom halves). Concurrent call restriction still
2408 * @sta: currently connected sta
2409 * @start: start or stop PS
2411 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2417 ret = ieee80211_sta_ps_transition(sta, start);
2424 * The TX headroom reserved by mac80211 for its own tx_status functions.
2425 * This is enough for the radiotap header.
2427 #define IEEE80211_TX_STATUS_HEADROOM 13
2430 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2431 * @sta: &struct ieee80211_sta pointer for the sleeping station
2432 * @tid: the TID that has buffered frames
2433 * @buffered: indicates whether or not frames are buffered for this TID
2435 * If a driver buffers frames for a powersave station instead of passing
2436 * them back to mac80211 for retransmission, the station may still need
2437 * to be told that there are buffered frames via the TIM bit.
2439 * This function informs mac80211 whether or not there are frames that are
2440 * buffered in the driver for a given TID; mac80211 can then use this data
2441 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2442 * call! Beware of the locking!)
2444 * If all frames are released to the station (due to PS-poll or uAPSD)
2445 * then the driver needs to inform mac80211 that there no longer are
2446 * frames buffered. However, when the station wakes up mac80211 assumes
2447 * that all buffered frames will be transmitted and clears this data,
2448 * drivers need to make sure they inform mac80211 about all buffered
2449 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2451 * Note that technically mac80211 only needs to know this per AC, not per
2452 * TID, but since driver buffering will inevitably happen per TID (since
2453 * it is related to aggregation) it is easier to make mac80211 map the
2454 * TID to the AC as required instead of keeping track in all drivers that
2457 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2458 u8 tid, bool buffered);
2461 * ieee80211_tx_status - transmit status callback
2463 * Call this function for all transmitted frames after they have been
2464 * transmitted. It is permissible to not call this function for
2465 * multicast frames but this can affect statistics.
2467 * This function may not be called in IRQ context. Calls to this function
2468 * for a single hardware must be synchronized against each other. Calls
2469 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2470 * may not be mixed for a single hardware.
2472 * @hw: the hardware the frame was transmitted by
2473 * @skb: the frame that was transmitted, owned by mac80211 after this call
2475 void ieee80211_tx_status(struct ieee80211_hw *hw,
2476 struct sk_buff *skb);
2479 * ieee80211_tx_status_ni - transmit status callback (in process context)
2481 * Like ieee80211_tx_status() but can be called in process context.
2483 * Calls to this function, ieee80211_tx_status() and
2484 * ieee80211_tx_status_irqsafe() may not be mixed
2485 * for a single hardware.
2487 * @hw: the hardware the frame was transmitted by
2488 * @skb: the frame that was transmitted, owned by mac80211 after this call
2490 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2491 struct sk_buff *skb)
2494 ieee80211_tx_status(hw, skb);
2499 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2501 * Like ieee80211_tx_status() but can be called in IRQ context
2502 * (internally defers to a tasklet.)
2504 * Calls to this function, ieee80211_tx_status() and
2505 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2507 * @hw: the hardware the frame was transmitted by
2508 * @skb: the frame that was transmitted, owned by mac80211 after this call
2510 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2511 struct sk_buff *skb);
2514 * ieee80211_report_low_ack - report non-responding station
2516 * When operating in AP-mode, call this function to report a non-responding
2519 * @sta: the non-responding connected sta
2520 * @num_packets: number of packets sent to @sta without a response
2522 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2525 * ieee80211_beacon_get_tim - beacon generation function
2526 * @hw: pointer obtained from ieee80211_alloc_hw().
2527 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2528 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2529 * Set to 0 if invalid (in non-AP modes).
2530 * @tim_length: pointer to variable that will receive the TIM IE length,
2531 * (including the ID and length bytes!).
2532 * Set to 0 if invalid (in non-AP modes).
2534 * If the driver implements beaconing modes, it must use this function to
2535 * obtain the beacon frame/template.
2537 * If the beacon frames are generated by the host system (i.e., not in
2538 * hardware/firmware), the driver uses this function to get each beacon
2539 * frame from mac80211 -- it is responsible for calling this function
2540 * before the beacon is needed (e.g. based on hardware interrupt).
2542 * If the beacon frames are generated by the device, then the driver
2543 * must use the returned beacon as the template and change the TIM IE
2544 * according to the current DTIM parameters/TIM bitmap.
2546 * The driver is responsible for freeing the returned skb.
2548 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2549 struct ieee80211_vif *vif,
2550 u16 *tim_offset, u16 *tim_length);
2553 * ieee80211_beacon_get - beacon generation function
2554 * @hw: pointer obtained from ieee80211_alloc_hw().
2555 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2557 * See ieee80211_beacon_get_tim().
2559 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2560 struct ieee80211_vif *vif)
2562 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2566 * ieee80211_pspoll_get - retrieve a PS Poll template
2567 * @hw: pointer obtained from ieee80211_alloc_hw().
2568 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2570 * Creates a PS Poll a template which can, for example, uploaded to
2571 * hardware. The template must be updated after association so that correct
2572 * AID, BSSID and MAC address is used.
2574 * Note: Caller (or hardware) is responsible for setting the
2575 * &IEEE80211_FCTL_PM bit.
2577 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2578 struct ieee80211_vif *vif);
2581 * ieee80211_nullfunc_get - retrieve a nullfunc template
2582 * @hw: pointer obtained from ieee80211_alloc_hw().
2583 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2585 * Creates a Nullfunc template which can, for example, uploaded to
2586 * hardware. The template must be updated after association so that correct
2587 * BSSID and address is used.
2589 * Note: Caller (or hardware) is responsible for setting the
2590 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2592 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2593 struct ieee80211_vif *vif);
2596 * ieee80211_probereq_get - retrieve a Probe Request template
2597 * @hw: pointer obtained from ieee80211_alloc_hw().
2598 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2599 * @ssid: SSID buffer
2600 * @ssid_len: length of SSID
2601 * @ie: buffer containing all IEs except SSID for the template
2602 * @ie_len: length of the IE buffer
2604 * Creates a Probe Request template which can, for example, be uploaded to
2607 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2608 struct ieee80211_vif *vif,
2609 const u8 *ssid, size_t ssid_len,
2610 const u8 *ie, size_t ie_len);
2613 * ieee80211_rts_get - RTS frame generation function
2614 * @hw: pointer obtained from ieee80211_alloc_hw().
2615 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2616 * @frame: pointer to the frame that is going to be protected by the RTS.
2617 * @frame_len: the frame length (in octets).
2618 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2619 * @rts: The buffer where to store the RTS frame.
2621 * If the RTS frames are generated by the host system (i.e., not in
2622 * hardware/firmware), the low-level driver uses this function to receive
2623 * the next RTS frame from the 802.11 code. The low-level is responsible
2624 * for calling this function before and RTS frame is needed.
2626 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2627 const void *frame, size_t frame_len,
2628 const struct ieee80211_tx_info *frame_txctl,
2629 struct ieee80211_rts *rts);
2632 * ieee80211_rts_duration - Get the duration field for an RTS frame
2633 * @hw: pointer obtained from ieee80211_alloc_hw().
2634 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2635 * @frame_len: the length of the frame that is going to be protected by the RTS.
2636 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2638 * If the RTS is generated in firmware, but the host system must provide
2639 * the duration field, the low-level driver uses this function to receive
2640 * the duration field value in little-endian byteorder.
2642 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2643 struct ieee80211_vif *vif, size_t frame_len,
2644 const struct ieee80211_tx_info *frame_txctl);
2647 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2648 * @hw: pointer obtained from ieee80211_alloc_hw().
2649 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2650 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2651 * @frame_len: the frame length (in octets).
2652 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2653 * @cts: The buffer where to store the CTS-to-self frame.
2655 * If the CTS-to-self frames are generated by the host system (i.e., not in
2656 * hardware/firmware), the low-level driver uses this function to receive
2657 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2658 * for calling this function before and CTS-to-self frame is needed.
2660 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2661 struct ieee80211_vif *vif,
2662 const void *frame, size_t frame_len,
2663 const struct ieee80211_tx_info *frame_txctl,
2664 struct ieee80211_cts *cts);
2667 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2668 * @hw: pointer obtained from ieee80211_alloc_hw().
2669 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2670 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2671 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2673 * If the CTS-to-self is generated in firmware, but the host system must provide
2674 * the duration field, the low-level driver uses this function to receive
2675 * the duration field value in little-endian byteorder.
2677 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2678 struct ieee80211_vif *vif,
2680 const struct ieee80211_tx_info *frame_txctl);
2683 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2684 * @hw: pointer obtained from ieee80211_alloc_hw().
2685 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2686 * @frame_len: the length of the frame.
2687 * @rate: the rate at which the frame is going to be transmitted.
2689 * Calculate the duration field of some generic frame, given its
2690 * length and transmission rate (in 100kbps).
2692 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2693 struct ieee80211_vif *vif,
2695 struct ieee80211_rate *rate);
2698 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2699 * @hw: pointer as obtained from ieee80211_alloc_hw().
2700 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2702 * Function for accessing buffered broadcast and multicast frames. If
2703 * hardware/firmware does not implement buffering of broadcast/multicast
2704 * frames when power saving is used, 802.11 code buffers them in the host
2705 * memory. The low-level driver uses this function to fetch next buffered
2706 * frame. In most cases, this is used when generating beacon frame. This
2707 * function returns a pointer to the next buffered skb or NULL if no more
2708 * buffered frames are available.
2710 * Note: buffered frames are returned only after DTIM beacon frame was
2711 * generated with ieee80211_beacon_get() and the low-level driver must thus
2712 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2713 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2714 * does not need to check for DTIM beacons separately and should be able to
2715 * use common code for all beacons.
2718 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2721 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2723 * This function returns the TKIP phase 1 key for the given IV32.
2725 * @keyconf: the parameter passed with the set key
2726 * @iv32: IV32 to get the P1K for
2727 * @p1k: a buffer to which the key will be written, as 5 u16 values
2729 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2730 u32 iv32, u16 *p1k);
2733 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2735 * This function returns the TKIP phase 1 key for the IV32 taken
2736 * from the given packet.
2738 * @keyconf: the parameter passed with the set key
2739 * @skb: the packet to take the IV32 value from that will be encrypted
2741 * @p1k: a buffer to which the key will be written, as 5 u16 values
2743 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2744 struct sk_buff *skb, u16 *p1k)
2746 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2747 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2748 u32 iv32 = get_unaligned_le32(&data[4]);
2750 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2754 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2756 * This function returns the TKIP phase 1 key for the given IV32
2757 * and transmitter address.
2759 * @keyconf: the parameter passed with the set key
2760 * @ta: TA that will be used with the key
2761 * @iv32: IV32 to get the P1K for
2762 * @p1k: a buffer to which the key will be written, as 5 u16 values
2764 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2765 const u8 *ta, u32 iv32, u16 *p1k);
2768 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2770 * This function computes the TKIP RC4 key for the IV values
2773 * @keyconf: the parameter passed with the set key
2774 * @skb: the packet to take the IV32/IV16 values from that will be
2775 * encrypted with this key
2776 * @p2k: a buffer to which the key will be written, 16 bytes
2778 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2779 struct sk_buff *skb, u8 *p2k);
2782 * struct ieee80211_key_seq - key sequence counter
2784 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2785 * @ccmp: PN data, most significant byte first (big endian,
2786 * reverse order than in packet)
2787 * @aes_cmac: PN data, most significant byte first (big endian,
2788 * reverse order than in packet)
2790 struct ieee80211_key_seq {
2806 * ieee80211_get_key_tx_seq - get key TX sequence counter
2808 * @keyconf: the parameter passed with the set key
2809 * @seq: buffer to receive the sequence data
2811 * This function allows a driver to retrieve the current TX IV/PN
2812 * for the given key. It must not be called if IV generation is
2813 * offloaded to the device.
2815 * Note that this function may only be called when no TX processing
2816 * can be done concurrently, for example when queues are stopped
2817 * and the stop has been synchronized.
2819 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2820 struct ieee80211_key_seq *seq);
2823 * ieee80211_get_key_rx_seq - get key RX sequence counter
2825 * @keyconf: the parameter passed with the set key
2826 * @tid: The TID, or -1 for the management frame value (CCMP only);
2827 * the value on TID 0 is also used for non-QoS frames. For
2828 * CMAC, only TID 0 is valid.
2829 * @seq: buffer to receive the sequence data
2831 * This function allows a driver to retrieve the current RX IV/PNs
2832 * for the given key. It must not be called if IV checking is done
2833 * by the device and not by mac80211.
2835 * Note that this function may only be called when no RX processing
2836 * can be done concurrently.
2838 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2839 int tid, struct ieee80211_key_seq *seq);
2842 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2843 * @vif: virtual interface the rekeying was done on
2844 * @bssid: The BSSID of the AP, for checking association
2845 * @replay_ctr: the new replay counter after GTK rekeying
2846 * @gfp: allocation flags
2848 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2849 const u8 *replay_ctr, gfp_t gfp);
2852 * ieee80211_wake_queue - wake specific queue
2853 * @hw: pointer as obtained from ieee80211_alloc_hw().
2854 * @queue: queue number (counted from zero).
2856 * Drivers should use this function instead of netif_wake_queue.
2858 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2861 * ieee80211_stop_queue - stop specific queue
2862 * @hw: pointer as obtained from ieee80211_alloc_hw().
2863 * @queue: queue number (counted from zero).
2865 * Drivers should use this function instead of netif_stop_queue.
2867 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2870 * ieee80211_queue_stopped - test status of the queue
2871 * @hw: pointer as obtained from ieee80211_alloc_hw().
2872 * @queue: queue number (counted from zero).
2874 * Drivers should use this function instead of netif_stop_queue.
2877 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2880 * ieee80211_stop_queues - stop all queues
2881 * @hw: pointer as obtained from ieee80211_alloc_hw().
2883 * Drivers should use this function instead of netif_stop_queue.
2885 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2888 * ieee80211_wake_queues - wake all queues
2889 * @hw: pointer as obtained from ieee80211_alloc_hw().
2891 * Drivers should use this function instead of netif_wake_queue.
2893 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2896 * ieee80211_scan_completed - completed hardware scan
2898 * When hardware scan offload is used (i.e. the hw_scan() callback is
2899 * assigned) this function needs to be called by the driver to notify
2900 * mac80211 that the scan finished. This function can be called from
2901 * any context, including hardirq context.
2903 * @hw: the hardware that finished the scan
2904 * @aborted: set to true if scan was aborted
2906 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2909 * ieee80211_sched_scan_results - got results from scheduled scan
2911 * When a scheduled scan is running, this function needs to be called by the
2912 * driver whenever there are new scan results available.
2914 * @hw: the hardware that is performing scheduled scans
2916 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
2919 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2921 * When a scheduled scan is running, this function can be called by
2922 * the driver if it needs to stop the scan to perform another task.
2923 * Usual scenarios are drivers that cannot continue the scheduled scan
2924 * while associating, for instance.
2926 * @hw: the hardware that is performing scheduled scans
2928 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
2931 * ieee80211_iterate_active_interfaces - iterate active interfaces
2933 * This function iterates over the interfaces associated with a given
2934 * hardware that are currently active and calls the callback for them.
2935 * This function allows the iterator function to sleep, when the iterator
2936 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2938 * Does not iterate over a new interface during add_interface()
2940 * @hw: the hardware struct of which the interfaces should be iterated over
2941 * @iterator: the iterator function to call
2942 * @data: first argument of the iterator function
2944 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2945 void (*iterator)(void *data, u8 *mac,
2946 struct ieee80211_vif *vif),
2950 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2952 * This function iterates over the interfaces associated with a given
2953 * hardware that are currently active and calls the callback for them.
2954 * This function requires the iterator callback function to be atomic,
2955 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2956 * Does not iterate over a new interface during add_interface()
2958 * @hw: the hardware struct of which the interfaces should be iterated over
2959 * @iterator: the iterator function to call, cannot sleep
2960 * @data: first argument of the iterator function
2962 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2963 void (*iterator)(void *data,
2965 struct ieee80211_vif *vif),
2969 * ieee80211_queue_work - add work onto the mac80211 workqueue
2971 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2972 * This helper ensures drivers are not queueing work when they should not be.
2974 * @hw: the hardware struct for the interface we are adding work for
2975 * @work: the work we want to add onto the mac80211 workqueue
2977 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2980 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2982 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2985 * @hw: the hardware struct for the interface we are adding work for
2986 * @dwork: delayable work to queue onto the mac80211 workqueue
2987 * @delay: number of jiffies to wait before queueing
2989 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2990 struct delayed_work *dwork,
2991 unsigned long delay);
2994 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2995 * @sta: the station for which to start a BA session
2996 * @tid: the TID to BA on.
2997 * @timeout: session timeout value (in TUs)
2999 * Return: success if addBA request was sent, failure otherwise
3001 * Although mac80211/low level driver/user space application can estimate
3002 * the need to start aggregation on a certain RA/TID, the session level
3003 * will be managed by the mac80211.
3005 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3009 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3010 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3011 * @ra: receiver address of the BA session recipient.
3012 * @tid: the TID to BA on.
3014 * This function must be called by low level driver once it has
3015 * finished with preparations for the BA session. It can be called
3018 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3022 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3023 * @sta: the station whose BA session to stop
3024 * @tid: the TID to stop BA.
3026 * Return: negative error if the TID is invalid, or no aggregation active
3028 * Although mac80211/low level driver/user space application can estimate
3029 * the need to stop aggregation on a certain RA/TID, the session level
3030 * will be managed by the mac80211.
3032 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3035 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3036 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3037 * @ra: receiver address of the BA session recipient.
3038 * @tid: the desired TID to BA on.
3040 * This function must be called by low level driver once it has
3041 * finished with preparations for the BA session tear down. It
3042 * can be called from any context.
3044 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3048 * ieee80211_find_sta - find a station
3050 * @vif: virtual interface to look for station on
3051 * @addr: station's address
3053 * This function must be called under RCU lock and the
3054 * resulting pointer is only valid under RCU lock as well.
3056 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3060 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3062 * @hw: pointer as obtained from ieee80211_alloc_hw()
3063 * @addr: remote station's address
3064 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3066 * This function must be called under RCU lock and the
3067 * resulting pointer is only valid under RCU lock as well.
3069 * NOTE: You may pass NULL for localaddr, but then you will just get
3070 * the first STA that matches the remote address 'addr'.
3071 * We can have multiple STA associated with multiple
3072 * logical stations (e.g. consider a station connecting to another
3073 * BSSID on the same AP hardware without disconnecting first).
3074 * In this case, the result of this method with localaddr NULL
3077 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3079 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3081 const u8 *localaddr);
3084 * ieee80211_sta_block_awake - block station from waking up
3086 * @pubsta: the station
3087 * @block: whether to block or unblock
3089 * Some devices require that all frames that are on the queues
3090 * for a specific station that went to sleep are flushed before
3091 * a poll response or frames after the station woke up can be
3092 * delivered to that it. Note that such frames must be rejected
3093 * by the driver as filtered, with the appropriate status flag.
3095 * This function allows implementing this mode in a race-free
3098 * To do this, a driver must keep track of the number of frames
3099 * still enqueued for a specific station. If this number is not
3100 * zero when the station goes to sleep, the driver must call
3101 * this function to force mac80211 to consider the station to
3102 * be asleep regardless of the station's actual state. Once the
3103 * number of outstanding frames reaches zero, the driver must
3104 * call this function again to unblock the station. That will
3105 * cause mac80211 to be able to send ps-poll responses, and if
3106 * the station queried in the meantime then frames will also
3107 * be sent out as a result of this. Additionally, the driver
3108 * will be notified that the station woke up some time after
3109 * it is unblocked, regardless of whether the station actually
3110 * woke up while blocked or not.
3112 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3113 struct ieee80211_sta *pubsta, bool block);
3116 * ieee80211_iter_keys - iterate keys programmed into the device
3117 * @hw: pointer obtained from ieee80211_alloc_hw()
3118 * @vif: virtual interface to iterate, may be %NULL for all
3119 * @iter: iterator function that will be called for each key
3120 * @iter_data: custom data to pass to the iterator function
3122 * This function can be used to iterate all the keys known to
3123 * mac80211, even those that weren't previously programmed into
3124 * the device. This is intended for use in WoWLAN if the device
3125 * needs reprogramming of the keys during suspend. Note that due
3126 * to locking reasons, it is also only safe to call this at few
3127 * spots since it must hold the RTNL and be able to sleep.
3129 * The order in which the keys are iterated matches the order
3130 * in which they were originally installed and handed to the
3133 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3134 struct ieee80211_vif *vif,
3135 void (*iter)(struct ieee80211_hw *hw,
3136 struct ieee80211_vif *vif,
3137 struct ieee80211_sta *sta,
3138 struct ieee80211_key_conf *key,
3143 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3144 * @hw: pointer obtained from ieee80211_alloc_hw().
3145 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3147 * Creates a Probe Request template which can, for example, be uploaded to
3148 * hardware. The template is filled with bssid, ssid and supported rate
3149 * information. This function must only be called from within the
3150 * .bss_info_changed callback function and only in managed mode. The function
3151 * is only useful when the interface is associated, otherwise it will return
3154 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3155 struct ieee80211_vif *vif);
3158 * ieee80211_beacon_loss - inform hardware does not receive beacons
3160 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3162 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
3163 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3164 * hardware is not receiving beacons with this function.
3166 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3169 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3171 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3173 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
3174 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3175 * needs to inform if the connection to the AP has been lost.
3177 * This function will cause immediate change to disassociated state,
3178 * without connection recovery attempts.
3180 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3183 * ieee80211_resume_disconnect - disconnect from AP after resume
3185 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3187 * Instructs mac80211 to disconnect from the AP after resume.
3188 * Drivers can use this after WoWLAN if they know that the
3189 * connection cannot be kept up, for example because keys were
3190 * used while the device was asleep but the replay counters or
3191 * similar cannot be retrieved from the device during resume.
3193 * Note that due to implementation issues, if the driver uses
3194 * the reconfiguration functionality during resume the interface
3195 * will still be added as associated first during resume and then
3196 * disconnect normally later.
3198 * This function can only be called from the resume callback and
3199 * the driver must not be holding any of its own locks while it
3200 * calls this function, or at least not any locks it needs in the
3201 * key configuration paths (if it supports HW crypto).
3203 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3206 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3208 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3210 * Some hardware require full power save to manage simultaneous BT traffic
3211 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3212 * burst of BT traffic. The hardware gets information of BT traffic via
3213 * hardware co-existence lines, and consequentially requests mac80211 to
3214 * (temporarily) enter full psm.
3215 * This function will only temporarily disable dynamic PS, not enable PSM if
3216 * it was not already enabled.
3217 * The driver must make sure to re-enable dynamic PS using
3218 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3221 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3224 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3226 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3228 * This function restores dynamic PS after being temporarily disabled via
3229 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3230 * be coupled with an eventual call to this function.
3233 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3236 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3237 * rssi threshold triggered
3239 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3240 * @rssi_event: the RSSI trigger event type
3241 * @gfp: context flags
3243 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3244 * monitoring is configured with an rssi threshold, the driver will inform
3245 * whenever the rssi level reaches the threshold.
3247 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3248 enum nl80211_cqm_rssi_threshold_event rssi_event,
3252 * ieee80211_get_operstate - get the operstate of the vif
3254 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3256 * The driver might need to know the operstate of the net_device
3257 * (specifically, whether the link is IF_OPER_UP after resume)
3259 unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3262 * ieee80211_chswitch_done - Complete channel switch process
3263 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3264 * @success: make the channel switch successful or not
3266 * Complete the channel switch post-process: set the new operational channel
3267 * and wake up the suspended queues.
3269 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3272 * ieee80211_request_smps - request SM PS transition
3273 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3274 * @smps_mode: new SM PS mode
3276 * This allows the driver to request an SM PS transition in managed
3277 * mode. This is useful when the driver has more information than
3278 * the stack about possible interference, for example by bluetooth.
3280 void ieee80211_request_smps(struct ieee80211_vif *vif,
3281 enum ieee80211_smps_mode smps_mode);
3284 * ieee80211_key_removed - disable hw acceleration for key
3285 * @key_conf: The key hw acceleration should be disabled for
3287 * This allows drivers to indicate that the given key has been
3288 * removed from hardware acceleration, due to a new key that
3289 * was added. Don't use this if the key can continue to be used
3290 * for TX, if the key restriction is on RX only it is permitted
3291 * to keep the key for TX only and not call this function.
3293 * Due to locking constraints, it may only be called during
3294 * @set_key. This function must be allowed to sleep, and the
3295 * key it tries to disable may still be used until it returns.
3297 void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3300 * ieee80211_ready_on_channel - notification of remain-on-channel start
3301 * @hw: pointer as obtained from ieee80211_alloc_hw()
3303 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3306 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3307 * @hw: pointer as obtained from ieee80211_alloc_hw()
3309 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3312 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3314 * in order not to harm the system performance and user experience, the device
3315 * may request not to allow any rx ba session and tear down existing rx ba
3316 * sessions based on system constraints such as periodic BT activity that needs
3317 * to limit wlan activity (eg.sco or a2dp)."
3318 * in such cases, the intention is to limit the duration of the rx ppdu and
3319 * therefore prevent the peer device to use a-mpdu aggregation.
3321 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3322 * @ba_rx_bitmap: Bit map of open rx ba per tid
3323 * @addr: & to bssid mac address
3325 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3329 * ieee80211_send_bar - send a BlockAckReq frame
3331 * can be used to flush pending frames from the peer's aggregation reorder
3334 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3335 * @ra: the peer's destination address
3336 * @tid: the TID of the aggregation session
3337 * @ssn: the new starting sequence number for the receiver
3339 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3341 /* Rate control API */
3344 * enum rate_control_changed - flags to indicate which parameter changed
3346 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3347 * changed, rate control algorithm can update its internal state if needed.
3349 enum rate_control_changed {
3350 IEEE80211_RC_HT_CHANGED = BIT(0)
3354 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3356 * @hw: The hardware the algorithm is invoked for.
3357 * @sband: The band this frame is being transmitted on.
3358 * @bss_conf: the current BSS configuration
3359 * @reported_rate: The rate control algorithm can fill this in to indicate
3360 * which rate should be reported to userspace as the current rate and
3361 * used for rate calculations in the mesh network.
3362 * @rts: whether RTS will be used for this frame because it is longer than the
3364 * @short_preamble: whether mac80211 will request short-preamble transmission
3365 * if the selected rate supports it
3366 * @max_rate_idx: user-requested maximum rate (not MCS for now)
3367 * (deprecated; this will be removed once drivers get updated to use
3369 * @rate_idx_mask: user-requested rate mask (not MCS for now)
3370 * @skb: the skb that will be transmitted, the control information in it needs
3372 * @bss: whether this frame is sent out in AP or IBSS mode
3374 struct ieee80211_tx_rate_control {
3375 struct ieee80211_hw *hw;
3376 struct ieee80211_supported_band *sband;
3377 struct ieee80211_bss_conf *bss_conf;
3378 struct sk_buff *skb;
3379 struct ieee80211_tx_rate reported_rate;
3380 bool rts, short_preamble;
3386 struct rate_control_ops {
3387 struct module *module;
3389 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3390 void (*free)(void *priv);
3392 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3393 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3394 struct ieee80211_sta *sta, void *priv_sta);
3395 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3396 struct ieee80211_sta *sta,
3397 void *priv_sta, u32 changed,
3398 enum nl80211_channel_type oper_chan_type);
3399 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3402 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3403 struct ieee80211_sta *sta, void *priv_sta,
3404 struct sk_buff *skb);
3405 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3406 struct ieee80211_tx_rate_control *txrc);
3408 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3409 struct dentry *dir);
3410 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3413 static inline int rate_supported(struct ieee80211_sta *sta,
3414 enum ieee80211_band band,
3417 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3421 * rate_control_send_low - helper for drivers for management/no-ack frames
3423 * Rate control algorithms that agree to use the lowest rate to
3424 * send management frames and NO_ACK data with the respective hw
3425 * retries should use this in the beginning of their mac80211 get_rate
3426 * callback. If true is returned the rate control can simply return.
3427 * If false is returned we guarantee that sta and sta and priv_sta is
3430 * Rate control algorithms wishing to do more intelligent selection of
3431 * rate for multicast/broadcast frames may choose to not use this.
3433 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3434 * that this may be null.
3435 * @priv_sta: private rate control structure. This may be null.
3436 * @txrc: rate control information we sholud populate for mac80211.
3438 bool rate_control_send_low(struct ieee80211_sta *sta,
3440 struct ieee80211_tx_rate_control *txrc);
3444 rate_lowest_index(struct ieee80211_supported_band *sband,
3445 struct ieee80211_sta *sta)
3449 for (i = 0; i < sband->n_bitrates; i++)
3450 if (rate_supported(sta, sband->band, i))
3453 /* warn when we cannot find a rate. */
3460 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3461 struct ieee80211_sta *sta)
3465 for (i = 0; i < sband->n_bitrates; i++)
3466 if (rate_supported(sta, sband->band, i))
3471 int ieee80211_rate_control_register(struct rate_control_ops *ops);
3472 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3475 conf_is_ht20(struct ieee80211_conf *conf)
3477 return conf->channel_type == NL80211_CHAN_HT20;
3481 conf_is_ht40_minus(struct ieee80211_conf *conf)
3483 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3487 conf_is_ht40_plus(struct ieee80211_conf *conf)
3489 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3493 conf_is_ht40(struct ieee80211_conf *conf)
3495 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3499 conf_is_ht(struct ieee80211_conf *conf)
3501 return conf->channel_type != NL80211_CHAN_NO_HT;
3504 static inline enum nl80211_iftype
3505 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3509 case NL80211_IFTYPE_STATION:
3510 return NL80211_IFTYPE_P2P_CLIENT;
3511 case NL80211_IFTYPE_AP:
3512 return NL80211_IFTYPE_P2P_GO;
3520 static inline enum nl80211_iftype
3521 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3523 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3526 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3528 int rssi_max_thold);
3530 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3532 int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
3534 int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
3535 struct sk_buff *skb);
3536 #endif /* MAC80211_H */