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_PSPOLL_RESPONSE: (internal?)
343 * This frame is a response to a PS-poll frame and should be sent
344 * although the station 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.
371 * Note: If you have to add new flags to the enumeration, then don't
372 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
374 enum mac80211_tx_control_flags {
375 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
376 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
377 IEEE80211_TX_CTL_NO_ACK = BIT(2),
378 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
379 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
380 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
381 IEEE80211_TX_CTL_AMPDU = BIT(6),
382 IEEE80211_TX_CTL_INJECTED = BIT(7),
383 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
384 IEEE80211_TX_STAT_ACK = BIT(9),
385 IEEE80211_TX_STAT_AMPDU = BIT(10),
386 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
387 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
388 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
389 IEEE80211_TX_INTFL_RETRIED = BIT(15),
390 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
391 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
392 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
393 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
394 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
395 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
396 IEEE80211_TX_CTL_LDPC = BIT(22),
397 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
398 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
399 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
400 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
403 #define IEEE80211_TX_CTL_STBC_SHIFT 23
406 * This definition is used as a mask to clear all temporary flags, which are
407 * set by the tx handlers for each transmission attempt by the mac80211 stack.
409 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
410 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
411 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
412 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
413 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
414 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
415 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
416 IEEE80211_TX_CTL_STBC)
419 * enum mac80211_rate_control_flags - per-rate flags set by the
420 * Rate Control algorithm.
422 * These flags are set by the Rate control algorithm for each rate during tx,
423 * in the @flags member of struct ieee80211_tx_rate.
425 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
426 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
427 * This is set if the current BSS requires ERP protection.
428 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
429 * @IEEE80211_TX_RC_MCS: HT rate.
430 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
432 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
433 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
434 * adjacent 20 MHz channels, if the current channel type is
435 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
436 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
438 enum mac80211_rate_control_flags {
439 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
440 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
441 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
443 /* rate index is an MCS rate number instead of an index */
444 IEEE80211_TX_RC_MCS = BIT(3),
445 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
446 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
447 IEEE80211_TX_RC_DUP_DATA = BIT(6),
448 IEEE80211_TX_RC_SHORT_GI = BIT(7),
452 /* there are 40 bytes if you don't need the rateset to be kept */
453 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
455 /* if you do need the rateset, then you have less space */
456 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
458 /* maximum number of rate stages */
459 #define IEEE80211_TX_MAX_RATES 5
462 * struct ieee80211_tx_rate - rate selection/status
464 * @idx: rate index to attempt to send with
465 * @flags: rate control flags (&enum mac80211_rate_control_flags)
466 * @count: number of tries in this rate before going to the next rate
468 * A value of -1 for @idx indicates an invalid rate and, if used
469 * in an array of retry rates, that no more rates should be tried.
471 * When used for transmit status reporting, the driver should
472 * always report the rate along with the flags it used.
474 * &struct ieee80211_tx_info contains an array of these structs
475 * in the control information, and it will be filled by the rate
476 * control algorithm according to what should be sent. For example,
477 * if this array contains, in the format { <idx>, <count> } the
479 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
480 * then this means that the frame should be transmitted
481 * up to twice at rate 3, up to twice at rate 2, and up to four
482 * times at rate 1 if it doesn't get acknowledged. Say it gets
483 * acknowledged by the peer after the fifth attempt, the status
484 * information should then contain
485 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
486 * since it was transmitted twice at rate 3, twice at rate 2
487 * and once at rate 1 after which we received an acknowledgement.
489 struct ieee80211_tx_rate {
496 * struct ieee80211_tx_info - skb transmit information
498 * This structure is placed in skb->cb for three uses:
499 * (1) mac80211 TX control - mac80211 tells the driver what to do
500 * (2) driver internal use (if applicable)
501 * (3) TX status information - driver tells mac80211 what happened
503 * The TX control's sta pointer is only valid during the ->tx call,
506 * @flags: transmit info flags, defined above
507 * @band: the band to transmit on (use for checking for races)
508 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
509 * @pad: padding, ignore
510 * @control: union for control data
511 * @status: union for status data
512 * @driver_data: array of driver_data pointers
513 * @ampdu_ack_len: number of acked aggregated frames.
514 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
515 * @ampdu_len: number of aggregated frames.
516 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
517 * @ack_signal: signal strength of the ACK frame
519 struct ieee80211_tx_info {
520 /* common information */
534 struct ieee80211_tx_rate rates[
535 IEEE80211_TX_MAX_RATES];
538 /* only needed before rate control */
539 unsigned long jiffies;
541 /* NB: vif can be NULL for injected frames */
542 struct ieee80211_vif *vif;
543 struct ieee80211_key_conf *hw_key;
544 struct ieee80211_sta *sta;
547 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
554 struct ieee80211_tx_rate driver_rates[
555 IEEE80211_TX_MAX_RATES];
556 void *rate_driver_data[
557 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
560 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
565 * struct ieee80211_sched_scan_ies - scheduled scan IEs
567 * This structure is used to pass the appropriate IEs to be used in scheduled
568 * scans for all bands. It contains both the IEs passed from the userspace
569 * and the ones generated by mac80211.
571 * @ie: array with the IEs for each supported band
572 * @len: array with the total length of the IEs for each band
574 struct ieee80211_sched_scan_ies {
575 u8 *ie[IEEE80211_NUM_BANDS];
576 size_t len[IEEE80211_NUM_BANDS];
579 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
581 return (struct ieee80211_tx_info *)skb->cb;
584 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
586 return (struct ieee80211_rx_status *)skb->cb;
590 * ieee80211_tx_info_clear_status - clear TX status
592 * @info: The &struct ieee80211_tx_info to be cleared.
594 * When the driver passes an skb back to mac80211, it must report
595 * a number of things in TX status. This function clears everything
596 * in the TX status but the rate control information (it does clear
597 * the count since you need to fill that in anyway).
599 * NOTE: You can only use this function if you do NOT use
600 * info->driver_data! Use info->rate_driver_data
601 * instead if you need only the less space that allows.
604 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
608 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
609 offsetof(struct ieee80211_tx_info, control.rates));
610 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
611 offsetof(struct ieee80211_tx_info, driver_rates));
612 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
613 /* clear the rate counts */
614 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
615 info->status.rates[i].count = 0;
618 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
619 memset(&info->status.ampdu_ack_len, 0,
620 sizeof(struct ieee80211_tx_info) -
621 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
626 * enum mac80211_rx_flags - receive flags
628 * These flags are used with the @flag member of &struct ieee80211_rx_status.
629 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
630 * Use together with %RX_FLAG_MMIC_STRIPPED.
631 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
632 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
633 * verification has been done by the hardware.
634 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
635 * If this flag is set, the stack cannot do any replay detection
636 * hence the driver or hardware will have to do that.
637 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
639 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
641 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
642 * field) is valid and contains the time the first symbol of the MPDU
643 * was received. This is useful in monitor mode and for proper IBSS
645 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
646 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
647 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
648 * @RX_FLAG_SHORT_GI: Short guard interval was used
650 enum mac80211_rx_flags {
651 RX_FLAG_MMIC_ERROR = 1<<0,
652 RX_FLAG_DECRYPTED = 1<<1,
653 RX_FLAG_MMIC_STRIPPED = 1<<3,
654 RX_FLAG_IV_STRIPPED = 1<<4,
655 RX_FLAG_FAILED_FCS_CRC = 1<<5,
656 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
657 RX_FLAG_MACTIME_MPDU = 1<<7,
658 RX_FLAG_SHORTPRE = 1<<8,
660 RX_FLAG_40MHZ = 1<<10,
661 RX_FLAG_SHORT_GI = 1<<11,
665 * struct ieee80211_rx_status - receive status
667 * The low-level driver should provide this information (the subset
668 * supported by hardware) to the 802.11 code with each received
669 * frame, in the skb's control buffer (cb).
671 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
672 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
673 * @band: the active band when this frame was received
674 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
675 * @signal: signal strength when receiving this frame, either in dBm, in dB or
676 * unspecified depending on the hardware capabilities flags
677 * @IEEE80211_HW_SIGNAL_*
678 * @antenna: antenna used
679 * @rate_idx: index of data rate into band's supported rates or MCS index if
680 * HT rates are use (RX_FLAG_HT)
682 * @rx_flags: internal RX flags for mac80211
684 struct ieee80211_rx_status {
686 enum ieee80211_band band;
692 unsigned int rx_flags;
696 * enum ieee80211_conf_flags - configuration flags
698 * Flags to define PHY configuration options
700 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
701 * to determine for example whether to calculate timestamps for packets
702 * or not, do not use instead of filter flags!
703 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
704 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
705 * meaning that the hardware still wakes up for beacons, is able to
706 * transmit frames and receive the possible acknowledgment frames.
707 * Not to be confused with hardware specific wakeup/sleep states,
708 * driver is responsible for that. See the section "Powersave support"
710 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
711 * the driver should be prepared to handle configuration requests but
712 * may turn the device off as much as possible. Typically, this flag will
713 * be set when an interface is set UP but not associated or scanning, but
714 * it can also be unset in that case when monitor interfaces are active.
715 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
718 enum ieee80211_conf_flags {
719 IEEE80211_CONF_MONITOR = (1<<0),
720 IEEE80211_CONF_PS = (1<<1),
721 IEEE80211_CONF_IDLE = (1<<2),
722 IEEE80211_CONF_OFFCHANNEL = (1<<3),
727 * enum ieee80211_conf_changed - denotes which configuration changed
729 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
730 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
731 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
732 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
733 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
734 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
735 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
736 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
738 enum ieee80211_conf_changed {
739 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
740 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
741 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
742 IEEE80211_CONF_CHANGE_PS = BIT(4),
743 IEEE80211_CONF_CHANGE_POWER = BIT(5),
744 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
745 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
746 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
750 * enum ieee80211_smps_mode - spatial multiplexing power save mode
752 * @IEEE80211_SMPS_AUTOMATIC: automatic
753 * @IEEE80211_SMPS_OFF: off
754 * @IEEE80211_SMPS_STATIC: static
755 * @IEEE80211_SMPS_DYNAMIC: dynamic
756 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
758 enum ieee80211_smps_mode {
759 IEEE80211_SMPS_AUTOMATIC,
761 IEEE80211_SMPS_STATIC,
762 IEEE80211_SMPS_DYNAMIC,
765 IEEE80211_SMPS_NUM_MODES,
769 * struct ieee80211_conf - configuration of the device
771 * This struct indicates how the driver shall configure the hardware.
773 * @flags: configuration flags defined above
775 * @listen_interval: listen interval in units of beacon interval
776 * @max_sleep_period: the maximum number of beacon intervals to sleep for
777 * before checking the beacon for a TIM bit (managed mode only); this
778 * value will be only achievable between DTIM frames, the hardware
779 * needs to check for the multicast traffic bit in DTIM beacons.
780 * This variable is valid only when the CONF_PS flag is set.
781 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
782 * in power saving. Power saving will not be enabled until a beacon
783 * has been received and the DTIM period is known.
784 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
785 * powersave documentation below. This variable is valid only when
786 * the CONF_PS flag is set.
788 * @power_level: requested transmit power (in dBm)
790 * @channel: the channel to tune to
791 * @channel_type: the channel (HT) type
793 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
794 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
795 * but actually means the number of transmissions not the number of retries
796 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
797 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
798 * number of transmissions not the number of retries
800 * @smps_mode: spatial multiplexing powersave mode; note that
801 * %IEEE80211_SMPS_STATIC is used when the device is not
802 * configured for an HT channel
804 struct ieee80211_conf {
806 int power_level, dynamic_ps_timeout;
807 int max_sleep_period;
812 u8 long_frame_max_tx_count, short_frame_max_tx_count;
814 struct ieee80211_channel *channel;
815 enum nl80211_channel_type channel_type;
816 enum ieee80211_smps_mode smps_mode;
820 * struct ieee80211_channel_switch - holds the channel switch data
822 * The information provided in this structure is required for channel switch
825 * @timestamp: value in microseconds of the 64-bit Time Synchronization
826 * Function (TSF) timer when the frame containing the channel switch
827 * announcement was received. This is simply the rx.mactime parameter
828 * the driver passed into mac80211.
829 * @block_tx: Indicates whether transmission must be blocked before the
830 * scheduled channel switch, as indicated by the AP.
831 * @channel: the new channel to switch to
832 * @count: the number of TBTT's until the channel switch event
834 struct ieee80211_channel_switch {
837 struct ieee80211_channel *channel;
842 * struct ieee80211_vif - per-interface data
844 * Data in this structure is continually present for driver
845 * use during the life of a virtual interface.
847 * @type: type of this virtual interface
848 * @bss_conf: BSS configuration for this interface, either our own
849 * or the BSS we're associated to
850 * @addr: address of this interface
851 * @p2p: indicates whether this AP or STA interface is a p2p
852 * interface, i.e. a GO or p2p-sta respectively
853 * @drv_priv: data area for driver use, will always be aligned to
856 struct ieee80211_vif {
857 enum nl80211_iftype type;
858 struct ieee80211_bss_conf bss_conf;
862 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
865 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
867 #ifdef CONFIG_MAC80211_MESH
868 return vif->type == NL80211_IFTYPE_MESH_POINT;
874 * enum ieee80211_key_flags - key flags
876 * These flags are used for communication about keys between the driver
877 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
879 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
880 * that the STA this key will be used with could be using QoS.
881 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
882 * driver to indicate that it requires IV generation for this
884 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
885 * the driver for a TKIP key if it requires Michael MIC
886 * generation in software.
887 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
888 * that the key is pairwise rather then a shared key.
889 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
890 * CCMP key if it requires CCMP encryption of management frames (MFP) to
891 * be done in software.
893 enum ieee80211_key_flags {
894 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
895 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
896 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
897 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
898 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
902 * struct ieee80211_key_conf - key information
904 * This key information is given by mac80211 to the driver by
905 * the set_key() callback in &struct ieee80211_ops.
907 * @hw_key_idx: To be set by the driver, this is the key index the driver
908 * wants to be given when a frame is transmitted and needs to be
909 * encrypted in hardware.
910 * @cipher: The key's cipher suite selector.
911 * @flags: key flags, see &enum ieee80211_key_flags.
912 * @keyidx: the key index (0-3)
913 * @keylen: key material length
914 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
916 * - Temporal Encryption Key (128 bits)
917 * - Temporal Authenticator Tx MIC Key (64 bits)
918 * - Temporal Authenticator Rx MIC Key (64 bits)
919 * @icv_len: The ICV length for this key type
920 * @iv_len: The IV length for this key type
922 struct ieee80211_key_conf {
934 * enum set_key_cmd - key command
936 * Used with the set_key() callback in &struct ieee80211_ops, this
937 * indicates whether a key is being removed or added.
939 * @SET_KEY: a key is set
940 * @DISABLE_KEY: a key must be disabled
943 SET_KEY, DISABLE_KEY,
947 * struct ieee80211_sta - station table entry
949 * A station table entry represents a station we are possibly
950 * communicating with. Since stations are RCU-managed in
951 * mac80211, any ieee80211_sta pointer you get access to must
952 * either be protected by rcu_read_lock() explicitly or implicitly,
953 * or you must take good care to not use such a pointer after a
954 * call to your sta_remove callback that removed it.
957 * @aid: AID we assigned to the station if we're an AP
958 * @supp_rates: Bitmap of supported rates (per band)
959 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
960 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
961 * @drv_priv: data area for driver use, will always be aligned to
962 * sizeof(void *), size is determined in hw information.
963 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
964 * if wme is supported.
965 * @max_sp: max Service Period. Only valid if wme is supported.
967 struct ieee80211_sta {
968 u32 supp_rates[IEEE80211_NUM_BANDS];
971 struct ieee80211_sta_ht_cap ht_cap;
977 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
981 * enum sta_notify_cmd - sta notify command
983 * Used with the sta_notify() callback in &struct ieee80211_ops, this
984 * indicates if an associated station made a power state transition.
986 * @STA_NOTIFY_SLEEP: a station is now sleeping
987 * @STA_NOTIFY_AWAKE: a sleeping station woke up
989 enum sta_notify_cmd {
990 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
994 * enum ieee80211_hw_flags - hardware flags
996 * These flags are used to indicate hardware capabilities to
997 * the stack. Generally, flags here should have their meaning
998 * done in a way that the simplest hardware doesn't need setting
999 * any particular flags. There are some exceptions to this rule,
1000 * however, so you are advised to review these flags carefully.
1002 * @IEEE80211_HW_HAS_RATE_CONTROL:
1003 * The hardware or firmware includes rate control, and cannot be
1004 * controlled by the stack. As such, no rate control algorithm
1005 * should be instantiated, and the TX rate reported to userspace
1006 * will be taken from the TX status instead of the rate control
1008 * Note that this requires that the driver implement a number of
1009 * callbacks so it has the correct information, it needs to have
1010 * the @set_rts_threshold callback and must look at the BSS config
1011 * @use_cts_prot for G/N protection, @use_short_slot for slot
1012 * timing in 2.4 GHz and @use_short_preamble for preambles for
1015 * @IEEE80211_HW_RX_INCLUDES_FCS:
1016 * Indicates that received frames passed to the stack include
1017 * the FCS at the end.
1019 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1020 * Some wireless LAN chipsets buffer broadcast/multicast frames
1021 * for power saving stations in the hardware/firmware and others
1022 * rely on the host system for such buffering. This option is used
1023 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1024 * multicast frames when there are power saving stations so that
1025 * the driver can fetch them with ieee80211_get_buffered_bc().
1027 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1028 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1030 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1031 * Hardware is not capable of receiving frames with short preamble on
1034 * @IEEE80211_HW_SIGNAL_UNSPEC:
1035 * Hardware can provide signal values but we don't know its units. We
1036 * expect values between 0 and @max_signal.
1037 * If possible please provide dB or dBm instead.
1039 * @IEEE80211_HW_SIGNAL_DBM:
1040 * Hardware gives signal values in dBm, decibel difference from
1041 * one milliwatt. This is the preferred method since it is standardized
1042 * between different devices. @max_signal does not need to be set.
1044 * @IEEE80211_HW_SPECTRUM_MGMT:
1045 * Hardware supports spectrum management defined in 802.11h
1046 * Measurement, Channel Switch, Quieting, TPC
1048 * @IEEE80211_HW_AMPDU_AGGREGATION:
1049 * Hardware supports 11n A-MPDU aggregation.
1051 * @IEEE80211_HW_SUPPORTS_PS:
1052 * Hardware has power save support (i.e. can go to sleep).
1054 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1055 * Hardware requires nullfunc frame handling in stack, implies
1056 * stack support for dynamic PS.
1058 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1059 * Hardware has support for dynamic PS.
1061 * @IEEE80211_HW_MFP_CAPABLE:
1062 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1064 * @IEEE80211_HW_BEACON_FILTER:
1065 * Hardware supports dropping of irrelevant beacon frames to
1066 * avoid waking up cpu.
1068 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1069 * Hardware supports static spatial multiplexing powersave,
1070 * ie. can turn off all but one chain even on HT connections
1071 * that should be using more chains.
1073 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1074 * Hardware supports dynamic spatial multiplexing powersave,
1075 * ie. can turn off all but one chain and then wake the rest
1076 * up as required after, for example, rts/cts handshake.
1078 * @IEEE80211_HW_SUPPORTS_UAPSD:
1079 * Hardware supports Unscheduled Automatic Power Save Delivery
1080 * (U-APSD) in managed mode. The mode is configured with
1081 * conf_tx() operation.
1083 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1084 * Hardware can provide ack status reports of Tx frames to
1087 * @IEEE80211_HW_CONNECTION_MONITOR:
1088 * The hardware performs its own connection monitoring, including
1089 * periodic keep-alives to the AP and probing the AP on beacon loss.
1090 * When this flag is set, signaling beacon-loss will cause an immediate
1091 * change to disassociated state.
1093 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1094 * Hardware can do connection quality monitoring - i.e. it can monitor
1095 * connection quality related parameters, such as the RSSI level and
1096 * provide notifications if configured trigger levels are reached.
1098 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1099 * This device needs to know the DTIM period for the BSS before
1102 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1103 * per-station GTKs as used by IBSS RSN or during fast transition. If
1104 * the device doesn't support per-station GTKs, but can be asked not
1105 * to decrypt group addressed frames, then IBSS RSN support is still
1106 * possible but software crypto will be used. Advertise the wiphy flag
1107 * only in that case.
1109 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1110 * autonomously manages the PS status of connected stations. When
1111 * this flag is set mac80211 will not trigger PS mode for connected
1112 * stations based on the PM bit of incoming frames.
1113 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1114 * the PS mode of connected stations.
1116 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1117 * setup strictly in HW. mac80211 should not attempt to do this in
1120 enum ieee80211_hw_flags {
1121 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1122 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1123 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1124 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1125 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1126 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1127 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1128 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1129 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1130 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1131 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1132 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1133 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1134 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1135 IEEE80211_HW_BEACON_FILTER = 1<<14,
1136 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1137 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1138 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1139 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1140 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1141 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1142 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1143 IEEE80211_HW_AP_LINK_PS = 1<<22,
1144 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1148 * struct ieee80211_hw - hardware information and state
1150 * This structure contains the configuration and hardware
1151 * information for an 802.11 PHY.
1153 * @wiphy: This points to the &struct wiphy allocated for this
1154 * 802.11 PHY. You must fill in the @perm_addr and @dev
1155 * members of this structure using SET_IEEE80211_DEV()
1156 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1157 * bands (with channels, bitrates) are registered here.
1159 * @conf: &struct ieee80211_conf, device configuration, don't use.
1161 * @priv: pointer to private area that was allocated for driver use
1162 * along with this structure.
1164 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1166 * @extra_tx_headroom: headroom to reserve in each transmit skb
1167 * for use by the driver (e.g. for transmit headers.)
1169 * @channel_change_time: time (in microseconds) it takes to change channels.
1171 * @max_signal: Maximum value for signal (rssi) in RX information, used
1172 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1174 * @max_listen_interval: max listen interval in units of beacon interval
1177 * @queues: number of available hardware transmit queues for
1178 * data packets. WMM/QoS requires at least four, these
1179 * queues need to have configurable access parameters.
1181 * @rate_control_algorithm: rate control algorithm for this hardware.
1182 * If unset (NULL), the default algorithm will be used. Must be
1183 * set before calling ieee80211_register_hw().
1185 * @vif_data_size: size (in bytes) of the drv_priv data area
1186 * within &struct ieee80211_vif.
1187 * @sta_data_size: size (in bytes) of the drv_priv data area
1188 * within &struct ieee80211_sta.
1190 * @max_rates: maximum number of alternate rate retry stages the hw
1192 * @max_report_rates: maximum number of alternate rate retry stages
1193 * the hw can report back.
1194 * @max_rate_tries: maximum number of tries for each stage
1196 * @napi_weight: weight used for NAPI polling. You must specify an
1197 * appropriate value here if a napi_poll operation is provided
1200 * @max_rx_aggregation_subframes: maximum buffer size (number of
1201 * sub-frames) to be used for A-MPDU block ack receiver
1203 * This is only relevant if the device has restrictions on the
1204 * number of subframes, if it relies on mac80211 to do reordering
1205 * it shouldn't be set.
1207 * @max_tx_aggregation_subframes: maximum number of subframes in an
1208 * aggregate an HT driver will transmit, used by the peer as a
1209 * hint to size its reorder buffer.
1211 struct ieee80211_hw {
1212 struct ieee80211_conf conf;
1213 struct wiphy *wiphy;
1214 const char *rate_control_algorithm;
1217 unsigned int extra_tx_headroom;
1218 int channel_change_time;
1223 u16 max_listen_interval;
1226 u8 max_report_rates;
1228 u8 max_rx_aggregation_subframes;
1229 u8 max_tx_aggregation_subframes;
1233 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1235 * @wiphy: the &struct wiphy which we want to query
1237 * mac80211 drivers can use this to get to their respective
1238 * &struct ieee80211_hw. Drivers wishing to get to their own private
1239 * structure can then access it via hw->priv. Note that mac802111 drivers should
1240 * not use wiphy_priv() to try to get their private driver structure as this
1241 * is already used internally by mac80211.
1243 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1246 * SET_IEEE80211_DEV - set device for 802.11 hardware
1248 * @hw: the &struct ieee80211_hw to set the device for
1249 * @dev: the &struct device of this 802.11 device
1251 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1253 set_wiphy_dev(hw->wiphy, dev);
1257 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1259 * @hw: the &struct ieee80211_hw to set the MAC address for
1260 * @addr: the address to set
1262 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1264 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1267 static inline struct ieee80211_rate *
1268 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1269 const struct ieee80211_tx_info *c)
1271 if (WARN_ON(c->control.rates[0].idx < 0))
1273 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1276 static inline struct ieee80211_rate *
1277 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1278 const struct ieee80211_tx_info *c)
1280 if (c->control.rts_cts_rate_idx < 0)
1282 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1285 static inline struct ieee80211_rate *
1286 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1287 const struct ieee80211_tx_info *c, int idx)
1289 if (c->control.rates[idx + 1].idx < 0)
1291 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1295 * DOC: Hardware crypto acceleration
1297 * mac80211 is capable of taking advantage of many hardware
1298 * acceleration designs for encryption and decryption operations.
1300 * The set_key() callback in the &struct ieee80211_ops for a given
1301 * device is called to enable hardware acceleration of encryption and
1302 * decryption. The callback takes a @sta parameter that will be NULL
1303 * for default keys or keys used for transmission only, or point to
1304 * the station information for the peer for individual keys.
1305 * Multiple transmission keys with the same key index may be used when
1306 * VLANs are configured for an access point.
1308 * When transmitting, the TX control data will use the @hw_key_idx
1309 * selected by the driver by modifying the &struct ieee80211_key_conf
1310 * pointed to by the @key parameter to the set_key() function.
1312 * The set_key() call for the %SET_KEY command should return 0 if
1313 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1314 * added; if you return 0 then hw_key_idx must be assigned to the
1315 * hardware key index, you are free to use the full u8 range.
1317 * When the cmd is %DISABLE_KEY then it must succeed.
1319 * Note that it is permissible to not decrypt a frame even if a key
1320 * for it has been uploaded to hardware, the stack will not make any
1321 * decision based on whether a key has been uploaded or not but rather
1322 * based on the receive flags.
1324 * The &struct ieee80211_key_conf structure pointed to by the @key
1325 * parameter is guaranteed to be valid until another call to set_key()
1326 * removes it, but it can only be used as a cookie to differentiate
1329 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1330 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1332 * The update_tkip_key() call updates the driver with the new phase 1 key.
1333 * This happens every time the iv16 wraps around (every 65536 packets). The
1334 * set_key() call will happen only once for each key (unless the AP did
1335 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1336 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1337 * handler is software decryption with wrap around of iv16.
1341 * DOC: Powersave support
1343 * mac80211 has support for various powersave implementations.
1345 * First, it can support hardware that handles all powersaving by itself,
1346 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1347 * flag. In that case, it will be told about the desired powersave mode
1348 * with the %IEEE80211_CONF_PS flag depending on the association status.
1349 * The hardware must take care of sending nullfunc frames when necessary,
1350 * i.e. when entering and leaving powersave mode. The hardware is required
1351 * to look at the AID in beacons and signal to the AP that it woke up when
1352 * it finds traffic directed to it.
1354 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1355 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1356 * with hardware wakeup and sleep states. Driver is responsible for waking
1357 * up the hardware before issuing commands to the hardware and putting it
1358 * back to sleep at appropriate times.
1360 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1361 * buffered multicast/broadcast frames after the beacon. Also it must be
1362 * possible to send frames and receive the acknowledment frame.
1364 * Other hardware designs cannot send nullfunc frames by themselves and also
1365 * need software support for parsing the TIM bitmap. This is also supported
1366 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1367 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1368 * required to pass up beacons. The hardware is still required to handle
1369 * waking up for multicast traffic; if it cannot the driver must handle that
1370 * as best as it can, mac80211 is too slow to do that.
1372 * Dynamic powersave is an extension to normal powersave in which the
1373 * hardware stays awake for a user-specified period of time after sending a
1374 * frame so that reply frames need not be buffered and therefore delayed to
1375 * the next wakeup. It's compromise of getting good enough latency when
1376 * there's data traffic and still saving significantly power in idle
1379 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1380 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1381 * flag and mac80211 will handle everything automatically. Additionally,
1382 * hardware having support for the dynamic PS feature may set the
1383 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1384 * dynamic PS mode itself. The driver needs to look at the
1385 * @dynamic_ps_timeout hardware configuration value and use it that value
1386 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1387 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1388 * enabled whenever user has enabled powersave.
1390 * Some hardware need to toggle a single shared antenna between WLAN and
1391 * Bluetooth to facilitate co-existence. These types of hardware set
1392 * limitations on the use of host controlled dynamic powersave whenever there
1393 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1394 * driver may request temporarily going into full power save, in order to
1395 * enable toggling the antenna between BT and WLAN. If the driver requests
1396 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1397 * temporarily set to zero until the driver re-enables dynamic powersave.
1399 * Driver informs U-APSD client support by enabling
1400 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1401 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1402 * Nullfunc frames and stay awake until the service period has ended. To
1403 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1404 * from that AC are transmitted with powersave enabled.
1406 * Note: U-APSD client mode is not yet supported with
1407 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1411 * DOC: Beacon filter support
1413 * Some hardware have beacon filter support to reduce host cpu wakeups
1414 * which will reduce system power consumption. It usuallly works so that
1415 * the firmware creates a checksum of the beacon but omits all constantly
1416 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1417 * beacon is forwarded to the host, otherwise it will be just dropped. That
1418 * way the host will only receive beacons where some relevant information
1419 * (for example ERP protection or WMM settings) have changed.
1421 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1422 * hardware capability. The driver needs to enable beacon filter support
1423 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1424 * power save is enabled, the stack will not check for beacon loss and the
1425 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1427 * The time (or number of beacons missed) until the firmware notifies the
1428 * driver of a beacon loss event (which in turn causes the driver to call
1429 * ieee80211_beacon_loss()) should be configurable and will be controlled
1430 * by mac80211 and the roaming algorithm in the future.
1432 * Since there may be constantly changing information elements that nothing
1433 * in the software stack cares about, we will, in the future, have mac80211
1434 * tell the driver which information elements are interesting in the sense
1435 * that we want to see changes in them. This will include
1436 * - a list of information element IDs
1437 * - a list of OUIs for the vendor information element
1439 * Ideally, the hardware would filter out any beacons without changes in the
1440 * requested elements, but if it cannot support that it may, at the expense
1441 * of some efficiency, filter out only a subset. For example, if the device
1442 * doesn't support checking for OUIs it should pass up all changes in all
1443 * vendor information elements.
1445 * Note that change, for the sake of simplification, also includes information
1446 * elements appearing or disappearing from the beacon.
1448 * Some hardware supports an "ignore list" instead, just make sure nothing
1449 * that was requested is on the ignore list, and include commonly changing
1450 * information element IDs in the ignore list, for example 11 (BSS load) and
1451 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1452 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1453 * it could also include some currently unused IDs.
1456 * In addition to these capabilities, hardware should support notifying the
1457 * host of changes in the beacon RSSI. This is relevant to implement roaming
1458 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1459 * the received data packets). This can consist in notifying the host when
1460 * the RSSI changes significantly or when it drops below or rises above
1461 * configurable thresholds. In the future these thresholds will also be
1462 * configured by mac80211 (which gets them from userspace) to implement
1463 * them as the roaming algorithm requires.
1465 * If the hardware cannot implement this, the driver should ask it to
1466 * periodically pass beacon frames to the host so that software can do the
1467 * signal strength threshold checking.
1471 * DOC: Spatial multiplexing power save
1473 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1474 * power in an 802.11n implementation. For details on the mechanism
1475 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1476 * "11.2.3 SM power save".
1478 * The mac80211 implementation is capable of sending action frames
1479 * to update the AP about the station's SMPS mode, and will instruct
1480 * the driver to enter the specific mode. It will also announce the
1481 * requested SMPS mode during the association handshake. Hardware
1482 * support for this feature is required, and can be indicated by
1485 * The default mode will be "automatic", which nl80211/cfg80211
1486 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1487 * turned off otherwise.
1489 * To support this feature, the driver must set the appropriate
1490 * hardware support flags, and handle the SMPS flag to the config()
1491 * operation. It will then with this mechanism be instructed to
1492 * enter the requested SMPS mode while associated to an HT AP.
1496 * DOC: Frame filtering
1498 * mac80211 requires to see many management frames for proper
1499 * operation, and users may want to see many more frames when
1500 * in monitor mode. However, for best CPU usage and power consumption,
1501 * having as few frames as possible percolate through the stack is
1502 * desirable. Hence, the hardware should filter as much as possible.
1504 * To achieve this, mac80211 uses filter flags (see below) to tell
1505 * the driver's configure_filter() function which frames should be
1506 * passed to mac80211 and which should be filtered out.
1508 * Before configure_filter() is invoked, the prepare_multicast()
1509 * callback is invoked with the parameters @mc_count and @mc_list
1510 * for the combined multicast address list of all virtual interfaces.
1511 * It's use is optional, and it returns a u64 that is passed to
1512 * configure_filter(). Additionally, configure_filter() has the
1513 * arguments @changed_flags telling which flags were changed and
1514 * @total_flags with the new flag states.
1516 * If your device has no multicast address filters your driver will
1517 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1518 * parameter to see whether multicast frames should be accepted
1521 * All unsupported flags in @total_flags must be cleared.
1522 * Hardware does not support a flag if it is incapable of _passing_
1523 * the frame to the stack. Otherwise the driver must ignore
1524 * the flag, but not clear it.
1525 * You must _only_ clear the flag (announce no support for the
1526 * flag to mac80211) if you are not able to pass the packet type
1527 * to the stack (so the hardware always filters it).
1528 * So for example, you should clear @FIF_CONTROL, if your hardware
1529 * always filters control frames. If your hardware always passes
1530 * control frames to the kernel and is incapable of filtering them,
1531 * you do _not_ clear the @FIF_CONTROL flag.
1532 * This rule applies to all other FIF flags as well.
1536 * enum ieee80211_filter_flags - hardware filter flags
1538 * These flags determine what the filter in hardware should be
1539 * programmed to let through and what should not be passed to the
1540 * stack. It is always safe to pass more frames than requested,
1541 * but this has negative impact on power consumption.
1543 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1544 * think of the BSS as your network segment and then this corresponds
1545 * to the regular ethernet device promiscuous mode.
1547 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1548 * by the user or if the hardware is not capable of filtering by
1549 * multicast address.
1551 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1552 * %RX_FLAG_FAILED_FCS_CRC for them)
1554 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1555 * the %RX_FLAG_FAILED_PLCP_CRC for them
1557 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1558 * to the hardware that it should not filter beacons or probe responses
1559 * by BSSID. Filtering them can greatly reduce the amount of processing
1560 * mac80211 needs to do and the amount of CPU wakeups, so you should
1561 * honour this flag if possible.
1563 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1564 * is not set then only those addressed to this station.
1566 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1568 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1569 * those addressed to this station.
1571 * @FIF_PROBE_REQ: pass probe request frames
1573 enum ieee80211_filter_flags {
1574 FIF_PROMISC_IN_BSS = 1<<0,
1575 FIF_ALLMULTI = 1<<1,
1577 FIF_PLCPFAIL = 1<<3,
1578 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1580 FIF_OTHER_BSS = 1<<6,
1582 FIF_PROBE_REQ = 1<<8,
1586 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1588 * These flags are used with the ampdu_action() callback in
1589 * &struct ieee80211_ops to indicate which action is needed.
1591 * Note that drivers MUST be able to deal with a TX aggregation
1592 * session being stopped even before they OK'ed starting it by
1593 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1594 * might receive the addBA frame and send a delBA right away!
1596 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1597 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1598 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1599 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1600 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1602 enum ieee80211_ampdu_mlme_action {
1603 IEEE80211_AMPDU_RX_START,
1604 IEEE80211_AMPDU_RX_STOP,
1605 IEEE80211_AMPDU_TX_START,
1606 IEEE80211_AMPDU_TX_STOP,
1607 IEEE80211_AMPDU_TX_OPERATIONAL,
1611 * enum ieee80211_tx_sync_type - TX sync type
1612 * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1613 * (and possibly also before direct probe)
1614 * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1615 * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1616 * (not implemented yet)
1618 enum ieee80211_tx_sync_type {
1619 IEEE80211_TX_SYNC_AUTH,
1620 IEEE80211_TX_SYNC_ASSOC,
1621 IEEE80211_TX_SYNC_ACTION,
1625 * enum ieee80211_frame_release_type - frame release reason
1626 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1628 enum ieee80211_frame_release_type {
1629 IEEE80211_FRAME_RELEASE_PSPOLL,
1633 * struct ieee80211_ops - callbacks from mac80211 to the driver
1635 * This structure contains various callbacks that the driver may
1636 * handle or, in some cases, must handle, for example to configure
1637 * the hardware to a new channel or to transmit a frame.
1639 * @tx: Handler that 802.11 module calls for each transmitted frame.
1640 * skb contains the buffer starting from the IEEE 802.11 header.
1641 * The low-level driver should send the frame out based on
1642 * configuration in the TX control data. This handler should,
1643 * preferably, never fail and stop queues appropriately, more
1644 * importantly, however, it must never fail for A-MPDU-queues.
1645 * This function should return NETDEV_TX_OK except in very
1647 * Must be implemented and atomic.
1649 * @start: Called before the first netdevice attached to the hardware
1650 * is enabled. This should turn on the hardware and must turn on
1651 * frame reception (for possibly enabled monitor interfaces.)
1652 * Returns negative error codes, these may be seen in userspace,
1654 * When the device is started it should not have a MAC address
1655 * to avoid acknowledging frames before a non-monitor device
1657 * Must be implemented and can sleep.
1659 * @stop: Called after last netdevice attached to the hardware
1660 * is disabled. This should turn off the hardware (at least
1661 * it must turn off frame reception.)
1662 * May be called right after add_interface if that rejects
1663 * an interface. If you added any work onto the mac80211 workqueue
1664 * you should ensure to cancel it on this callback.
1665 * Must be implemented and can sleep.
1667 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1668 * stop transmitting and doing any other configuration, and then
1669 * ask the device to suspend. This is only invoked when WoWLAN is
1670 * configured, otherwise the device is deconfigured completely and
1671 * reconfigured at resume time.
1672 * The driver may also impose special conditions under which it
1673 * wants to use the "normal" suspend (deconfigure), say if it only
1674 * supports WoWLAN when the device is associated. In this case, it
1675 * must return 1 from this function.
1677 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1678 * now resuming its operation, after this the device must be fully
1679 * functional again. If this returns an error, the only way out is
1680 * to also unregister the device. If it returns 1, then mac80211
1681 * will also go through the regular complete restart on resume.
1683 * @add_interface: Called when a netdevice attached to the hardware is
1684 * enabled. Because it is not called for monitor mode devices, @start
1685 * and @stop must be implemented.
1686 * The driver should perform any initialization it needs before
1687 * the device can be enabled. The initial configuration for the
1688 * interface is given in the conf parameter.
1689 * The callback may refuse to add an interface by returning a
1690 * negative error code (which will be seen in userspace.)
1691 * Must be implemented and can sleep.
1693 * @change_interface: Called when a netdevice changes type. This callback
1694 * is optional, but only if it is supported can interface types be
1695 * switched while the interface is UP. The callback may sleep.
1696 * Note that while an interface is being switched, it will not be
1697 * found by the interface iteration callbacks.
1699 * @remove_interface: Notifies a driver that an interface is going down.
1700 * The @stop callback is called after this if it is the last interface
1701 * and no monitor interfaces are present.
1702 * When all interfaces are removed, the MAC address in the hardware
1703 * must be cleared so the device no longer acknowledges packets,
1704 * the mac_addr member of the conf structure is, however, set to the
1705 * MAC address of the device going away.
1706 * Hence, this callback must be implemented. It can sleep.
1708 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1709 * function to change hardware configuration, e.g., channel.
1710 * This function should never fail but returns a negative error code
1711 * if it does. The callback can sleep.
1713 * @bss_info_changed: Handler for configuration requests related to BSS
1714 * parameters that may vary during BSS's lifespan, and may affect low
1715 * level driver (e.g. assoc/disassoc status, erp parameters).
1716 * This function should not be used if no BSS has been set, unless
1717 * for association indication. The @changed parameter indicates which
1718 * of the bss parameters has changed when a call is made. The callback
1721 * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1722 * driver should sync with the GO's powersaving so the device doesn't
1723 * transmit the frame while the GO is asleep. In the regular AP case
1724 * it may be used by drivers for devices implementing other restrictions
1725 * on talking to APs, e.g. due to regulatory enforcement or just HW
1727 * This function is called for every authentication, association and
1728 * action frame separately since applications might attempt to auth
1729 * with multiple APs before chosing one to associate to. If it returns
1730 * an error, the corresponding authentication, association or frame
1731 * transmission is aborted and reported as having failed. It is always
1732 * called after tuning to the correct channel.
1733 * The callback might be called multiple times before @finish_tx_sync
1734 * (but @finish_tx_sync will be called once for each) but in practice
1735 * this is unlikely to happen. It can also refuse in that case if the
1736 * driver cannot handle that situation.
1737 * This callback can sleep.
1738 * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1739 * an error. This callback can sleep.
1741 * @prepare_multicast: Prepare for multicast filter configuration.
1742 * This callback is optional, and its return value is passed
1743 * to configure_filter(). This callback must be atomic.
1745 * @configure_filter: Configure the device's RX filter.
1746 * See the section "Frame filtering" for more information.
1747 * This callback must be implemented and can sleep.
1749 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1750 * must be set or cleared for a given STA. Must be atomic.
1752 * @set_key: See the section "Hardware crypto acceleration"
1753 * This callback is only called between add_interface and
1754 * remove_interface calls, i.e. while the given virtual interface
1756 * Returns a negative error code if the key can't be added.
1757 * The callback can sleep.
1759 * @update_tkip_key: See the section "Hardware crypto acceleration"
1760 * This callback will be called in the context of Rx. Called for drivers
1761 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1762 * The callback must be atomic.
1764 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1765 * host is suspended, it can assign this callback to retrieve the data
1766 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1767 * After rekeying was done it should (for example during resume) notify
1768 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1770 * @hw_scan: Ask the hardware to service the scan request, no need to start
1771 * the scan state machine in stack. The scan must honour the channel
1772 * configuration done by the regulatory agent in the wiphy's
1773 * registered bands. The hardware (or the driver) needs to make sure
1774 * that power save is disabled.
1775 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1776 * entire IEs after the SSID, so that drivers need not look at these
1777 * at all but just send them after the SSID -- mac80211 includes the
1778 * (extended) supported rates and HT information (where applicable).
1779 * When the scan finishes, ieee80211_scan_completed() must be called;
1780 * note that it also must be called when the scan cannot finish due to
1781 * any error unless this callback returned a negative error code.
1782 * The callback can sleep.
1784 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1785 * The driver should ask the hardware to cancel the scan (if possible),
1786 * but the scan will be completed only after the driver will call
1787 * ieee80211_scan_completed().
1788 * This callback is needed for wowlan, to prevent enqueueing a new
1789 * scan_work after the low-level driver was already suspended.
1790 * The callback can sleep.
1792 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1793 * specific intervals. The driver must call the
1794 * ieee80211_sched_scan_results() function whenever it finds results.
1795 * This process will continue until sched_scan_stop is called.
1797 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1799 * @sw_scan_start: Notifier function that is called just before a software scan
1800 * is started. Can be NULL, if the driver doesn't need this notification.
1801 * The callback can sleep.
1803 * @sw_scan_complete: Notifier function that is called just after a
1804 * software scan finished. Can be NULL, if the driver doesn't need
1805 * this notification.
1806 * The callback can sleep.
1808 * @get_stats: Return low-level statistics.
1809 * Returns zero if statistics are available.
1810 * The callback can sleep.
1812 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1813 * callback should be provided to read the TKIP transmit IVs (both IV32
1814 * and IV16) for the given key from hardware.
1815 * The callback must be atomic.
1817 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1818 * if the device does fragmentation by itself; if this callback is
1819 * implemented then the stack will not do fragmentation.
1820 * The callback can sleep.
1822 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1823 * The callback can sleep.
1825 * @sta_add: Notifies low level driver about addition of an associated station,
1826 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1828 * @sta_remove: Notifies low level driver about removal of an associated
1829 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1831 * @sta_notify: Notifies low level driver about power state transition of an
1832 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1833 * in AP mode, this callback will not be called when the flag
1834 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1836 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1837 * bursting) for a hardware TX queue.
1838 * Returns a negative error code on failure.
1839 * The callback can sleep.
1841 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1842 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1843 * required function.
1844 * The callback can sleep.
1846 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1847 * Currently, this is only used for IBSS mode debugging. Is not a
1848 * required function.
1849 * The callback can sleep.
1851 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1852 * with other STAs in the IBSS. This is only used in IBSS mode. This
1853 * function is optional if the firmware/hardware takes full care of
1854 * TSF synchronization.
1855 * The callback can sleep.
1857 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1858 * This is needed only for IBSS mode and the result of this function is
1859 * used to determine whether to reply to Probe Requests.
1860 * Returns non-zero if this device sent the last beacon.
1861 * The callback can sleep.
1863 * @ampdu_action: Perform a certain A-MPDU action
1864 * The RA/TID combination determines the destination and TID we want
1865 * the ampdu action to be performed for. The action is defined through
1866 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1867 * is the first frame we expect to perform the action on. Notice
1868 * that TX/RX_STOP can pass NULL for this parameter.
1869 * The @buf_size parameter is only valid when the action is set to
1870 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1871 * buffer size (number of subframes) for this session -- the driver
1872 * may neither send aggregates containing more subframes than this
1873 * nor send aggregates in a way that lost frames would exceed the
1874 * buffer size. If just limiting the aggregate size, this would be
1875 * possible with a buf_size of 8:
1877 * - RX: 2....7 (lost frame #1)
1879 * which is invalid since #1 was now re-transmitted well past the
1880 * buffer size of 8. Correct ways to retransmit #1 would be:
1881 * - TX: 1 or 18 or 81
1882 * Even "189" would be wrong since 1 could be lost again.
1884 * Returns a negative error code on failure.
1885 * The callback can sleep.
1887 * @get_survey: Return per-channel survey information
1889 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1890 * need to set wiphy->rfkill_poll to %true before registration,
1891 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1892 * The callback can sleep.
1894 * @set_coverage_class: Set slot time for given coverage class as specified
1895 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1896 * accordingly. This callback is not required and may sleep.
1898 * @testmode_cmd: Implement a cfg80211 test mode command.
1899 * The callback can sleep.
1900 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
1902 * @flush: Flush all pending frames from the hardware queue, making sure
1903 * that the hardware queues are empty. If the parameter @drop is set
1904 * to %true, pending frames may be dropped. The callback can sleep.
1906 * @channel_switch: Drivers that need (or want) to offload the channel
1907 * switch operation for CSAs received from the AP may implement this
1908 * callback. They must then call ieee80211_chswitch_done() to indicate
1909 * completion of the channel switch.
1911 * @napi_poll: Poll Rx queue for incoming data frames.
1913 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1914 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1915 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1916 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1918 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1920 * @remain_on_channel: Starts an off-channel period on the given channel, must
1921 * call back to ieee80211_ready_on_channel() when on that channel. Note
1922 * that normal channel traffic is not stopped as this is intended for hw
1923 * offload. Frames to transmit on the off-channel channel are transmitted
1924 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1925 * duration (which will always be non-zero) expires, the driver must call
1926 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1927 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1928 * aborted before it expires. This callback may sleep.
1930 * @set_ringparam: Set tx and rx ring sizes.
1932 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1934 * @tx_frames_pending: Check if there is any pending frame in the hardware
1935 * queues before entering power save.
1937 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1938 * when transmitting a frame. Currently only legacy rates are handled.
1939 * The callback can sleep.
1940 * @rssi_callback: Notify driver when the average RSSI goes above/below
1941 * thresholds that were registered previously. The callback can sleep.
1943 * @release_buffered_frames: Release buffered frames according to the given
1944 * parameters. In the case where the driver buffers some frames for
1945 * sleeping stations mac80211 will use this callback to tell the driver
1946 * to release some frames, either for PS-poll or uAPSD.
1947 * Note that if the @more_data paramter is %false the driver must check
1948 * if there are more frames on the given TIDs, and if there are more than
1949 * the frames being released then it must still set the more-data bit in
1950 * the frame. If the @more_data parameter is %true, then of course the
1951 * more-data bit must always be set.
1952 * The @tids parameter tells the driver which TIDs to release frames
1953 * from, for PS-poll it will always have only a single bit set.
1954 * In the case this is used for uAPSD, the @num_frames parameter may be
1955 * bigger than one, but the driver may send fewer frames (it must send
1956 * at least one, however). In this case it is also responsible for
1957 * setting the EOSP flag in the QoS header of the frames.
1958 * This callback must be atomic.
1960 struct ieee80211_ops {
1961 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1962 int (*start)(struct ieee80211_hw *hw);
1963 void (*stop)(struct ieee80211_hw *hw);
1965 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
1966 int (*resume)(struct ieee80211_hw *hw);
1968 int (*add_interface)(struct ieee80211_hw *hw,
1969 struct ieee80211_vif *vif);
1970 int (*change_interface)(struct ieee80211_hw *hw,
1971 struct ieee80211_vif *vif,
1972 enum nl80211_iftype new_type, bool p2p);
1973 void (*remove_interface)(struct ieee80211_hw *hw,
1974 struct ieee80211_vif *vif);
1975 int (*config)(struct ieee80211_hw *hw, u32 changed);
1976 void (*bss_info_changed)(struct ieee80211_hw *hw,
1977 struct ieee80211_vif *vif,
1978 struct ieee80211_bss_conf *info,
1981 int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1982 const u8 *bssid, enum ieee80211_tx_sync_type type);
1983 void (*finish_tx_sync)(struct ieee80211_hw *hw,
1984 struct ieee80211_vif *vif,
1986 enum ieee80211_tx_sync_type type);
1988 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1989 struct netdev_hw_addr_list *mc_list);
1990 void (*configure_filter)(struct ieee80211_hw *hw,
1991 unsigned int changed_flags,
1992 unsigned int *total_flags,
1994 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1996 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1997 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1998 struct ieee80211_key_conf *key);
1999 void (*update_tkip_key)(struct ieee80211_hw *hw,
2000 struct ieee80211_vif *vif,
2001 struct ieee80211_key_conf *conf,
2002 struct ieee80211_sta *sta,
2003 u32 iv32, u16 *phase1key);
2004 void (*set_rekey_data)(struct ieee80211_hw *hw,
2005 struct ieee80211_vif *vif,
2006 struct cfg80211_gtk_rekey_data *data);
2007 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2008 struct cfg80211_scan_request *req);
2009 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2010 struct ieee80211_vif *vif);
2011 int (*sched_scan_start)(struct ieee80211_hw *hw,
2012 struct ieee80211_vif *vif,
2013 struct cfg80211_sched_scan_request *req,
2014 struct ieee80211_sched_scan_ies *ies);
2015 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2016 struct ieee80211_vif *vif);
2017 void (*sw_scan_start)(struct ieee80211_hw *hw);
2018 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2019 int (*get_stats)(struct ieee80211_hw *hw,
2020 struct ieee80211_low_level_stats *stats);
2021 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2022 u32 *iv32, u16 *iv16);
2023 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2024 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2025 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2026 struct ieee80211_sta *sta);
2027 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2028 struct ieee80211_sta *sta);
2029 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2030 enum sta_notify_cmd, struct ieee80211_sta *sta);
2031 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
2032 const struct ieee80211_tx_queue_params *params);
2033 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2034 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2036 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2037 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2038 int (*ampdu_action)(struct ieee80211_hw *hw,
2039 struct ieee80211_vif *vif,
2040 enum ieee80211_ampdu_mlme_action action,
2041 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2043 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2044 struct survey_info *survey);
2045 void (*rfkill_poll)(struct ieee80211_hw *hw);
2046 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2047 #ifdef CONFIG_NL80211_TESTMODE
2048 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2049 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2050 struct netlink_callback *cb,
2051 void *data, int len);
2053 void (*flush)(struct ieee80211_hw *hw, bool drop);
2054 void (*channel_switch)(struct ieee80211_hw *hw,
2055 struct ieee80211_channel_switch *ch_switch);
2056 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2057 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2058 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2060 int (*remain_on_channel)(struct ieee80211_hw *hw,
2061 struct ieee80211_channel *chan,
2062 enum nl80211_channel_type channel_type,
2064 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2065 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2066 void (*get_ringparam)(struct ieee80211_hw *hw,
2067 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2068 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2069 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2070 const struct cfg80211_bitrate_mask *mask);
2071 void (*rssi_callback)(struct ieee80211_hw *hw,
2072 enum ieee80211_rssi_event rssi_event);
2074 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2075 struct ieee80211_sta *sta,
2076 u16 tids, int num_frames,
2077 enum ieee80211_frame_release_type reason,
2082 * ieee80211_alloc_hw - Allocate a new hardware device
2084 * This must be called once for each hardware device. The returned pointer
2085 * must be used to refer to this device when calling other functions.
2086 * mac80211 allocates a private data area for the driver pointed to by
2087 * @priv in &struct ieee80211_hw, the size of this area is given as
2090 * @priv_data_len: length of private data
2091 * @ops: callbacks for this device
2093 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2094 const struct ieee80211_ops *ops);
2097 * ieee80211_register_hw - Register hardware device
2099 * You must call this function before any other functions in
2100 * mac80211. Note that before a hardware can be registered, you
2101 * need to fill the contained wiphy's information.
2103 * @hw: the device to register as returned by ieee80211_alloc_hw()
2105 int ieee80211_register_hw(struct ieee80211_hw *hw);
2108 * struct ieee80211_tpt_blink - throughput blink description
2109 * @throughput: throughput in Kbit/sec
2110 * @blink_time: blink time in milliseconds
2111 * (full cycle, ie. one off + one on period)
2113 struct ieee80211_tpt_blink {
2119 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2120 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2121 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2122 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2123 * interface is connected in some way, including being an AP
2125 enum ieee80211_tpt_led_trigger_flags {
2126 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2127 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2128 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2131 #ifdef CONFIG_MAC80211_LEDS
2132 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2133 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2134 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2135 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2136 extern char *__ieee80211_create_tpt_led_trigger(
2137 struct ieee80211_hw *hw, unsigned int flags,
2138 const struct ieee80211_tpt_blink *blink_table,
2139 unsigned int blink_table_len);
2142 * ieee80211_get_tx_led_name - get name of TX LED
2144 * mac80211 creates a transmit LED trigger for each wireless hardware
2145 * that can be used to drive LEDs if your driver registers a LED device.
2146 * This function returns the name (or %NULL if not configured for LEDs)
2147 * of the trigger so you can automatically link the LED device.
2149 * @hw: the hardware to get the LED trigger name for
2151 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2153 #ifdef CONFIG_MAC80211_LEDS
2154 return __ieee80211_get_tx_led_name(hw);
2161 * ieee80211_get_rx_led_name - get name of RX LED
2163 * mac80211 creates a receive LED trigger for each wireless hardware
2164 * that can be used to drive LEDs if your driver registers a LED device.
2165 * This function returns the name (or %NULL if not configured for LEDs)
2166 * of the trigger so you can automatically link the LED device.
2168 * @hw: the hardware to get the LED trigger name for
2170 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2172 #ifdef CONFIG_MAC80211_LEDS
2173 return __ieee80211_get_rx_led_name(hw);
2180 * ieee80211_get_assoc_led_name - get name of association LED
2182 * mac80211 creates a association LED trigger for each wireless hardware
2183 * that can be used to drive LEDs if your driver registers a LED device.
2184 * This function returns the name (or %NULL if not configured for LEDs)
2185 * of the trigger so you can automatically link the LED device.
2187 * @hw: the hardware to get the LED trigger name for
2189 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2191 #ifdef CONFIG_MAC80211_LEDS
2192 return __ieee80211_get_assoc_led_name(hw);
2199 * ieee80211_get_radio_led_name - get name of radio LED
2201 * mac80211 creates a radio change LED trigger for each wireless hardware
2202 * that can be used to drive LEDs if your driver registers a LED device.
2203 * This function returns the name (or %NULL if not configured for LEDs)
2204 * of the trigger so you can automatically link the LED device.
2206 * @hw: the hardware to get the LED trigger name for
2208 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2210 #ifdef CONFIG_MAC80211_LEDS
2211 return __ieee80211_get_radio_led_name(hw);
2218 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2219 * @hw: the hardware to create the trigger for
2220 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2221 * @blink_table: the blink table -- needs to be ordered by throughput
2222 * @blink_table_len: size of the blink table
2224 * This function returns %NULL (in case of error, or if no LED
2225 * triggers are configured) or the name of the new trigger.
2226 * This function must be called before ieee80211_register_hw().
2228 static inline char *
2229 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2230 const struct ieee80211_tpt_blink *blink_table,
2231 unsigned int blink_table_len)
2233 #ifdef CONFIG_MAC80211_LEDS
2234 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2242 * ieee80211_unregister_hw - Unregister a hardware device
2244 * This function instructs mac80211 to free allocated resources
2245 * and unregister netdevices from the networking subsystem.
2247 * @hw: the hardware to unregister
2249 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2252 * ieee80211_free_hw - free hardware descriptor
2254 * This function frees everything that was allocated, including the
2255 * private data for the driver. You must call ieee80211_unregister_hw()
2256 * before calling this function.
2258 * @hw: the hardware to free
2260 void ieee80211_free_hw(struct ieee80211_hw *hw);
2263 * ieee80211_restart_hw - restart hardware completely
2265 * Call this function when the hardware was restarted for some reason
2266 * (hardware error, ...) and the driver is unable to restore its state
2267 * by itself. mac80211 assumes that at this point the driver/hardware
2268 * is completely uninitialised and stopped, it starts the process by
2269 * calling the ->start() operation. The driver will need to reset all
2270 * internal state that it has prior to calling this function.
2272 * @hw: the hardware to restart
2274 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2276 /** ieee80211_napi_schedule - schedule NAPI poll
2278 * Use this function to schedule NAPI polling on a device.
2280 * @hw: the hardware to start polling
2282 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2284 /** ieee80211_napi_complete - complete NAPI polling
2286 * Use this function to finish NAPI polling on a device.
2288 * @hw: the hardware to stop polling
2290 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2293 * ieee80211_rx - receive frame
2295 * Use this function to hand received frames to mac80211. The receive
2296 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2297 * paged @skb is used, the driver is recommended to put the ieee80211
2298 * header of the frame on the linear part of the @skb to avoid memory
2299 * allocation and/or memcpy by the stack.
2301 * This function may not be called in IRQ context. Calls to this function
2302 * for a single hardware must be synchronized against each other. Calls to
2303 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2304 * mixed for a single hardware.
2306 * In process context use instead ieee80211_rx_ni().
2308 * @hw: the hardware this frame came in on
2309 * @skb: the buffer to receive, owned by mac80211 after this call
2311 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2314 * ieee80211_rx_irqsafe - receive frame
2316 * Like ieee80211_rx() but can be called in IRQ context
2317 * (internally defers to a tasklet.)
2319 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2320 * be mixed for a single hardware.
2322 * @hw: the hardware this frame came in on
2323 * @skb: the buffer to receive, owned by mac80211 after this call
2325 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2328 * ieee80211_rx_ni - receive frame (in process context)
2330 * Like ieee80211_rx() but can be called in process context
2331 * (internally disables bottom halves).
2333 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2334 * not be mixed for a single hardware.
2336 * @hw: the hardware this frame came in on
2337 * @skb: the buffer to receive, owned by mac80211 after this call
2339 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2340 struct sk_buff *skb)
2343 ieee80211_rx(hw, skb);
2348 * ieee80211_sta_ps_transition - PS transition for connected sta
2350 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2351 * flag set, use this function to inform mac80211 about a connected station
2352 * entering/leaving PS mode.
2354 * This function may not be called in IRQ context or with softirqs enabled.
2356 * Calls to this function for a single hardware must be synchronized against
2359 * The function returns -EINVAL when the requested PS mode is already set.
2361 * @sta: currently connected sta
2362 * @start: start or stop PS
2364 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2367 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2368 * (in process context)
2370 * Like ieee80211_sta_ps_transition() but can be called in process context
2371 * (internally disables bottom halves). Concurrent call restriction still
2374 * @sta: currently connected sta
2375 * @start: start or stop PS
2377 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2383 ret = ieee80211_sta_ps_transition(sta, start);
2390 * The TX headroom reserved by mac80211 for its own tx_status functions.
2391 * This is enough for the radiotap header.
2393 #define IEEE80211_TX_STATUS_HEADROOM 13
2396 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2397 * @sta: &struct ieee80211_sta pointer for the sleeping station
2398 * @tid: the TID that has buffered frames
2399 * @buffered: indicates whether or not frames are buffered for this TID
2401 * If a driver buffers frames for a powersave station instead of passing
2402 * them back to mac80211 for retransmission, the station may still need
2403 * to be told that there are buffered frames via the TIM bit.
2405 * This function informs mac80211 whether or not there are frames that are
2406 * buffered in the driver for a given TID; mac80211 can then use this data
2407 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2408 * call! Beware of the locking!)
2410 * If all frames are released to the station (due to PS-poll or uAPSD)
2411 * then the driver needs to inform mac80211 that there no longer are
2412 * frames buffered. However, when the station wakes up mac80211 assumes
2413 * that all buffered frames will be transmitted and clears this data,
2414 * drivers need to make sure they inform mac80211 about all buffered
2415 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2417 * Note that technically mac80211 only needs to know this per AC, not per
2418 * TID, but since driver buffering will inevitably happen per TID (since
2419 * it is related to aggregation) it is easier to make mac80211 map the
2420 * TID to the AC as required instead of keeping track in all drivers that
2423 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2424 u8 tid, bool buffered);
2427 * ieee80211_tx_status - transmit status callback
2429 * Call this function for all transmitted frames after they have been
2430 * transmitted. It is permissible to not call this function for
2431 * multicast frames but this can affect statistics.
2433 * This function may not be called in IRQ context. Calls to this function
2434 * for a single hardware must be synchronized against each other. Calls
2435 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2436 * may not be mixed for a single hardware.
2438 * @hw: the hardware the frame was transmitted by
2439 * @skb: the frame that was transmitted, owned by mac80211 after this call
2441 void ieee80211_tx_status(struct ieee80211_hw *hw,
2442 struct sk_buff *skb);
2445 * ieee80211_tx_status_ni - transmit status callback (in process context)
2447 * Like ieee80211_tx_status() but can be called in process context.
2449 * Calls to this function, ieee80211_tx_status() and
2450 * ieee80211_tx_status_irqsafe() may not be mixed
2451 * for a single hardware.
2453 * @hw: the hardware the frame was transmitted by
2454 * @skb: the frame that was transmitted, owned by mac80211 after this call
2456 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2457 struct sk_buff *skb)
2460 ieee80211_tx_status(hw, skb);
2465 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2467 * Like ieee80211_tx_status() but can be called in IRQ context
2468 * (internally defers to a tasklet.)
2470 * Calls to this function, ieee80211_tx_status() and
2471 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2473 * @hw: the hardware the frame was transmitted by
2474 * @skb: the frame that was transmitted, owned by mac80211 after this call
2476 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2477 struct sk_buff *skb);
2480 * ieee80211_report_low_ack - report non-responding station
2482 * When operating in AP-mode, call this function to report a non-responding
2485 * @sta: the non-responding connected sta
2486 * @num_packets: number of packets sent to @sta without a response
2488 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2491 * ieee80211_beacon_get_tim - beacon generation function
2492 * @hw: pointer obtained from ieee80211_alloc_hw().
2493 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2494 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2495 * Set to 0 if invalid (in non-AP modes).
2496 * @tim_length: pointer to variable that will receive the TIM IE length,
2497 * (including the ID and length bytes!).
2498 * Set to 0 if invalid (in non-AP modes).
2500 * If the driver implements beaconing modes, it must use this function to
2501 * obtain the beacon frame/template.
2503 * If the beacon frames are generated by the host system (i.e., not in
2504 * hardware/firmware), the driver uses this function to get each beacon
2505 * frame from mac80211 -- it is responsible for calling this function
2506 * before the beacon is needed (e.g. based on hardware interrupt).
2508 * If the beacon frames are generated by the device, then the driver
2509 * must use the returned beacon as the template and change the TIM IE
2510 * according to the current DTIM parameters/TIM bitmap.
2512 * The driver is responsible for freeing the returned skb.
2514 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2515 struct ieee80211_vif *vif,
2516 u16 *tim_offset, u16 *tim_length);
2519 * ieee80211_beacon_get - beacon generation function
2520 * @hw: pointer obtained from ieee80211_alloc_hw().
2521 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2523 * See ieee80211_beacon_get_tim().
2525 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2526 struct ieee80211_vif *vif)
2528 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2532 * ieee80211_pspoll_get - retrieve a PS Poll template
2533 * @hw: pointer obtained from ieee80211_alloc_hw().
2534 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2536 * Creates a PS Poll a template which can, for example, uploaded to
2537 * hardware. The template must be updated after association so that correct
2538 * AID, BSSID and MAC address is used.
2540 * Note: Caller (or hardware) is responsible for setting the
2541 * &IEEE80211_FCTL_PM bit.
2543 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2544 struct ieee80211_vif *vif);
2547 * ieee80211_nullfunc_get - retrieve a nullfunc template
2548 * @hw: pointer obtained from ieee80211_alloc_hw().
2549 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2551 * Creates a Nullfunc template which can, for example, uploaded to
2552 * hardware. The template must be updated after association so that correct
2553 * BSSID and address is used.
2555 * Note: Caller (or hardware) is responsible for setting the
2556 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2558 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2559 struct ieee80211_vif *vif);
2562 * ieee80211_probereq_get - retrieve a Probe Request template
2563 * @hw: pointer obtained from ieee80211_alloc_hw().
2564 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2565 * @ssid: SSID buffer
2566 * @ssid_len: length of SSID
2567 * @ie: buffer containing all IEs except SSID for the template
2568 * @ie_len: length of the IE buffer
2570 * Creates a Probe Request template which can, for example, be uploaded to
2573 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2574 struct ieee80211_vif *vif,
2575 const u8 *ssid, size_t ssid_len,
2576 const u8 *ie, size_t ie_len);
2579 * ieee80211_rts_get - RTS frame generation function
2580 * @hw: pointer obtained from ieee80211_alloc_hw().
2581 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2582 * @frame: pointer to the frame that is going to be protected by the RTS.
2583 * @frame_len: the frame length (in octets).
2584 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2585 * @rts: The buffer where to store the RTS frame.
2587 * If the RTS frames are generated by the host system (i.e., not in
2588 * hardware/firmware), the low-level driver uses this function to receive
2589 * the next RTS frame from the 802.11 code. The low-level is responsible
2590 * for calling this function before and RTS frame is needed.
2592 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2593 const void *frame, size_t frame_len,
2594 const struct ieee80211_tx_info *frame_txctl,
2595 struct ieee80211_rts *rts);
2598 * ieee80211_rts_duration - Get the duration field for an RTS frame
2599 * @hw: pointer obtained from ieee80211_alloc_hw().
2600 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2601 * @frame_len: the length of the frame that is going to be protected by the RTS.
2602 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2604 * If the RTS is generated in firmware, but the host system must provide
2605 * the duration field, the low-level driver uses this function to receive
2606 * the duration field value in little-endian byteorder.
2608 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2609 struct ieee80211_vif *vif, size_t frame_len,
2610 const struct ieee80211_tx_info *frame_txctl);
2613 * ieee80211_ctstoself_get - CTS-to-self 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 CTS-to-self.
2617 * @frame_len: the frame length (in octets).
2618 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2619 * @cts: The buffer where to store the CTS-to-self frame.
2621 * If the CTS-to-self 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 CTS-to-self frame from the 802.11 code. The low-level is responsible
2624 * for calling this function before and CTS-to-self frame is needed.
2626 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2627 struct ieee80211_vif *vif,
2628 const void *frame, size_t frame_len,
2629 const struct ieee80211_tx_info *frame_txctl,
2630 struct ieee80211_cts *cts);
2633 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2634 * @hw: pointer obtained from ieee80211_alloc_hw().
2635 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2636 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2637 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2639 * If the CTS-to-self is generated in firmware, but the host system must provide
2640 * the duration field, the low-level driver uses this function to receive
2641 * the duration field value in little-endian byteorder.
2643 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2644 struct ieee80211_vif *vif,
2646 const struct ieee80211_tx_info *frame_txctl);
2649 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2650 * @hw: pointer obtained from ieee80211_alloc_hw().
2651 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2652 * @frame_len: the length of the frame.
2653 * @rate: the rate at which the frame is going to be transmitted.
2655 * Calculate the duration field of some generic frame, given its
2656 * length and transmission rate (in 100kbps).
2658 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2659 struct ieee80211_vif *vif,
2661 struct ieee80211_rate *rate);
2664 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2665 * @hw: pointer as obtained from ieee80211_alloc_hw().
2666 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2668 * Function for accessing buffered broadcast and multicast frames. If
2669 * hardware/firmware does not implement buffering of broadcast/multicast
2670 * frames when power saving is used, 802.11 code buffers them in the host
2671 * memory. The low-level driver uses this function to fetch next buffered
2672 * frame. In most cases, this is used when generating beacon frame. This
2673 * function returns a pointer to the next buffered skb or NULL if no more
2674 * buffered frames are available.
2676 * Note: buffered frames are returned only after DTIM beacon frame was
2677 * generated with ieee80211_beacon_get() and the low-level driver must thus
2678 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2679 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2680 * does not need to check for DTIM beacons separately and should be able to
2681 * use common code for all beacons.
2684 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2687 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2689 * This function returns the TKIP phase 1 key for the given IV32.
2691 * @keyconf: the parameter passed with the set key
2692 * @iv32: IV32 to get the P1K for
2693 * @p1k: a buffer to which the key will be written, as 5 u16 values
2695 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2696 u32 iv32, u16 *p1k);
2699 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2701 * This function returns the TKIP phase 1 key for the IV32 taken
2702 * from the given packet.
2704 * @keyconf: the parameter passed with the set key
2705 * @skb: the packet to take the IV32 value from that will be encrypted
2707 * @p1k: a buffer to which the key will be written, as 5 u16 values
2709 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2710 struct sk_buff *skb, u16 *p1k)
2712 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2713 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2714 u32 iv32 = get_unaligned_le32(&data[4]);
2716 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2720 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2722 * This function returns the TKIP phase 1 key for the given IV32
2723 * and transmitter address.
2725 * @keyconf: the parameter passed with the set key
2726 * @ta: TA that will be used with the key
2727 * @iv32: IV32 to get the P1K for
2728 * @p1k: a buffer to which the key will be written, as 5 u16 values
2730 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2731 const u8 *ta, u32 iv32, u16 *p1k);
2734 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2736 * This function computes the TKIP RC4 key for the IV values
2739 * @keyconf: the parameter passed with the set key
2740 * @skb: the packet to take the IV32/IV16 values from that will be
2741 * encrypted with this key
2742 * @p2k: a buffer to which the key will be written, 16 bytes
2744 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2745 struct sk_buff *skb, u8 *p2k);
2748 * struct ieee80211_key_seq - key sequence counter
2750 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2751 * @ccmp: PN data, most significant byte first (big endian,
2752 * reverse order than in packet)
2753 * @aes_cmac: PN data, most significant byte first (big endian,
2754 * reverse order than in packet)
2756 struct ieee80211_key_seq {
2772 * ieee80211_get_key_tx_seq - get key TX sequence counter
2774 * @keyconf: the parameter passed with the set key
2775 * @seq: buffer to receive the sequence data
2777 * This function allows a driver to retrieve the current TX IV/PN
2778 * for the given key. It must not be called if IV generation is
2779 * offloaded to the device.
2781 * Note that this function may only be called when no TX processing
2782 * can be done concurrently, for example when queues are stopped
2783 * and the stop has been synchronized.
2785 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2786 struct ieee80211_key_seq *seq);
2789 * ieee80211_get_key_rx_seq - get key RX sequence counter
2791 * @keyconf: the parameter passed with the set key
2792 * @tid: The TID, or -1 for the management frame value (CCMP only);
2793 * the value on TID 0 is also used for non-QoS frames. For
2794 * CMAC, only TID 0 is valid.
2795 * @seq: buffer to receive the sequence data
2797 * This function allows a driver to retrieve the current RX IV/PNs
2798 * for the given key. It must not be called if IV checking is done
2799 * by the device and not by mac80211.
2801 * Note that this function may only be called when no RX processing
2802 * can be done concurrently.
2804 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2805 int tid, struct ieee80211_key_seq *seq);
2808 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2809 * @vif: virtual interface the rekeying was done on
2810 * @bssid: The BSSID of the AP, for checking association
2811 * @replay_ctr: the new replay counter after GTK rekeying
2812 * @gfp: allocation flags
2814 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2815 const u8 *replay_ctr, gfp_t gfp);
2818 * ieee80211_wake_queue - wake specific queue
2819 * @hw: pointer as obtained from ieee80211_alloc_hw().
2820 * @queue: queue number (counted from zero).
2822 * Drivers should use this function instead of netif_wake_queue.
2824 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2827 * ieee80211_stop_queue - stop specific queue
2828 * @hw: pointer as obtained from ieee80211_alloc_hw().
2829 * @queue: queue number (counted from zero).
2831 * Drivers should use this function instead of netif_stop_queue.
2833 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2836 * ieee80211_queue_stopped - test status of the queue
2837 * @hw: pointer as obtained from ieee80211_alloc_hw().
2838 * @queue: queue number (counted from zero).
2840 * Drivers should use this function instead of netif_stop_queue.
2843 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2846 * ieee80211_stop_queues - stop all queues
2847 * @hw: pointer as obtained from ieee80211_alloc_hw().
2849 * Drivers should use this function instead of netif_stop_queue.
2851 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2854 * ieee80211_wake_queues - wake all queues
2855 * @hw: pointer as obtained from ieee80211_alloc_hw().
2857 * Drivers should use this function instead of netif_wake_queue.
2859 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2862 * ieee80211_scan_completed - completed hardware scan
2864 * When hardware scan offload is used (i.e. the hw_scan() callback is
2865 * assigned) this function needs to be called by the driver to notify
2866 * mac80211 that the scan finished. This function can be called from
2867 * any context, including hardirq context.
2869 * @hw: the hardware that finished the scan
2870 * @aborted: set to true if scan was aborted
2872 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2875 * ieee80211_sched_scan_results - got results from scheduled scan
2877 * When a scheduled scan is running, this function needs to be called by the
2878 * driver whenever there are new scan results available.
2880 * @hw: the hardware that is performing scheduled scans
2882 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
2885 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2887 * When a scheduled scan is running, this function can be called by
2888 * the driver if it needs to stop the scan to perform another task.
2889 * Usual scenarios are drivers that cannot continue the scheduled scan
2890 * while associating, for instance.
2892 * @hw: the hardware that is performing scheduled scans
2894 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
2897 * ieee80211_iterate_active_interfaces - iterate active interfaces
2899 * This function iterates over the interfaces associated with a given
2900 * hardware that are currently active and calls the callback for them.
2901 * This function allows the iterator function to sleep, when the iterator
2902 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2904 * Does not iterate over a new interface during add_interface()
2906 * @hw: the hardware struct of which the interfaces should be iterated over
2907 * @iterator: the iterator function to call
2908 * @data: first argument of the iterator function
2910 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2911 void (*iterator)(void *data, u8 *mac,
2912 struct ieee80211_vif *vif),
2916 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2918 * This function iterates over the interfaces associated with a given
2919 * hardware that are currently active and calls the callback for them.
2920 * This function requires the iterator callback function to be atomic,
2921 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2922 * Does not iterate over a new interface during add_interface()
2924 * @hw: the hardware struct of which the interfaces should be iterated over
2925 * @iterator: the iterator function to call, cannot sleep
2926 * @data: first argument of the iterator function
2928 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2929 void (*iterator)(void *data,
2931 struct ieee80211_vif *vif),
2935 * ieee80211_queue_work - add work onto the mac80211 workqueue
2937 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2938 * This helper ensures drivers are not queueing work when they should not be.
2940 * @hw: the hardware struct for the interface we are adding work for
2941 * @work: the work we want to add onto the mac80211 workqueue
2943 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2946 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2948 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2951 * @hw: the hardware struct for the interface we are adding work for
2952 * @dwork: delayable work to queue onto the mac80211 workqueue
2953 * @delay: number of jiffies to wait before queueing
2955 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2956 struct delayed_work *dwork,
2957 unsigned long delay);
2960 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2961 * @sta: the station for which to start a BA session
2962 * @tid: the TID to BA on.
2963 * @timeout: session timeout value (in TUs)
2965 * Return: success if addBA request was sent, failure otherwise
2967 * Although mac80211/low level driver/user space application can estimate
2968 * the need to start aggregation on a certain RA/TID, the session level
2969 * will be managed by the mac80211.
2971 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2975 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2976 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2977 * @ra: receiver address of the BA session recipient.
2978 * @tid: the TID to BA on.
2980 * This function must be called by low level driver once it has
2981 * finished with preparations for the BA session. It can be called
2984 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2988 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2989 * @sta: the station whose BA session to stop
2990 * @tid: the TID to stop BA.
2992 * Return: negative error if the TID is invalid, or no aggregation active
2994 * Although mac80211/low level driver/user space application can estimate
2995 * the need to stop aggregation on a certain RA/TID, the session level
2996 * will be managed by the mac80211.
2998 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3001 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3002 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3003 * @ra: receiver address of the BA session recipient.
3004 * @tid: the desired TID to BA on.
3006 * This function must be called by low level driver once it has
3007 * finished with preparations for the BA session tear down. It
3008 * can be called from any context.
3010 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3014 * ieee80211_find_sta - find a station
3016 * @vif: virtual interface to look for station on
3017 * @addr: station's address
3019 * This function must be called under RCU lock and the
3020 * resulting pointer is only valid under RCU lock as well.
3022 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3026 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3028 * @hw: pointer as obtained from ieee80211_alloc_hw()
3029 * @addr: remote station's address
3030 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3032 * This function must be called under RCU lock and the
3033 * resulting pointer is only valid under RCU lock as well.
3035 * NOTE: You may pass NULL for localaddr, but then you will just get
3036 * the first STA that matches the remote address 'addr'.
3037 * We can have multiple STA associated with multiple
3038 * logical stations (e.g. consider a station connecting to another
3039 * BSSID on the same AP hardware without disconnecting first).
3040 * In this case, the result of this method with localaddr NULL
3043 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3045 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3047 const u8 *localaddr);
3050 * ieee80211_sta_block_awake - block station from waking up
3052 * @pubsta: the station
3053 * @block: whether to block or unblock
3055 * Some devices require that all frames that are on the queues
3056 * for a specific station that went to sleep are flushed before
3057 * a poll response or frames after the station woke up can be
3058 * delivered to that it. Note that such frames must be rejected
3059 * by the driver as filtered, with the appropriate status flag.
3061 * This function allows implementing this mode in a race-free
3064 * To do this, a driver must keep track of the number of frames
3065 * still enqueued for a specific station. If this number is not
3066 * zero when the station goes to sleep, the driver must call
3067 * this function to force mac80211 to consider the station to
3068 * be asleep regardless of the station's actual state. Once the
3069 * number of outstanding frames reaches zero, the driver must
3070 * call this function again to unblock the station. That will
3071 * cause mac80211 to be able to send ps-poll responses, and if
3072 * the station queried in the meantime then frames will also
3073 * be sent out as a result of this. Additionally, the driver
3074 * will be notified that the station woke up some time after
3075 * it is unblocked, regardless of whether the station actually
3076 * woke up while blocked or not.
3078 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3079 struct ieee80211_sta *pubsta, bool block);
3082 * ieee80211_iter_keys - iterate keys programmed into the device
3083 * @hw: pointer obtained from ieee80211_alloc_hw()
3084 * @vif: virtual interface to iterate, may be %NULL for all
3085 * @iter: iterator function that will be called for each key
3086 * @iter_data: custom data to pass to the iterator function
3088 * This function can be used to iterate all the keys known to
3089 * mac80211, even those that weren't previously programmed into
3090 * the device. This is intended for use in WoWLAN if the device
3091 * needs reprogramming of the keys during suspend. Note that due
3092 * to locking reasons, it is also only safe to call this at few
3093 * spots since it must hold the RTNL and be able to sleep.
3095 * The order in which the keys are iterated matches the order
3096 * in which they were originally installed and handed to the
3099 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3100 struct ieee80211_vif *vif,
3101 void (*iter)(struct ieee80211_hw *hw,
3102 struct ieee80211_vif *vif,
3103 struct ieee80211_sta *sta,
3104 struct ieee80211_key_conf *key,
3109 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3110 * @hw: pointer obtained from ieee80211_alloc_hw().
3111 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3113 * Creates a Probe Request template which can, for example, be uploaded to
3114 * hardware. The template is filled with bssid, ssid and supported rate
3115 * information. This function must only be called from within the
3116 * .bss_info_changed callback function and only in managed mode. The function
3117 * is only useful when the interface is associated, otherwise it will return
3120 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3121 struct ieee80211_vif *vif);
3124 * ieee80211_beacon_loss - inform hardware does not receive beacons
3126 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3128 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
3129 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3130 * hardware is not receiving beacons with this function.
3132 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3135 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3137 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3139 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
3140 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3141 * needs to inform if the connection to the AP has been lost.
3143 * This function will cause immediate change to disassociated state,
3144 * without connection recovery attempts.
3146 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3149 * ieee80211_resume_disconnect - disconnect from AP after resume
3151 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3153 * Instructs mac80211 to disconnect from the AP after resume.
3154 * Drivers can use this after WoWLAN if they know that the
3155 * connection cannot be kept up, for example because keys were
3156 * used while the device was asleep but the replay counters or
3157 * similar cannot be retrieved from the device during resume.
3159 * Note that due to implementation issues, if the driver uses
3160 * the reconfiguration functionality during resume the interface
3161 * will still be added as associated first during resume and then
3162 * disconnect normally later.
3164 * This function can only be called from the resume callback and
3165 * the driver must not be holding any of its own locks while it
3166 * calls this function, or at least not any locks it needs in the
3167 * key configuration paths (if it supports HW crypto).
3169 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3172 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3174 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3176 * Some hardware require full power save to manage simultaneous BT traffic
3177 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3178 * burst of BT traffic. The hardware gets information of BT traffic via
3179 * hardware co-existence lines, and consequentially requests mac80211 to
3180 * (temporarily) enter full psm.
3181 * This function will only temporarily disable dynamic PS, not enable PSM if
3182 * it was not already enabled.
3183 * The driver must make sure to re-enable dynamic PS using
3184 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3187 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3190 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3192 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3194 * This function restores dynamic PS after being temporarily disabled via
3195 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3196 * be coupled with an eventual call to this function.
3199 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3202 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3203 * rssi threshold triggered
3205 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3206 * @rssi_event: the RSSI trigger event type
3207 * @gfp: context flags
3209 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3210 * monitoring is configured with an rssi threshold, the driver will inform
3211 * whenever the rssi level reaches the threshold.
3213 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3214 enum nl80211_cqm_rssi_threshold_event rssi_event,
3218 * ieee80211_get_operstate - get the operstate of the vif
3220 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3222 * The driver might need to know the operstate of the net_device
3223 * (specifically, whether the link is IF_OPER_UP after resume)
3225 unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3228 * ieee80211_chswitch_done - Complete channel switch process
3229 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3230 * @success: make the channel switch successful or not
3232 * Complete the channel switch post-process: set the new operational channel
3233 * and wake up the suspended queues.
3235 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3238 * ieee80211_request_smps - request SM PS transition
3239 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3240 * @smps_mode: new SM PS mode
3242 * This allows the driver to request an SM PS transition in managed
3243 * mode. This is useful when the driver has more information than
3244 * the stack about possible interference, for example by bluetooth.
3246 void ieee80211_request_smps(struct ieee80211_vif *vif,
3247 enum ieee80211_smps_mode smps_mode);
3250 * ieee80211_key_removed - disable hw acceleration for key
3251 * @key_conf: The key hw acceleration should be disabled for
3253 * This allows drivers to indicate that the given key has been
3254 * removed from hardware acceleration, due to a new key that
3255 * was added. Don't use this if the key can continue to be used
3256 * for TX, if the key restriction is on RX only it is permitted
3257 * to keep the key for TX only and not call this function.
3259 * Due to locking constraints, it may only be called during
3260 * @set_key. This function must be allowed to sleep, and the
3261 * key it tries to disable may still be used until it returns.
3263 void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3266 * ieee80211_ready_on_channel - notification of remain-on-channel start
3267 * @hw: pointer as obtained from ieee80211_alloc_hw()
3269 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3272 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3273 * @hw: pointer as obtained from ieee80211_alloc_hw()
3275 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3278 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3280 * in order not to harm the system performance and user experience, the device
3281 * may request not to allow any rx ba session and tear down existing rx ba
3282 * sessions based on system constraints such as periodic BT activity that needs
3283 * to limit wlan activity (eg.sco or a2dp)."
3284 * in such cases, the intention is to limit the duration of the rx ppdu and
3285 * therefore prevent the peer device to use a-mpdu aggregation.
3287 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3288 * @ba_rx_bitmap: Bit map of open rx ba per tid
3289 * @addr: & to bssid mac address
3291 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3295 * ieee80211_send_bar - send a BlockAckReq frame
3297 * can be used to flush pending frames from the peer's aggregation reorder
3300 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3301 * @ra: the peer's destination address
3302 * @tid: the TID of the aggregation session
3303 * @ssn: the new starting sequence number for the receiver
3305 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3307 /* Rate control API */
3310 * enum rate_control_changed - flags to indicate which parameter changed
3312 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3313 * changed, rate control algorithm can update its internal state if needed.
3315 enum rate_control_changed {
3316 IEEE80211_RC_HT_CHANGED = BIT(0)
3320 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3322 * @hw: The hardware the algorithm is invoked for.
3323 * @sband: The band this frame is being transmitted on.
3324 * @bss_conf: the current BSS configuration
3325 * @reported_rate: The rate control algorithm can fill this in to indicate
3326 * which rate should be reported to userspace as the current rate and
3327 * used for rate calculations in the mesh network.
3328 * @rts: whether RTS will be used for this frame because it is longer than the
3330 * @short_preamble: whether mac80211 will request short-preamble transmission
3331 * if the selected rate supports it
3332 * @max_rate_idx: user-requested maximum rate (not MCS for now)
3333 * (deprecated; this will be removed once drivers get updated to use
3335 * @rate_idx_mask: user-requested rate mask (not MCS for now)
3336 * @skb: the skb that will be transmitted, the control information in it needs
3338 * @bss: whether this frame is sent out in AP or IBSS mode
3340 struct ieee80211_tx_rate_control {
3341 struct ieee80211_hw *hw;
3342 struct ieee80211_supported_band *sband;
3343 struct ieee80211_bss_conf *bss_conf;
3344 struct sk_buff *skb;
3345 struct ieee80211_tx_rate reported_rate;
3346 bool rts, short_preamble;
3352 struct rate_control_ops {
3353 struct module *module;
3355 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3356 void (*free)(void *priv);
3358 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3359 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3360 struct ieee80211_sta *sta, void *priv_sta);
3361 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3362 struct ieee80211_sta *sta,
3363 void *priv_sta, u32 changed,
3364 enum nl80211_channel_type oper_chan_type);
3365 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3368 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3369 struct ieee80211_sta *sta, void *priv_sta,
3370 struct sk_buff *skb);
3371 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3372 struct ieee80211_tx_rate_control *txrc);
3374 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3375 struct dentry *dir);
3376 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3379 static inline int rate_supported(struct ieee80211_sta *sta,
3380 enum ieee80211_band band,
3383 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3387 * rate_control_send_low - helper for drivers for management/no-ack frames
3389 * Rate control algorithms that agree to use the lowest rate to
3390 * send management frames and NO_ACK data with the respective hw
3391 * retries should use this in the beginning of their mac80211 get_rate
3392 * callback. If true is returned the rate control can simply return.
3393 * If false is returned we guarantee that sta and sta and priv_sta is
3396 * Rate control algorithms wishing to do more intelligent selection of
3397 * rate for multicast/broadcast frames may choose to not use this.
3399 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3400 * that this may be null.
3401 * @priv_sta: private rate control structure. This may be null.
3402 * @txrc: rate control information we sholud populate for mac80211.
3404 bool rate_control_send_low(struct ieee80211_sta *sta,
3406 struct ieee80211_tx_rate_control *txrc);
3410 rate_lowest_index(struct ieee80211_supported_band *sband,
3411 struct ieee80211_sta *sta)
3415 for (i = 0; i < sband->n_bitrates; i++)
3416 if (rate_supported(sta, sband->band, i))
3419 /* warn when we cannot find a rate. */
3426 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3427 struct ieee80211_sta *sta)
3431 for (i = 0; i < sband->n_bitrates; i++)
3432 if (rate_supported(sta, sband->band, i))
3437 int ieee80211_rate_control_register(struct rate_control_ops *ops);
3438 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3441 conf_is_ht20(struct ieee80211_conf *conf)
3443 return conf->channel_type == NL80211_CHAN_HT20;
3447 conf_is_ht40_minus(struct ieee80211_conf *conf)
3449 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3453 conf_is_ht40_plus(struct ieee80211_conf *conf)
3455 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3459 conf_is_ht40(struct ieee80211_conf *conf)
3461 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3465 conf_is_ht(struct ieee80211_conf *conf)
3467 return conf->channel_type != NL80211_CHAN_NO_HT;
3470 static inline enum nl80211_iftype
3471 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3475 case NL80211_IFTYPE_STATION:
3476 return NL80211_IFTYPE_P2P_CLIENT;
3477 case NL80211_IFTYPE_AP:
3478 return NL80211_IFTYPE_P2P_GO;
3486 static inline enum nl80211_iftype
3487 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3489 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3492 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3494 int rssi_max_thold);
3496 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3498 int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
3500 int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
3501 struct sk_buff *skb);
3502 #endif /* MAC80211_H */