2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
97 enum ieee80211_max_queues
{
98 IEEE80211_MAX_QUEUES
= 16,
101 #define IEEE80211_INVAL_HW_QUEUE 0xff
104 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
105 * @IEEE80211_AC_VO: voice
106 * @IEEE80211_AC_VI: video
107 * @IEEE80211_AC_BE: best effort
108 * @IEEE80211_AC_BK: background
110 enum ieee80211_ac_numbers
{
116 #define IEEE80211_NUM_ACS 4
119 * struct ieee80211_tx_queue_params - transmit queue configuration
121 * The information provided in this structure is required for QoS
122 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
124 * @aifs: arbitration interframe space [0..255]
125 * @cw_min: minimum contention window [a value of the form
126 * 2^n-1 in the range 1..32767]
127 * @cw_max: maximum contention window [like @cw_min]
128 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
129 * @uapsd: is U-APSD mode enabled for the queue
131 struct ieee80211_tx_queue_params
{
139 struct ieee80211_low_level_stats
{
140 unsigned int dot11ACKFailureCount
;
141 unsigned int dot11RTSFailureCount
;
142 unsigned int dot11FCSErrorCount
;
143 unsigned int dot11RTSSuccessCount
;
147 * enum ieee80211_chanctx_change - change flag for channel context
148 * @IEEE80211_CHANCTX_CHANGE_CHANNEL_TYPE: The channel type was changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
151 enum ieee80211_chanctx_change
{
152 IEEE80211_CHANCTX_CHANGE_CHANNEL_TYPE
= BIT(0),
153 IEEE80211_CHANCTX_CHANGE_RX_CHAINS
= BIT(1),
157 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
159 * This is the driver-visible part. The ieee80211_chanctx
160 * that contains it is visible in mac80211 only.
162 * @channel: the channel to tune to
163 * @channel_type: the channel (HT) type
164 * @rx_chains_static: The number of RX chains that must always be
165 * active on the channel to receive MIMO transmissions
166 * @rx_chains_dynamic: The number of RX chains that must be enabled
167 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
168 * this will always be >= @rx_chains_always.
169 * @drv_priv: data area for driver use, will always be aligned to
170 * sizeof(void *), size is determined in hw information.
172 struct ieee80211_chanctx_conf
{
173 struct ieee80211_channel
*channel
;
174 enum nl80211_channel_type channel_type
;
176 u8 rx_chains_static
, rx_chains_dynamic
;
178 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
182 * enum ieee80211_bss_change - BSS change notification flags
184 * These flags are used with the bss_info_changed() callback
185 * to indicate which BSS parameter changed.
187 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
188 * also implies a change in the AID.
189 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
190 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
191 * @BSS_CHANGED_ERP_SLOT: slot timing changed
192 * @BSS_CHANGED_HT: 802.11n parameters changed
193 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
194 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
195 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
196 * reason (IBSS and managed mode)
197 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
198 * new beacon (beaconing modes)
199 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
200 * enabled/disabled (beaconing modes)
201 * @BSS_CHANGED_CQM: Connection quality monitor config changed
202 * @BSS_CHANGED_IBSS: IBSS join status changed
203 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
204 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
205 * that it is only ever disabled for station mode.
206 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
207 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
208 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
209 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
210 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
211 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
212 * changed (currently only in P2P client mode, GO mode will be later)
214 enum ieee80211_bss_change
{
215 BSS_CHANGED_ASSOC
= 1<<0,
216 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
217 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
218 BSS_CHANGED_ERP_SLOT
= 1<<3,
219 BSS_CHANGED_HT
= 1<<4,
220 BSS_CHANGED_BASIC_RATES
= 1<<5,
221 BSS_CHANGED_BEACON_INT
= 1<<6,
222 BSS_CHANGED_BSSID
= 1<<7,
223 BSS_CHANGED_BEACON
= 1<<8,
224 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
225 BSS_CHANGED_CQM
= 1<<10,
226 BSS_CHANGED_IBSS
= 1<<11,
227 BSS_CHANGED_ARP_FILTER
= 1<<12,
228 BSS_CHANGED_QOS
= 1<<13,
229 BSS_CHANGED_IDLE
= 1<<14,
230 BSS_CHANGED_SSID
= 1<<15,
231 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
232 BSS_CHANGED_PS
= 1<<17,
233 BSS_CHANGED_TXPOWER
= 1<<18,
234 BSS_CHANGED_P2P_PS
= 1<<19,
236 /* when adding here, make sure to change ieee80211_reconfig */
240 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
241 * of addresses for an interface increase beyond this value, hardware ARP
242 * filtering will be disabled.
244 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
247 * enum ieee80211_rssi_event - RSSI threshold event
248 * An indicator for when RSSI goes below/above a certain threshold.
249 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
250 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
252 enum ieee80211_rssi_event
{
258 * struct ieee80211_bss_conf - holds the BSS's changing parameters
260 * This structure keeps information about a BSS (and an association
261 * to that BSS) that can change during the lifetime of the BSS.
263 * @assoc: association status
264 * @ibss_joined: indicates whether this station is part of an IBSS
266 * @ibss_creator: indicates if a new IBSS network is being created
267 * @aid: association ID number, valid only when @assoc is true
268 * @use_cts_prot: use CTS protection
269 * @use_short_preamble: use 802.11b short preamble;
270 * if the hardware cannot handle this it must set the
271 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
272 * @use_short_slot: use short slot time (only relevant for ERP);
273 * if the hardware cannot handle this it must set the
274 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
275 * @dtim_period: num of beacons before the next DTIM, for beaconing,
276 * valid in station mode only while @assoc is true and if also
277 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
279 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
280 * as it may have been received during scanning long ago)
281 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
282 * the driver/device can use this to calculate synchronisation
283 * @beacon_int: beacon interval
284 * @assoc_capability: capabilities taken from assoc resp
285 * @basic_rates: bitmap of basic rates, each bit stands for an
286 * index into the rate table configured by the driver in
288 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
289 * @bssid: The BSSID for this BSS
290 * @enable_beacon: whether beaconing should be enabled or not
291 * @channel_type: Channel type for this BSS -- the hardware might be
292 * configured for HT40+ while this BSS only uses no-HT, for
294 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
295 * This field is only valid when the channel type is one of the HT types.
296 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
298 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
299 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
300 * may filter ARP queries targeted for other addresses than listed here.
301 * The driver must allow ARP queries targeted for all address listed here
302 * to pass through. An empty list implies no ARP queries need to pass.
303 * @arp_addr_cnt: Number of addresses currently on the list.
304 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
305 * filter ARP queries based on the @arp_addr_list, if disabled, the
306 * hardware must not perform any ARP filtering. Note, that the filter will
307 * be enabled also in promiscuous mode.
308 * @qos: This is a QoS-enabled BSS.
309 * @idle: This interface is idle. There's also a global idle flag in the
310 * hardware config which may be more appropriate depending on what
311 * your driver/device needs to do.
312 * @ps: power-save mode (STA only). This flag is NOT affected by
313 * offchannel/dynamic_ps operations.
314 * @ssid: The SSID of the current vif. Only valid in AP-mode.
315 * @ssid_len: Length of SSID given in @ssid.
316 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
317 * @txpower: TX power in dBm
318 * @p2p_ctwindow: P2P CTWindow, only for P2P client interfaces
319 * @p2p_oppps: P2P opportunistic PS is enabled
321 struct ieee80211_bss_conf
{
323 /* association related data */
324 bool assoc
, ibss_joined
;
327 /* erp related data */
329 bool use_short_preamble
;
334 u16 assoc_capability
;
338 int mcast_rate
[IEEE80211_NUM_BANDS
];
339 u16 ht_operation_mode
;
342 enum nl80211_channel_type channel_type
;
343 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
345 bool arp_filter_enabled
;
349 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
358 * enum mac80211_tx_control_flags - flags to describe transmission information/status
360 * These flags are used with the @flags member of &ieee80211_tx_info.
362 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
363 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
364 * number to this frame, taking care of not overwriting the fragment
365 * number and increasing the sequence number only when the
366 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
367 * assign sequence numbers to QoS-data frames but cannot do so correctly
368 * for non-QoS-data and management frames because beacons need them from
369 * that counter as well and mac80211 cannot guarantee proper sequencing.
370 * If this flag is set, the driver should instruct the hardware to
371 * assign a sequence number to the frame or assign one itself. Cf. IEEE
372 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
373 * beacons and always be clear for frames without a sequence number field.
374 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
375 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
377 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
378 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
379 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
380 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
381 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
382 * because the destination STA was in powersave mode. Note that to
383 * avoid race conditions, the filter must be set by the hardware or
384 * firmware upon receiving a frame that indicates that the station
385 * went to sleep (must be done on device to filter frames already on
386 * the queue) and may only be unset after mac80211 gives the OK for
387 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
388 * since only then is it guaranteed that no more frames are in the
390 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
391 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
392 * is for the whole aggregation.
393 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
394 * so consider using block ack request (BAR).
395 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
396 * set by rate control algorithms to indicate probe rate, will
397 * be cleared for fragmented frames (except on the last fragment)
398 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
399 * used to indicate that a pending frame requires TX processing before
400 * it can be sent out.
401 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
402 * used to indicate that a frame was already retried due to PS
403 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
404 * used to indicate frame should not be encrypted
405 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
406 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
407 * be sent although the station is in powersave mode.
408 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
409 * transmit function after the current frame, this can be used
410 * by drivers to kick the DMA queue only if unset or when the
412 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
413 * after TX status because the destination was asleep, it must not
414 * be modified again (no seqno assignment, crypto, etc.)
415 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
416 * MLME command (internal to mac80211 to figure out whether to send TX
417 * status to user space)
418 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
419 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
420 * frame and selects the maximum number of streams that it can use.
421 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
422 * the off-channel channel when a remain-on-channel offload is done
423 * in hardware -- normal packets still flow and are expected to be
424 * handled properly by the device.
425 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
426 * testing. It will be sent out with incorrect Michael MIC key to allow
427 * TKIP countermeasures to be tested.
428 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
429 * This flag is actually used for management frame especially for P2P
430 * frames not being sent at CCK rate in 2GHz band.
431 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
432 * when its status is reported the service period ends. For frames in
433 * an SP that mac80211 transmits, it is already set; for driver frames
434 * the driver may set this flag. It is also used to do the same for
436 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
437 * This flag is used to send nullfunc frame at minimum rate when
438 * the nullfunc is used for connection monitoring purpose.
439 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
440 * would be fragmented by size (this is optional, only used for
441 * monitor injection).
443 * Note: If you have to add new flags to the enumeration, then don't
444 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
446 enum mac80211_tx_control_flags
{
447 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
448 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
449 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
450 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
451 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
452 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
453 IEEE80211_TX_CTL_AMPDU
= BIT(6),
454 IEEE80211_TX_CTL_INJECTED
= BIT(7),
455 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
456 IEEE80211_TX_STAT_ACK
= BIT(9),
457 IEEE80211_TX_STAT_AMPDU
= BIT(10),
458 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
459 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
460 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
461 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
462 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
463 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
464 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
465 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
466 /* hole at 20, use later */
467 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
468 IEEE80211_TX_CTL_LDPC
= BIT(22),
469 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
470 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
471 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
472 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
473 IEEE80211_TX_STATUS_EOSP
= BIT(28),
474 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
475 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
478 #define IEEE80211_TX_CTL_STBC_SHIFT 23
481 * This definition is used as a mask to clear all temporary flags, which are
482 * set by the tx handlers for each transmission attempt by the mac80211 stack.
484 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
485 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
486 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
487 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
488 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
489 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
490 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
491 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
494 * enum mac80211_rate_control_flags - per-rate flags set by the
495 * Rate Control algorithm.
497 * These flags are set by the Rate control algorithm for each rate during tx,
498 * in the @flags member of struct ieee80211_tx_rate.
500 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
501 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
502 * This is set if the current BSS requires ERP protection.
503 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
504 * @IEEE80211_TX_RC_MCS: HT rate.
505 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
507 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
508 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
509 * adjacent 20 MHz channels, if the current channel type is
510 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
511 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
513 enum mac80211_rate_control_flags
{
514 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
515 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
516 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
518 /* rate index is an MCS rate number instead of an index */
519 IEEE80211_TX_RC_MCS
= BIT(3),
520 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
521 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
522 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
523 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
527 /* there are 40 bytes if you don't need the rateset to be kept */
528 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
530 /* if you do need the rateset, then you have less space */
531 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
533 /* maximum number of rate stages */
534 #define IEEE80211_TX_MAX_RATES 4
537 * struct ieee80211_tx_rate - rate selection/status
539 * @idx: rate index to attempt to send with
540 * @flags: rate control flags (&enum mac80211_rate_control_flags)
541 * @count: number of tries in this rate before going to the next rate
543 * A value of -1 for @idx indicates an invalid rate and, if used
544 * in an array of retry rates, that no more rates should be tried.
546 * When used for transmit status reporting, the driver should
547 * always report the rate along with the flags it used.
549 * &struct ieee80211_tx_info contains an array of these structs
550 * in the control information, and it will be filled by the rate
551 * control algorithm according to what should be sent. For example,
552 * if this array contains, in the format { <idx>, <count> } the
554 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
555 * then this means that the frame should be transmitted
556 * up to twice at rate 3, up to twice at rate 2, and up to four
557 * times at rate 1 if it doesn't get acknowledged. Say it gets
558 * acknowledged by the peer after the fifth attempt, the status
559 * information should then contain
560 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
561 * since it was transmitted twice at rate 3, twice at rate 2
562 * and once at rate 1 after which we received an acknowledgement.
564 struct ieee80211_tx_rate
{
571 * struct ieee80211_tx_info - skb transmit information
573 * This structure is placed in skb->cb for three uses:
574 * (1) mac80211 TX control - mac80211 tells the driver what to do
575 * (2) driver internal use (if applicable)
576 * (3) TX status information - driver tells mac80211 what happened
578 * @flags: transmit info flags, defined above
579 * @band: the band to transmit on (use for checking for races)
580 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
581 * @ack_frame_id: internal frame ID for TX status, used internally
582 * @control: union for control data
583 * @status: union for status data
584 * @driver_data: array of driver_data pointers
585 * @ampdu_ack_len: number of acked aggregated frames.
586 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
587 * @ampdu_len: number of aggregated frames.
588 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
589 * @ack_signal: signal strength of the ACK frame
591 struct ieee80211_tx_info
{
592 /* common information */
605 struct ieee80211_tx_rate rates
[
606 IEEE80211_TX_MAX_RATES
];
610 /* only needed before rate control */
611 unsigned long jiffies
;
613 /* NB: vif can be NULL for injected frames */
614 struct ieee80211_vif
*vif
;
615 struct ieee80211_key_conf
*hw_key
;
619 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
627 struct ieee80211_tx_rate driver_rates
[
628 IEEE80211_TX_MAX_RATES
];
629 void *rate_driver_data
[
630 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
633 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
638 * struct ieee80211_sched_scan_ies - scheduled scan IEs
640 * This structure is used to pass the appropriate IEs to be used in scheduled
641 * scans for all bands. It contains both the IEs passed from the userspace
642 * and the ones generated by mac80211.
644 * @ie: array with the IEs for each supported band
645 * @len: array with the total length of the IEs for each band
647 struct ieee80211_sched_scan_ies
{
648 u8
*ie
[IEEE80211_NUM_BANDS
];
649 size_t len
[IEEE80211_NUM_BANDS
];
652 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
654 return (struct ieee80211_tx_info
*)skb
->cb
;
657 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
659 return (struct ieee80211_rx_status
*)skb
->cb
;
663 * ieee80211_tx_info_clear_status - clear TX status
665 * @info: The &struct ieee80211_tx_info to be cleared.
667 * When the driver passes an skb back to mac80211, it must report
668 * a number of things in TX status. This function clears everything
669 * in the TX status but the rate control information (it does clear
670 * the count since you need to fill that in anyway).
672 * NOTE: You can only use this function if you do NOT use
673 * info->driver_data! Use info->rate_driver_data
674 * instead if you need only the less space that allows.
677 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
681 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
682 offsetof(struct ieee80211_tx_info
, control
.rates
));
683 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
684 offsetof(struct ieee80211_tx_info
, driver_rates
));
685 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
686 /* clear the rate counts */
687 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
688 info
->status
.rates
[i
].count
= 0;
691 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
692 memset(&info
->status
.ampdu_ack_len
, 0,
693 sizeof(struct ieee80211_tx_info
) -
694 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
699 * enum mac80211_rx_flags - receive flags
701 * These flags are used with the @flag member of &struct ieee80211_rx_status.
702 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
703 * Use together with %RX_FLAG_MMIC_STRIPPED.
704 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
705 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
706 * verification has been done by the hardware.
707 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
708 * If this flag is set, the stack cannot do any replay detection
709 * hence the driver or hardware will have to do that.
710 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
712 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
714 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
715 * field) is valid and contains the time the first symbol of the MPDU
716 * was received. This is useful in monitor mode and for proper IBSS
718 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
719 * field) is valid and contains the time the last symbol of the MPDU
720 * (including FCS) was received.
721 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
722 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
723 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
724 * @RX_FLAG_SHORT_GI: Short guard interval was used
725 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
726 * Valid only for data frames (mainly A-MPDU)
727 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
728 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
729 * to hw.radiotap_mcs_details to advertise that fact
730 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
731 * number (@ampdu_reference) must be populated and be a distinct number for
733 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
734 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
735 * monitoring purposes only
736 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
737 * subframes of a single A-MPDU
738 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
739 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
741 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
742 * is stored in the @ampdu_delimiter_crc field)
744 enum mac80211_rx_flags
{
745 RX_FLAG_MMIC_ERROR
= BIT(0),
746 RX_FLAG_DECRYPTED
= BIT(1),
747 RX_FLAG_MMIC_STRIPPED
= BIT(3),
748 RX_FLAG_IV_STRIPPED
= BIT(4),
749 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
750 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
751 RX_FLAG_MACTIME_START
= BIT(7),
752 RX_FLAG_SHORTPRE
= BIT(8),
754 RX_FLAG_40MHZ
= BIT(10),
755 RX_FLAG_SHORT_GI
= BIT(11),
756 RX_FLAG_NO_SIGNAL_VAL
= BIT(12),
757 RX_FLAG_HT_GF
= BIT(13),
758 RX_FLAG_AMPDU_DETAILS
= BIT(14),
759 RX_FLAG_AMPDU_REPORT_ZEROLEN
= BIT(15),
760 RX_FLAG_AMPDU_IS_ZEROLEN
= BIT(16),
761 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(17),
762 RX_FLAG_AMPDU_IS_LAST
= BIT(18),
763 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(19),
764 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(20),
765 RX_FLAG_MACTIME_END
= BIT(21),
769 * struct ieee80211_rx_status - receive status
771 * The low-level driver should provide this information (the subset
772 * supported by hardware) to the 802.11 code with each received
773 * frame, in the skb's control buffer (cb).
775 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
776 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
777 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
778 * it but can store it and pass it back to the driver for synchronisation
779 * @band: the active band when this frame was received
780 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
781 * @signal: signal strength when receiving this frame, either in dBm, in dB or
782 * unspecified depending on the hardware capabilities flags
783 * @IEEE80211_HW_SIGNAL_*
784 * @antenna: antenna used
785 * @rate_idx: index of data rate into band's supported rates or MCS index if
786 * HT rates are use (RX_FLAG_HT)
788 * @rx_flags: internal RX flags for mac80211
789 * @ampdu_reference: A-MPDU reference number, must be a different value for
790 * each A-MPDU but the same for each subframe within one A-MPDU
791 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
792 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
793 * @vendor_radiotap_len: radiotap vendor namespace length
794 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
795 * that the actual data must be at the start of the SKB data
797 * @vendor_radiotap_oui: radiotap vendor namespace OUI
798 * @vendor_radiotap_subns: radiotap vendor sub namespace
800 struct ieee80211_rx_status
{
802 u32 device_timestamp
;
805 u32 vendor_radiotap_bitmap
;
806 u16 vendor_radiotap_len
;
813 u8 ampdu_delimiter_crc
;
814 u8 vendor_radiotap_align
;
815 u8 vendor_radiotap_oui
[3];
816 u8 vendor_radiotap_subns
;
820 * enum ieee80211_conf_flags - configuration flags
822 * Flags to define PHY configuration options
824 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
825 * to determine for example whether to calculate timestamps for packets
826 * or not, do not use instead of filter flags!
827 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
828 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
829 * meaning that the hardware still wakes up for beacons, is able to
830 * transmit frames and receive the possible acknowledgment frames.
831 * Not to be confused with hardware specific wakeup/sleep states,
832 * driver is responsible for that. See the section "Powersave support"
834 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
835 * the driver should be prepared to handle configuration requests but
836 * may turn the device off as much as possible. Typically, this flag will
837 * be set when an interface is set UP but not associated or scanning, but
838 * it can also be unset in that case when monitor interfaces are active.
839 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
842 enum ieee80211_conf_flags
{
843 IEEE80211_CONF_MONITOR
= (1<<0),
844 IEEE80211_CONF_PS
= (1<<1),
845 IEEE80211_CONF_IDLE
= (1<<2),
846 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
851 * enum ieee80211_conf_changed - denotes which configuration changed
853 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
854 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
855 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
856 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
857 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
858 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
859 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
860 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
861 * Note that this is only valid if channel contexts are not used,
862 * otherwise each channel context has the number of chains listed.
864 enum ieee80211_conf_changed
{
865 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
866 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
867 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
868 IEEE80211_CONF_CHANGE_PS
= BIT(4),
869 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
870 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
871 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
872 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
876 * enum ieee80211_smps_mode - spatial multiplexing power save mode
878 * @IEEE80211_SMPS_AUTOMATIC: automatic
879 * @IEEE80211_SMPS_OFF: off
880 * @IEEE80211_SMPS_STATIC: static
881 * @IEEE80211_SMPS_DYNAMIC: dynamic
882 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
884 enum ieee80211_smps_mode
{
885 IEEE80211_SMPS_AUTOMATIC
,
887 IEEE80211_SMPS_STATIC
,
888 IEEE80211_SMPS_DYNAMIC
,
891 IEEE80211_SMPS_NUM_MODES
,
895 * struct ieee80211_conf - configuration of the device
897 * This struct indicates how the driver shall configure the hardware.
899 * @flags: configuration flags defined above
901 * @listen_interval: listen interval in units of beacon interval
902 * @max_sleep_period: the maximum number of beacon intervals to sleep for
903 * before checking the beacon for a TIM bit (managed mode only); this
904 * value will be only achievable between DTIM frames, the hardware
905 * needs to check for the multicast traffic bit in DTIM beacons.
906 * This variable is valid only when the CONF_PS flag is set.
907 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
908 * in power saving. Power saving will not be enabled until a beacon
909 * has been received and the DTIM period is known.
910 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
911 * powersave documentation below. This variable is valid only when
912 * the CONF_PS flag is set.
914 * @power_level: requested transmit power (in dBm), backward compatibility
915 * value only that is set to the minimum of all interfaces
917 * @channel: the channel to tune to
918 * @channel_type: the channel (HT) type
920 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
921 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
922 * but actually means the number of transmissions not the number of retries
923 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
924 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
925 * number of transmissions not the number of retries
927 * @smps_mode: spatial multiplexing powersave mode; note that
928 * %IEEE80211_SMPS_STATIC is used when the device is not
929 * configured for an HT channel.
930 * Note that this is only valid if channel contexts are not used,
931 * otherwise each channel context has the number of chains listed.
933 struct ieee80211_conf
{
935 int power_level
, dynamic_ps_timeout
;
936 int max_sleep_period
;
941 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
943 struct ieee80211_channel
*channel
;
944 enum nl80211_channel_type channel_type
;
945 enum ieee80211_smps_mode smps_mode
;
949 * struct ieee80211_channel_switch - holds the channel switch data
951 * The information provided in this structure is required for channel switch
954 * @timestamp: value in microseconds of the 64-bit Time Synchronization
955 * Function (TSF) timer when the frame containing the channel switch
956 * announcement was received. This is simply the rx.mactime parameter
957 * the driver passed into mac80211.
958 * @block_tx: Indicates whether transmission must be blocked before the
959 * scheduled channel switch, as indicated by the AP.
960 * @channel: the new channel to switch to
961 * @count: the number of TBTT's until the channel switch event
963 struct ieee80211_channel_switch
{
966 struct ieee80211_channel
*channel
;
971 * enum ieee80211_vif_flags - virtual interface flags
973 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
974 * on this virtual interface to avoid unnecessary CPU wakeups
975 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
976 * monitoring on this virtual interface -- i.e. it can monitor
977 * connection quality related parameters, such as the RSSI level and
978 * provide notifications if configured trigger levels are reached.
980 enum ieee80211_vif_flags
{
981 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
982 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
986 * struct ieee80211_vif - per-interface data
988 * Data in this structure is continually present for driver
989 * use during the life of a virtual interface.
991 * @type: type of this virtual interface
992 * @bss_conf: BSS configuration for this interface, either our own
993 * or the BSS we're associated to
994 * @addr: address of this interface
995 * @p2p: indicates whether this AP or STA interface is a p2p
996 * interface, i.e. a GO or p2p-sta respectively
997 * @driver_flags: flags/capabilities the driver has for this interface,
998 * these need to be set (or cleared) when the interface is added
999 * or, if supported by the driver, the interface type is changed
1000 * at runtime, mac80211 will never touch this field
1001 * @hw_queue: hardware queue for each AC
1002 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1003 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1004 * when it is not assigned. This pointer is RCU-protected due to the TX
1005 * path needing to access it; even though the netdev carrier will always
1006 * be off when it is %NULL there can still be races and packets could be
1007 * processed after it switches back to %NULL.
1008 * @drv_priv: data area for driver use, will always be aligned to
1011 struct ieee80211_vif
{
1012 enum nl80211_iftype type
;
1013 struct ieee80211_bss_conf bss_conf
;
1018 u8 hw_queue
[IEEE80211_NUM_ACS
];
1020 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1025 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
1028 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1030 #ifdef CONFIG_MAC80211_MESH
1031 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1037 * enum ieee80211_key_flags - key flags
1039 * These flags are used for communication about keys between the driver
1040 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1042 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
1043 * that the STA this key will be used with could be using QoS.
1044 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1045 * driver to indicate that it requires IV generation for this
1047 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1048 * the driver for a TKIP key if it requires Michael MIC
1049 * generation in software.
1050 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1051 * that the key is pairwise rather then a shared key.
1052 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1053 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1054 * be done in software.
1055 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1056 * if space should be prepared for the IV, but the IV
1057 * itself should not be generated. Do not set together with
1058 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1059 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1060 * management frames. The flag can help drivers that have a hardware
1061 * crypto implementation that doesn't deal with management frames
1062 * properly by allowing them to not upload the keys to hardware and
1063 * fall back to software crypto. Note that this flag deals only with
1064 * RX, if your crypto engine can't deal with TX you can also set the
1065 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1067 enum ieee80211_key_flags
{
1068 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
1069 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
1070 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
1071 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
1072 IEEE80211_KEY_FLAG_SW_MGMT_TX
= 1<<4,
1073 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= 1<<5,
1074 IEEE80211_KEY_FLAG_RX_MGMT
= 1<<6,
1078 * struct ieee80211_key_conf - key information
1080 * This key information is given by mac80211 to the driver by
1081 * the set_key() callback in &struct ieee80211_ops.
1083 * @hw_key_idx: To be set by the driver, this is the key index the driver
1084 * wants to be given when a frame is transmitted and needs to be
1085 * encrypted in hardware.
1086 * @cipher: The key's cipher suite selector.
1087 * @flags: key flags, see &enum ieee80211_key_flags.
1088 * @keyidx: the key index (0-3)
1089 * @keylen: key material length
1090 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1092 * - Temporal Encryption Key (128 bits)
1093 * - Temporal Authenticator Tx MIC Key (64 bits)
1094 * - Temporal Authenticator Rx MIC Key (64 bits)
1095 * @icv_len: The ICV length for this key type
1096 * @iv_len: The IV length for this key type
1098 struct ieee80211_key_conf
{
1110 * enum set_key_cmd - key command
1112 * Used with the set_key() callback in &struct ieee80211_ops, this
1113 * indicates whether a key is being removed or added.
1115 * @SET_KEY: a key is set
1116 * @DISABLE_KEY: a key must be disabled
1119 SET_KEY
, DISABLE_KEY
,
1123 * enum ieee80211_sta_state - station state
1125 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1126 * this is a special state for add/remove transitions
1127 * @IEEE80211_STA_NONE: station exists without special state
1128 * @IEEE80211_STA_AUTH: station is authenticated
1129 * @IEEE80211_STA_ASSOC: station is associated
1130 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1132 enum ieee80211_sta_state
{
1133 /* NOTE: These need to be ordered correctly! */
1134 IEEE80211_STA_NOTEXIST
,
1137 IEEE80211_STA_ASSOC
,
1138 IEEE80211_STA_AUTHORIZED
,
1142 * struct ieee80211_sta - station table entry
1144 * A station table entry represents a station we are possibly
1145 * communicating with. Since stations are RCU-managed in
1146 * mac80211, any ieee80211_sta pointer you get access to must
1147 * either be protected by rcu_read_lock() explicitly or implicitly,
1148 * or you must take good care to not use such a pointer after a
1149 * call to your sta_remove callback that removed it.
1151 * @addr: MAC address
1152 * @aid: AID we assigned to the station if we're an AP
1153 * @supp_rates: Bitmap of supported rates (per band)
1154 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1155 * @vht_cap: VHT capabilities of this STA; Not restricting any capabilities
1156 * of remote STA. Taking as is.
1157 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1158 * @drv_priv: data area for driver use, will always be aligned to
1159 * sizeof(void *), size is determined in hw information.
1160 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1161 * if wme is supported.
1162 * @max_sp: max Service Period. Only valid if wme is supported.
1164 struct ieee80211_sta
{
1165 u32 supp_rates
[IEEE80211_NUM_BANDS
];
1168 struct ieee80211_sta_ht_cap ht_cap
;
1169 struct ieee80211_sta_vht_cap vht_cap
;
1175 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
1179 * enum sta_notify_cmd - sta notify command
1181 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1182 * indicates if an associated station made a power state transition.
1184 * @STA_NOTIFY_SLEEP: a station is now sleeping
1185 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1187 enum sta_notify_cmd
{
1188 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1192 * struct ieee80211_tx_control - TX control data
1194 * @sta: station table entry, this sta pointer may be NULL and
1195 * it is not allowed to copy the pointer, due to RCU.
1197 struct ieee80211_tx_control
{
1198 struct ieee80211_sta
*sta
;
1202 * enum ieee80211_hw_flags - hardware flags
1204 * These flags are used to indicate hardware capabilities to
1205 * the stack. Generally, flags here should have their meaning
1206 * done in a way that the simplest hardware doesn't need setting
1207 * any particular flags. There are some exceptions to this rule,
1208 * however, so you are advised to review these flags carefully.
1210 * @IEEE80211_HW_HAS_RATE_CONTROL:
1211 * The hardware or firmware includes rate control, and cannot be
1212 * controlled by the stack. As such, no rate control algorithm
1213 * should be instantiated, and the TX rate reported to userspace
1214 * will be taken from the TX status instead of the rate control
1216 * Note that this requires that the driver implement a number of
1217 * callbacks so it has the correct information, it needs to have
1218 * the @set_rts_threshold callback and must look at the BSS config
1219 * @use_cts_prot for G/N protection, @use_short_slot for slot
1220 * timing in 2.4 GHz and @use_short_preamble for preambles for
1223 * @IEEE80211_HW_RX_INCLUDES_FCS:
1224 * Indicates that received frames passed to the stack include
1225 * the FCS at the end.
1227 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1228 * Some wireless LAN chipsets buffer broadcast/multicast frames
1229 * for power saving stations in the hardware/firmware and others
1230 * rely on the host system for such buffering. This option is used
1231 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1232 * multicast frames when there are power saving stations so that
1233 * the driver can fetch them with ieee80211_get_buffered_bc().
1235 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1236 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1238 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1239 * Hardware is not capable of receiving frames with short preamble on
1242 * @IEEE80211_HW_SIGNAL_UNSPEC:
1243 * Hardware can provide signal values but we don't know its units. We
1244 * expect values between 0 and @max_signal.
1245 * If possible please provide dB or dBm instead.
1247 * @IEEE80211_HW_SIGNAL_DBM:
1248 * Hardware gives signal values in dBm, decibel difference from
1249 * one milliwatt. This is the preferred method since it is standardized
1250 * between different devices. @max_signal does not need to be set.
1252 * @IEEE80211_HW_SPECTRUM_MGMT:
1253 * Hardware supports spectrum management defined in 802.11h
1254 * Measurement, Channel Switch, Quieting, TPC
1256 * @IEEE80211_HW_AMPDU_AGGREGATION:
1257 * Hardware supports 11n A-MPDU aggregation.
1259 * @IEEE80211_HW_SUPPORTS_PS:
1260 * Hardware has power save support (i.e. can go to sleep).
1262 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1263 * Hardware requires nullfunc frame handling in stack, implies
1264 * stack support for dynamic PS.
1266 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1267 * Hardware has support for dynamic PS.
1269 * @IEEE80211_HW_MFP_CAPABLE:
1270 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1272 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1273 * Hardware supports static spatial multiplexing powersave,
1274 * ie. can turn off all but one chain even on HT connections
1275 * that should be using more chains.
1277 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1278 * Hardware supports dynamic spatial multiplexing powersave,
1279 * ie. can turn off all but one chain and then wake the rest
1280 * up as required after, for example, rts/cts handshake.
1282 * @IEEE80211_HW_SUPPORTS_UAPSD:
1283 * Hardware supports Unscheduled Automatic Power Save Delivery
1284 * (U-APSD) in managed mode. The mode is configured with
1285 * conf_tx() operation.
1287 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1288 * Hardware can provide ack status reports of Tx frames to
1291 * @IEEE80211_HW_CONNECTION_MONITOR:
1292 * The hardware performs its own connection monitoring, including
1293 * periodic keep-alives to the AP and probing the AP on beacon loss.
1294 * When this flag is set, signaling beacon-loss will cause an immediate
1295 * change to disassociated state.
1297 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1298 * This device needs to know the DTIM period for the BSS before
1301 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1302 * per-station GTKs as used by IBSS RSN or during fast transition. If
1303 * the device doesn't support per-station GTKs, but can be asked not
1304 * to decrypt group addressed frames, then IBSS RSN support is still
1305 * possible but software crypto will be used. Advertise the wiphy flag
1306 * only in that case.
1308 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1309 * autonomously manages the PS status of connected stations. When
1310 * this flag is set mac80211 will not trigger PS mode for connected
1311 * stations based on the PM bit of incoming frames.
1312 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1313 * the PS mode of connected stations.
1315 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1316 * setup strictly in HW. mac80211 should not attempt to do this in
1319 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1320 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1323 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1324 * a virtual monitor interface when monitor interfaces are the only
1325 * active interfaces.
1327 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1328 * queue mapping in order to use different queues (not just one per AC)
1329 * for different virtual interfaces. See the doc section on HW queue
1330 * control for more details.
1332 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1333 * P2P Interface. This will be honoured even if more than one interface
1336 enum ieee80211_hw_flags
{
1337 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1338 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1339 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1340 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1341 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1342 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1343 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1344 IEEE80211_HW_NEED_DTIM_PERIOD
= 1<<7,
1345 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1346 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1347 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1348 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1349 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1350 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1351 IEEE80211_HW_WANT_MONITOR_VIF
= 1<<14,
1352 IEEE80211_HW_SUPPORTS_STATIC_SMPS
= 1<<15,
1353 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS
= 1<<16,
1354 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1355 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1356 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1357 IEEE80211_HW_QUEUE_CONTROL
= 1<<20,
1358 IEEE80211_HW_SUPPORTS_PER_STA_GTK
= 1<<21,
1359 IEEE80211_HW_AP_LINK_PS
= 1<<22,
1360 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
= 1<<23,
1361 IEEE80211_HW_SCAN_WHILE_IDLE
= 1<<24,
1362 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
= 1<<25,
1366 * struct ieee80211_hw - hardware information and state
1368 * This structure contains the configuration and hardware
1369 * information for an 802.11 PHY.
1371 * @wiphy: This points to the &struct wiphy allocated for this
1372 * 802.11 PHY. You must fill in the @perm_addr and @dev
1373 * members of this structure using SET_IEEE80211_DEV()
1374 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1375 * bands (with channels, bitrates) are registered here.
1377 * @conf: &struct ieee80211_conf, device configuration, don't use.
1379 * @priv: pointer to private area that was allocated for driver use
1380 * along with this structure.
1382 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1384 * @extra_tx_headroom: headroom to reserve in each transmit skb
1385 * for use by the driver (e.g. for transmit headers.)
1387 * @channel_change_time: time (in microseconds) it takes to change channels.
1389 * @max_signal: Maximum value for signal (rssi) in RX information, used
1390 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1392 * @max_listen_interval: max listen interval in units of beacon interval
1395 * @queues: number of available hardware transmit queues for
1396 * data packets. WMM/QoS requires at least four, these
1397 * queues need to have configurable access parameters.
1399 * @rate_control_algorithm: rate control algorithm for this hardware.
1400 * If unset (NULL), the default algorithm will be used. Must be
1401 * set before calling ieee80211_register_hw().
1403 * @vif_data_size: size (in bytes) of the drv_priv data area
1404 * within &struct ieee80211_vif.
1405 * @sta_data_size: size (in bytes) of the drv_priv data area
1406 * within &struct ieee80211_sta.
1407 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1408 * within &struct ieee80211_chanctx_conf.
1410 * @max_rates: maximum number of alternate rate retry stages the hw
1412 * @max_report_rates: maximum number of alternate rate retry stages
1413 * the hw can report back.
1414 * @max_rate_tries: maximum number of tries for each stage
1416 * @napi_weight: weight used for NAPI polling. You must specify an
1417 * appropriate value here if a napi_poll operation is provided
1420 * @max_rx_aggregation_subframes: maximum buffer size (number of
1421 * sub-frames) to be used for A-MPDU block ack receiver
1423 * This is only relevant if the device has restrictions on the
1424 * number of subframes, if it relies on mac80211 to do reordering
1425 * it shouldn't be set.
1427 * @max_tx_aggregation_subframes: maximum number of subframes in an
1428 * aggregate an HT driver will transmit, used by the peer as a
1429 * hint to size its reorder buffer.
1431 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1432 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1434 * @radiotap_mcs_details: lists which MCS information can the HW
1435 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1436 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1437 * adding _BW is supported today.
1439 * @netdev_features: netdev features to be set in each netdev created
1440 * from this HW. Note only HW checksum features are currently
1441 * compatible with mac80211. Other feature bits will be rejected.
1443 struct ieee80211_hw
{
1444 struct ieee80211_conf conf
;
1445 struct wiphy
*wiphy
;
1446 const char *rate_control_algorithm
;
1449 unsigned int extra_tx_headroom
;
1450 int channel_change_time
;
1453 int chanctx_data_size
;
1456 u16 max_listen_interval
;
1459 u8 max_report_rates
;
1461 u8 max_rx_aggregation_subframes
;
1462 u8 max_tx_aggregation_subframes
;
1463 u8 offchannel_tx_hw_queue
;
1464 u8 radiotap_mcs_details
;
1465 netdev_features_t netdev_features
;
1469 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1471 * @wiphy: the &struct wiphy which we want to query
1473 * mac80211 drivers can use this to get to their respective
1474 * &struct ieee80211_hw. Drivers wishing to get to their own private
1475 * structure can then access it via hw->priv. Note that mac802111 drivers should
1476 * not use wiphy_priv() to try to get their private driver structure as this
1477 * is already used internally by mac80211.
1479 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1482 * SET_IEEE80211_DEV - set device for 802.11 hardware
1484 * @hw: the &struct ieee80211_hw to set the device for
1485 * @dev: the &struct device of this 802.11 device
1487 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1489 set_wiphy_dev(hw
->wiphy
, dev
);
1493 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1495 * @hw: the &struct ieee80211_hw to set the MAC address for
1496 * @addr: the address to set
1498 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1500 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1503 static inline struct ieee80211_rate
*
1504 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1505 const struct ieee80211_tx_info
*c
)
1507 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
1509 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1512 static inline struct ieee80211_rate
*
1513 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1514 const struct ieee80211_tx_info
*c
)
1516 if (c
->control
.rts_cts_rate_idx
< 0)
1518 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1521 static inline struct ieee80211_rate
*
1522 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1523 const struct ieee80211_tx_info
*c
, int idx
)
1525 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1527 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1531 * ieee80211_free_txskb - free TX skb
1535 * Free a transmit skb. Use this funtion when some failure
1536 * to transmit happened and thus status cannot be reported.
1538 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1541 * DOC: Hardware crypto acceleration
1543 * mac80211 is capable of taking advantage of many hardware
1544 * acceleration designs for encryption and decryption operations.
1546 * The set_key() callback in the &struct ieee80211_ops for a given
1547 * device is called to enable hardware acceleration of encryption and
1548 * decryption. The callback takes a @sta parameter that will be NULL
1549 * for default keys or keys used for transmission only, or point to
1550 * the station information for the peer for individual keys.
1551 * Multiple transmission keys with the same key index may be used when
1552 * VLANs are configured for an access point.
1554 * When transmitting, the TX control data will use the @hw_key_idx
1555 * selected by the driver by modifying the &struct ieee80211_key_conf
1556 * pointed to by the @key parameter to the set_key() function.
1558 * The set_key() call for the %SET_KEY command should return 0 if
1559 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1560 * added; if you return 0 then hw_key_idx must be assigned to the
1561 * hardware key index, you are free to use the full u8 range.
1563 * When the cmd is %DISABLE_KEY then it must succeed.
1565 * Note that it is permissible to not decrypt a frame even if a key
1566 * for it has been uploaded to hardware, the stack will not make any
1567 * decision based on whether a key has been uploaded or not but rather
1568 * based on the receive flags.
1570 * The &struct ieee80211_key_conf structure pointed to by the @key
1571 * parameter is guaranteed to be valid until another call to set_key()
1572 * removes it, but it can only be used as a cookie to differentiate
1575 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1576 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1578 * The update_tkip_key() call updates the driver with the new phase 1 key.
1579 * This happens every time the iv16 wraps around (every 65536 packets). The
1580 * set_key() call will happen only once for each key (unless the AP did
1581 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1582 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1583 * handler is software decryption with wrap around of iv16.
1587 * DOC: Powersave support
1589 * mac80211 has support for various powersave implementations.
1591 * First, it can support hardware that handles all powersaving by itself,
1592 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1593 * flag. In that case, it will be told about the desired powersave mode
1594 * with the %IEEE80211_CONF_PS flag depending on the association status.
1595 * The hardware must take care of sending nullfunc frames when necessary,
1596 * i.e. when entering and leaving powersave mode. The hardware is required
1597 * to look at the AID in beacons and signal to the AP that it woke up when
1598 * it finds traffic directed to it.
1600 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1601 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1602 * with hardware wakeup and sleep states. Driver is responsible for waking
1603 * up the hardware before issuing commands to the hardware and putting it
1604 * back to sleep at appropriate times.
1606 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1607 * buffered multicast/broadcast frames after the beacon. Also it must be
1608 * possible to send frames and receive the acknowledment frame.
1610 * Other hardware designs cannot send nullfunc frames by themselves and also
1611 * need software support for parsing the TIM bitmap. This is also supported
1612 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1613 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1614 * required to pass up beacons. The hardware is still required to handle
1615 * waking up for multicast traffic; if it cannot the driver must handle that
1616 * as best as it can, mac80211 is too slow to do that.
1618 * Dynamic powersave is an extension to normal powersave in which the
1619 * hardware stays awake for a user-specified period of time after sending a
1620 * frame so that reply frames need not be buffered and therefore delayed to
1621 * the next wakeup. It's compromise of getting good enough latency when
1622 * there's data traffic and still saving significantly power in idle
1625 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1626 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1627 * flag and mac80211 will handle everything automatically. Additionally,
1628 * hardware having support for the dynamic PS feature may set the
1629 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1630 * dynamic PS mode itself. The driver needs to look at the
1631 * @dynamic_ps_timeout hardware configuration value and use it that value
1632 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1633 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1634 * enabled whenever user has enabled powersave.
1636 * Some hardware need to toggle a single shared antenna between WLAN and
1637 * Bluetooth to facilitate co-existence. These types of hardware set
1638 * limitations on the use of host controlled dynamic powersave whenever there
1639 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1640 * driver may request temporarily going into full power save, in order to
1641 * enable toggling the antenna between BT and WLAN. If the driver requests
1642 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1643 * temporarily set to zero until the driver re-enables dynamic powersave.
1645 * Driver informs U-APSD client support by enabling
1646 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1647 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1648 * Nullfunc frames and stay awake until the service period has ended. To
1649 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1650 * from that AC are transmitted with powersave enabled.
1652 * Note: U-APSD client mode is not yet supported with
1653 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1657 * DOC: Beacon filter support
1659 * Some hardware have beacon filter support to reduce host cpu wakeups
1660 * which will reduce system power consumption. It usually works so that
1661 * the firmware creates a checksum of the beacon but omits all constantly
1662 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1663 * beacon is forwarded to the host, otherwise it will be just dropped. That
1664 * way the host will only receive beacons where some relevant information
1665 * (for example ERP protection or WMM settings) have changed.
1667 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1668 * interface capability. The driver needs to enable beacon filter support
1669 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1670 * power save is enabled, the stack will not check for beacon loss and the
1671 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1673 * The time (or number of beacons missed) until the firmware notifies the
1674 * driver of a beacon loss event (which in turn causes the driver to call
1675 * ieee80211_beacon_loss()) should be configurable and will be controlled
1676 * by mac80211 and the roaming algorithm in the future.
1678 * Since there may be constantly changing information elements that nothing
1679 * in the software stack cares about, we will, in the future, have mac80211
1680 * tell the driver which information elements are interesting in the sense
1681 * that we want to see changes in them. This will include
1682 * - a list of information element IDs
1683 * - a list of OUIs for the vendor information element
1685 * Ideally, the hardware would filter out any beacons without changes in the
1686 * requested elements, but if it cannot support that it may, at the expense
1687 * of some efficiency, filter out only a subset. For example, if the device
1688 * doesn't support checking for OUIs it should pass up all changes in all
1689 * vendor information elements.
1691 * Note that change, for the sake of simplification, also includes information
1692 * elements appearing or disappearing from the beacon.
1694 * Some hardware supports an "ignore list" instead, just make sure nothing
1695 * that was requested is on the ignore list, and include commonly changing
1696 * information element IDs in the ignore list, for example 11 (BSS load) and
1697 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1698 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1699 * it could also include some currently unused IDs.
1702 * In addition to these capabilities, hardware should support notifying the
1703 * host of changes in the beacon RSSI. This is relevant to implement roaming
1704 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1705 * the received data packets). This can consist in notifying the host when
1706 * the RSSI changes significantly or when it drops below or rises above
1707 * configurable thresholds. In the future these thresholds will also be
1708 * configured by mac80211 (which gets them from userspace) to implement
1709 * them as the roaming algorithm requires.
1711 * If the hardware cannot implement this, the driver should ask it to
1712 * periodically pass beacon frames to the host so that software can do the
1713 * signal strength threshold checking.
1717 * DOC: Spatial multiplexing power save
1719 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1720 * power in an 802.11n implementation. For details on the mechanism
1721 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1722 * "11.2.3 SM power save".
1724 * The mac80211 implementation is capable of sending action frames
1725 * to update the AP about the station's SMPS mode, and will instruct
1726 * the driver to enter the specific mode. It will also announce the
1727 * requested SMPS mode during the association handshake. Hardware
1728 * support for this feature is required, and can be indicated by
1731 * The default mode will be "automatic", which nl80211/cfg80211
1732 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1733 * turned off otherwise.
1735 * To support this feature, the driver must set the appropriate
1736 * hardware support flags, and handle the SMPS flag to the config()
1737 * operation. It will then with this mechanism be instructed to
1738 * enter the requested SMPS mode while associated to an HT AP.
1742 * DOC: Frame filtering
1744 * mac80211 requires to see many management frames for proper
1745 * operation, and users may want to see many more frames when
1746 * in monitor mode. However, for best CPU usage and power consumption,
1747 * having as few frames as possible percolate through the stack is
1748 * desirable. Hence, the hardware should filter as much as possible.
1750 * To achieve this, mac80211 uses filter flags (see below) to tell
1751 * the driver's configure_filter() function which frames should be
1752 * passed to mac80211 and which should be filtered out.
1754 * Before configure_filter() is invoked, the prepare_multicast()
1755 * callback is invoked with the parameters @mc_count and @mc_list
1756 * for the combined multicast address list of all virtual interfaces.
1757 * It's use is optional, and it returns a u64 that is passed to
1758 * configure_filter(). Additionally, configure_filter() has the
1759 * arguments @changed_flags telling which flags were changed and
1760 * @total_flags with the new flag states.
1762 * If your device has no multicast address filters your driver will
1763 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1764 * parameter to see whether multicast frames should be accepted
1767 * All unsupported flags in @total_flags must be cleared.
1768 * Hardware does not support a flag if it is incapable of _passing_
1769 * the frame to the stack. Otherwise the driver must ignore
1770 * the flag, but not clear it.
1771 * You must _only_ clear the flag (announce no support for the
1772 * flag to mac80211) if you are not able to pass the packet type
1773 * to the stack (so the hardware always filters it).
1774 * So for example, you should clear @FIF_CONTROL, if your hardware
1775 * always filters control frames. If your hardware always passes
1776 * control frames to the kernel and is incapable of filtering them,
1777 * you do _not_ clear the @FIF_CONTROL flag.
1778 * This rule applies to all other FIF flags as well.
1782 * DOC: AP support for powersaving clients
1784 * In order to implement AP and P2P GO modes, mac80211 has support for
1785 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1786 * There currently is no support for sAPSD.
1788 * There is one assumption that mac80211 makes, namely that a client
1789 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1790 * Both are supported, and both can be used by the same client, but
1791 * they can't be used concurrently by the same client. This simplifies
1794 * The first thing to keep in mind is that there is a flag for complete
1795 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1796 * mac80211 expects the driver to handle most of the state machine for
1797 * powersaving clients and will ignore the PM bit in incoming frames.
1798 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1799 * stations' powersave transitions. In this mode, mac80211 also doesn't
1800 * handle PS-Poll/uAPSD.
1802 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1803 * PM bit in incoming frames for client powersave transitions. When a
1804 * station goes to sleep, we will stop transmitting to it. There is,
1805 * however, a race condition: a station might go to sleep while there is
1806 * data buffered on hardware queues. If the device has support for this
1807 * it will reject frames, and the driver should give the frames back to
1808 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1809 * cause mac80211 to retry the frame when the station wakes up. The
1810 * driver is also notified of powersave transitions by calling its
1811 * @sta_notify callback.
1813 * When the station is asleep, it has three choices: it can wake up,
1814 * it can PS-Poll, or it can possibly start a uAPSD service period.
1815 * Waking up is implemented by simply transmitting all buffered (and
1816 * filtered) frames to the station. This is the easiest case. When
1817 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1818 * will inform the driver of this with the @allow_buffered_frames
1819 * callback; this callback is optional. mac80211 will then transmit
1820 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1821 * on each frame. The last frame in the service period (or the only
1822 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1823 * indicate that it ends the service period; as this frame must have
1824 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1825 * When TX status is reported for this frame, the service period is
1826 * marked has having ended and a new one can be started by the peer.
1828 * Additionally, non-bufferable MMPDUs can also be transmitted by
1829 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1831 * Another race condition can happen on some devices like iwlwifi
1832 * when there are frames queued for the station and it wakes up
1833 * or polls; the frames that are already queued could end up being
1834 * transmitted first instead, causing reordering and/or wrong
1835 * processing of the EOSP. The cause is that allowing frames to be
1836 * transmitted to a certain station is out-of-band communication to
1837 * the device. To allow this problem to be solved, the driver can
1838 * call ieee80211_sta_block_awake() if frames are buffered when it
1839 * is notified that the station went to sleep. When all these frames
1840 * have been filtered (see above), it must call the function again
1841 * to indicate that the station is no longer blocked.
1843 * If the driver buffers frames in the driver for aggregation in any
1844 * way, it must use the ieee80211_sta_set_buffered() call when it is
1845 * notified of the station going to sleep to inform mac80211 of any
1846 * TIDs that have frames buffered. Note that when a station wakes up
1847 * this information is reset (hence the requirement to call it when
1848 * informed of the station going to sleep). Then, when a service
1849 * period starts for any reason, @release_buffered_frames is called
1850 * with the number of frames to be released and which TIDs they are
1851 * to come from. In this case, the driver is responsible for setting
1852 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1853 * to help the @more_data paramter is passed to tell the driver if
1854 * there is more data on other TIDs -- the TIDs to release frames
1855 * from are ignored since mac80211 doesn't know how many frames the
1856 * buffers for those TIDs contain.
1858 * If the driver also implement GO mode, where absence periods may
1859 * shorten service periods (or abort PS-Poll responses), it must
1860 * filter those response frames except in the case of frames that
1861 * are buffered in the driver -- those must remain buffered to avoid
1862 * reordering. Because it is possible that no frames are released
1863 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1864 * to indicate to mac80211 that the service period ended anyway.
1866 * Finally, if frames from multiple TIDs are released from mac80211
1867 * but the driver might reorder them, it must clear & set the flags
1868 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1869 * and also take care of the EOSP and MORE_DATA bits in the frame.
1870 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1874 * DOC: HW queue control
1876 * Before HW queue control was introduced, mac80211 only had a single static
1877 * assignment of per-interface AC software queues to hardware queues. This
1878 * was problematic for a few reasons:
1879 * 1) off-channel transmissions might get stuck behind other frames
1880 * 2) multiple virtual interfaces couldn't be handled correctly
1881 * 3) after-DTIM frames could get stuck behind other frames
1883 * To solve this, hardware typically uses multiple different queues for all
1884 * the different usages, and this needs to be propagated into mac80211 so it
1885 * won't have the same problem with the software queues.
1887 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1888 * flag that tells it that the driver implements its own queue control. To do
1889 * so, the driver will set up the various queues in each &struct ieee80211_vif
1890 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1891 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1892 * if necessary will queue the frame on the right software queue that mirrors
1893 * the hardware queue.
1894 * Additionally, the driver has to then use these HW queue IDs for the queue
1895 * management functions (ieee80211_stop_queue() et al.)
1897 * The driver is free to set up the queue mappings as needed, multiple virtual
1898 * interfaces may map to the same hardware queues if needed. The setup has to
1899 * happen during add_interface or change_interface callbacks. For example, a
1900 * driver supporting station+station and station+AP modes might decide to have
1901 * 10 hardware queues to handle different scenarios:
1903 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1904 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1905 * after-DTIM queue for AP: 8
1906 * off-channel queue: 9
1908 * It would then set up the hardware like this:
1909 * hw.offchannel_tx_hw_queue = 9
1911 * and the first virtual interface that is added as follows:
1912 * vif.hw_queue[IEEE80211_AC_VO] = 0
1913 * vif.hw_queue[IEEE80211_AC_VI] = 1
1914 * vif.hw_queue[IEEE80211_AC_BE] = 2
1915 * vif.hw_queue[IEEE80211_AC_BK] = 3
1916 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1917 * and the second virtual interface with 4-7.
1919 * If queue 6 gets full, for example, mac80211 would only stop the second
1920 * virtual interface's BE queue since virtual interface queues are per AC.
1922 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1923 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1924 * queue could potentially be shared since mac80211 will look at cab_queue when
1925 * a queue is stopped/woken even if the interface is not in AP mode.
1929 * enum ieee80211_filter_flags - hardware filter flags
1931 * These flags determine what the filter in hardware should be
1932 * programmed to let through and what should not be passed to the
1933 * stack. It is always safe to pass more frames than requested,
1934 * but this has negative impact on power consumption.
1936 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1937 * think of the BSS as your network segment and then this corresponds
1938 * to the regular ethernet device promiscuous mode.
1940 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1941 * by the user or if the hardware is not capable of filtering by
1942 * multicast address.
1944 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1945 * %RX_FLAG_FAILED_FCS_CRC for them)
1947 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1948 * the %RX_FLAG_FAILED_PLCP_CRC for them
1950 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1951 * to the hardware that it should not filter beacons or probe responses
1952 * by BSSID. Filtering them can greatly reduce the amount of processing
1953 * mac80211 needs to do and the amount of CPU wakeups, so you should
1954 * honour this flag if possible.
1956 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1957 * is not set then only those addressed to this station.
1959 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1961 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1962 * those addressed to this station.
1964 * @FIF_PROBE_REQ: pass probe request frames
1966 enum ieee80211_filter_flags
{
1967 FIF_PROMISC_IN_BSS
= 1<<0,
1968 FIF_ALLMULTI
= 1<<1,
1970 FIF_PLCPFAIL
= 1<<3,
1971 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1973 FIF_OTHER_BSS
= 1<<6,
1975 FIF_PROBE_REQ
= 1<<8,
1979 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1981 * These flags are used with the ampdu_action() callback in
1982 * &struct ieee80211_ops to indicate which action is needed.
1984 * Note that drivers MUST be able to deal with a TX aggregation
1985 * session being stopped even before they OK'ed starting it by
1986 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1987 * might receive the addBA frame and send a delBA right away!
1989 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1990 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1991 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1992 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1993 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1995 enum ieee80211_ampdu_mlme_action
{
1996 IEEE80211_AMPDU_RX_START
,
1997 IEEE80211_AMPDU_RX_STOP
,
1998 IEEE80211_AMPDU_TX_START
,
1999 IEEE80211_AMPDU_TX_STOP
,
2000 IEEE80211_AMPDU_TX_OPERATIONAL
,
2004 * enum ieee80211_frame_release_type - frame release reason
2005 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2006 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2007 * frame received on trigger-enabled AC
2009 enum ieee80211_frame_release_type
{
2010 IEEE80211_FRAME_RELEASE_PSPOLL
,
2011 IEEE80211_FRAME_RELEASE_UAPSD
,
2015 * enum ieee80211_rate_control_changed - flags to indicate what changed
2017 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2018 * to this station changed.
2019 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2020 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2021 * changed (in IBSS mode) due to discovering more information about
2024 enum ieee80211_rate_control_changed
{
2025 IEEE80211_RC_BW_CHANGED
= BIT(0),
2026 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
2027 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
2031 * struct ieee80211_ops - callbacks from mac80211 to the driver
2033 * This structure contains various callbacks that the driver may
2034 * handle or, in some cases, must handle, for example to configure
2035 * the hardware to a new channel or to transmit a frame.
2037 * @tx: Handler that 802.11 module calls for each transmitted frame.
2038 * skb contains the buffer starting from the IEEE 802.11 header.
2039 * The low-level driver should send the frame out based on
2040 * configuration in the TX control data. This handler should,
2041 * preferably, never fail and stop queues appropriately.
2044 * @start: Called before the first netdevice attached to the hardware
2045 * is enabled. This should turn on the hardware and must turn on
2046 * frame reception (for possibly enabled monitor interfaces.)
2047 * Returns negative error codes, these may be seen in userspace,
2049 * When the device is started it should not have a MAC address
2050 * to avoid acknowledging frames before a non-monitor device
2052 * Must be implemented and can sleep.
2054 * @stop: Called after last netdevice attached to the hardware
2055 * is disabled. This should turn off the hardware (at least
2056 * it must turn off frame reception.)
2057 * May be called right after add_interface if that rejects
2058 * an interface. If you added any work onto the mac80211 workqueue
2059 * you should ensure to cancel it on this callback.
2060 * Must be implemented and can sleep.
2062 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2063 * stop transmitting and doing any other configuration, and then
2064 * ask the device to suspend. This is only invoked when WoWLAN is
2065 * configured, otherwise the device is deconfigured completely and
2066 * reconfigured at resume time.
2067 * The driver may also impose special conditions under which it
2068 * wants to use the "normal" suspend (deconfigure), say if it only
2069 * supports WoWLAN when the device is associated. In this case, it
2070 * must return 1 from this function.
2072 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2073 * now resuming its operation, after this the device must be fully
2074 * functional again. If this returns an error, the only way out is
2075 * to also unregister the device. If it returns 1, then mac80211
2076 * will also go through the regular complete restart on resume.
2078 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2079 * modified. The reason is that device_set_wakeup_enable() is
2080 * supposed to be called when the configuration changes, not only
2083 * @add_interface: Called when a netdevice attached to the hardware is
2084 * enabled. Because it is not called for monitor mode devices, @start
2085 * and @stop must be implemented.
2086 * The driver should perform any initialization it needs before
2087 * the device can be enabled. The initial configuration for the
2088 * interface is given in the conf parameter.
2089 * The callback may refuse to add an interface by returning a
2090 * negative error code (which will be seen in userspace.)
2091 * Must be implemented and can sleep.
2093 * @change_interface: Called when a netdevice changes type. This callback
2094 * is optional, but only if it is supported can interface types be
2095 * switched while the interface is UP. The callback may sleep.
2096 * Note that while an interface is being switched, it will not be
2097 * found by the interface iteration callbacks.
2099 * @remove_interface: Notifies a driver that an interface is going down.
2100 * The @stop callback is called after this if it is the last interface
2101 * and no monitor interfaces are present.
2102 * When all interfaces are removed, the MAC address in the hardware
2103 * must be cleared so the device no longer acknowledges packets,
2104 * the mac_addr member of the conf structure is, however, set to the
2105 * MAC address of the device going away.
2106 * Hence, this callback must be implemented. It can sleep.
2108 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2109 * function to change hardware configuration, e.g., channel.
2110 * This function should never fail but returns a negative error code
2111 * if it does. The callback can sleep.
2113 * @bss_info_changed: Handler for configuration requests related to BSS
2114 * parameters that may vary during BSS's lifespan, and may affect low
2115 * level driver (e.g. assoc/disassoc status, erp parameters).
2116 * This function should not be used if no BSS has been set, unless
2117 * for association indication. The @changed parameter indicates which
2118 * of the bss parameters has changed when a call is made. The callback
2121 * @prepare_multicast: Prepare for multicast filter configuration.
2122 * This callback is optional, and its return value is passed
2123 * to configure_filter(). This callback must be atomic.
2125 * @configure_filter: Configure the device's RX filter.
2126 * See the section "Frame filtering" for more information.
2127 * This callback must be implemented and can sleep.
2129 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2130 * must be set or cleared for a given STA. Must be atomic.
2132 * @set_key: See the section "Hardware crypto acceleration"
2133 * This callback is only called between add_interface and
2134 * remove_interface calls, i.e. while the given virtual interface
2136 * Returns a negative error code if the key can't be added.
2137 * The callback can sleep.
2139 * @update_tkip_key: See the section "Hardware crypto acceleration"
2140 * This callback will be called in the context of Rx. Called for drivers
2141 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2142 * The callback must be atomic.
2144 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2145 * host is suspended, it can assign this callback to retrieve the data
2146 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2147 * After rekeying was done it should (for example during resume) notify
2148 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2150 * @hw_scan: Ask the hardware to service the scan request, no need to start
2151 * the scan state machine in stack. The scan must honour the channel
2152 * configuration done by the regulatory agent in the wiphy's
2153 * registered bands. The hardware (or the driver) needs to make sure
2154 * that power save is disabled.
2155 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2156 * entire IEs after the SSID, so that drivers need not look at these
2157 * at all but just send them after the SSID -- mac80211 includes the
2158 * (extended) supported rates and HT information (where applicable).
2159 * When the scan finishes, ieee80211_scan_completed() must be called;
2160 * note that it also must be called when the scan cannot finish due to
2161 * any error unless this callback returned a negative error code.
2162 * The callback can sleep.
2164 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2165 * The driver should ask the hardware to cancel the scan (if possible),
2166 * but the scan will be completed only after the driver will call
2167 * ieee80211_scan_completed().
2168 * This callback is needed for wowlan, to prevent enqueueing a new
2169 * scan_work after the low-level driver was already suspended.
2170 * The callback can sleep.
2172 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2173 * specific intervals. The driver must call the
2174 * ieee80211_sched_scan_results() function whenever it finds results.
2175 * This process will continue until sched_scan_stop is called.
2177 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2179 * @sw_scan_start: Notifier function that is called just before a software scan
2180 * is started. Can be NULL, if the driver doesn't need this notification.
2181 * The callback can sleep.
2183 * @sw_scan_complete: Notifier function that is called just after a
2184 * software scan finished. Can be NULL, if the driver doesn't need
2185 * this notification.
2186 * The callback can sleep.
2188 * @get_stats: Return low-level statistics.
2189 * Returns zero if statistics are available.
2190 * The callback can sleep.
2192 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2193 * callback should be provided to read the TKIP transmit IVs (both IV32
2194 * and IV16) for the given key from hardware.
2195 * The callback must be atomic.
2197 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2198 * if the device does fragmentation by itself; if this callback is
2199 * implemented then the stack will not do fragmentation.
2200 * The callback can sleep.
2202 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2203 * The callback can sleep.
2205 * @sta_add: Notifies low level driver about addition of an associated station,
2206 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2208 * @sta_remove: Notifies low level driver about removal of an associated
2209 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2211 * @sta_notify: Notifies low level driver about power state transition of an
2212 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2213 * in AP mode, this callback will not be called when the flag
2214 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2216 * @sta_state: Notifies low level driver about state transition of a
2217 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2218 * This callback is mutually exclusive with @sta_add/@sta_remove.
2219 * It must not fail for down transitions but may fail for transitions
2220 * up the list of states.
2221 * The callback can sleep.
2223 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2224 * used to transmit to the station. The changes are advertised with bits
2225 * from &enum ieee80211_rate_control_changed and the values are reflected
2226 * in the station data. This callback should only be used when the driver
2227 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2228 * otherwise the rate control algorithm is notified directly.
2231 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2232 * bursting) for a hardware TX queue.
2233 * Returns a negative error code on failure.
2234 * The callback can sleep.
2236 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2237 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2238 * required function.
2239 * The callback can sleep.
2241 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2242 * Currently, this is only used for IBSS mode debugging. Is not a
2243 * required function.
2244 * The callback can sleep.
2246 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2247 * with other STAs in the IBSS. This is only used in IBSS mode. This
2248 * function is optional if the firmware/hardware takes full care of
2249 * TSF synchronization.
2250 * The callback can sleep.
2252 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2253 * This is needed only for IBSS mode and the result of this function is
2254 * used to determine whether to reply to Probe Requests.
2255 * Returns non-zero if this device sent the last beacon.
2256 * The callback can sleep.
2258 * @ampdu_action: Perform a certain A-MPDU action
2259 * The RA/TID combination determines the destination and TID we want
2260 * the ampdu action to be performed for. The action is defined through
2261 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2262 * is the first frame we expect to perform the action on. Notice
2263 * that TX/RX_STOP can pass NULL for this parameter.
2264 * The @buf_size parameter is only valid when the action is set to
2265 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2266 * buffer size (number of subframes) for this session -- the driver
2267 * may neither send aggregates containing more subframes than this
2268 * nor send aggregates in a way that lost frames would exceed the
2269 * buffer size. If just limiting the aggregate size, this would be
2270 * possible with a buf_size of 8:
2272 * - RX: 2....7 (lost frame #1)
2274 * which is invalid since #1 was now re-transmitted well past the
2275 * buffer size of 8. Correct ways to retransmit #1 would be:
2276 * - TX: 1 or 18 or 81
2277 * Even "189" would be wrong since 1 could be lost again.
2279 * Returns a negative error code on failure.
2280 * The callback can sleep.
2282 * @get_survey: Return per-channel survey information
2284 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2285 * need to set wiphy->rfkill_poll to %true before registration,
2286 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2287 * The callback can sleep.
2289 * @set_coverage_class: Set slot time for given coverage class as specified
2290 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2291 * accordingly. This callback is not required and may sleep.
2293 * @testmode_cmd: Implement a cfg80211 test mode command.
2294 * The callback can sleep.
2295 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2297 * @flush: Flush all pending frames from the hardware queue, making sure
2298 * that the hardware queues are empty. If the parameter @drop is set
2299 * to %true, pending frames may be dropped. The callback can sleep.
2301 * @channel_switch: Drivers that need (or want) to offload the channel
2302 * switch operation for CSAs received from the AP may implement this
2303 * callback. They must then call ieee80211_chswitch_done() to indicate
2304 * completion of the channel switch.
2306 * @napi_poll: Poll Rx queue for incoming data frames.
2308 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2309 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2310 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2311 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2313 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2315 * @remain_on_channel: Starts an off-channel period on the given channel, must
2316 * call back to ieee80211_ready_on_channel() when on that channel. Note
2317 * that normal channel traffic is not stopped as this is intended for hw
2318 * offload. Frames to transmit on the off-channel channel are transmitted
2319 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2320 * duration (which will always be non-zero) expires, the driver must call
2321 * ieee80211_remain_on_channel_expired().
2322 * Note that this callback may be called while the device is in IDLE and
2323 * must be accepted in this case.
2324 * This callback may sleep.
2325 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2326 * aborted before it expires. This callback may sleep.
2328 * @set_ringparam: Set tx and rx ring sizes.
2330 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2332 * @tx_frames_pending: Check if there is any pending frame in the hardware
2333 * queues before entering power save.
2335 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2336 * when transmitting a frame. Currently only legacy rates are handled.
2337 * The callback can sleep.
2338 * @rssi_callback: Notify driver when the average RSSI goes above/below
2339 * thresholds that were registered previously. The callback can sleep.
2341 * @release_buffered_frames: Release buffered frames according to the given
2342 * parameters. In the case where the driver buffers some frames for
2343 * sleeping stations mac80211 will use this callback to tell the driver
2344 * to release some frames, either for PS-poll or uAPSD.
2345 * Note that if the @more_data paramter is %false the driver must check
2346 * if there are more frames on the given TIDs, and if there are more than
2347 * the frames being released then it must still set the more-data bit in
2348 * the frame. If the @more_data parameter is %true, then of course the
2349 * more-data bit must always be set.
2350 * The @tids parameter tells the driver which TIDs to release frames
2351 * from, for PS-poll it will always have only a single bit set.
2352 * In the case this is used for a PS-poll initiated release, the
2353 * @num_frames parameter will always be 1 so code can be shared. In
2354 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2355 * on the TX status (and must report TX status) so that the PS-poll
2356 * period is properly ended. This is used to avoid sending multiple
2357 * responses for a retried PS-poll frame.
2358 * In the case this is used for uAPSD, the @num_frames parameter may be
2359 * bigger than one, but the driver may send fewer frames (it must send
2360 * at least one, however). In this case it is also responsible for
2361 * setting the EOSP flag in the QoS header of the frames. Also, when the
2362 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2363 * on the last frame in the SP. Alternatively, it may call the function
2364 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2365 * This callback must be atomic.
2366 * @allow_buffered_frames: Prepare device to allow the given number of frames
2367 * to go out to the given station. The frames will be sent by mac80211
2368 * via the usual TX path after this call. The TX information for frames
2369 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2370 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2371 * frames from multiple TIDs are released and the driver might reorder
2372 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2373 * on the last frame and clear it on all others and also handle the EOSP
2374 * bit in the QoS header correctly. Alternatively, it can also call the
2375 * ieee80211_sta_eosp_irqsafe() function.
2376 * The @tids parameter is a bitmap and tells the driver which TIDs the
2377 * frames will be on; it will at most have two bits set.
2378 * This callback must be atomic.
2380 * @get_et_sset_count: Ethtool API to get string-set count.
2382 * @get_et_stats: Ethtool API to get a set of u64 stats.
2384 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2385 * and perhaps other supported types of ethtool data-sets.
2387 * @get_rssi: Get current signal strength in dBm, the function is optional
2390 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2391 * before associated. In multi-channel scenarios, a virtual interface is
2392 * bound to a channel before it is associated, but as it isn't associated
2393 * yet it need not necessarily be given airtime, in particular since any
2394 * transmission to a P2P GO needs to be synchronized against the GO's
2395 * powersave state. mac80211 will call this function before transmitting a
2396 * management frame prior to having successfully associated to allow the
2397 * driver to give it channel time for the transmission, to get a response
2398 * and to be able to synchronize with the GO.
2399 * The callback will be called before each transmission and upon return
2400 * mac80211 will transmit the frame right away.
2401 * The callback is optional and can (should!) sleep.
2403 * @add_chanctx: Notifies device driver about new channel context creation.
2404 * @remove_chanctx: Notifies device driver about channel context destruction.
2405 * @change_chanctx: Notifies device driver about channel context changes that
2406 * may happen when combining different virtual interfaces on the same
2407 * channel context with different settings
2408 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2409 * to vif. Possible use is for hw queue remapping.
2410 * @unassign_vif_chanctx: Notifies device driver about channel context being
2412 * @start_ap: Start operation on the AP interface, this is called after all the
2413 * information in bss_conf is set and beacon can be retrieved. A channel
2414 * context is bound before this is called. Note that if the driver uses
2415 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2416 * just "paused" for scanning/ROC, which is indicated by the beacon being
2417 * disabled/enabled via @bss_info_changed.
2418 * @stop_ap: Stop operation on the AP interface.
2420 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2421 * reconfiguration has completed. This can help the driver implement the
2422 * reconfiguration step. This callback may sleep.
2424 struct ieee80211_ops
{
2425 void (*tx
)(struct ieee80211_hw
*hw
,
2426 struct ieee80211_tx_control
*control
,
2427 struct sk_buff
*skb
);
2428 int (*start
)(struct ieee80211_hw
*hw
);
2429 void (*stop
)(struct ieee80211_hw
*hw
);
2431 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
2432 int (*resume
)(struct ieee80211_hw
*hw
);
2433 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
2435 int (*add_interface
)(struct ieee80211_hw
*hw
,
2436 struct ieee80211_vif
*vif
);
2437 int (*change_interface
)(struct ieee80211_hw
*hw
,
2438 struct ieee80211_vif
*vif
,
2439 enum nl80211_iftype new_type
, bool p2p
);
2440 void (*remove_interface
)(struct ieee80211_hw
*hw
,
2441 struct ieee80211_vif
*vif
);
2442 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
2443 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
2444 struct ieee80211_vif
*vif
,
2445 struct ieee80211_bss_conf
*info
,
2448 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2449 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2451 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
2452 struct netdev_hw_addr_list
*mc_list
);
2453 void (*configure_filter
)(struct ieee80211_hw
*hw
,
2454 unsigned int changed_flags
,
2455 unsigned int *total_flags
,
2457 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
2459 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
2460 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
2461 struct ieee80211_key_conf
*key
);
2462 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
2463 struct ieee80211_vif
*vif
,
2464 struct ieee80211_key_conf
*conf
,
2465 struct ieee80211_sta
*sta
,
2466 u32 iv32
, u16
*phase1key
);
2467 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
2468 struct ieee80211_vif
*vif
,
2469 struct cfg80211_gtk_rekey_data
*data
);
2470 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2471 struct cfg80211_scan_request
*req
);
2472 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
2473 struct ieee80211_vif
*vif
);
2474 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
2475 struct ieee80211_vif
*vif
,
2476 struct cfg80211_sched_scan_request
*req
,
2477 struct ieee80211_sched_scan_ies
*ies
);
2478 void (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
2479 struct ieee80211_vif
*vif
);
2480 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
2481 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
2482 int (*get_stats
)(struct ieee80211_hw
*hw
,
2483 struct ieee80211_low_level_stats
*stats
);
2484 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
2485 u32
*iv32
, u16
*iv16
);
2486 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2487 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
2488 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2489 struct ieee80211_sta
*sta
);
2490 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2491 struct ieee80211_sta
*sta
);
2492 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2493 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
2494 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2495 struct ieee80211_sta
*sta
,
2496 enum ieee80211_sta_state old_state
,
2497 enum ieee80211_sta_state new_state
);
2498 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
2499 struct ieee80211_vif
*vif
,
2500 struct ieee80211_sta
*sta
,
2502 int (*conf_tx
)(struct ieee80211_hw
*hw
,
2503 struct ieee80211_vif
*vif
, u16 ac
,
2504 const struct ieee80211_tx_queue_params
*params
);
2505 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2506 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2508 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2509 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
2510 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
2511 struct ieee80211_vif
*vif
,
2512 enum ieee80211_ampdu_mlme_action action
,
2513 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
,
2515 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
2516 struct survey_info
*survey
);
2517 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
2518 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, u8 coverage_class
);
2519 #ifdef CONFIG_NL80211_TESTMODE
2520 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, void *data
, int len
);
2521 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
2522 struct netlink_callback
*cb
,
2523 void *data
, int len
);
2525 void (*flush
)(struct ieee80211_hw
*hw
, bool drop
);
2526 void (*channel_switch
)(struct ieee80211_hw
*hw
,
2527 struct ieee80211_channel_switch
*ch_switch
);
2528 int (*napi_poll
)(struct ieee80211_hw
*hw
, int budget
);
2529 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
2530 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
2532 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
2533 struct ieee80211_vif
*vif
,
2534 struct ieee80211_channel
*chan
,
2535 enum nl80211_channel_type channel_type
,
2537 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
2538 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
2539 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
2540 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
2541 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
2542 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2543 const struct cfg80211_bitrate_mask
*mask
);
2544 void (*rssi_callback
)(struct ieee80211_hw
*hw
,
2545 enum ieee80211_rssi_event rssi_event
);
2547 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
2548 struct ieee80211_sta
*sta
,
2549 u16 tids
, int num_frames
,
2550 enum ieee80211_frame_release_type reason
,
2552 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
2553 struct ieee80211_sta
*sta
,
2554 u16 tids
, int num_frames
,
2555 enum ieee80211_frame_release_type reason
,
2558 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
2559 struct ieee80211_vif
*vif
, int sset
);
2560 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
2561 struct ieee80211_vif
*vif
,
2562 struct ethtool_stats
*stats
, u64
*data
);
2563 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
2564 struct ieee80211_vif
*vif
,
2565 u32 sset
, u8
*data
);
2566 int (*get_rssi
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2567 struct ieee80211_sta
*sta
, s8
*rssi_dbm
);
2569 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
2570 struct ieee80211_vif
*vif
);
2572 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
2573 struct ieee80211_chanctx_conf
*ctx
);
2574 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
2575 struct ieee80211_chanctx_conf
*ctx
);
2576 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
2577 struct ieee80211_chanctx_conf
*ctx
,
2579 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
2580 struct ieee80211_vif
*vif
,
2581 struct ieee80211_chanctx_conf
*ctx
);
2582 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
2583 struct ieee80211_vif
*vif
,
2584 struct ieee80211_chanctx_conf
*ctx
);
2586 void (*restart_complete
)(struct ieee80211_hw
*hw
);
2590 * ieee80211_alloc_hw - Allocate a new hardware device
2592 * This must be called once for each hardware device. The returned pointer
2593 * must be used to refer to this device when calling other functions.
2594 * mac80211 allocates a private data area for the driver pointed to by
2595 * @priv in &struct ieee80211_hw, the size of this area is given as
2598 * @priv_data_len: length of private data
2599 * @ops: callbacks for this device
2601 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
2602 const struct ieee80211_ops
*ops
);
2605 * ieee80211_register_hw - Register hardware device
2607 * You must call this function before any other functions in
2608 * mac80211. Note that before a hardware can be registered, you
2609 * need to fill the contained wiphy's information.
2611 * @hw: the device to register as returned by ieee80211_alloc_hw()
2613 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
2616 * struct ieee80211_tpt_blink - throughput blink description
2617 * @throughput: throughput in Kbit/sec
2618 * @blink_time: blink time in milliseconds
2619 * (full cycle, ie. one off + one on period)
2621 struct ieee80211_tpt_blink
{
2627 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2628 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2629 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2630 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2631 * interface is connected in some way, including being an AP
2633 enum ieee80211_tpt_led_trigger_flags
{
2634 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
2635 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
2636 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
2639 #ifdef CONFIG_MAC80211_LEDS
2640 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
2641 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
2642 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
2643 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
2644 extern char *__ieee80211_create_tpt_led_trigger(
2645 struct ieee80211_hw
*hw
, unsigned int flags
,
2646 const struct ieee80211_tpt_blink
*blink_table
,
2647 unsigned int blink_table_len
);
2650 * ieee80211_get_tx_led_name - get name of TX LED
2652 * mac80211 creates a transmit LED trigger for each wireless hardware
2653 * that can be used to drive LEDs if your driver registers a LED device.
2654 * This function returns the name (or %NULL if not configured for LEDs)
2655 * of the trigger so you can automatically link the LED device.
2657 * @hw: the hardware to get the LED trigger name for
2659 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
2661 #ifdef CONFIG_MAC80211_LEDS
2662 return __ieee80211_get_tx_led_name(hw
);
2669 * ieee80211_get_rx_led_name - get name of RX LED
2671 * mac80211 creates a receive LED trigger for each wireless hardware
2672 * that can be used to drive LEDs if your driver registers a LED device.
2673 * This function returns the name (or %NULL if not configured for LEDs)
2674 * of the trigger so you can automatically link the LED device.
2676 * @hw: the hardware to get the LED trigger name for
2678 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
2680 #ifdef CONFIG_MAC80211_LEDS
2681 return __ieee80211_get_rx_led_name(hw
);
2688 * ieee80211_get_assoc_led_name - get name of association LED
2690 * mac80211 creates a association LED trigger for each wireless hardware
2691 * that can be used to drive LEDs if your driver registers a LED device.
2692 * This function returns the name (or %NULL if not configured for LEDs)
2693 * of the trigger so you can automatically link the LED device.
2695 * @hw: the hardware to get the LED trigger name for
2697 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
2699 #ifdef CONFIG_MAC80211_LEDS
2700 return __ieee80211_get_assoc_led_name(hw
);
2707 * ieee80211_get_radio_led_name - get name of radio LED
2709 * mac80211 creates a radio change LED trigger for each wireless hardware
2710 * that can be used to drive LEDs if your driver registers a LED device.
2711 * This function returns the name (or %NULL if not configured for LEDs)
2712 * of the trigger so you can automatically link the LED device.
2714 * @hw: the hardware to get the LED trigger name for
2716 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
2718 #ifdef CONFIG_MAC80211_LEDS
2719 return __ieee80211_get_radio_led_name(hw
);
2726 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2727 * @hw: the hardware to create the trigger for
2728 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2729 * @blink_table: the blink table -- needs to be ordered by throughput
2730 * @blink_table_len: size of the blink table
2732 * This function returns %NULL (in case of error, or if no LED
2733 * triggers are configured) or the name of the new trigger.
2734 * This function must be called before ieee80211_register_hw().
2736 static inline char *
2737 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
2738 const struct ieee80211_tpt_blink
*blink_table
,
2739 unsigned int blink_table_len
)
2741 #ifdef CONFIG_MAC80211_LEDS
2742 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
2750 * ieee80211_unregister_hw - Unregister a hardware device
2752 * This function instructs mac80211 to free allocated resources
2753 * and unregister netdevices from the networking subsystem.
2755 * @hw: the hardware to unregister
2757 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
2760 * ieee80211_free_hw - free hardware descriptor
2762 * This function frees everything that was allocated, including the
2763 * private data for the driver. You must call ieee80211_unregister_hw()
2764 * before calling this function.
2766 * @hw: the hardware to free
2768 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
2771 * ieee80211_restart_hw - restart hardware completely
2773 * Call this function when the hardware was restarted for some reason
2774 * (hardware error, ...) and the driver is unable to restore its state
2775 * by itself. mac80211 assumes that at this point the driver/hardware
2776 * is completely uninitialised and stopped, it starts the process by
2777 * calling the ->start() operation. The driver will need to reset all
2778 * internal state that it has prior to calling this function.
2780 * @hw: the hardware to restart
2782 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
2784 /** ieee80211_napi_schedule - schedule NAPI poll
2786 * Use this function to schedule NAPI polling on a device.
2788 * @hw: the hardware to start polling
2790 void ieee80211_napi_schedule(struct ieee80211_hw
*hw
);
2792 /** ieee80211_napi_complete - complete NAPI polling
2794 * Use this function to finish NAPI polling on a device.
2796 * @hw: the hardware to stop polling
2798 void ieee80211_napi_complete(struct ieee80211_hw
*hw
);
2801 * ieee80211_rx - receive frame
2803 * Use this function to hand received frames to mac80211. The receive
2804 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2805 * paged @skb is used, the driver is recommended to put the ieee80211
2806 * header of the frame on the linear part of the @skb to avoid memory
2807 * allocation and/or memcpy by the stack.
2809 * This function may not be called in IRQ context. Calls to this function
2810 * for a single hardware must be synchronized against each other. Calls to
2811 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2812 * mixed for a single hardware.
2814 * In process context use instead ieee80211_rx_ni().
2816 * @hw: the hardware this frame came in on
2817 * @skb: the buffer to receive, owned by mac80211 after this call
2819 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2822 * ieee80211_rx_irqsafe - receive frame
2824 * Like ieee80211_rx() but can be called in IRQ context
2825 * (internally defers to a tasklet.)
2827 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2828 * be mixed for a single hardware.
2830 * @hw: the hardware this frame came in on
2831 * @skb: the buffer to receive, owned by mac80211 after this call
2833 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2836 * ieee80211_rx_ni - receive frame (in process context)
2838 * Like ieee80211_rx() but can be called in process context
2839 * (internally disables bottom halves).
2841 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2842 * not be mixed for a single hardware.
2844 * @hw: the hardware this frame came in on
2845 * @skb: the buffer to receive, owned by mac80211 after this call
2847 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
2848 struct sk_buff
*skb
)
2851 ieee80211_rx(hw
, skb
);
2856 * ieee80211_sta_ps_transition - PS transition for connected sta
2858 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2859 * flag set, use this function to inform mac80211 about a connected station
2860 * entering/leaving PS mode.
2862 * This function may not be called in IRQ context or with softirqs enabled.
2864 * Calls to this function for a single hardware must be synchronized against
2867 * The function returns -EINVAL when the requested PS mode is already set.
2869 * @sta: currently connected sta
2870 * @start: start or stop PS
2872 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
2875 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2876 * (in process context)
2878 * Like ieee80211_sta_ps_transition() but can be called in process context
2879 * (internally disables bottom halves). Concurrent call restriction still
2882 * @sta: currently connected sta
2883 * @start: start or stop PS
2885 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
2891 ret
= ieee80211_sta_ps_transition(sta
, start
);
2898 * The TX headroom reserved by mac80211 for its own tx_status functions.
2899 * This is enough for the radiotap header.
2901 #define IEEE80211_TX_STATUS_HEADROOM 14
2904 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2905 * @sta: &struct ieee80211_sta pointer for the sleeping station
2906 * @tid: the TID that has buffered frames
2907 * @buffered: indicates whether or not frames are buffered for this TID
2909 * If a driver buffers frames for a powersave station instead of passing
2910 * them back to mac80211 for retransmission, the station may still need
2911 * to be told that there are buffered frames via the TIM bit.
2913 * This function informs mac80211 whether or not there are frames that are
2914 * buffered in the driver for a given TID; mac80211 can then use this data
2915 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2916 * call! Beware of the locking!)
2918 * If all frames are released to the station (due to PS-poll or uAPSD)
2919 * then the driver needs to inform mac80211 that there no longer are
2920 * frames buffered. However, when the station wakes up mac80211 assumes
2921 * that all buffered frames will be transmitted and clears this data,
2922 * drivers need to make sure they inform mac80211 about all buffered
2923 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2925 * Note that technically mac80211 only needs to know this per AC, not per
2926 * TID, but since driver buffering will inevitably happen per TID (since
2927 * it is related to aggregation) it is easier to make mac80211 map the
2928 * TID to the AC as required instead of keeping track in all drivers that
2931 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
2932 u8 tid
, bool buffered
);
2935 * ieee80211_tx_status - transmit status callback
2937 * Call this function for all transmitted frames after they have been
2938 * transmitted. It is permissible to not call this function for
2939 * multicast frames but this can affect statistics.
2941 * This function may not be called in IRQ context. Calls to this function
2942 * for a single hardware must be synchronized against each other. Calls
2943 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2944 * may not be mixed for a single hardware.
2946 * @hw: the hardware the frame was transmitted by
2947 * @skb: the frame that was transmitted, owned by mac80211 after this call
2949 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
2950 struct sk_buff
*skb
);
2953 * ieee80211_tx_status_ni - transmit status callback (in process context)
2955 * Like ieee80211_tx_status() but can be called in process context.
2957 * Calls to this function, ieee80211_tx_status() and
2958 * ieee80211_tx_status_irqsafe() may not be mixed
2959 * for a single hardware.
2961 * @hw: the hardware the frame was transmitted by
2962 * @skb: the frame that was transmitted, owned by mac80211 after this call
2964 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
2965 struct sk_buff
*skb
)
2968 ieee80211_tx_status(hw
, skb
);
2973 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2975 * Like ieee80211_tx_status() but can be called in IRQ context
2976 * (internally defers to a tasklet.)
2978 * Calls to this function, ieee80211_tx_status() and
2979 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2981 * @hw: the hardware the frame was transmitted by
2982 * @skb: the frame that was transmitted, owned by mac80211 after this call
2984 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
2985 struct sk_buff
*skb
);
2988 * ieee80211_report_low_ack - report non-responding station
2990 * When operating in AP-mode, call this function to report a non-responding
2993 * @sta: the non-responding connected sta
2994 * @num_packets: number of packets sent to @sta without a response
2996 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
2999 * ieee80211_beacon_get_tim - beacon generation function
3000 * @hw: pointer obtained from ieee80211_alloc_hw().
3001 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3002 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3003 * Set to 0 if invalid (in non-AP modes).
3004 * @tim_length: pointer to variable that will receive the TIM IE length,
3005 * (including the ID and length bytes!).
3006 * Set to 0 if invalid (in non-AP modes).
3008 * If the driver implements beaconing modes, it must use this function to
3009 * obtain the beacon frame/template.
3011 * If the beacon frames are generated by the host system (i.e., not in
3012 * hardware/firmware), the driver uses this function to get each beacon
3013 * frame from mac80211 -- it is responsible for calling this function
3014 * before the beacon is needed (e.g. based on hardware interrupt).
3016 * If the beacon frames are generated by the device, then the driver
3017 * must use the returned beacon as the template and change the TIM IE
3018 * according to the current DTIM parameters/TIM bitmap.
3020 * The driver is responsible for freeing the returned skb.
3022 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
3023 struct ieee80211_vif
*vif
,
3024 u16
*tim_offset
, u16
*tim_length
);
3027 * ieee80211_beacon_get - beacon generation function
3028 * @hw: pointer obtained from ieee80211_alloc_hw().
3029 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3031 * See ieee80211_beacon_get_tim().
3033 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
3034 struct ieee80211_vif
*vif
)
3036 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
3040 * ieee80211_proberesp_get - retrieve a Probe Response template
3041 * @hw: pointer obtained from ieee80211_alloc_hw().
3042 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3044 * Creates a Probe Response template which can, for example, be uploaded to
3045 * hardware. The destination address should be set by the caller.
3047 * Can only be called in AP mode.
3049 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
3050 struct ieee80211_vif
*vif
);
3053 * ieee80211_pspoll_get - retrieve a PS Poll template
3054 * @hw: pointer obtained from ieee80211_alloc_hw().
3055 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3057 * Creates a PS Poll a template which can, for example, uploaded to
3058 * hardware. The template must be updated after association so that correct
3059 * AID, BSSID and MAC address is used.
3061 * Note: Caller (or hardware) is responsible for setting the
3062 * &IEEE80211_FCTL_PM bit.
3064 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
3065 struct ieee80211_vif
*vif
);
3068 * ieee80211_nullfunc_get - retrieve a nullfunc template
3069 * @hw: pointer obtained from ieee80211_alloc_hw().
3070 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3072 * Creates a Nullfunc template which can, for example, uploaded to
3073 * hardware. The template must be updated after association so that correct
3074 * BSSID and address is used.
3076 * Note: Caller (or hardware) is responsible for setting the
3077 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3079 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
3080 struct ieee80211_vif
*vif
);
3083 * ieee80211_probereq_get - retrieve a Probe Request template
3084 * @hw: pointer obtained from ieee80211_alloc_hw().
3085 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3086 * @ssid: SSID buffer
3087 * @ssid_len: length of SSID
3088 * @ie: buffer containing all IEs except SSID for the template
3089 * @ie_len: length of the IE buffer
3091 * Creates a Probe Request template which can, for example, be uploaded to
3094 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
3095 struct ieee80211_vif
*vif
,
3096 const u8
*ssid
, size_t ssid_len
,
3097 const u8
*ie
, size_t ie_len
);
3100 * ieee80211_rts_get - RTS frame generation function
3101 * @hw: pointer obtained from ieee80211_alloc_hw().
3102 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3103 * @frame: pointer to the frame that is going to be protected by the RTS.
3104 * @frame_len: the frame length (in octets).
3105 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3106 * @rts: The buffer where to store the RTS frame.
3108 * If the RTS frames are generated by the host system (i.e., not in
3109 * hardware/firmware), the low-level driver uses this function to receive
3110 * the next RTS frame from the 802.11 code. The low-level is responsible
3111 * for calling this function before and RTS frame is needed.
3113 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3114 const void *frame
, size_t frame_len
,
3115 const struct ieee80211_tx_info
*frame_txctl
,
3116 struct ieee80211_rts
*rts
);
3119 * ieee80211_rts_duration - Get the duration field for an RTS frame
3120 * @hw: pointer obtained from ieee80211_alloc_hw().
3121 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3122 * @frame_len: the length of the frame that is going to be protected by the RTS.
3123 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3125 * If the RTS is generated in firmware, but the host system must provide
3126 * the duration field, the low-level driver uses this function to receive
3127 * the duration field value in little-endian byteorder.
3129 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
3130 struct ieee80211_vif
*vif
, size_t frame_len
,
3131 const struct ieee80211_tx_info
*frame_txctl
);
3134 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3135 * @hw: pointer obtained from ieee80211_alloc_hw().
3136 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3137 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3138 * @frame_len: the frame length (in octets).
3139 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3140 * @cts: The buffer where to store the CTS-to-self frame.
3142 * If the CTS-to-self frames are generated by the host system (i.e., not in
3143 * hardware/firmware), the low-level driver uses this function to receive
3144 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3145 * for calling this function before and CTS-to-self frame is needed.
3147 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
3148 struct ieee80211_vif
*vif
,
3149 const void *frame
, size_t frame_len
,
3150 const struct ieee80211_tx_info
*frame_txctl
,
3151 struct ieee80211_cts
*cts
);
3154 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3155 * @hw: pointer obtained from ieee80211_alloc_hw().
3156 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3157 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3158 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3160 * If the CTS-to-self is generated in firmware, but the host system must provide
3161 * the duration field, the low-level driver uses this function to receive
3162 * the duration field value in little-endian byteorder.
3164 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
3165 struct ieee80211_vif
*vif
,
3167 const struct ieee80211_tx_info
*frame_txctl
);
3170 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3171 * @hw: pointer obtained from ieee80211_alloc_hw().
3172 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3173 * @band: the band to calculate the frame duration on
3174 * @frame_len: the length of the frame.
3175 * @rate: the rate at which the frame is going to be transmitted.
3177 * Calculate the duration field of some generic frame, given its
3178 * length and transmission rate (in 100kbps).
3180 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
3181 struct ieee80211_vif
*vif
,
3182 enum ieee80211_band band
,
3184 struct ieee80211_rate
*rate
);
3187 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3188 * @hw: pointer as obtained from ieee80211_alloc_hw().
3189 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3191 * Function for accessing buffered broadcast and multicast frames. If
3192 * hardware/firmware does not implement buffering of broadcast/multicast
3193 * frames when power saving is used, 802.11 code buffers them in the host
3194 * memory. The low-level driver uses this function to fetch next buffered
3195 * frame. In most cases, this is used when generating beacon frame. This
3196 * function returns a pointer to the next buffered skb or NULL if no more
3197 * buffered frames are available.
3199 * Note: buffered frames are returned only after DTIM beacon frame was
3200 * generated with ieee80211_beacon_get() and the low-level driver must thus
3201 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3202 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3203 * does not need to check for DTIM beacons separately and should be able to
3204 * use common code for all beacons.
3207 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3210 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3212 * This function returns the TKIP phase 1 key for the given IV32.
3214 * @keyconf: the parameter passed with the set key
3215 * @iv32: IV32 to get the P1K for
3216 * @p1k: a buffer to which the key will be written, as 5 u16 values
3218 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
3219 u32 iv32
, u16
*p1k
);
3222 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3224 * This function returns the TKIP phase 1 key for the IV32 taken
3225 * from the given packet.
3227 * @keyconf: the parameter passed with the set key
3228 * @skb: the packet to take the IV32 value from that will be encrypted
3230 * @p1k: a buffer to which the key will be written, as 5 u16 values
3232 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
3233 struct sk_buff
*skb
, u16
*p1k
)
3235 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
3236 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
3237 u32 iv32
= get_unaligned_le32(&data
[4]);
3239 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
3243 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3245 * This function returns the TKIP phase 1 key for the given IV32
3246 * and transmitter address.
3248 * @keyconf: the parameter passed with the set key
3249 * @ta: TA that will be used with the key
3250 * @iv32: IV32 to get the P1K for
3251 * @p1k: a buffer to which the key will be written, as 5 u16 values
3253 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
3254 const u8
*ta
, u32 iv32
, u16
*p1k
);
3257 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3259 * This function computes the TKIP RC4 key for the IV values
3262 * @keyconf: the parameter passed with the set key
3263 * @skb: the packet to take the IV32/IV16 values from that will be
3264 * encrypted with this key
3265 * @p2k: a buffer to which the key will be written, 16 bytes
3267 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
3268 struct sk_buff
*skb
, u8
*p2k
);
3271 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3273 * This function computes the two AES-CMAC sub-keys, based on the
3274 * previously installed master key.
3276 * @keyconf: the parameter passed with the set key
3277 * @k1: a buffer to be filled with the 1st sub-key
3278 * @k2: a buffer to be filled with the 2nd sub-key
3280 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf
*keyconf
,
3284 * struct ieee80211_key_seq - key sequence counter
3286 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3287 * @ccmp: PN data, most significant byte first (big endian,
3288 * reverse order than in packet)
3289 * @aes_cmac: PN data, most significant byte first (big endian,
3290 * reverse order than in packet)
3292 struct ieee80211_key_seq
{
3308 * ieee80211_get_key_tx_seq - get key TX sequence counter
3310 * @keyconf: the parameter passed with the set key
3311 * @seq: buffer to receive the sequence data
3313 * This function allows a driver to retrieve the current TX IV/PN
3314 * for the given key. It must not be called if IV generation is
3315 * offloaded to the device.
3317 * Note that this function may only be called when no TX processing
3318 * can be done concurrently, for example when queues are stopped
3319 * and the stop has been synchronized.
3321 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
3322 struct ieee80211_key_seq
*seq
);
3325 * ieee80211_get_key_rx_seq - get key RX sequence counter
3327 * @keyconf: the parameter passed with the set key
3328 * @tid: The TID, or -1 for the management frame value (CCMP only);
3329 * the value on TID 0 is also used for non-QoS frames. For
3330 * CMAC, only TID 0 is valid.
3331 * @seq: buffer to receive the sequence data
3333 * This function allows a driver to retrieve the current RX IV/PNs
3334 * for the given key. It must not be called if IV checking is done
3335 * by the device and not by mac80211.
3337 * Note that this function may only be called when no RX processing
3338 * can be done concurrently.
3340 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
3341 int tid
, struct ieee80211_key_seq
*seq
);
3344 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3345 * @vif: virtual interface the rekeying was done on
3346 * @bssid: The BSSID of the AP, for checking association
3347 * @replay_ctr: the new replay counter after GTK rekeying
3348 * @gfp: allocation flags
3350 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
3351 const u8
*replay_ctr
, gfp_t gfp
);
3354 * ieee80211_wake_queue - wake specific queue
3355 * @hw: pointer as obtained from ieee80211_alloc_hw().
3356 * @queue: queue number (counted from zero).
3358 * Drivers should use this function instead of netif_wake_queue.
3360 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
3363 * ieee80211_stop_queue - stop specific queue
3364 * @hw: pointer as obtained from ieee80211_alloc_hw().
3365 * @queue: queue number (counted from zero).
3367 * Drivers should use this function instead of netif_stop_queue.
3369 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
3372 * ieee80211_queue_stopped - test status of the queue
3373 * @hw: pointer as obtained from ieee80211_alloc_hw().
3374 * @queue: queue number (counted from zero).
3376 * Drivers should use this function instead of netif_stop_queue.
3379 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
3382 * ieee80211_stop_queues - stop all queues
3383 * @hw: pointer as obtained from ieee80211_alloc_hw().
3385 * Drivers should use this function instead of netif_stop_queue.
3387 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
3390 * ieee80211_wake_queues - wake all queues
3391 * @hw: pointer as obtained from ieee80211_alloc_hw().
3393 * Drivers should use this function instead of netif_wake_queue.
3395 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
3398 * ieee80211_scan_completed - completed hardware scan
3400 * When hardware scan offload is used (i.e. the hw_scan() callback is
3401 * assigned) this function needs to be called by the driver to notify
3402 * mac80211 that the scan finished. This function can be called from
3403 * any context, including hardirq context.
3405 * @hw: the hardware that finished the scan
3406 * @aborted: set to true if scan was aborted
3408 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
3411 * ieee80211_sched_scan_results - got results from scheduled scan
3413 * When a scheduled scan is running, this function needs to be called by the
3414 * driver whenever there are new scan results available.
3416 * @hw: the hardware that is performing scheduled scans
3418 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
3421 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3423 * When a scheduled scan is running, this function can be called by
3424 * the driver if it needs to stop the scan to perform another task.
3425 * Usual scenarios are drivers that cannot continue the scheduled scan
3426 * while associating, for instance.
3428 * @hw: the hardware that is performing scheduled scans
3430 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
3433 * enum ieee80211_interface_iteration_flags - interface iteration flags
3434 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3435 * been added to the driver; However, note that during hardware
3436 * reconfiguration (after restart_hw) it will iterate over a new
3437 * interface and over all the existing interfaces even if they
3438 * haven't been re-added to the driver yet.
3439 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3440 * interfaces, even if they haven't been re-added to the driver yet.
3442 enum ieee80211_interface_iteration_flags
{
3443 IEEE80211_IFACE_ITER_NORMAL
= 0,
3444 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
3448 * ieee80211_iterate_active_interfaces - iterate active interfaces
3450 * This function iterates over the interfaces associated with a given
3451 * hardware that are currently active and calls the callback for them.
3452 * This function allows the iterator function to sleep, when the iterator
3453 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3455 * Does not iterate over a new interface during add_interface().
3457 * @hw: the hardware struct of which the interfaces should be iterated over
3458 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3459 * @iterator: the iterator function to call
3460 * @data: first argument of the iterator function
3462 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
3464 void (*iterator
)(void *data
, u8
*mac
,
3465 struct ieee80211_vif
*vif
),
3469 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3471 * This function iterates over the interfaces associated with a given
3472 * hardware that are currently active and calls the callback for them.
3473 * This function requires the iterator callback function to be atomic,
3474 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3475 * Does not iterate over a new interface during add_interface().
3477 * @hw: the hardware struct of which the interfaces should be iterated over
3478 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3479 * @iterator: the iterator function to call, cannot sleep
3480 * @data: first argument of the iterator function
3482 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
3484 void (*iterator
)(void *data
,
3486 struct ieee80211_vif
*vif
),
3490 * ieee80211_queue_work - add work onto the mac80211 workqueue
3492 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3493 * This helper ensures drivers are not queueing work when they should not be.
3495 * @hw: the hardware struct for the interface we are adding work for
3496 * @work: the work we want to add onto the mac80211 workqueue
3498 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
3501 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3503 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3506 * @hw: the hardware struct for the interface we are adding work for
3507 * @dwork: delayable work to queue onto the mac80211 workqueue
3508 * @delay: number of jiffies to wait before queueing
3510 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
3511 struct delayed_work
*dwork
,
3512 unsigned long delay
);
3515 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3516 * @sta: the station for which to start a BA session
3517 * @tid: the TID to BA on.
3518 * @timeout: session timeout value (in TUs)
3520 * Return: success if addBA request was sent, failure otherwise
3522 * Although mac80211/low level driver/user space application can estimate
3523 * the need to start aggregation on a certain RA/TID, the session level
3524 * will be managed by the mac80211.
3526 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
3530 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3531 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3532 * @ra: receiver address of the BA session recipient.
3533 * @tid: the TID to BA on.
3535 * This function must be called by low level driver once it has
3536 * finished with preparations for the BA session. It can be called
3539 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
3543 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3544 * @sta: the station whose BA session to stop
3545 * @tid: the TID to stop BA.
3547 * Return: negative error if the TID is invalid, or no aggregation active
3549 * Although mac80211/low level driver/user space application can estimate
3550 * the need to stop aggregation on a certain RA/TID, the session level
3551 * will be managed by the mac80211.
3553 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
3556 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3557 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3558 * @ra: receiver address of the BA session recipient.
3559 * @tid: the desired TID to BA on.
3561 * This function must be called by low level driver once it has
3562 * finished with preparations for the BA session tear down. It
3563 * can be called from any context.
3565 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
3569 * ieee80211_find_sta - find a station
3571 * @vif: virtual interface to look for station on
3572 * @addr: station's address
3574 * This function must be called under RCU lock and the
3575 * resulting pointer is only valid under RCU lock as well.
3577 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
3581 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3583 * @hw: pointer as obtained from ieee80211_alloc_hw()
3584 * @addr: remote station's address
3585 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3587 * This function must be called under RCU lock and the
3588 * resulting pointer is only valid under RCU lock as well.
3590 * NOTE: You may pass NULL for localaddr, but then you will just get
3591 * the first STA that matches the remote address 'addr'.
3592 * We can have multiple STA associated with multiple
3593 * logical stations (e.g. consider a station connecting to another
3594 * BSSID on the same AP hardware without disconnecting first).
3595 * In this case, the result of this method with localaddr NULL
3598 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3600 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
3602 const u8
*localaddr
);
3605 * ieee80211_sta_block_awake - block station from waking up
3607 * @pubsta: the station
3608 * @block: whether to block or unblock
3610 * Some devices require that all frames that are on the queues
3611 * for a specific station that went to sleep are flushed before
3612 * a poll response or frames after the station woke up can be
3613 * delivered to that it. Note that such frames must be rejected
3614 * by the driver as filtered, with the appropriate status flag.
3616 * This function allows implementing this mode in a race-free
3619 * To do this, a driver must keep track of the number of frames
3620 * still enqueued for a specific station. If this number is not
3621 * zero when the station goes to sleep, the driver must call
3622 * this function to force mac80211 to consider the station to
3623 * be asleep regardless of the station's actual state. Once the
3624 * number of outstanding frames reaches zero, the driver must
3625 * call this function again to unblock the station. That will
3626 * cause mac80211 to be able to send ps-poll responses, and if
3627 * the station queried in the meantime then frames will also
3628 * be sent out as a result of this. Additionally, the driver
3629 * will be notified that the station woke up some time after
3630 * it is unblocked, regardless of whether the station actually
3631 * woke up while blocked or not.
3633 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
3634 struct ieee80211_sta
*pubsta
, bool block
);
3637 * ieee80211_sta_eosp - notify mac80211 about end of SP
3638 * @pubsta: the station
3640 * When a device transmits frames in a way that it can't tell
3641 * mac80211 in the TX status about the EOSP, it must clear the
3642 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3643 * This applies for PS-Poll as well as uAPSD.
3645 * Note that there is no non-_irqsafe version right now as
3646 * it wasn't needed, but just like _tx_status() and _rx()
3647 * must not be mixed in irqsafe/non-irqsafe versions, this
3648 * function must not be mixed with those either. Use the
3649 * all irqsafe, or all non-irqsafe, don't mix! If you need
3650 * the non-irqsafe version of this, you need to add it.
3652 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta
*pubsta
);
3655 * ieee80211_iter_keys - iterate keys programmed into the device
3656 * @hw: pointer obtained from ieee80211_alloc_hw()
3657 * @vif: virtual interface to iterate, may be %NULL for all
3658 * @iter: iterator function that will be called for each key
3659 * @iter_data: custom data to pass to the iterator function
3661 * This function can be used to iterate all the keys known to
3662 * mac80211, even those that weren't previously programmed into
3663 * the device. This is intended for use in WoWLAN if the device
3664 * needs reprogramming of the keys during suspend. Note that due
3665 * to locking reasons, it is also only safe to call this at few
3666 * spots since it must hold the RTNL and be able to sleep.
3668 * The order in which the keys are iterated matches the order
3669 * in which they were originally installed and handed to the
3672 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
3673 struct ieee80211_vif
*vif
,
3674 void (*iter
)(struct ieee80211_hw
*hw
,
3675 struct ieee80211_vif
*vif
,
3676 struct ieee80211_sta
*sta
,
3677 struct ieee80211_key_conf
*key
,
3682 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
3683 * @hw: pointre obtained from ieee80211_alloc_hw().
3684 * @iter: iterator function
3685 * @iter_data: data passed to iterator function
3687 * Iterate all active channel contexts. This function is atomic and
3688 * doesn't acquire any locks internally that might be held in other
3689 * places while calling into the driver.
3691 * The iterator will not find a context that's being added (during
3692 * the driver callback to add it) but will find it while it's being
3695 void ieee80211_iter_chan_contexts_atomic(
3696 struct ieee80211_hw
*hw
,
3697 void (*iter
)(struct ieee80211_hw
*hw
,
3698 struct ieee80211_chanctx_conf
*chanctx_conf
,
3703 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3704 * @hw: pointer obtained from ieee80211_alloc_hw().
3705 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3707 * Creates a Probe Request template which can, for example, be uploaded to
3708 * hardware. The template is filled with bssid, ssid and supported rate
3709 * information. This function must only be called from within the
3710 * .bss_info_changed callback function and only in managed mode. The function
3711 * is only useful when the interface is associated, otherwise it will return
3714 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
3715 struct ieee80211_vif
*vif
);
3718 * ieee80211_beacon_loss - inform hardware does not receive beacons
3720 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3722 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3723 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3724 * hardware is not receiving beacons with this function.
3726 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
3729 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3731 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3733 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3734 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3735 * needs to inform if the connection to the AP has been lost.
3737 * This function will cause immediate change to disassociated state,
3738 * without connection recovery attempts.
3740 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
3743 * ieee80211_resume_disconnect - disconnect from AP after resume
3745 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3747 * Instructs mac80211 to disconnect from the AP after resume.
3748 * Drivers can use this after WoWLAN if they know that the
3749 * connection cannot be kept up, for example because keys were
3750 * used while the device was asleep but the replay counters or
3751 * similar cannot be retrieved from the device during resume.
3753 * Note that due to implementation issues, if the driver uses
3754 * the reconfiguration functionality during resume the interface
3755 * will still be added as associated first during resume and then
3756 * disconnect normally later.
3758 * This function can only be called from the resume callback and
3759 * the driver must not be holding any of its own locks while it
3760 * calls this function, or at least not any locks it needs in the
3761 * key configuration paths (if it supports HW crypto).
3763 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
3766 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3768 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3770 * Some hardware require full power save to manage simultaneous BT traffic
3771 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3772 * burst of BT traffic. The hardware gets information of BT traffic via
3773 * hardware co-existence lines, and consequentially requests mac80211 to
3774 * (temporarily) enter full psm.
3775 * This function will only temporarily disable dynamic PS, not enable PSM if
3776 * it was not already enabled.
3777 * The driver must make sure to re-enable dynamic PS using
3778 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3781 void ieee80211_disable_dyn_ps(struct ieee80211_vif
*vif
);
3784 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3786 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3788 * This function restores dynamic PS after being temporarily disabled via
3789 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3790 * be coupled with an eventual call to this function.
3793 void ieee80211_enable_dyn_ps(struct ieee80211_vif
*vif
);
3796 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3797 * rssi threshold triggered
3799 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3800 * @rssi_event: the RSSI trigger event type
3801 * @gfp: context flags
3803 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3804 * monitoring is configured with an rssi threshold, the driver will inform
3805 * whenever the rssi level reaches the threshold.
3807 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
3808 enum nl80211_cqm_rssi_threshold_event rssi_event
,
3812 * ieee80211_chswitch_done - Complete channel switch process
3813 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3814 * @success: make the channel switch successful or not
3816 * Complete the channel switch post-process: set the new operational channel
3817 * and wake up the suspended queues.
3819 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
3822 * ieee80211_request_smps - request SM PS transition
3823 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3824 * @smps_mode: new SM PS mode
3826 * This allows the driver to request an SM PS transition in managed
3827 * mode. This is useful when the driver has more information than
3828 * the stack about possible interference, for example by bluetooth.
3830 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
3831 enum ieee80211_smps_mode smps_mode
);
3834 * ieee80211_ready_on_channel - notification of remain-on-channel start
3835 * @hw: pointer as obtained from ieee80211_alloc_hw()
3837 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
3840 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3841 * @hw: pointer as obtained from ieee80211_alloc_hw()
3843 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
3846 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3848 * in order not to harm the system performance and user experience, the device
3849 * may request not to allow any rx ba session and tear down existing rx ba
3850 * sessions based on system constraints such as periodic BT activity that needs
3851 * to limit wlan activity (eg.sco or a2dp)."
3852 * in such cases, the intention is to limit the duration of the rx ppdu and
3853 * therefore prevent the peer device to use a-mpdu aggregation.
3855 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3856 * @ba_rx_bitmap: Bit map of open rx ba per tid
3857 * @addr: & to bssid mac address
3859 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
3863 * ieee80211_send_bar - send a BlockAckReq frame
3865 * can be used to flush pending frames from the peer's aggregation reorder
3868 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3869 * @ra: the peer's destination address
3870 * @tid: the TID of the aggregation session
3871 * @ssn: the new starting sequence number for the receiver
3873 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
3875 /* Rate control API */
3878 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3880 * @hw: The hardware the algorithm is invoked for.
3881 * @sband: The band this frame is being transmitted on.
3882 * @bss_conf: the current BSS configuration
3883 * @skb: the skb that will be transmitted, the control information in it needs
3885 * @reported_rate: The rate control algorithm can fill this in to indicate
3886 * which rate should be reported to userspace as the current rate and
3887 * used for rate calculations in the mesh network.
3888 * @rts: whether RTS will be used for this frame because it is longer than the
3890 * @short_preamble: whether mac80211 will request short-preamble transmission
3891 * if the selected rate supports it
3892 * @max_rate_idx: user-requested maximum (legacy) rate
3893 * (deprecated; this will be removed once drivers get updated to use
3895 * @rate_idx_mask: user-requested (legacy) rate mask
3896 * @rate_idx_mcs_mask: user-requested MCS rate mask
3897 * @bss: whether this frame is sent out in AP or IBSS mode
3899 struct ieee80211_tx_rate_control
{
3900 struct ieee80211_hw
*hw
;
3901 struct ieee80211_supported_band
*sband
;
3902 struct ieee80211_bss_conf
*bss_conf
;
3903 struct sk_buff
*skb
;
3904 struct ieee80211_tx_rate reported_rate
;
3905 bool rts
, short_preamble
;
3908 u8 rate_idx_mcs_mask
[IEEE80211_HT_MCS_MASK_LEN
];
3912 struct rate_control_ops
{
3913 struct module
*module
;
3915 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
3916 void (*free
)(void *priv
);
3918 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
3919 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
3920 struct ieee80211_sta
*sta
, void *priv_sta
);
3921 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
3922 struct ieee80211_sta
*sta
, void *priv_sta
,
3924 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
3927 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
3928 struct ieee80211_sta
*sta
, void *priv_sta
,
3929 struct sk_buff
*skb
);
3930 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
3931 struct ieee80211_tx_rate_control
*txrc
);
3933 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
3934 struct dentry
*dir
);
3935 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
3938 static inline int rate_supported(struct ieee80211_sta
*sta
,
3939 enum ieee80211_band band
,
3942 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
3946 * rate_control_send_low - helper for drivers for management/no-ack frames
3948 * Rate control algorithms that agree to use the lowest rate to
3949 * send management frames and NO_ACK data with the respective hw
3950 * retries should use this in the beginning of their mac80211 get_rate
3951 * callback. If true is returned the rate control can simply return.
3952 * If false is returned we guarantee that sta and sta and priv_sta is
3955 * Rate control algorithms wishing to do more intelligent selection of
3956 * rate for multicast/broadcast frames may choose to not use this.
3958 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3959 * that this may be null.
3960 * @priv_sta: private rate control structure. This may be null.
3961 * @txrc: rate control information we sholud populate for mac80211.
3963 bool rate_control_send_low(struct ieee80211_sta
*sta
,
3965 struct ieee80211_tx_rate_control
*txrc
);
3969 rate_lowest_index(struct ieee80211_supported_band
*sband
,
3970 struct ieee80211_sta
*sta
)
3974 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3975 if (rate_supported(sta
, sband
->band
, i
))
3978 /* warn when we cannot find a rate. */
3981 /* and return 0 (the lowest index) */
3986 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
3987 struct ieee80211_sta
*sta
)
3991 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3992 if (rate_supported(sta
, sband
->band
, i
))
3997 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
3998 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
4001 conf_is_ht20(struct ieee80211_conf
*conf
)
4003 return conf
->channel_type
== NL80211_CHAN_HT20
;
4007 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
4009 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
4013 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
4015 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
4019 conf_is_ht40(struct ieee80211_conf
*conf
)
4021 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
4025 conf_is_ht(struct ieee80211_conf
*conf
)
4027 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
4030 static inline enum nl80211_iftype
4031 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
4035 case NL80211_IFTYPE_STATION
:
4036 return NL80211_IFTYPE_P2P_CLIENT
;
4037 case NL80211_IFTYPE_AP
:
4038 return NL80211_IFTYPE_P2P_GO
;
4046 static inline enum nl80211_iftype
4047 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
4049 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
4052 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
4054 int rssi_max_thold
);
4056 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
4059 * ieee80211_ave_rssi - report the average rssi for the specified interface
4061 * @vif: the specified virtual interface
4063 * This function return the average rssi value for the requested interface.
4064 * It assumes that the given vif is valid.
4066 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
4068 #endif /* MAC80211_H */