2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
97 enum ieee80211_max_queues
{
98 IEEE80211_MAX_QUEUES
= 4,
102 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
103 * @IEEE80211_AC_VO: voice
104 * @IEEE80211_AC_VI: video
105 * @IEEE80211_AC_BE: best effort
106 * @IEEE80211_AC_BK: background
108 enum ieee80211_ac_numbers
{
114 #define IEEE80211_NUM_ACS 4
117 * struct ieee80211_tx_queue_params - transmit queue configuration
119 * The information provided in this structure is required for QoS
120 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
122 * @aifs: arbitration interframe space [0..255]
123 * @cw_min: minimum contention window [a value of the form
124 * 2^n-1 in the range 1..32767]
125 * @cw_max: maximum contention window [like @cw_min]
126 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
127 * @uapsd: is U-APSD mode enabled for the queue
129 struct ieee80211_tx_queue_params
{
137 struct ieee80211_low_level_stats
{
138 unsigned int dot11ACKFailureCount
;
139 unsigned int dot11RTSFailureCount
;
140 unsigned int dot11FCSErrorCount
;
141 unsigned int dot11RTSSuccessCount
;
145 * enum ieee80211_bss_change - BSS change notification flags
147 * These flags are used with the bss_info_changed() callback
148 * to indicate which BSS parameter changed.
150 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
151 * also implies a change in the AID.
152 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
153 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
154 * @BSS_CHANGED_ERP_SLOT: slot timing changed
155 * @BSS_CHANGED_HT: 802.11n parameters changed
156 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
157 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
158 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
159 * reason (IBSS and managed mode)
160 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
161 * new beacon (beaconing modes)
162 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
163 * enabled/disabled (beaconing modes)
164 * @BSS_CHANGED_CQM: Connection quality monitor config changed
165 * @BSS_CHANGED_IBSS: IBSS join status changed
166 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
167 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
168 * that it is only ever disabled for station mode.
169 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
170 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
171 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
173 enum ieee80211_bss_change
{
174 BSS_CHANGED_ASSOC
= 1<<0,
175 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
176 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
177 BSS_CHANGED_ERP_SLOT
= 1<<3,
178 BSS_CHANGED_HT
= 1<<4,
179 BSS_CHANGED_BASIC_RATES
= 1<<5,
180 BSS_CHANGED_BEACON_INT
= 1<<6,
181 BSS_CHANGED_BSSID
= 1<<7,
182 BSS_CHANGED_BEACON
= 1<<8,
183 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
184 BSS_CHANGED_CQM
= 1<<10,
185 BSS_CHANGED_IBSS
= 1<<11,
186 BSS_CHANGED_ARP_FILTER
= 1<<12,
187 BSS_CHANGED_QOS
= 1<<13,
188 BSS_CHANGED_IDLE
= 1<<14,
189 BSS_CHANGED_SSID
= 1<<15,
190 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
192 /* when adding here, make sure to change ieee80211_reconfig */
196 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
197 * of addresses for an interface increase beyond this value, hardware ARP
198 * filtering will be disabled.
200 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
203 * enum ieee80211_rssi_event - RSSI threshold event
204 * An indicator for when RSSI goes below/above a certain threshold.
205 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
206 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
208 enum ieee80211_rssi_event
{
214 * struct ieee80211_bss_conf - holds the BSS's changing parameters
216 * This structure keeps information about a BSS (and an association
217 * to that BSS) that can change during the lifetime of the BSS.
219 * @assoc: association status
220 * @ibss_joined: indicates whether this station is part of an IBSS
222 * @aid: association ID number, valid only when @assoc is true
223 * @use_cts_prot: use CTS protection
224 * @use_short_preamble: use 802.11b short preamble;
225 * if the hardware cannot handle this it must set the
226 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
227 * @use_short_slot: use short slot time (only relevant for ERP);
228 * if the hardware cannot handle this it must set the
229 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
230 * @dtim_period: num of beacons before the next DTIM, for beaconing,
231 * valid in station mode only while @assoc is true and if also
232 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
234 * @last_tsf: last beacon's/probe response's TSF timestamp (could be old
235 * as it may have been received during scanning long ago)
236 * @beacon_int: beacon interval
237 * @assoc_capability: capabilities taken from assoc resp
238 * @basic_rates: bitmap of basic rates, each bit stands for an
239 * index into the rate table configured by the driver in
241 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
242 * @bssid: The BSSID for this BSS
243 * @enable_beacon: whether beaconing should be enabled or not
244 * @channel_type: Channel type for this BSS -- the hardware might be
245 * configured for HT40+ while this BSS only uses no-HT, for
247 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
248 * This field is only valid when the channel type is one of the HT types.
249 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
251 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
252 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
253 * may filter ARP queries targeted for other addresses than listed here.
254 * The driver must allow ARP queries targeted for all address listed here
255 * to pass through. An empty list implies no ARP queries need to pass.
256 * @arp_addr_cnt: Number of addresses currently on the list.
257 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
258 * filter ARP queries based on the @arp_addr_list, if disabled, the
259 * hardware must not perform any ARP filtering. Note, that the filter will
260 * be enabled also in promiscuous mode.
261 * @qos: This is a QoS-enabled BSS.
262 * @idle: This interface is idle. There's also a global idle flag in the
263 * hardware config which may be more appropriate depending on what
264 * your driver/device needs to do.
265 * @ssid: The SSID of the current vif. Only valid in AP-mode.
266 * @ssid_len: Length of SSID given in @ssid.
267 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
269 struct ieee80211_bss_conf
{
271 /* association related data */
272 bool assoc
, ibss_joined
;
274 /* erp related data */
276 bool use_short_preamble
;
281 u16 assoc_capability
;
284 int mcast_rate
[IEEE80211_NUM_BANDS
];
285 u16 ht_operation_mode
;
288 enum nl80211_channel_type channel_type
;
289 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
291 bool arp_filter_enabled
;
294 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
300 * enum mac80211_tx_control_flags - flags to describe transmission information/status
302 * These flags are used with the @flags member of &ieee80211_tx_info.
304 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
305 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
306 * number to this frame, taking care of not overwriting the fragment
307 * number and increasing the sequence number only when the
308 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
309 * assign sequence numbers to QoS-data frames but cannot do so correctly
310 * for non-QoS-data and management frames because beacons need them from
311 * that counter as well and mac80211 cannot guarantee proper sequencing.
312 * If this flag is set, the driver should instruct the hardware to
313 * assign a sequence number to the frame or assign one itself. Cf. IEEE
314 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
315 * beacons and always be clear for frames without a sequence number field.
316 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
317 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
319 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
320 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
321 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
322 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
323 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
324 * because the destination STA was in powersave mode. Note that to
325 * avoid race conditions, the filter must be set by the hardware or
326 * firmware upon receiving a frame that indicates that the station
327 * went to sleep (must be done on device to filter frames already on
328 * the queue) and may only be unset after mac80211 gives the OK for
329 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
330 * since only then is it guaranteed that no more frames are in the
332 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
333 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
334 * is for the whole aggregation.
335 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
336 * so consider using block ack request (BAR).
337 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
338 * set by rate control algorithms to indicate probe rate, will
339 * be cleared for fragmented frames (except on the last fragment)
340 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
341 * used to indicate that a pending frame requires TX processing before
342 * it can be sent out.
343 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
344 * used to indicate that a frame was already retried due to PS
345 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
346 * used to indicate frame should not be encrypted
347 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
348 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
349 * be sent although the station is in powersave mode.
350 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
351 * transmit function after the current frame, this can be used
352 * by drivers to kick the DMA queue only if unset or when the
354 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
355 * after TX status because the destination was asleep, it must not
356 * be modified again (no seqno assignment, crypto, etc.)
357 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
358 * MLME command (internal to mac80211 to figure out whether to send TX
359 * status to user space)
360 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
361 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
362 * frame and selects the maximum number of streams that it can use.
363 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
364 * the off-channel channel when a remain-on-channel offload is done
365 * in hardware -- normal packets still flow and are expected to be
366 * handled properly by the device.
367 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
368 * testing. It will be sent out with incorrect Michael MIC key to allow
369 * TKIP countermeasures to be tested.
370 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
371 * This flag is actually used for management frame especially for P2P
372 * frames not being sent at CCK rate in 2GHz band.
373 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
374 * when its status is reported the service period ends. For frames in
375 * an SP that mac80211 transmits, it is already set; for driver frames
376 * the driver may set this flag. It is also used to do the same for
378 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
379 * This flag is used to send nullfunc frame at minimum rate when
380 * the nullfunc is used for connection monitoring purpose.
381 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
382 * would be fragmented by size (this is optional, only used for
383 * monitor injection).
385 * Note: If you have to add new flags to the enumeration, then don't
386 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
388 enum mac80211_tx_control_flags
{
389 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
390 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
391 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
392 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
393 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
394 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
395 IEEE80211_TX_CTL_AMPDU
= BIT(6),
396 IEEE80211_TX_CTL_INJECTED
= BIT(7),
397 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
398 IEEE80211_TX_STAT_ACK
= BIT(9),
399 IEEE80211_TX_STAT_AMPDU
= BIT(10),
400 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
401 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
402 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
403 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
404 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
405 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
406 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
407 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
408 /* hole at 20, use later */
409 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
410 IEEE80211_TX_CTL_LDPC
= BIT(22),
411 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
412 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
413 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
414 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
415 IEEE80211_TX_STATUS_EOSP
= BIT(28),
416 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
417 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
420 #define IEEE80211_TX_CTL_STBC_SHIFT 23
423 * This definition is used as a mask to clear all temporary flags, which are
424 * set by the tx handlers for each transmission attempt by the mac80211 stack.
426 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
427 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
428 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
429 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
430 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
431 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
432 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
433 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
436 * enum mac80211_rate_control_flags - per-rate flags set by the
437 * Rate Control algorithm.
439 * These flags are set by the Rate control algorithm for each rate during tx,
440 * in the @flags member of struct ieee80211_tx_rate.
442 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
443 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
444 * This is set if the current BSS requires ERP protection.
445 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
446 * @IEEE80211_TX_RC_MCS: HT rate.
447 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
449 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
450 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
451 * adjacent 20 MHz channels, if the current channel type is
452 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
453 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
455 enum mac80211_rate_control_flags
{
456 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
457 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
458 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
460 /* rate index is an MCS rate number instead of an index */
461 IEEE80211_TX_RC_MCS
= BIT(3),
462 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
463 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
464 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
465 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
469 /* there are 40 bytes if you don't need the rateset to be kept */
470 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
472 /* if you do need the rateset, then you have less space */
473 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
475 /* maximum number of rate stages */
476 #define IEEE80211_TX_MAX_RATES 5
479 * struct ieee80211_tx_rate - rate selection/status
481 * @idx: rate index to attempt to send with
482 * @flags: rate control flags (&enum mac80211_rate_control_flags)
483 * @count: number of tries in this rate before going to the next rate
485 * A value of -1 for @idx indicates an invalid rate and, if used
486 * in an array of retry rates, that no more rates should be tried.
488 * When used for transmit status reporting, the driver should
489 * always report the rate along with the flags it used.
491 * &struct ieee80211_tx_info contains an array of these structs
492 * in the control information, and it will be filled by the rate
493 * control algorithm according to what should be sent. For example,
494 * if this array contains, in the format { <idx>, <count> } the
496 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
497 * then this means that the frame should be transmitted
498 * up to twice at rate 3, up to twice at rate 2, and up to four
499 * times at rate 1 if it doesn't get acknowledged. Say it gets
500 * acknowledged by the peer after the fifth attempt, the status
501 * information should then contain
502 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
503 * since it was transmitted twice at rate 3, twice at rate 2
504 * and once at rate 1 after which we received an acknowledgement.
506 struct ieee80211_tx_rate
{
513 * struct ieee80211_tx_info - skb transmit information
515 * This structure is placed in skb->cb for three uses:
516 * (1) mac80211 TX control - mac80211 tells the driver what to do
517 * (2) driver internal use (if applicable)
518 * (3) TX status information - driver tells mac80211 what happened
520 * The TX control's sta pointer is only valid during the ->tx call,
523 * @flags: transmit info flags, defined above
524 * @band: the band to transmit on (use for checking for races)
525 * @reserved: reserved for future use
526 * @ack_frame_id: internal frame ID for TX status, used internally
527 * @control: union for control data
528 * @status: union for status data
529 * @driver_data: array of driver_data pointers
530 * @ampdu_ack_len: number of acked aggregated frames.
531 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
532 * @ampdu_len: number of aggregated frames.
533 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
534 * @ack_signal: signal strength of the ACK frame
536 struct ieee80211_tx_info
{
537 /* common information */
550 struct ieee80211_tx_rate rates
[
551 IEEE80211_TX_MAX_RATES
];
554 /* only needed before rate control */
555 unsigned long jiffies
;
557 /* NB: vif can be NULL for injected frames */
558 struct ieee80211_vif
*vif
;
559 struct ieee80211_key_conf
*hw_key
;
560 struct ieee80211_sta
*sta
;
563 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
571 struct ieee80211_tx_rate driver_rates
[
572 IEEE80211_TX_MAX_RATES
];
573 void *rate_driver_data
[
574 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
577 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
582 * struct ieee80211_sched_scan_ies - scheduled scan IEs
584 * This structure is used to pass the appropriate IEs to be used in scheduled
585 * scans for all bands. It contains both the IEs passed from the userspace
586 * and the ones generated by mac80211.
588 * @ie: array with the IEs for each supported band
589 * @len: array with the total length of the IEs for each band
591 struct ieee80211_sched_scan_ies
{
592 u8
*ie
[IEEE80211_NUM_BANDS
];
593 size_t len
[IEEE80211_NUM_BANDS
];
596 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
598 return (struct ieee80211_tx_info
*)skb
->cb
;
601 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
603 return (struct ieee80211_rx_status
*)skb
->cb
;
607 * ieee80211_tx_info_clear_status - clear TX status
609 * @info: The &struct ieee80211_tx_info to be cleared.
611 * When the driver passes an skb back to mac80211, it must report
612 * a number of things in TX status. This function clears everything
613 * in the TX status but the rate control information (it does clear
614 * the count since you need to fill that in anyway).
616 * NOTE: You can only use this function if you do NOT use
617 * info->driver_data! Use info->rate_driver_data
618 * instead if you need only the less space that allows.
621 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
625 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
626 offsetof(struct ieee80211_tx_info
, control
.rates
));
627 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
628 offsetof(struct ieee80211_tx_info
, driver_rates
));
629 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
630 /* clear the rate counts */
631 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
632 info
->status
.rates
[i
].count
= 0;
635 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
636 memset(&info
->status
.ampdu_ack_len
, 0,
637 sizeof(struct ieee80211_tx_info
) -
638 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
643 * enum mac80211_rx_flags - receive flags
645 * These flags are used with the @flag member of &struct ieee80211_rx_status.
646 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
647 * Use together with %RX_FLAG_MMIC_STRIPPED.
648 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
649 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
650 * verification has been done by the hardware.
651 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
652 * If this flag is set, the stack cannot do any replay detection
653 * hence the driver or hardware will have to do that.
654 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
656 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
658 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
659 * field) is valid and contains the time the first symbol of the MPDU
660 * was received. This is useful in monitor mode and for proper IBSS
662 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
663 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
664 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
665 * @RX_FLAG_SHORT_GI: Short guard interval was used
666 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
667 * Valid only for data frames (mainly A-MPDU)
669 enum mac80211_rx_flags
{
670 RX_FLAG_MMIC_ERROR
= 1<<0,
671 RX_FLAG_DECRYPTED
= 1<<1,
672 RX_FLAG_MMIC_STRIPPED
= 1<<3,
673 RX_FLAG_IV_STRIPPED
= 1<<4,
674 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
675 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
676 RX_FLAG_MACTIME_MPDU
= 1<<7,
677 RX_FLAG_SHORTPRE
= 1<<8,
679 RX_FLAG_40MHZ
= 1<<10,
680 RX_FLAG_SHORT_GI
= 1<<11,
681 RX_FLAG_NO_SIGNAL_VAL
= 1<<12,
685 * struct ieee80211_rx_status - receive status
687 * The low-level driver should provide this information (the subset
688 * supported by hardware) to the 802.11 code with each received
689 * frame, in the skb's control buffer (cb).
691 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
692 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
693 * @band: the active band when this frame was received
694 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
695 * @signal: signal strength when receiving this frame, either in dBm, in dB or
696 * unspecified depending on the hardware capabilities flags
697 * @IEEE80211_HW_SIGNAL_*
698 * @antenna: antenna used
699 * @rate_idx: index of data rate into band's supported rates or MCS index if
700 * HT rates are use (RX_FLAG_HT)
702 * @rx_flags: internal RX flags for mac80211
704 struct ieee80211_rx_status
{
706 enum ieee80211_band band
;
712 unsigned int rx_flags
;
716 * enum ieee80211_conf_flags - configuration flags
718 * Flags to define PHY configuration options
720 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
721 * to determine for example whether to calculate timestamps for packets
722 * or not, do not use instead of filter flags!
723 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
724 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
725 * meaning that the hardware still wakes up for beacons, is able to
726 * transmit frames and receive the possible acknowledgment frames.
727 * Not to be confused with hardware specific wakeup/sleep states,
728 * driver is responsible for that. See the section "Powersave support"
730 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
731 * the driver should be prepared to handle configuration requests but
732 * may turn the device off as much as possible. Typically, this flag will
733 * be set when an interface is set UP but not associated or scanning, but
734 * it can also be unset in that case when monitor interfaces are active.
735 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
738 enum ieee80211_conf_flags
{
739 IEEE80211_CONF_MONITOR
= (1<<0),
740 IEEE80211_CONF_PS
= (1<<1),
741 IEEE80211_CONF_IDLE
= (1<<2),
742 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
747 * enum ieee80211_conf_changed - denotes which configuration changed
749 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
750 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
751 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
752 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
753 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
754 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
755 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
756 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
758 enum ieee80211_conf_changed
{
759 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
760 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
761 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
762 IEEE80211_CONF_CHANGE_PS
= BIT(4),
763 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
764 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
765 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
766 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
770 * enum ieee80211_smps_mode - spatial multiplexing power save mode
772 * @IEEE80211_SMPS_AUTOMATIC: automatic
773 * @IEEE80211_SMPS_OFF: off
774 * @IEEE80211_SMPS_STATIC: static
775 * @IEEE80211_SMPS_DYNAMIC: dynamic
776 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
778 enum ieee80211_smps_mode
{
779 IEEE80211_SMPS_AUTOMATIC
,
781 IEEE80211_SMPS_STATIC
,
782 IEEE80211_SMPS_DYNAMIC
,
785 IEEE80211_SMPS_NUM_MODES
,
789 * struct ieee80211_conf - configuration of the device
791 * This struct indicates how the driver shall configure the hardware.
793 * @flags: configuration flags defined above
795 * @listen_interval: listen interval in units of beacon interval
796 * @max_sleep_period: the maximum number of beacon intervals to sleep for
797 * before checking the beacon for a TIM bit (managed mode only); this
798 * value will be only achievable between DTIM frames, the hardware
799 * needs to check for the multicast traffic bit in DTIM beacons.
800 * This variable is valid only when the CONF_PS flag is set.
801 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
802 * in power saving. Power saving will not be enabled until a beacon
803 * has been received and the DTIM period is known.
804 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
805 * powersave documentation below. This variable is valid only when
806 * the CONF_PS flag is set.
808 * @power_level: requested transmit power (in dBm)
810 * @channel: the channel to tune to
811 * @channel_type: the channel (HT) type
813 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
814 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
815 * but actually means the number of transmissions not the number of retries
816 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
817 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
818 * number of transmissions not the number of retries
820 * @smps_mode: spatial multiplexing powersave mode; note that
821 * %IEEE80211_SMPS_STATIC is used when the device is not
822 * configured for an HT channel
824 struct ieee80211_conf
{
826 int power_level
, dynamic_ps_timeout
;
827 int max_sleep_period
;
832 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
834 struct ieee80211_channel
*channel
;
835 enum nl80211_channel_type channel_type
;
836 enum ieee80211_smps_mode smps_mode
;
840 * struct ieee80211_channel_switch - holds the channel switch data
842 * The information provided in this structure is required for channel switch
845 * @timestamp: value in microseconds of the 64-bit Time Synchronization
846 * Function (TSF) timer when the frame containing the channel switch
847 * announcement was received. This is simply the rx.mactime parameter
848 * the driver passed into mac80211.
849 * @block_tx: Indicates whether transmission must be blocked before the
850 * scheduled channel switch, as indicated by the AP.
851 * @channel: the new channel to switch to
852 * @count: the number of TBTT's until the channel switch event
854 struct ieee80211_channel_switch
{
857 struct ieee80211_channel
*channel
;
862 * enum ieee80211_vif_flags - virtual interface flags
864 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
865 * on this virtual interface to avoid unnecessary CPU wakeups
866 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
867 * monitoring on this virtual interface -- i.e. it can monitor
868 * connection quality related parameters, such as the RSSI level and
869 * provide notifications if configured trigger levels are reached.
871 enum ieee80211_vif_flags
{
872 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
873 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
877 * struct ieee80211_vif - per-interface data
879 * Data in this structure is continually present for driver
880 * use during the life of a virtual interface.
882 * @type: type of this virtual interface
883 * @bss_conf: BSS configuration for this interface, either our own
884 * or the BSS we're associated to
885 * @addr: address of this interface
886 * @p2p: indicates whether this AP or STA interface is a p2p
887 * interface, i.e. a GO or p2p-sta respectively
888 * @driver_flags: flags/capabilities the driver has for this interface,
889 * these need to be set (or cleared) when the interface is added
890 * or, if supported by the driver, the interface type is changed
891 * at runtime, mac80211 will never touch this field
892 * @drv_priv: data area for driver use, will always be aligned to
895 struct ieee80211_vif
{
896 enum nl80211_iftype type
;
897 struct ieee80211_bss_conf bss_conf
;
902 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
905 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
907 #ifdef CONFIG_MAC80211_MESH
908 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
914 * enum ieee80211_key_flags - key flags
916 * These flags are used for communication about keys between the driver
917 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
919 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
920 * that the STA this key will be used with could be using QoS.
921 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
922 * driver to indicate that it requires IV generation for this
924 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
925 * the driver for a TKIP key if it requires Michael MIC
926 * generation in software.
927 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
928 * that the key is pairwise rather then a shared key.
929 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
930 * CCMP key if it requires CCMP encryption of management frames (MFP) to
931 * be done in software.
932 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
933 * for a CCMP key if space should be prepared for the IV, but the IV
934 * itself should not be generated. Do not set together with
935 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
937 enum ieee80211_key_flags
{
938 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
939 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
940 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
941 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
942 IEEE80211_KEY_FLAG_SW_MGMT
= 1<<4,
943 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= 1<<5,
947 * struct ieee80211_key_conf - key information
949 * This key information is given by mac80211 to the driver by
950 * the set_key() callback in &struct ieee80211_ops.
952 * @hw_key_idx: To be set by the driver, this is the key index the driver
953 * wants to be given when a frame is transmitted and needs to be
954 * encrypted in hardware.
955 * @cipher: The key's cipher suite selector.
956 * @flags: key flags, see &enum ieee80211_key_flags.
957 * @keyidx: the key index (0-3)
958 * @keylen: key material length
959 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
961 * - Temporal Encryption Key (128 bits)
962 * - Temporal Authenticator Tx MIC Key (64 bits)
963 * - Temporal Authenticator Rx MIC Key (64 bits)
964 * @icv_len: The ICV length for this key type
965 * @iv_len: The IV length for this key type
967 struct ieee80211_key_conf
{
979 * enum set_key_cmd - key command
981 * Used with the set_key() callback in &struct ieee80211_ops, this
982 * indicates whether a key is being removed or added.
984 * @SET_KEY: a key is set
985 * @DISABLE_KEY: a key must be disabled
988 SET_KEY
, DISABLE_KEY
,
992 * enum ieee80211_sta_state - station state
994 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
995 * this is a special state for add/remove transitions
996 * @IEEE80211_STA_NONE: station exists without special state
997 * @IEEE80211_STA_AUTH: station is authenticated
998 * @IEEE80211_STA_ASSOC: station is associated
999 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1001 enum ieee80211_sta_state
{
1002 /* NOTE: These need to be ordered correctly! */
1003 IEEE80211_STA_NOTEXIST
,
1006 IEEE80211_STA_ASSOC
,
1007 IEEE80211_STA_AUTHORIZED
,
1011 * struct ieee80211_sta - station table entry
1013 * A station table entry represents a station we are possibly
1014 * communicating with. Since stations are RCU-managed in
1015 * mac80211, any ieee80211_sta pointer you get access to must
1016 * either be protected by rcu_read_lock() explicitly or implicitly,
1017 * or you must take good care to not use such a pointer after a
1018 * call to your sta_remove callback that removed it.
1020 * @addr: MAC address
1021 * @aid: AID we assigned to the station if we're an AP
1022 * @supp_rates: Bitmap of supported rates (per band)
1023 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1024 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1025 * @drv_priv: data area for driver use, will always be aligned to
1026 * sizeof(void *), size is determined in hw information.
1027 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1028 * if wme is supported.
1029 * @max_sp: max Service Period. Only valid if wme is supported.
1031 struct ieee80211_sta
{
1032 u32 supp_rates
[IEEE80211_NUM_BANDS
];
1035 struct ieee80211_sta_ht_cap ht_cap
;
1041 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
1045 * enum sta_notify_cmd - sta notify command
1047 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1048 * indicates if an associated station made a power state transition.
1050 * @STA_NOTIFY_SLEEP: a station is now sleeping
1051 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1053 enum sta_notify_cmd
{
1054 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1058 * enum ieee80211_hw_flags - hardware flags
1060 * These flags are used to indicate hardware capabilities to
1061 * the stack. Generally, flags here should have their meaning
1062 * done in a way that the simplest hardware doesn't need setting
1063 * any particular flags. There are some exceptions to this rule,
1064 * however, so you are advised to review these flags carefully.
1066 * @IEEE80211_HW_HAS_RATE_CONTROL:
1067 * The hardware or firmware includes rate control, and cannot be
1068 * controlled by the stack. As such, no rate control algorithm
1069 * should be instantiated, and the TX rate reported to userspace
1070 * will be taken from the TX status instead of the rate control
1072 * Note that this requires that the driver implement a number of
1073 * callbacks so it has the correct information, it needs to have
1074 * the @set_rts_threshold callback and must look at the BSS config
1075 * @use_cts_prot for G/N protection, @use_short_slot for slot
1076 * timing in 2.4 GHz and @use_short_preamble for preambles for
1079 * @IEEE80211_HW_RX_INCLUDES_FCS:
1080 * Indicates that received frames passed to the stack include
1081 * the FCS at the end.
1083 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1084 * Some wireless LAN chipsets buffer broadcast/multicast frames
1085 * for power saving stations in the hardware/firmware and others
1086 * rely on the host system for such buffering. This option is used
1087 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1088 * multicast frames when there are power saving stations so that
1089 * the driver can fetch them with ieee80211_get_buffered_bc().
1091 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1092 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1094 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1095 * Hardware is not capable of receiving frames with short preamble on
1098 * @IEEE80211_HW_SIGNAL_UNSPEC:
1099 * Hardware can provide signal values but we don't know its units. We
1100 * expect values between 0 and @max_signal.
1101 * If possible please provide dB or dBm instead.
1103 * @IEEE80211_HW_SIGNAL_DBM:
1104 * Hardware gives signal values in dBm, decibel difference from
1105 * one milliwatt. This is the preferred method since it is standardized
1106 * between different devices. @max_signal does not need to be set.
1108 * @IEEE80211_HW_SPECTRUM_MGMT:
1109 * Hardware supports spectrum management defined in 802.11h
1110 * Measurement, Channel Switch, Quieting, TPC
1112 * @IEEE80211_HW_AMPDU_AGGREGATION:
1113 * Hardware supports 11n A-MPDU aggregation.
1115 * @IEEE80211_HW_SUPPORTS_PS:
1116 * Hardware has power save support (i.e. can go to sleep).
1118 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1119 * Hardware requires nullfunc frame handling in stack, implies
1120 * stack support for dynamic PS.
1122 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1123 * Hardware has support for dynamic PS.
1125 * @IEEE80211_HW_MFP_CAPABLE:
1126 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1128 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1129 * Hardware supports static spatial multiplexing powersave,
1130 * ie. can turn off all but one chain even on HT connections
1131 * that should be using more chains.
1133 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1134 * Hardware supports dynamic spatial multiplexing powersave,
1135 * ie. can turn off all but one chain and then wake the rest
1136 * up as required after, for example, rts/cts handshake.
1138 * @IEEE80211_HW_SUPPORTS_UAPSD:
1139 * Hardware supports Unscheduled Automatic Power Save Delivery
1140 * (U-APSD) in managed mode. The mode is configured with
1141 * conf_tx() operation.
1143 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1144 * Hardware can provide ack status reports of Tx frames to
1147 * @IEEE80211_HW_CONNECTION_MONITOR:
1148 * The hardware performs its own connection monitoring, including
1149 * periodic keep-alives to the AP and probing the AP on beacon loss.
1150 * When this flag is set, signaling beacon-loss will cause an immediate
1151 * change to disassociated state.
1153 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1154 * This device needs to know the DTIM period for the BSS before
1157 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1158 * per-station GTKs as used by IBSS RSN or during fast transition. If
1159 * the device doesn't support per-station GTKs, but can be asked not
1160 * to decrypt group addressed frames, then IBSS RSN support is still
1161 * possible but software crypto will be used. Advertise the wiphy flag
1162 * only in that case.
1164 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1165 * autonomously manages the PS status of connected stations. When
1166 * this flag is set mac80211 will not trigger PS mode for connected
1167 * stations based on the PM bit of incoming frames.
1168 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1169 * the PS mode of connected stations.
1171 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1172 * setup strictly in HW. mac80211 should not attempt to do this in
1175 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1176 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1179 enum ieee80211_hw_flags
{
1180 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1181 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1182 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1183 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1184 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1185 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1186 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1187 IEEE80211_HW_NEED_DTIM_PERIOD
= 1<<7,
1188 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1189 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1190 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1191 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1192 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1193 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1195 IEEE80211_HW_SUPPORTS_STATIC_SMPS
= 1<<15,
1196 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS
= 1<<16,
1197 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1198 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1199 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1201 IEEE80211_HW_SUPPORTS_PER_STA_GTK
= 1<<21,
1202 IEEE80211_HW_AP_LINK_PS
= 1<<22,
1203 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
= 1<<23,
1204 IEEE80211_HW_SCAN_WHILE_IDLE
= 1<<24,
1208 * struct ieee80211_hw - hardware information and state
1210 * This structure contains the configuration and hardware
1211 * information for an 802.11 PHY.
1213 * @wiphy: This points to the &struct wiphy allocated for this
1214 * 802.11 PHY. You must fill in the @perm_addr and @dev
1215 * members of this structure using SET_IEEE80211_DEV()
1216 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1217 * bands (with channels, bitrates) are registered here.
1219 * @conf: &struct ieee80211_conf, device configuration, don't use.
1221 * @priv: pointer to private area that was allocated for driver use
1222 * along with this structure.
1224 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1226 * @extra_tx_headroom: headroom to reserve in each transmit skb
1227 * for use by the driver (e.g. for transmit headers.)
1229 * @channel_change_time: time (in microseconds) it takes to change channels.
1231 * @max_signal: Maximum value for signal (rssi) in RX information, used
1232 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1234 * @max_listen_interval: max listen interval in units of beacon interval
1237 * @queues: number of available hardware transmit queues for
1238 * data packets. WMM/QoS requires at least four, these
1239 * queues need to have configurable access parameters.
1241 * @rate_control_algorithm: rate control algorithm for this hardware.
1242 * If unset (NULL), the default algorithm will be used. Must be
1243 * set before calling ieee80211_register_hw().
1245 * @vif_data_size: size (in bytes) of the drv_priv data area
1246 * within &struct ieee80211_vif.
1247 * @sta_data_size: size (in bytes) of the drv_priv data area
1248 * within &struct ieee80211_sta.
1250 * @max_rates: maximum number of alternate rate retry stages the hw
1252 * @max_report_rates: maximum number of alternate rate retry stages
1253 * the hw can report back.
1254 * @max_rate_tries: maximum number of tries for each stage
1256 * @napi_weight: weight used for NAPI polling. You must specify an
1257 * appropriate value here if a napi_poll operation is provided
1260 * @max_rx_aggregation_subframes: maximum buffer size (number of
1261 * sub-frames) to be used for A-MPDU block ack receiver
1263 * This is only relevant if the device has restrictions on the
1264 * number of subframes, if it relies on mac80211 to do reordering
1265 * it shouldn't be set.
1267 * @max_tx_aggregation_subframes: maximum number of subframes in an
1268 * aggregate an HT driver will transmit, used by the peer as a
1269 * hint to size its reorder buffer.
1271 struct ieee80211_hw
{
1272 struct ieee80211_conf conf
;
1273 struct wiphy
*wiphy
;
1274 const char *rate_control_algorithm
;
1277 unsigned int extra_tx_headroom
;
1278 int channel_change_time
;
1283 u16 max_listen_interval
;
1286 u8 max_report_rates
;
1288 u8 max_rx_aggregation_subframes
;
1289 u8 max_tx_aggregation_subframes
;
1293 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1295 * @wiphy: the &struct wiphy which we want to query
1297 * mac80211 drivers can use this to get to their respective
1298 * &struct ieee80211_hw. Drivers wishing to get to their own private
1299 * structure can then access it via hw->priv. Note that mac802111 drivers should
1300 * not use wiphy_priv() to try to get their private driver structure as this
1301 * is already used internally by mac80211.
1303 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1306 * SET_IEEE80211_DEV - set device for 802.11 hardware
1308 * @hw: the &struct ieee80211_hw to set the device for
1309 * @dev: the &struct device of this 802.11 device
1311 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1313 set_wiphy_dev(hw
->wiphy
, dev
);
1317 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1319 * @hw: the &struct ieee80211_hw to set the MAC address for
1320 * @addr: the address to set
1322 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1324 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1327 static inline struct ieee80211_rate
*
1328 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1329 const struct ieee80211_tx_info
*c
)
1331 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
1333 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1336 static inline struct ieee80211_rate
*
1337 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1338 const struct ieee80211_tx_info
*c
)
1340 if (c
->control
.rts_cts_rate_idx
< 0)
1342 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1345 static inline struct ieee80211_rate
*
1346 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1347 const struct ieee80211_tx_info
*c
, int idx
)
1349 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1351 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1355 * ieee80211_free_txskb - free TX skb
1359 * Free a transmit skb. Use this funtion when some failure
1360 * to transmit happened and thus status cannot be reported.
1362 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1365 * DOC: Hardware crypto acceleration
1367 * mac80211 is capable of taking advantage of many hardware
1368 * acceleration designs for encryption and decryption operations.
1370 * The set_key() callback in the &struct ieee80211_ops for a given
1371 * device is called to enable hardware acceleration of encryption and
1372 * decryption. The callback takes a @sta parameter that will be NULL
1373 * for default keys or keys used for transmission only, or point to
1374 * the station information for the peer for individual keys.
1375 * Multiple transmission keys with the same key index may be used when
1376 * VLANs are configured for an access point.
1378 * When transmitting, the TX control data will use the @hw_key_idx
1379 * selected by the driver by modifying the &struct ieee80211_key_conf
1380 * pointed to by the @key parameter to the set_key() function.
1382 * The set_key() call for the %SET_KEY command should return 0 if
1383 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1384 * added; if you return 0 then hw_key_idx must be assigned to the
1385 * hardware key index, you are free to use the full u8 range.
1387 * When the cmd is %DISABLE_KEY then it must succeed.
1389 * Note that it is permissible to not decrypt a frame even if a key
1390 * for it has been uploaded to hardware, the stack will not make any
1391 * decision based on whether a key has been uploaded or not but rather
1392 * based on the receive flags.
1394 * The &struct ieee80211_key_conf structure pointed to by the @key
1395 * parameter is guaranteed to be valid until another call to set_key()
1396 * removes it, but it can only be used as a cookie to differentiate
1399 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1400 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1402 * The update_tkip_key() call updates the driver with the new phase 1 key.
1403 * This happens every time the iv16 wraps around (every 65536 packets). The
1404 * set_key() call will happen only once for each key (unless the AP did
1405 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1406 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1407 * handler is software decryption with wrap around of iv16.
1411 * DOC: Powersave support
1413 * mac80211 has support for various powersave implementations.
1415 * First, it can support hardware that handles all powersaving by itself,
1416 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1417 * flag. In that case, it will be told about the desired powersave mode
1418 * with the %IEEE80211_CONF_PS flag depending on the association status.
1419 * The hardware must take care of sending nullfunc frames when necessary,
1420 * i.e. when entering and leaving powersave mode. The hardware is required
1421 * to look at the AID in beacons and signal to the AP that it woke up when
1422 * it finds traffic directed to it.
1424 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1425 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1426 * with hardware wakeup and sleep states. Driver is responsible for waking
1427 * up the hardware before issuing commands to the hardware and putting it
1428 * back to sleep at appropriate times.
1430 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1431 * buffered multicast/broadcast frames after the beacon. Also it must be
1432 * possible to send frames and receive the acknowledment frame.
1434 * Other hardware designs cannot send nullfunc frames by themselves and also
1435 * need software support for parsing the TIM bitmap. This is also supported
1436 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1437 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1438 * required to pass up beacons. The hardware is still required to handle
1439 * waking up for multicast traffic; if it cannot the driver must handle that
1440 * as best as it can, mac80211 is too slow to do that.
1442 * Dynamic powersave is an extension to normal powersave in which the
1443 * hardware stays awake for a user-specified period of time after sending a
1444 * frame so that reply frames need not be buffered and therefore delayed to
1445 * the next wakeup. It's compromise of getting good enough latency when
1446 * there's data traffic and still saving significantly power in idle
1449 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1450 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1451 * flag and mac80211 will handle everything automatically. Additionally,
1452 * hardware having support for the dynamic PS feature may set the
1453 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1454 * dynamic PS mode itself. The driver needs to look at the
1455 * @dynamic_ps_timeout hardware configuration value and use it that value
1456 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1457 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1458 * enabled whenever user has enabled powersave.
1460 * Some hardware need to toggle a single shared antenna between WLAN and
1461 * Bluetooth to facilitate co-existence. These types of hardware set
1462 * limitations on the use of host controlled dynamic powersave whenever there
1463 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1464 * driver may request temporarily going into full power save, in order to
1465 * enable toggling the antenna between BT and WLAN. If the driver requests
1466 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1467 * temporarily set to zero until the driver re-enables dynamic powersave.
1469 * Driver informs U-APSD client support by enabling
1470 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1471 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1472 * Nullfunc frames and stay awake until the service period has ended. To
1473 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1474 * from that AC are transmitted with powersave enabled.
1476 * Note: U-APSD client mode is not yet supported with
1477 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1481 * DOC: Beacon filter support
1483 * Some hardware have beacon filter support to reduce host cpu wakeups
1484 * which will reduce system power consumption. It usually works so that
1485 * the firmware creates a checksum of the beacon but omits all constantly
1486 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1487 * beacon is forwarded to the host, otherwise it will be just dropped. That
1488 * way the host will only receive beacons where some relevant information
1489 * (for example ERP protection or WMM settings) have changed.
1491 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1492 * interface capability. The driver needs to enable beacon filter support
1493 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1494 * power save is enabled, the stack will not check for beacon loss and the
1495 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1497 * The time (or number of beacons missed) until the firmware notifies the
1498 * driver of a beacon loss event (which in turn causes the driver to call
1499 * ieee80211_beacon_loss()) should be configurable and will be controlled
1500 * by mac80211 and the roaming algorithm in the future.
1502 * Since there may be constantly changing information elements that nothing
1503 * in the software stack cares about, we will, in the future, have mac80211
1504 * tell the driver which information elements are interesting in the sense
1505 * that we want to see changes in them. This will include
1506 * - a list of information element IDs
1507 * - a list of OUIs for the vendor information element
1509 * Ideally, the hardware would filter out any beacons without changes in the
1510 * requested elements, but if it cannot support that it may, at the expense
1511 * of some efficiency, filter out only a subset. For example, if the device
1512 * doesn't support checking for OUIs it should pass up all changes in all
1513 * vendor information elements.
1515 * Note that change, for the sake of simplification, also includes information
1516 * elements appearing or disappearing from the beacon.
1518 * Some hardware supports an "ignore list" instead, just make sure nothing
1519 * that was requested is on the ignore list, and include commonly changing
1520 * information element IDs in the ignore list, for example 11 (BSS load) and
1521 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1522 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1523 * it could also include some currently unused IDs.
1526 * In addition to these capabilities, hardware should support notifying the
1527 * host of changes in the beacon RSSI. This is relevant to implement roaming
1528 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1529 * the received data packets). This can consist in notifying the host when
1530 * the RSSI changes significantly or when it drops below or rises above
1531 * configurable thresholds. In the future these thresholds will also be
1532 * configured by mac80211 (which gets them from userspace) to implement
1533 * them as the roaming algorithm requires.
1535 * If the hardware cannot implement this, the driver should ask it to
1536 * periodically pass beacon frames to the host so that software can do the
1537 * signal strength threshold checking.
1541 * DOC: Spatial multiplexing power save
1543 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1544 * power in an 802.11n implementation. For details on the mechanism
1545 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1546 * "11.2.3 SM power save".
1548 * The mac80211 implementation is capable of sending action frames
1549 * to update the AP about the station's SMPS mode, and will instruct
1550 * the driver to enter the specific mode. It will also announce the
1551 * requested SMPS mode during the association handshake. Hardware
1552 * support for this feature is required, and can be indicated by
1555 * The default mode will be "automatic", which nl80211/cfg80211
1556 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1557 * turned off otherwise.
1559 * To support this feature, the driver must set the appropriate
1560 * hardware support flags, and handle the SMPS flag to the config()
1561 * operation. It will then with this mechanism be instructed to
1562 * enter the requested SMPS mode while associated to an HT AP.
1566 * DOC: Frame filtering
1568 * mac80211 requires to see many management frames for proper
1569 * operation, and users may want to see many more frames when
1570 * in monitor mode. However, for best CPU usage and power consumption,
1571 * having as few frames as possible percolate through the stack is
1572 * desirable. Hence, the hardware should filter as much as possible.
1574 * To achieve this, mac80211 uses filter flags (see below) to tell
1575 * the driver's configure_filter() function which frames should be
1576 * passed to mac80211 and which should be filtered out.
1578 * Before configure_filter() is invoked, the prepare_multicast()
1579 * callback is invoked with the parameters @mc_count and @mc_list
1580 * for the combined multicast address list of all virtual interfaces.
1581 * It's use is optional, and it returns a u64 that is passed to
1582 * configure_filter(). Additionally, configure_filter() has the
1583 * arguments @changed_flags telling which flags were changed and
1584 * @total_flags with the new flag states.
1586 * If your device has no multicast address filters your driver will
1587 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1588 * parameter to see whether multicast frames should be accepted
1591 * All unsupported flags in @total_flags must be cleared.
1592 * Hardware does not support a flag if it is incapable of _passing_
1593 * the frame to the stack. Otherwise the driver must ignore
1594 * the flag, but not clear it.
1595 * You must _only_ clear the flag (announce no support for the
1596 * flag to mac80211) if you are not able to pass the packet type
1597 * to the stack (so the hardware always filters it).
1598 * So for example, you should clear @FIF_CONTROL, if your hardware
1599 * always filters control frames. If your hardware always passes
1600 * control frames to the kernel and is incapable of filtering them,
1601 * you do _not_ clear the @FIF_CONTROL flag.
1602 * This rule applies to all other FIF flags as well.
1606 * DOC: AP support for powersaving clients
1608 * In order to implement AP and P2P GO modes, mac80211 has support for
1609 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1610 * There currently is no support for sAPSD.
1612 * There is one assumption that mac80211 makes, namely that a client
1613 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1614 * Both are supported, and both can be used by the same client, but
1615 * they can't be used concurrently by the same client. This simplifies
1618 * The first thing to keep in mind is that there is a flag for complete
1619 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1620 * mac80211 expects the driver to handle most of the state machine for
1621 * powersaving clients and will ignore the PM bit in incoming frames.
1622 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1623 * stations' powersave transitions. In this mode, mac80211 also doesn't
1624 * handle PS-Poll/uAPSD.
1626 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1627 * PM bit in incoming frames for client powersave transitions. When a
1628 * station goes to sleep, we will stop transmitting to it. There is,
1629 * however, a race condition: a station might go to sleep while there is
1630 * data buffered on hardware queues. If the device has support for this
1631 * it will reject frames, and the driver should give the frames back to
1632 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1633 * cause mac80211 to retry the frame when the station wakes up. The
1634 * driver is also notified of powersave transitions by calling its
1635 * @sta_notify callback.
1637 * When the station is asleep, it has three choices: it can wake up,
1638 * it can PS-Poll, or it can possibly start a uAPSD service period.
1639 * Waking up is implemented by simply transmitting all buffered (and
1640 * filtered) frames to the station. This is the easiest case. When
1641 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1642 * will inform the driver of this with the @allow_buffered_frames
1643 * callback; this callback is optional. mac80211 will then transmit
1644 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1645 * on each frame. The last frame in the service period (or the only
1646 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1647 * indicate that it ends the service period; as this frame must have
1648 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1649 * When TX status is reported for this frame, the service period is
1650 * marked has having ended and a new one can be started by the peer.
1652 * Additionally, non-bufferable MMPDUs can also be transmitted by
1653 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1655 * Another race condition can happen on some devices like iwlwifi
1656 * when there are frames queued for the station and it wakes up
1657 * or polls; the frames that are already queued could end up being
1658 * transmitted first instead, causing reordering and/or wrong
1659 * processing of the EOSP. The cause is that allowing frames to be
1660 * transmitted to a certain station is out-of-band communication to
1661 * the device. To allow this problem to be solved, the driver can
1662 * call ieee80211_sta_block_awake() if frames are buffered when it
1663 * is notified that the station went to sleep. When all these frames
1664 * have been filtered (see above), it must call the function again
1665 * to indicate that the station is no longer blocked.
1667 * If the driver buffers frames in the driver for aggregation in any
1668 * way, it must use the ieee80211_sta_set_buffered() call when it is
1669 * notified of the station going to sleep to inform mac80211 of any
1670 * TIDs that have frames buffered. Note that when a station wakes up
1671 * this information is reset (hence the requirement to call it when
1672 * informed of the station going to sleep). Then, when a service
1673 * period starts for any reason, @release_buffered_frames is called
1674 * with the number of frames to be released and which TIDs they are
1675 * to come from. In this case, the driver is responsible for setting
1676 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1677 * to help the @more_data paramter is passed to tell the driver if
1678 * there is more data on other TIDs -- the TIDs to release frames
1679 * from are ignored since mac80211 doesn't know how many frames the
1680 * buffers for those TIDs contain.
1682 * If the driver also implement GO mode, where absence periods may
1683 * shorten service periods (or abort PS-Poll responses), it must
1684 * filter those response frames except in the case of frames that
1685 * are buffered in the driver -- those must remain buffered to avoid
1686 * reordering. Because it is possible that no frames are released
1687 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1688 * to indicate to mac80211 that the service period ended anyway.
1690 * Finally, if frames from multiple TIDs are released from mac80211
1691 * but the driver might reorder them, it must clear & set the flags
1692 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1693 * and also take care of the EOSP and MORE_DATA bits in the frame.
1694 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1698 * enum ieee80211_filter_flags - hardware filter flags
1700 * These flags determine what the filter in hardware should be
1701 * programmed to let through and what should not be passed to the
1702 * stack. It is always safe to pass more frames than requested,
1703 * but this has negative impact on power consumption.
1705 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1706 * think of the BSS as your network segment and then this corresponds
1707 * to the regular ethernet device promiscuous mode.
1709 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1710 * by the user or if the hardware is not capable of filtering by
1711 * multicast address.
1713 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1714 * %RX_FLAG_FAILED_FCS_CRC for them)
1716 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1717 * the %RX_FLAG_FAILED_PLCP_CRC for them
1719 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1720 * to the hardware that it should not filter beacons or probe responses
1721 * by BSSID. Filtering them can greatly reduce the amount of processing
1722 * mac80211 needs to do and the amount of CPU wakeups, so you should
1723 * honour this flag if possible.
1725 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1726 * is not set then only those addressed to this station.
1728 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1730 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1731 * those addressed to this station.
1733 * @FIF_PROBE_REQ: pass probe request frames
1735 enum ieee80211_filter_flags
{
1736 FIF_PROMISC_IN_BSS
= 1<<0,
1737 FIF_ALLMULTI
= 1<<1,
1739 FIF_PLCPFAIL
= 1<<3,
1740 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1742 FIF_OTHER_BSS
= 1<<6,
1744 FIF_PROBE_REQ
= 1<<8,
1748 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1750 * These flags are used with the ampdu_action() callback in
1751 * &struct ieee80211_ops to indicate which action is needed.
1753 * Note that drivers MUST be able to deal with a TX aggregation
1754 * session being stopped even before they OK'ed starting it by
1755 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1756 * might receive the addBA frame and send a delBA right away!
1758 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1759 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1760 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1761 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1762 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1764 enum ieee80211_ampdu_mlme_action
{
1765 IEEE80211_AMPDU_RX_START
,
1766 IEEE80211_AMPDU_RX_STOP
,
1767 IEEE80211_AMPDU_TX_START
,
1768 IEEE80211_AMPDU_TX_STOP
,
1769 IEEE80211_AMPDU_TX_OPERATIONAL
,
1773 * enum ieee80211_frame_release_type - frame release reason
1774 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1775 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1776 * frame received on trigger-enabled AC
1778 enum ieee80211_frame_release_type
{
1779 IEEE80211_FRAME_RELEASE_PSPOLL
,
1780 IEEE80211_FRAME_RELEASE_UAPSD
,
1784 * enum ieee80211_rate_control_changed - flags to indicate what changed
1786 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
1787 * to this station changed.
1788 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
1790 enum ieee80211_rate_control_changed
{
1791 IEEE80211_RC_BW_CHANGED
= BIT(0),
1792 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
1796 * struct ieee80211_ops - callbacks from mac80211 to the driver
1798 * This structure contains various callbacks that the driver may
1799 * handle or, in some cases, must handle, for example to configure
1800 * the hardware to a new channel or to transmit a frame.
1802 * @tx: Handler that 802.11 module calls for each transmitted frame.
1803 * skb contains the buffer starting from the IEEE 802.11 header.
1804 * The low-level driver should send the frame out based on
1805 * configuration in the TX control data. This handler should,
1806 * preferably, never fail and stop queues appropriately.
1807 * This must be implemented if @tx_frags is not.
1810 * @tx_frags: Called to transmit multiple fragments of a single MSDU.
1811 * This handler must consume all fragments, sending out some of
1812 * them only is useless and it can't ask for some of them to be
1813 * queued again. If the frame is not fragmented the queue has a
1814 * single SKB only. To avoid issues with the networking stack
1815 * when TX status is reported the frames should be removed from
1817 * If this is used, the tx_info @vif and @sta pointers will be
1818 * invalid -- you must not use them in that case.
1819 * This must be implemented if @tx isn't.
1822 * @start: Called before the first netdevice attached to the hardware
1823 * is enabled. This should turn on the hardware and must turn on
1824 * frame reception (for possibly enabled monitor interfaces.)
1825 * Returns negative error codes, these may be seen in userspace,
1827 * When the device is started it should not have a MAC address
1828 * to avoid acknowledging frames before a non-monitor device
1830 * Must be implemented and can sleep.
1832 * @stop: Called after last netdevice attached to the hardware
1833 * is disabled. This should turn off the hardware (at least
1834 * it must turn off frame reception.)
1835 * May be called right after add_interface if that rejects
1836 * an interface. If you added any work onto the mac80211 workqueue
1837 * you should ensure to cancel it on this callback.
1838 * Must be implemented and can sleep.
1840 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1841 * stop transmitting and doing any other configuration, and then
1842 * ask the device to suspend. This is only invoked when WoWLAN is
1843 * configured, otherwise the device is deconfigured completely and
1844 * reconfigured at resume time.
1845 * The driver may also impose special conditions under which it
1846 * wants to use the "normal" suspend (deconfigure), say if it only
1847 * supports WoWLAN when the device is associated. In this case, it
1848 * must return 1 from this function.
1850 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1851 * now resuming its operation, after this the device must be fully
1852 * functional again. If this returns an error, the only way out is
1853 * to also unregister the device. If it returns 1, then mac80211
1854 * will also go through the regular complete restart on resume.
1856 * @add_interface: Called when a netdevice attached to the hardware is
1857 * enabled. Because it is not called for monitor mode devices, @start
1858 * and @stop must be implemented.
1859 * The driver should perform any initialization it needs before
1860 * the device can be enabled. The initial configuration for the
1861 * interface is given in the conf parameter.
1862 * The callback may refuse to add an interface by returning a
1863 * negative error code (which will be seen in userspace.)
1864 * Must be implemented and can sleep.
1866 * @change_interface: Called when a netdevice changes type. This callback
1867 * is optional, but only if it is supported can interface types be
1868 * switched while the interface is UP. The callback may sleep.
1869 * Note that while an interface is being switched, it will not be
1870 * found by the interface iteration callbacks.
1872 * @remove_interface: Notifies a driver that an interface is going down.
1873 * The @stop callback is called after this if it is the last interface
1874 * and no monitor interfaces are present.
1875 * When all interfaces are removed, the MAC address in the hardware
1876 * must be cleared so the device no longer acknowledges packets,
1877 * the mac_addr member of the conf structure is, however, set to the
1878 * MAC address of the device going away.
1879 * Hence, this callback must be implemented. It can sleep.
1881 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1882 * function to change hardware configuration, e.g., channel.
1883 * This function should never fail but returns a negative error code
1884 * if it does. The callback can sleep.
1886 * @bss_info_changed: Handler for configuration requests related to BSS
1887 * parameters that may vary during BSS's lifespan, and may affect low
1888 * level driver (e.g. assoc/disassoc status, erp parameters).
1889 * This function should not be used if no BSS has been set, unless
1890 * for association indication. The @changed parameter indicates which
1891 * of the bss parameters has changed when a call is made. The callback
1894 * @prepare_multicast: Prepare for multicast filter configuration.
1895 * This callback is optional, and its return value is passed
1896 * to configure_filter(). This callback must be atomic.
1898 * @configure_filter: Configure the device's RX filter.
1899 * See the section "Frame filtering" for more information.
1900 * This callback must be implemented and can sleep.
1902 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1903 * must be set or cleared for a given STA. Must be atomic.
1905 * @set_key: See the section "Hardware crypto acceleration"
1906 * This callback is only called between add_interface and
1907 * remove_interface calls, i.e. while the given virtual interface
1909 * Returns a negative error code if the key can't be added.
1910 * The callback can sleep.
1912 * @update_tkip_key: See the section "Hardware crypto acceleration"
1913 * This callback will be called in the context of Rx. Called for drivers
1914 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1915 * The callback must be atomic.
1917 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1918 * host is suspended, it can assign this callback to retrieve the data
1919 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1920 * After rekeying was done it should (for example during resume) notify
1921 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1923 * @hw_scan: Ask the hardware to service the scan request, no need to start
1924 * the scan state machine in stack. The scan must honour the channel
1925 * configuration done by the regulatory agent in the wiphy's
1926 * registered bands. The hardware (or the driver) needs to make sure
1927 * that power save is disabled.
1928 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1929 * entire IEs after the SSID, so that drivers need not look at these
1930 * at all but just send them after the SSID -- mac80211 includes the
1931 * (extended) supported rates and HT information (where applicable).
1932 * When the scan finishes, ieee80211_scan_completed() must be called;
1933 * note that it also must be called when the scan cannot finish due to
1934 * any error unless this callback returned a negative error code.
1935 * The callback can sleep.
1937 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1938 * The driver should ask the hardware to cancel the scan (if possible),
1939 * but the scan will be completed only after the driver will call
1940 * ieee80211_scan_completed().
1941 * This callback is needed for wowlan, to prevent enqueueing a new
1942 * scan_work after the low-level driver was already suspended.
1943 * The callback can sleep.
1945 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1946 * specific intervals. The driver must call the
1947 * ieee80211_sched_scan_results() function whenever it finds results.
1948 * This process will continue until sched_scan_stop is called.
1950 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1952 * @sw_scan_start: Notifier function that is called just before a software scan
1953 * is started. Can be NULL, if the driver doesn't need this notification.
1954 * The callback can sleep.
1956 * @sw_scan_complete: Notifier function that is called just after a
1957 * software scan finished. Can be NULL, if the driver doesn't need
1958 * this notification.
1959 * The callback can sleep.
1961 * @get_stats: Return low-level statistics.
1962 * Returns zero if statistics are available.
1963 * The callback can sleep.
1965 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1966 * callback should be provided to read the TKIP transmit IVs (both IV32
1967 * and IV16) for the given key from hardware.
1968 * The callback must be atomic.
1970 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1971 * if the device does fragmentation by itself; if this callback is
1972 * implemented then the stack will not do fragmentation.
1973 * The callback can sleep.
1975 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1976 * The callback can sleep.
1978 * @sta_add: Notifies low level driver about addition of an associated station,
1979 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1981 * @sta_remove: Notifies low level driver about removal of an associated
1982 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1984 * @sta_notify: Notifies low level driver about power state transition of an
1985 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1986 * in AP mode, this callback will not be called when the flag
1987 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1989 * @sta_state: Notifies low level driver about state transition of a
1990 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
1991 * This callback is mutually exclusive with @sta_add/@sta_remove.
1992 * It must not fail for down transitions but may fail for transitions
1993 * up the list of states.
1994 * The callback can sleep.
1996 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
1997 * used to transmit to the station. The changes are advertised with bits
1998 * from &enum ieee80211_rate_control_changed and the values are reflected
1999 * in the station data. This callback should only be used when the driver
2000 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2001 * otherwise the rate control algorithm is notified directly.
2004 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2005 * bursting) for a hardware TX queue.
2006 * Returns a negative error code on failure.
2007 * The callback can sleep.
2009 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2010 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2011 * required function.
2012 * The callback can sleep.
2014 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2015 * Currently, this is only used for IBSS mode debugging. Is not a
2016 * required function.
2017 * The callback can sleep.
2019 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2020 * with other STAs in the IBSS. This is only used in IBSS mode. This
2021 * function is optional if the firmware/hardware takes full care of
2022 * TSF synchronization.
2023 * The callback can sleep.
2025 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2026 * This is needed only for IBSS mode and the result of this function is
2027 * used to determine whether to reply to Probe Requests.
2028 * Returns non-zero if this device sent the last beacon.
2029 * The callback can sleep.
2031 * @ampdu_action: Perform a certain A-MPDU action
2032 * The RA/TID combination determines the destination and TID we want
2033 * the ampdu action to be performed for. The action is defined through
2034 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2035 * is the first frame we expect to perform the action on. Notice
2036 * that TX/RX_STOP can pass NULL for this parameter.
2037 * The @buf_size parameter is only valid when the action is set to
2038 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2039 * buffer size (number of subframes) for this session -- the driver
2040 * may neither send aggregates containing more subframes than this
2041 * nor send aggregates in a way that lost frames would exceed the
2042 * buffer size. If just limiting the aggregate size, this would be
2043 * possible with a buf_size of 8:
2045 * - RX: 2....7 (lost frame #1)
2047 * which is invalid since #1 was now re-transmitted well past the
2048 * buffer size of 8. Correct ways to retransmit #1 would be:
2049 * - TX: 1 or 18 or 81
2050 * Even "189" would be wrong since 1 could be lost again.
2052 * Returns a negative error code on failure.
2053 * The callback can sleep.
2055 * @get_survey: Return per-channel survey information
2057 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2058 * need to set wiphy->rfkill_poll to %true before registration,
2059 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2060 * The callback can sleep.
2062 * @set_coverage_class: Set slot time for given coverage class as specified
2063 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2064 * accordingly. This callback is not required and may sleep.
2066 * @testmode_cmd: Implement a cfg80211 test mode command.
2067 * The callback can sleep.
2068 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2070 * @flush: Flush all pending frames from the hardware queue, making sure
2071 * that the hardware queues are empty. If the parameter @drop is set
2072 * to %true, pending frames may be dropped. The callback can sleep.
2074 * @channel_switch: Drivers that need (or want) to offload the channel
2075 * switch operation for CSAs received from the AP may implement this
2076 * callback. They must then call ieee80211_chswitch_done() to indicate
2077 * completion of the channel switch.
2079 * @napi_poll: Poll Rx queue for incoming data frames.
2081 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2082 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2083 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2084 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2086 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2088 * @remain_on_channel: Starts an off-channel period on the given channel, must
2089 * call back to ieee80211_ready_on_channel() when on that channel. Note
2090 * that normal channel traffic is not stopped as this is intended for hw
2091 * offload. Frames to transmit on the off-channel channel are transmitted
2092 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2093 * duration (which will always be non-zero) expires, the driver must call
2094 * ieee80211_remain_on_channel_expired(). This callback may sleep.
2095 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2096 * aborted before it expires. This callback may sleep.
2098 * @set_ringparam: Set tx and rx ring sizes.
2100 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2102 * @tx_frames_pending: Check if there is any pending frame in the hardware
2103 * queues before entering power save.
2105 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2106 * when transmitting a frame. Currently only legacy rates are handled.
2107 * The callback can sleep.
2108 * @rssi_callback: Notify driver when the average RSSI goes above/below
2109 * thresholds that were registered previously. The callback can sleep.
2111 * @release_buffered_frames: Release buffered frames according to the given
2112 * parameters. In the case where the driver buffers some frames for
2113 * sleeping stations mac80211 will use this callback to tell the driver
2114 * to release some frames, either for PS-poll or uAPSD.
2115 * Note that if the @more_data paramter is %false the driver must check
2116 * if there are more frames on the given TIDs, and if there are more than
2117 * the frames being released then it must still set the more-data bit in
2118 * the frame. If the @more_data parameter is %true, then of course the
2119 * more-data bit must always be set.
2120 * The @tids parameter tells the driver which TIDs to release frames
2121 * from, for PS-poll it will always have only a single bit set.
2122 * In the case this is used for a PS-poll initiated release, the
2123 * @num_frames parameter will always be 1 so code can be shared. In
2124 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2125 * on the TX status (and must report TX status) so that the PS-poll
2126 * period is properly ended. This is used to avoid sending multiple
2127 * responses for a retried PS-poll frame.
2128 * In the case this is used for uAPSD, the @num_frames parameter may be
2129 * bigger than one, but the driver may send fewer frames (it must send
2130 * at least one, however). In this case it is also responsible for
2131 * setting the EOSP flag in the QoS header of the frames. Also, when the
2132 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2133 * on the last frame in the SP. Alternatively, it may call the function
2134 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2135 * This callback must be atomic.
2136 * @allow_buffered_frames: Prepare device to allow the given number of frames
2137 * to go out to the given station. The frames will be sent by mac80211
2138 * via the usual TX path after this call. The TX information for frames
2139 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2140 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2141 * frames from multiple TIDs are released and the driver might reorder
2142 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2143 * on the last frame and clear it on all others and also handle the EOSP
2144 * bit in the QoS header correctly. Alternatively, it can also call the
2145 * ieee80211_sta_eosp_irqsafe() function.
2146 * The @tids parameter is a bitmap and tells the driver which TIDs the
2147 * frames will be on; it will at most have two bits set.
2148 * This callback must be atomic.
2150 struct ieee80211_ops
{
2151 void (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2152 void (*tx_frags
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2153 struct ieee80211_sta
*sta
, struct sk_buff_head
*skbs
);
2154 int (*start
)(struct ieee80211_hw
*hw
);
2155 void (*stop
)(struct ieee80211_hw
*hw
);
2157 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
2158 int (*resume
)(struct ieee80211_hw
*hw
);
2160 int (*add_interface
)(struct ieee80211_hw
*hw
,
2161 struct ieee80211_vif
*vif
);
2162 int (*change_interface
)(struct ieee80211_hw
*hw
,
2163 struct ieee80211_vif
*vif
,
2164 enum nl80211_iftype new_type
, bool p2p
);
2165 void (*remove_interface
)(struct ieee80211_hw
*hw
,
2166 struct ieee80211_vif
*vif
);
2167 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
2168 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
2169 struct ieee80211_vif
*vif
,
2170 struct ieee80211_bss_conf
*info
,
2173 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
2174 struct netdev_hw_addr_list
*mc_list
);
2175 void (*configure_filter
)(struct ieee80211_hw
*hw
,
2176 unsigned int changed_flags
,
2177 unsigned int *total_flags
,
2179 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
2181 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
2182 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
2183 struct ieee80211_key_conf
*key
);
2184 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
2185 struct ieee80211_vif
*vif
,
2186 struct ieee80211_key_conf
*conf
,
2187 struct ieee80211_sta
*sta
,
2188 u32 iv32
, u16
*phase1key
);
2189 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
2190 struct ieee80211_vif
*vif
,
2191 struct cfg80211_gtk_rekey_data
*data
);
2192 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2193 struct cfg80211_scan_request
*req
);
2194 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
2195 struct ieee80211_vif
*vif
);
2196 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
2197 struct ieee80211_vif
*vif
,
2198 struct cfg80211_sched_scan_request
*req
,
2199 struct ieee80211_sched_scan_ies
*ies
);
2200 void (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
2201 struct ieee80211_vif
*vif
);
2202 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
2203 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
2204 int (*get_stats
)(struct ieee80211_hw
*hw
,
2205 struct ieee80211_low_level_stats
*stats
);
2206 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
2207 u32
*iv32
, u16
*iv16
);
2208 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2209 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2210 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2211 struct ieee80211_sta
*sta
);
2212 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2213 struct ieee80211_sta
*sta
);
2214 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2215 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
2216 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2217 struct ieee80211_sta
*sta
,
2218 enum ieee80211_sta_state old_state
,
2219 enum ieee80211_sta_state new_state
);
2220 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
2221 struct ieee80211_vif
*vif
,
2222 struct ieee80211_sta
*sta
,
2224 int (*conf_tx
)(struct ieee80211_hw
*hw
,
2225 struct ieee80211_vif
*vif
, u16 ac
,
2226 const struct ieee80211_tx_queue_params
*params
);
2227 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2228 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2230 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2231 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
2232 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
2233 struct ieee80211_vif
*vif
,
2234 enum ieee80211_ampdu_mlme_action action
,
2235 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
,
2237 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
2238 struct survey_info
*survey
);
2239 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
2240 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, u8 coverage_class
);
2241 #ifdef CONFIG_NL80211_TESTMODE
2242 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, void *data
, int len
);
2243 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
2244 struct netlink_callback
*cb
,
2245 void *data
, int len
);
2247 void (*flush
)(struct ieee80211_hw
*hw
, bool drop
);
2248 void (*channel_switch
)(struct ieee80211_hw
*hw
,
2249 struct ieee80211_channel_switch
*ch_switch
);
2250 int (*napi_poll
)(struct ieee80211_hw
*hw
, int budget
);
2251 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
2252 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
2254 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
2255 struct ieee80211_channel
*chan
,
2256 enum nl80211_channel_type channel_type
,
2258 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
2259 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
2260 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
2261 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
2262 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
2263 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2264 const struct cfg80211_bitrate_mask
*mask
);
2265 void (*rssi_callback
)(struct ieee80211_hw
*hw
,
2266 enum ieee80211_rssi_event rssi_event
);
2268 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
2269 struct ieee80211_sta
*sta
,
2270 u16 tids
, int num_frames
,
2271 enum ieee80211_frame_release_type reason
,
2273 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
2274 struct ieee80211_sta
*sta
,
2275 u16 tids
, int num_frames
,
2276 enum ieee80211_frame_release_type reason
,
2281 * ieee80211_alloc_hw - Allocate a new hardware device
2283 * This must be called once for each hardware device. The returned pointer
2284 * must be used to refer to this device when calling other functions.
2285 * mac80211 allocates a private data area for the driver pointed to by
2286 * @priv in &struct ieee80211_hw, the size of this area is given as
2289 * @priv_data_len: length of private data
2290 * @ops: callbacks for this device
2292 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
2293 const struct ieee80211_ops
*ops
);
2296 * ieee80211_register_hw - Register hardware device
2298 * You must call this function before any other functions in
2299 * mac80211. Note that before a hardware can be registered, you
2300 * need to fill the contained wiphy's information.
2302 * @hw: the device to register as returned by ieee80211_alloc_hw()
2304 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
2307 * struct ieee80211_tpt_blink - throughput blink description
2308 * @throughput: throughput in Kbit/sec
2309 * @blink_time: blink time in milliseconds
2310 * (full cycle, ie. one off + one on period)
2312 struct ieee80211_tpt_blink
{
2318 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2319 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2320 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2321 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2322 * interface is connected in some way, including being an AP
2324 enum ieee80211_tpt_led_trigger_flags
{
2325 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
2326 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
2327 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
2330 #ifdef CONFIG_MAC80211_LEDS
2331 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
2332 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
2333 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
2334 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
2335 extern char *__ieee80211_create_tpt_led_trigger(
2336 struct ieee80211_hw
*hw
, unsigned int flags
,
2337 const struct ieee80211_tpt_blink
*blink_table
,
2338 unsigned int blink_table_len
);
2341 * ieee80211_get_tx_led_name - get name of TX LED
2343 * mac80211 creates a transmit LED trigger for each wireless hardware
2344 * that can be used to drive LEDs if your driver registers a LED device.
2345 * This function returns the name (or %NULL if not configured for LEDs)
2346 * of the trigger so you can automatically link the LED device.
2348 * @hw: the hardware to get the LED trigger name for
2350 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
2352 #ifdef CONFIG_MAC80211_LEDS
2353 return __ieee80211_get_tx_led_name(hw
);
2360 * ieee80211_get_rx_led_name - get name of RX LED
2362 * mac80211 creates a receive LED trigger for each wireless hardware
2363 * that can be used to drive LEDs if your driver registers a LED device.
2364 * This function returns the name (or %NULL if not configured for LEDs)
2365 * of the trigger so you can automatically link the LED device.
2367 * @hw: the hardware to get the LED trigger name for
2369 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
2371 #ifdef CONFIG_MAC80211_LEDS
2372 return __ieee80211_get_rx_led_name(hw
);
2379 * ieee80211_get_assoc_led_name - get name of association LED
2381 * mac80211 creates a association LED trigger for each wireless hardware
2382 * that can be used to drive LEDs if your driver registers a LED device.
2383 * This function returns the name (or %NULL if not configured for LEDs)
2384 * of the trigger so you can automatically link the LED device.
2386 * @hw: the hardware to get the LED trigger name for
2388 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
2390 #ifdef CONFIG_MAC80211_LEDS
2391 return __ieee80211_get_assoc_led_name(hw
);
2398 * ieee80211_get_radio_led_name - get name of radio LED
2400 * mac80211 creates a radio change LED trigger for each wireless hardware
2401 * that can be used to drive LEDs if your driver registers a LED device.
2402 * This function returns the name (or %NULL if not configured for LEDs)
2403 * of the trigger so you can automatically link the LED device.
2405 * @hw: the hardware to get the LED trigger name for
2407 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
2409 #ifdef CONFIG_MAC80211_LEDS
2410 return __ieee80211_get_radio_led_name(hw
);
2417 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2418 * @hw: the hardware to create the trigger for
2419 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2420 * @blink_table: the blink table -- needs to be ordered by throughput
2421 * @blink_table_len: size of the blink table
2423 * This function returns %NULL (in case of error, or if no LED
2424 * triggers are configured) or the name of the new trigger.
2425 * This function must be called before ieee80211_register_hw().
2427 static inline char *
2428 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
2429 const struct ieee80211_tpt_blink
*blink_table
,
2430 unsigned int blink_table_len
)
2432 #ifdef CONFIG_MAC80211_LEDS
2433 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
2441 * ieee80211_unregister_hw - Unregister a hardware device
2443 * This function instructs mac80211 to free allocated resources
2444 * and unregister netdevices from the networking subsystem.
2446 * @hw: the hardware to unregister
2448 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
2451 * ieee80211_free_hw - free hardware descriptor
2453 * This function frees everything that was allocated, including the
2454 * private data for the driver. You must call ieee80211_unregister_hw()
2455 * before calling this function.
2457 * @hw: the hardware to free
2459 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
2462 * ieee80211_restart_hw - restart hardware completely
2464 * Call this function when the hardware was restarted for some reason
2465 * (hardware error, ...) and the driver is unable to restore its state
2466 * by itself. mac80211 assumes that at this point the driver/hardware
2467 * is completely uninitialised and stopped, it starts the process by
2468 * calling the ->start() operation. The driver will need to reset all
2469 * internal state that it has prior to calling this function.
2471 * @hw: the hardware to restart
2473 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
2475 /** ieee80211_napi_schedule - schedule NAPI poll
2477 * Use this function to schedule NAPI polling on a device.
2479 * @hw: the hardware to start polling
2481 void ieee80211_napi_schedule(struct ieee80211_hw
*hw
);
2483 /** ieee80211_napi_complete - complete NAPI polling
2485 * Use this function to finish NAPI polling on a device.
2487 * @hw: the hardware to stop polling
2489 void ieee80211_napi_complete(struct ieee80211_hw
*hw
);
2492 * ieee80211_rx - receive frame
2494 * Use this function to hand received frames to mac80211. The receive
2495 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2496 * paged @skb is used, the driver is recommended to put the ieee80211
2497 * header of the frame on the linear part of the @skb to avoid memory
2498 * allocation and/or memcpy by the stack.
2500 * This function may not be called in IRQ context. Calls to this function
2501 * for a single hardware must be synchronized against each other. Calls to
2502 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2503 * mixed for a single hardware.
2505 * In process context use instead ieee80211_rx_ni().
2507 * @hw: the hardware this frame came in on
2508 * @skb: the buffer to receive, owned by mac80211 after this call
2510 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2513 * ieee80211_rx_irqsafe - receive frame
2515 * Like ieee80211_rx() but can be called in IRQ context
2516 * (internally defers to a tasklet.)
2518 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2519 * be mixed for a single hardware.
2521 * @hw: the hardware this frame came in on
2522 * @skb: the buffer to receive, owned by mac80211 after this call
2524 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2527 * ieee80211_rx_ni - receive frame (in process context)
2529 * Like ieee80211_rx() but can be called in process context
2530 * (internally disables bottom halves).
2532 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2533 * not be mixed for a single hardware.
2535 * @hw: the hardware this frame came in on
2536 * @skb: the buffer to receive, owned by mac80211 after this call
2538 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
2539 struct sk_buff
*skb
)
2542 ieee80211_rx(hw
, skb
);
2547 * ieee80211_sta_ps_transition - PS transition for connected sta
2549 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2550 * flag set, use this function to inform mac80211 about a connected station
2551 * entering/leaving PS mode.
2553 * This function may not be called in IRQ context or with softirqs enabled.
2555 * Calls to this function for a single hardware must be synchronized against
2558 * The function returns -EINVAL when the requested PS mode is already set.
2560 * @sta: currently connected sta
2561 * @start: start or stop PS
2563 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
2566 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2567 * (in process context)
2569 * Like ieee80211_sta_ps_transition() but can be called in process context
2570 * (internally disables bottom halves). Concurrent call restriction still
2573 * @sta: currently connected sta
2574 * @start: start or stop PS
2576 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
2582 ret
= ieee80211_sta_ps_transition(sta
, start
);
2589 * The TX headroom reserved by mac80211 for its own tx_status functions.
2590 * This is enough for the radiotap header.
2592 #define IEEE80211_TX_STATUS_HEADROOM 14
2595 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2596 * @sta: &struct ieee80211_sta pointer for the sleeping station
2597 * @tid: the TID that has buffered frames
2598 * @buffered: indicates whether or not frames are buffered for this TID
2600 * If a driver buffers frames for a powersave station instead of passing
2601 * them back to mac80211 for retransmission, the station may still need
2602 * to be told that there are buffered frames via the TIM bit.
2604 * This function informs mac80211 whether or not there are frames that are
2605 * buffered in the driver for a given TID; mac80211 can then use this data
2606 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2607 * call! Beware of the locking!)
2609 * If all frames are released to the station (due to PS-poll or uAPSD)
2610 * then the driver needs to inform mac80211 that there no longer are
2611 * frames buffered. However, when the station wakes up mac80211 assumes
2612 * that all buffered frames will be transmitted and clears this data,
2613 * drivers need to make sure they inform mac80211 about all buffered
2614 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2616 * Note that technically mac80211 only needs to know this per AC, not per
2617 * TID, but since driver buffering will inevitably happen per TID (since
2618 * it is related to aggregation) it is easier to make mac80211 map the
2619 * TID to the AC as required instead of keeping track in all drivers that
2622 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
2623 u8 tid
, bool buffered
);
2626 * ieee80211_tx_status - transmit status callback
2628 * Call this function for all transmitted frames after they have been
2629 * transmitted. It is permissible to not call this function for
2630 * multicast frames but this can affect statistics.
2632 * This function may not be called in IRQ context. Calls to this function
2633 * for a single hardware must be synchronized against each other. Calls
2634 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2635 * may not be mixed for a single hardware.
2637 * @hw: the hardware the frame was transmitted by
2638 * @skb: the frame that was transmitted, owned by mac80211 after this call
2640 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
2641 struct sk_buff
*skb
);
2644 * ieee80211_tx_status_ni - transmit status callback (in process context)
2646 * Like ieee80211_tx_status() but can be called in process context.
2648 * Calls to this function, ieee80211_tx_status() and
2649 * ieee80211_tx_status_irqsafe() may not be mixed
2650 * for a single hardware.
2652 * @hw: the hardware the frame was transmitted by
2653 * @skb: the frame that was transmitted, owned by mac80211 after this call
2655 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
2656 struct sk_buff
*skb
)
2659 ieee80211_tx_status(hw
, skb
);
2664 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2666 * Like ieee80211_tx_status() but can be called in IRQ context
2667 * (internally defers to a tasklet.)
2669 * Calls to this function, ieee80211_tx_status() and
2670 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2672 * @hw: the hardware the frame was transmitted by
2673 * @skb: the frame that was transmitted, owned by mac80211 after this call
2675 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
2676 struct sk_buff
*skb
);
2679 * ieee80211_report_low_ack - report non-responding station
2681 * When operating in AP-mode, call this function to report a non-responding
2684 * @sta: the non-responding connected sta
2685 * @num_packets: number of packets sent to @sta without a response
2687 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
2690 * ieee80211_beacon_get_tim - beacon generation function
2691 * @hw: pointer obtained from ieee80211_alloc_hw().
2692 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2693 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2694 * Set to 0 if invalid (in non-AP modes).
2695 * @tim_length: pointer to variable that will receive the TIM IE length,
2696 * (including the ID and length bytes!).
2697 * Set to 0 if invalid (in non-AP modes).
2699 * If the driver implements beaconing modes, it must use this function to
2700 * obtain the beacon frame/template.
2702 * If the beacon frames are generated by the host system (i.e., not in
2703 * hardware/firmware), the driver uses this function to get each beacon
2704 * frame from mac80211 -- it is responsible for calling this function
2705 * before the beacon is needed (e.g. based on hardware interrupt).
2707 * If the beacon frames are generated by the device, then the driver
2708 * must use the returned beacon as the template and change the TIM IE
2709 * according to the current DTIM parameters/TIM bitmap.
2711 * The driver is responsible for freeing the returned skb.
2713 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
2714 struct ieee80211_vif
*vif
,
2715 u16
*tim_offset
, u16
*tim_length
);
2718 * ieee80211_beacon_get - beacon generation function
2719 * @hw: pointer obtained from ieee80211_alloc_hw().
2720 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2722 * See ieee80211_beacon_get_tim().
2724 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
2725 struct ieee80211_vif
*vif
)
2727 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
2731 * ieee80211_proberesp_get - retrieve a Probe Response template
2732 * @hw: pointer obtained from ieee80211_alloc_hw().
2733 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2735 * Creates a Probe Response template which can, for example, be uploaded to
2736 * hardware. The destination address should be set by the caller.
2738 * Can only be called in AP mode.
2740 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
2741 struct ieee80211_vif
*vif
);
2744 * ieee80211_pspoll_get - retrieve a PS Poll template
2745 * @hw: pointer obtained from ieee80211_alloc_hw().
2746 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2748 * Creates a PS Poll a template which can, for example, uploaded to
2749 * hardware. The template must be updated after association so that correct
2750 * AID, BSSID and MAC address is used.
2752 * Note: Caller (or hardware) is responsible for setting the
2753 * &IEEE80211_FCTL_PM bit.
2755 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
2756 struct ieee80211_vif
*vif
);
2759 * ieee80211_nullfunc_get - retrieve a nullfunc template
2760 * @hw: pointer obtained from ieee80211_alloc_hw().
2761 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2763 * Creates a Nullfunc template which can, for example, uploaded to
2764 * hardware. The template must be updated after association so that correct
2765 * BSSID and address is used.
2767 * Note: Caller (or hardware) is responsible for setting the
2768 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2770 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
2771 struct ieee80211_vif
*vif
);
2774 * ieee80211_probereq_get - retrieve a Probe Request template
2775 * @hw: pointer obtained from ieee80211_alloc_hw().
2776 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2777 * @ssid: SSID buffer
2778 * @ssid_len: length of SSID
2779 * @ie: buffer containing all IEs except SSID for the template
2780 * @ie_len: length of the IE buffer
2782 * Creates a Probe Request template which can, for example, be uploaded to
2785 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
2786 struct ieee80211_vif
*vif
,
2787 const u8
*ssid
, size_t ssid_len
,
2788 const u8
*ie
, size_t ie_len
);
2791 * ieee80211_rts_get - RTS frame generation function
2792 * @hw: pointer obtained from ieee80211_alloc_hw().
2793 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2794 * @frame: pointer to the frame that is going to be protected by the RTS.
2795 * @frame_len: the frame length (in octets).
2796 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2797 * @rts: The buffer where to store the RTS frame.
2799 * If the RTS frames are generated by the host system (i.e., not in
2800 * hardware/firmware), the low-level driver uses this function to receive
2801 * the next RTS frame from the 802.11 code. The low-level is responsible
2802 * for calling this function before and RTS frame is needed.
2804 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2805 const void *frame
, size_t frame_len
,
2806 const struct ieee80211_tx_info
*frame_txctl
,
2807 struct ieee80211_rts
*rts
);
2810 * ieee80211_rts_duration - Get the duration field for an RTS frame
2811 * @hw: pointer obtained from ieee80211_alloc_hw().
2812 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2813 * @frame_len: the length of the frame that is going to be protected by the RTS.
2814 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2816 * If the RTS is generated in firmware, but the host system must provide
2817 * the duration field, the low-level driver uses this function to receive
2818 * the duration field value in little-endian byteorder.
2820 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
2821 struct ieee80211_vif
*vif
, size_t frame_len
,
2822 const struct ieee80211_tx_info
*frame_txctl
);
2825 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2826 * @hw: pointer obtained from ieee80211_alloc_hw().
2827 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2828 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2829 * @frame_len: the frame length (in octets).
2830 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2831 * @cts: The buffer where to store the CTS-to-self frame.
2833 * If the CTS-to-self frames are generated by the host system (i.e., not in
2834 * hardware/firmware), the low-level driver uses this function to receive
2835 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2836 * for calling this function before and CTS-to-self frame is needed.
2838 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
2839 struct ieee80211_vif
*vif
,
2840 const void *frame
, size_t frame_len
,
2841 const struct ieee80211_tx_info
*frame_txctl
,
2842 struct ieee80211_cts
*cts
);
2845 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2846 * @hw: pointer obtained from ieee80211_alloc_hw().
2847 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2848 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2849 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2851 * If the CTS-to-self is generated in firmware, but the host system must provide
2852 * the duration field, the low-level driver uses this function to receive
2853 * the duration field value in little-endian byteorder.
2855 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
2856 struct ieee80211_vif
*vif
,
2858 const struct ieee80211_tx_info
*frame_txctl
);
2861 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2862 * @hw: pointer obtained from ieee80211_alloc_hw().
2863 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2864 * @frame_len: the length of the frame.
2865 * @rate: the rate at which the frame is going to be transmitted.
2867 * Calculate the duration field of some generic frame, given its
2868 * length and transmission rate (in 100kbps).
2870 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
2871 struct ieee80211_vif
*vif
,
2873 struct ieee80211_rate
*rate
);
2876 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2877 * @hw: pointer as obtained from ieee80211_alloc_hw().
2878 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2880 * Function for accessing buffered broadcast and multicast frames. If
2881 * hardware/firmware does not implement buffering of broadcast/multicast
2882 * frames when power saving is used, 802.11 code buffers them in the host
2883 * memory. The low-level driver uses this function to fetch next buffered
2884 * frame. In most cases, this is used when generating beacon frame. This
2885 * function returns a pointer to the next buffered skb or NULL if no more
2886 * buffered frames are available.
2888 * Note: buffered frames are returned only after DTIM beacon frame was
2889 * generated with ieee80211_beacon_get() and the low-level driver must thus
2890 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2891 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2892 * does not need to check for DTIM beacons separately and should be able to
2893 * use common code for all beacons.
2896 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2899 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2901 * This function returns the TKIP phase 1 key for the given IV32.
2903 * @keyconf: the parameter passed with the set key
2904 * @iv32: IV32 to get the P1K for
2905 * @p1k: a buffer to which the key will be written, as 5 u16 values
2907 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
2908 u32 iv32
, u16
*p1k
);
2911 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2913 * This function returns the TKIP phase 1 key for the IV32 taken
2914 * from the given packet.
2916 * @keyconf: the parameter passed with the set key
2917 * @skb: the packet to take the IV32 value from that will be encrypted
2919 * @p1k: a buffer to which the key will be written, as 5 u16 values
2921 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
2922 struct sk_buff
*skb
, u16
*p1k
)
2924 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
2925 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
2926 u32 iv32
= get_unaligned_le32(&data
[4]);
2928 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
2932 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2934 * This function returns the TKIP phase 1 key for the given IV32
2935 * and transmitter address.
2937 * @keyconf: the parameter passed with the set key
2938 * @ta: TA that will be used with the key
2939 * @iv32: IV32 to get the P1K for
2940 * @p1k: a buffer to which the key will be written, as 5 u16 values
2942 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
2943 const u8
*ta
, u32 iv32
, u16
*p1k
);
2946 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2948 * This function computes the TKIP RC4 key for the IV values
2951 * @keyconf: the parameter passed with the set key
2952 * @skb: the packet to take the IV32/IV16 values from that will be
2953 * encrypted with this key
2954 * @p2k: a buffer to which the key will be written, 16 bytes
2956 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
2957 struct sk_buff
*skb
, u8
*p2k
);
2960 * struct ieee80211_key_seq - key sequence counter
2962 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2963 * @ccmp: PN data, most significant byte first (big endian,
2964 * reverse order than in packet)
2965 * @aes_cmac: PN data, most significant byte first (big endian,
2966 * reverse order than in packet)
2968 struct ieee80211_key_seq
{
2984 * ieee80211_get_key_tx_seq - get key TX sequence counter
2986 * @keyconf: the parameter passed with the set key
2987 * @seq: buffer to receive the sequence data
2989 * This function allows a driver to retrieve the current TX IV/PN
2990 * for the given key. It must not be called if IV generation is
2991 * offloaded to the device.
2993 * Note that this function may only be called when no TX processing
2994 * can be done concurrently, for example when queues are stopped
2995 * and the stop has been synchronized.
2997 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
2998 struct ieee80211_key_seq
*seq
);
3001 * ieee80211_get_key_rx_seq - get key RX sequence counter
3003 * @keyconf: the parameter passed with the set key
3004 * @tid: The TID, or -1 for the management frame value (CCMP only);
3005 * the value on TID 0 is also used for non-QoS frames. For
3006 * CMAC, only TID 0 is valid.
3007 * @seq: buffer to receive the sequence data
3009 * This function allows a driver to retrieve the current RX IV/PNs
3010 * for the given key. It must not be called if IV checking is done
3011 * by the device and not by mac80211.
3013 * Note that this function may only be called when no RX processing
3014 * can be done concurrently.
3016 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
3017 int tid
, struct ieee80211_key_seq
*seq
);
3020 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3021 * @vif: virtual interface the rekeying was done on
3022 * @bssid: The BSSID of the AP, for checking association
3023 * @replay_ctr: the new replay counter after GTK rekeying
3024 * @gfp: allocation flags
3026 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
3027 const u8
*replay_ctr
, gfp_t gfp
);
3030 * ieee80211_wake_queue - wake specific queue
3031 * @hw: pointer as obtained from ieee80211_alloc_hw().
3032 * @queue: queue number (counted from zero).
3034 * Drivers should use this function instead of netif_wake_queue.
3036 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
3039 * ieee80211_stop_queue - stop specific queue
3040 * @hw: pointer as obtained from ieee80211_alloc_hw().
3041 * @queue: queue number (counted from zero).
3043 * Drivers should use this function instead of netif_stop_queue.
3045 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
3048 * ieee80211_queue_stopped - test status of the queue
3049 * @hw: pointer as obtained from ieee80211_alloc_hw().
3050 * @queue: queue number (counted from zero).
3052 * Drivers should use this function instead of netif_stop_queue.
3055 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
3058 * ieee80211_stop_queues - stop all queues
3059 * @hw: pointer as obtained from ieee80211_alloc_hw().
3061 * Drivers should use this function instead of netif_stop_queue.
3063 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
3066 * ieee80211_wake_queues - wake all queues
3067 * @hw: pointer as obtained from ieee80211_alloc_hw().
3069 * Drivers should use this function instead of netif_wake_queue.
3071 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
3074 * ieee80211_scan_completed - completed hardware scan
3076 * When hardware scan offload is used (i.e. the hw_scan() callback is
3077 * assigned) this function needs to be called by the driver to notify
3078 * mac80211 that the scan finished. This function can be called from
3079 * any context, including hardirq context.
3081 * @hw: the hardware that finished the scan
3082 * @aborted: set to true if scan was aborted
3084 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
3087 * ieee80211_sched_scan_results - got results from scheduled scan
3089 * When a scheduled scan is running, this function needs to be called by the
3090 * driver whenever there are new scan results available.
3092 * @hw: the hardware that is performing scheduled scans
3094 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
3097 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3099 * When a scheduled scan is running, this function can be called by
3100 * the driver if it needs to stop the scan to perform another task.
3101 * Usual scenarios are drivers that cannot continue the scheduled scan
3102 * while associating, for instance.
3104 * @hw: the hardware that is performing scheduled scans
3106 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
3109 * ieee80211_iterate_active_interfaces - iterate active interfaces
3111 * This function iterates over the interfaces associated with a given
3112 * hardware that are currently active and calls the callback for them.
3113 * This function allows the iterator function to sleep, when the iterator
3114 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3116 * Does not iterate over a new interface during add_interface()
3118 * @hw: the hardware struct of which the interfaces should be iterated over
3119 * @iterator: the iterator function to call
3120 * @data: first argument of the iterator function
3122 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
3123 void (*iterator
)(void *data
, u8
*mac
,
3124 struct ieee80211_vif
*vif
),
3128 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3130 * This function iterates over the interfaces associated with a given
3131 * hardware that are currently active and calls the callback for them.
3132 * This function requires the iterator callback function to be atomic,
3133 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3134 * Does not iterate over a new interface during add_interface()
3136 * @hw: the hardware struct of which the interfaces should be iterated over
3137 * @iterator: the iterator function to call, cannot sleep
3138 * @data: first argument of the iterator function
3140 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
3141 void (*iterator
)(void *data
,
3143 struct ieee80211_vif
*vif
),
3147 * ieee80211_queue_work - add work onto the mac80211 workqueue
3149 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3150 * This helper ensures drivers are not queueing work when they should not be.
3152 * @hw: the hardware struct for the interface we are adding work for
3153 * @work: the work we want to add onto the mac80211 workqueue
3155 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
3158 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3160 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3163 * @hw: the hardware struct for the interface we are adding work for
3164 * @dwork: delayable work to queue onto the mac80211 workqueue
3165 * @delay: number of jiffies to wait before queueing
3167 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
3168 struct delayed_work
*dwork
,
3169 unsigned long delay
);
3172 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3173 * @sta: the station for which to start a BA session
3174 * @tid: the TID to BA on.
3175 * @timeout: session timeout value (in TUs)
3177 * Return: success if addBA request was sent, failure otherwise
3179 * Although mac80211/low level driver/user space application can estimate
3180 * the need to start aggregation on a certain RA/TID, the session level
3181 * will be managed by the mac80211.
3183 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
3187 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3188 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3189 * @ra: receiver address of the BA session recipient.
3190 * @tid: the TID to BA on.
3192 * This function must be called by low level driver once it has
3193 * finished with preparations for the BA session. It can be called
3196 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
3200 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3201 * @sta: the station whose BA session to stop
3202 * @tid: the TID to stop BA.
3204 * Return: negative error if the TID is invalid, or no aggregation active
3206 * Although mac80211/low level driver/user space application can estimate
3207 * the need to stop aggregation on a certain RA/TID, the session level
3208 * will be managed by the mac80211.
3210 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
3213 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3214 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3215 * @ra: receiver address of the BA session recipient.
3216 * @tid: the desired TID to BA on.
3218 * This function must be called by low level driver once it has
3219 * finished with preparations for the BA session tear down. It
3220 * can be called from any context.
3222 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
3226 * ieee80211_find_sta - find a station
3228 * @vif: virtual interface to look for station on
3229 * @addr: station's address
3231 * This function must be called under RCU lock and the
3232 * resulting pointer is only valid under RCU lock as well.
3234 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
3238 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3240 * @hw: pointer as obtained from ieee80211_alloc_hw()
3241 * @addr: remote station's address
3242 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3244 * This function must be called under RCU lock and the
3245 * resulting pointer is only valid under RCU lock as well.
3247 * NOTE: You may pass NULL for localaddr, but then you will just get
3248 * the first STA that matches the remote address 'addr'.
3249 * We can have multiple STA associated with multiple
3250 * logical stations (e.g. consider a station connecting to another
3251 * BSSID on the same AP hardware without disconnecting first).
3252 * In this case, the result of this method with localaddr NULL
3255 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3257 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
3259 const u8
*localaddr
);
3262 * ieee80211_sta_block_awake - block station from waking up
3264 * @pubsta: the station
3265 * @block: whether to block or unblock
3267 * Some devices require that all frames that are on the queues
3268 * for a specific station that went to sleep are flushed before
3269 * a poll response or frames after the station woke up can be
3270 * delivered to that it. Note that such frames must be rejected
3271 * by the driver as filtered, with the appropriate status flag.
3273 * This function allows implementing this mode in a race-free
3276 * To do this, a driver must keep track of the number of frames
3277 * still enqueued for a specific station. If this number is not
3278 * zero when the station goes to sleep, the driver must call
3279 * this function to force mac80211 to consider the station to
3280 * be asleep regardless of the station's actual state. Once the
3281 * number of outstanding frames reaches zero, the driver must
3282 * call this function again to unblock the station. That will
3283 * cause mac80211 to be able to send ps-poll responses, and if
3284 * the station queried in the meantime then frames will also
3285 * be sent out as a result of this. Additionally, the driver
3286 * will be notified that the station woke up some time after
3287 * it is unblocked, regardless of whether the station actually
3288 * woke up while blocked or not.
3290 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
3291 struct ieee80211_sta
*pubsta
, bool block
);
3294 * ieee80211_sta_eosp - notify mac80211 about end of SP
3295 * @pubsta: the station
3297 * When a device transmits frames in a way that it can't tell
3298 * mac80211 in the TX status about the EOSP, it must clear the
3299 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3300 * This applies for PS-Poll as well as uAPSD.
3302 * Note that there is no non-_irqsafe version right now as
3303 * it wasn't needed, but just like _tx_status() and _rx()
3304 * must not be mixed in irqsafe/non-irqsafe versions, this
3305 * function must not be mixed with those either. Use the
3306 * all irqsafe, or all non-irqsafe, don't mix! If you need
3307 * the non-irqsafe version of this, you need to add it.
3309 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta
*pubsta
);
3312 * ieee80211_iter_keys - iterate keys programmed into the device
3313 * @hw: pointer obtained from ieee80211_alloc_hw()
3314 * @vif: virtual interface to iterate, may be %NULL for all
3315 * @iter: iterator function that will be called for each key
3316 * @iter_data: custom data to pass to the iterator function
3318 * This function can be used to iterate all the keys known to
3319 * mac80211, even those that weren't previously programmed into
3320 * the device. This is intended for use in WoWLAN if the device
3321 * needs reprogramming of the keys during suspend. Note that due
3322 * to locking reasons, it is also only safe to call this at few
3323 * spots since it must hold the RTNL and be able to sleep.
3325 * The order in which the keys are iterated matches the order
3326 * in which they were originally installed and handed to the
3329 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
3330 struct ieee80211_vif
*vif
,
3331 void (*iter
)(struct ieee80211_hw
*hw
,
3332 struct ieee80211_vif
*vif
,
3333 struct ieee80211_sta
*sta
,
3334 struct ieee80211_key_conf
*key
,
3339 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3340 * @hw: pointer obtained from ieee80211_alloc_hw().
3341 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3343 * Creates a Probe Request template which can, for example, be uploaded to
3344 * hardware. The template is filled with bssid, ssid and supported rate
3345 * information. This function must only be called from within the
3346 * .bss_info_changed callback function and only in managed mode. The function
3347 * is only useful when the interface is associated, otherwise it will return
3350 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
3351 struct ieee80211_vif
*vif
);
3354 * ieee80211_beacon_loss - inform hardware does not receive beacons
3356 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3358 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3359 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3360 * hardware is not receiving beacons with this function.
3362 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
3365 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3367 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3369 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3370 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3371 * needs to inform if the connection to the AP has been lost.
3373 * This function will cause immediate change to disassociated state,
3374 * without connection recovery attempts.
3376 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
3379 * ieee80211_resume_disconnect - disconnect from AP after resume
3381 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3383 * Instructs mac80211 to disconnect from the AP after resume.
3384 * Drivers can use this after WoWLAN if they know that the
3385 * connection cannot be kept up, for example because keys were
3386 * used while the device was asleep but the replay counters or
3387 * similar cannot be retrieved from the device during resume.
3389 * Note that due to implementation issues, if the driver uses
3390 * the reconfiguration functionality during resume the interface
3391 * will still be added as associated first during resume and then
3392 * disconnect normally later.
3394 * This function can only be called from the resume callback and
3395 * the driver must not be holding any of its own locks while it
3396 * calls this function, or at least not any locks it needs in the
3397 * key configuration paths (if it supports HW crypto).
3399 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
3402 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3404 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3406 * Some hardware require full power save to manage simultaneous BT traffic
3407 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3408 * burst of BT traffic. The hardware gets information of BT traffic via
3409 * hardware co-existence lines, and consequentially requests mac80211 to
3410 * (temporarily) enter full psm.
3411 * This function will only temporarily disable dynamic PS, not enable PSM if
3412 * it was not already enabled.
3413 * The driver must make sure to re-enable dynamic PS using
3414 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3417 void ieee80211_disable_dyn_ps(struct ieee80211_vif
*vif
);
3420 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3422 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3424 * This function restores dynamic PS after being temporarily disabled via
3425 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3426 * be coupled with an eventual call to this function.
3429 void ieee80211_enable_dyn_ps(struct ieee80211_vif
*vif
);
3432 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3433 * rssi threshold triggered
3435 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3436 * @rssi_event: the RSSI trigger event type
3437 * @gfp: context flags
3439 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3440 * monitoring is configured with an rssi threshold, the driver will inform
3441 * whenever the rssi level reaches the threshold.
3443 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
3444 enum nl80211_cqm_rssi_threshold_event rssi_event
,
3448 * ieee80211_get_operstate - get the operstate of the vif
3450 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3452 * The driver might need to know the operstate of the net_device
3453 * (specifically, whether the link is IF_OPER_UP after resume)
3455 unsigned char ieee80211_get_operstate(struct ieee80211_vif
*vif
);
3458 * ieee80211_chswitch_done - Complete channel switch process
3459 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3460 * @success: make the channel switch successful or not
3462 * Complete the channel switch post-process: set the new operational channel
3463 * and wake up the suspended queues.
3465 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
3468 * ieee80211_request_smps - request SM PS transition
3469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3470 * @smps_mode: new SM PS mode
3472 * This allows the driver to request an SM PS transition in managed
3473 * mode. This is useful when the driver has more information than
3474 * the stack about possible interference, for example by bluetooth.
3476 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
3477 enum ieee80211_smps_mode smps_mode
);
3480 * ieee80211_key_removed - disable hw acceleration for key
3481 * @key_conf: The key hw acceleration should be disabled for
3483 * This allows drivers to indicate that the given key has been
3484 * removed from hardware acceleration, due to a new key that
3485 * was added. Don't use this if the key can continue to be used
3486 * for TX, if the key restriction is on RX only it is permitted
3487 * to keep the key for TX only and not call this function.
3489 * Due to locking constraints, it may only be called during
3490 * @set_key. This function must be allowed to sleep, and the
3491 * key it tries to disable may still be used until it returns.
3493 void ieee80211_key_removed(struct ieee80211_key_conf
*key_conf
);
3496 * ieee80211_ready_on_channel - notification of remain-on-channel start
3497 * @hw: pointer as obtained from ieee80211_alloc_hw()
3499 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
3502 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3503 * @hw: pointer as obtained from ieee80211_alloc_hw()
3505 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
3508 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3510 * in order not to harm the system performance and user experience, the device
3511 * may request not to allow any rx ba session and tear down existing rx ba
3512 * sessions based on system constraints such as periodic BT activity that needs
3513 * to limit wlan activity (eg.sco or a2dp)."
3514 * in such cases, the intention is to limit the duration of the rx ppdu and
3515 * therefore prevent the peer device to use a-mpdu aggregation.
3517 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3518 * @ba_rx_bitmap: Bit map of open rx ba per tid
3519 * @addr: & to bssid mac address
3521 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
3525 * ieee80211_send_bar - send a BlockAckReq frame
3527 * can be used to flush pending frames from the peer's aggregation reorder
3530 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3531 * @ra: the peer's destination address
3532 * @tid: the TID of the aggregation session
3533 * @ssn: the new starting sequence number for the receiver
3535 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
3537 /* Rate control API */
3540 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3542 * @hw: The hardware the algorithm is invoked for.
3543 * @sband: The band this frame is being transmitted on.
3544 * @bss_conf: the current BSS configuration
3545 * @skb: the skb that will be transmitted, the control information in it needs
3547 * @reported_rate: The rate control algorithm can fill this in to indicate
3548 * which rate should be reported to userspace as the current rate and
3549 * used for rate calculations in the mesh network.
3550 * @rts: whether RTS will be used for this frame because it is longer than the
3552 * @short_preamble: whether mac80211 will request short-preamble transmission
3553 * if the selected rate supports it
3554 * @max_rate_idx: user-requested maximum (legacy) rate
3555 * (deprecated; this will be removed once drivers get updated to use
3557 * @rate_idx_mask: user-requested (legacy) rate mask
3558 * @rate_idx_mcs_mask: user-requested MCS rate mask
3559 * @bss: whether this frame is sent out in AP or IBSS mode
3561 struct ieee80211_tx_rate_control
{
3562 struct ieee80211_hw
*hw
;
3563 struct ieee80211_supported_band
*sband
;
3564 struct ieee80211_bss_conf
*bss_conf
;
3565 struct sk_buff
*skb
;
3566 struct ieee80211_tx_rate reported_rate
;
3567 bool rts
, short_preamble
;
3570 u8 rate_idx_mcs_mask
[IEEE80211_HT_MCS_MASK_LEN
];
3574 struct rate_control_ops
{
3575 struct module
*module
;
3577 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
3578 void (*free
)(void *priv
);
3580 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
3581 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
3582 struct ieee80211_sta
*sta
, void *priv_sta
);
3583 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
3584 struct ieee80211_sta
*sta
, void *priv_sta
,
3586 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
3589 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
3590 struct ieee80211_sta
*sta
, void *priv_sta
,
3591 struct sk_buff
*skb
);
3592 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
3593 struct ieee80211_tx_rate_control
*txrc
);
3595 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
3596 struct dentry
*dir
);
3597 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
3600 static inline int rate_supported(struct ieee80211_sta
*sta
,
3601 enum ieee80211_band band
,
3604 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
3608 * rate_control_send_low - helper for drivers for management/no-ack frames
3610 * Rate control algorithms that agree to use the lowest rate to
3611 * send management frames and NO_ACK data with the respective hw
3612 * retries should use this in the beginning of their mac80211 get_rate
3613 * callback. If true is returned the rate control can simply return.
3614 * If false is returned we guarantee that sta and sta and priv_sta is
3617 * Rate control algorithms wishing to do more intelligent selection of
3618 * rate for multicast/broadcast frames may choose to not use this.
3620 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3621 * that this may be null.
3622 * @priv_sta: private rate control structure. This may be null.
3623 * @txrc: rate control information we sholud populate for mac80211.
3625 bool rate_control_send_low(struct ieee80211_sta
*sta
,
3627 struct ieee80211_tx_rate_control
*txrc
);
3631 rate_lowest_index(struct ieee80211_supported_band
*sband
,
3632 struct ieee80211_sta
*sta
)
3636 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3637 if (rate_supported(sta
, sband
->band
, i
))
3640 /* warn when we cannot find a rate. */
3643 /* and return 0 (the lowest index) */
3648 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
3649 struct ieee80211_sta
*sta
)
3653 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3654 if (rate_supported(sta
, sband
->band
, i
))
3659 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
3660 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
3663 conf_is_ht20(struct ieee80211_conf
*conf
)
3665 return conf
->channel_type
== NL80211_CHAN_HT20
;
3669 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
3671 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
3675 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
3677 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
3681 conf_is_ht40(struct ieee80211_conf
*conf
)
3683 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
3687 conf_is_ht(struct ieee80211_conf
*conf
)
3689 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
3692 static inline enum nl80211_iftype
3693 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
3697 case NL80211_IFTYPE_STATION
:
3698 return NL80211_IFTYPE_P2P_CLIENT
;
3699 case NL80211_IFTYPE_AP
:
3700 return NL80211_IFTYPE_P2P_GO
;
3708 static inline enum nl80211_iftype
3709 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
3711 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
3714 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
3716 int rssi_max_thold
);
3718 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
3720 int ieee80211_add_srates_ie(struct ieee80211_vif
*vif
,
3721 struct sk_buff
*skb
, bool need_basic
);
3723 int ieee80211_add_ext_srates_ie(struct ieee80211_vif
*vif
,
3724 struct sk_buff
*skb
, bool need_basic
);
3725 #endif /* MAC80211_H */