2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
91 * enum ieee80211_max_queues - maximum number of queues
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 enum ieee80211_max_queues
{
96 IEEE80211_MAX_QUEUES
= 4,
100 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101 * @IEEE80211_AC_VO: voice
102 * @IEEE80211_AC_VI: video
103 * @IEEE80211_AC_BE: best effort
104 * @IEEE80211_AC_BK: background
106 enum ieee80211_ac_numbers
{
114 * struct ieee80211_tx_queue_params - transmit queue configuration
116 * The information provided in this structure is required for QoS
117 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
119 * @aifs: arbitration interframe space [0..255]
120 * @cw_min: minimum contention window [a value of the form
121 * 2^n-1 in the range 1..32767]
122 * @cw_max: maximum contention window [like @cw_min]
123 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
124 * @uapsd: is U-APSD mode enabled for the queue
126 struct ieee80211_tx_queue_params
{
134 struct ieee80211_low_level_stats
{
135 unsigned int dot11ACKFailureCount
;
136 unsigned int dot11RTSFailureCount
;
137 unsigned int dot11FCSErrorCount
;
138 unsigned int dot11RTSSuccessCount
;
142 * enum ieee80211_bss_change - BSS change notification flags
144 * These flags are used with the bss_info_changed() callback
145 * to indicate which BSS parameter changed.
147 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
148 * also implies a change in the AID.
149 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
150 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
151 * @BSS_CHANGED_ERP_SLOT: slot timing changed
152 * @BSS_CHANGED_HT: 802.11n parameters changed
153 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
154 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
155 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
156 * reason (IBSS and managed mode)
157 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
158 * new beacon (beaconing modes)
159 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
160 * enabled/disabled (beaconing modes)
161 * @BSS_CHANGED_CQM: Connection quality monitor config changed
162 * @BSS_CHANGED_IBSS: IBSS join status changed
163 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
164 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
165 * that it is only ever disabled for station mode.
166 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
168 enum ieee80211_bss_change
{
169 BSS_CHANGED_ASSOC
= 1<<0,
170 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
171 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
172 BSS_CHANGED_ERP_SLOT
= 1<<3,
173 BSS_CHANGED_HT
= 1<<4,
174 BSS_CHANGED_BASIC_RATES
= 1<<5,
175 BSS_CHANGED_BEACON_INT
= 1<<6,
176 BSS_CHANGED_BSSID
= 1<<7,
177 BSS_CHANGED_BEACON
= 1<<8,
178 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
179 BSS_CHANGED_CQM
= 1<<10,
180 BSS_CHANGED_IBSS
= 1<<11,
181 BSS_CHANGED_ARP_FILTER
= 1<<12,
182 BSS_CHANGED_QOS
= 1<<13,
183 BSS_CHANGED_IDLE
= 1<<14,
185 /* when adding here, make sure to change ieee80211_reconfig */
189 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
190 * of addresses for an interface increase beyond this value, hardware ARP
191 * filtering will be disabled.
193 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
196 * struct ieee80211_bss_conf - holds the BSS's changing parameters
198 * This structure keeps information about a BSS (and an association
199 * to that BSS) that can change during the lifetime of the BSS.
201 * @assoc: association status
202 * @ibss_joined: indicates whether this station is part of an IBSS
204 * @aid: association ID number, valid only when @assoc is true
205 * @use_cts_prot: use CTS protection
206 * @use_short_preamble: use 802.11b short preamble;
207 * if the hardware cannot handle this it must set the
208 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
209 * @use_short_slot: use short slot time (only relevant for ERP);
210 * if the hardware cannot handle this it must set the
211 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
212 * @dtim_period: num of beacons before the next DTIM, for beaconing,
213 * valid in station mode only while @assoc is true and if also
214 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
216 * @timestamp: beacon timestamp
217 * @beacon_int: beacon interval
218 * @assoc_capability: capabilities taken from assoc resp
219 * @basic_rates: bitmap of basic rates, each bit stands for an
220 * index into the rate table configured by the driver in
222 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
223 * @bssid: The BSSID for this BSS
224 * @enable_beacon: whether beaconing should be enabled or not
225 * @channel_type: Channel type for this BSS -- the hardware might be
226 * configured for HT40+ while this BSS only uses no-HT, for
228 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
229 * This field is only valid when the channel type is one of the HT types.
230 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
232 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
233 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
234 * may filter ARP queries targeted for other addresses than listed here.
235 * The driver must allow ARP queries targeted for all address listed here
236 * to pass through. An empty list implies no ARP queries need to pass.
237 * @arp_addr_cnt: Number of addresses currently on the list.
238 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
239 * filter ARP queries based on the @arp_addr_list, if disabled, the
240 * hardware must not perform any ARP filtering. Note, that the filter will
241 * be enabled also in promiscuous mode.
242 * @qos: This is a QoS-enabled BSS.
243 * @idle: This interface is idle. There's also a global idle flag in the
244 * hardware config which may be more appropriate depending on what
245 * your driver/device needs to do.
247 struct ieee80211_bss_conf
{
249 /* association related data */
250 bool assoc
, ibss_joined
;
252 /* erp related data */
254 bool use_short_preamble
;
259 u16 assoc_capability
;
262 int mcast_rate
[IEEE80211_NUM_BANDS
];
263 u16 ht_operation_mode
;
266 enum nl80211_channel_type channel_type
;
267 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
269 bool arp_filter_enabled
;
275 * enum mac80211_tx_control_flags - flags to describe transmission information/status
277 * These flags are used with the @flags member of &ieee80211_tx_info.
279 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
280 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
281 * number to this frame, taking care of not overwriting the fragment
282 * number and increasing the sequence number only when the
283 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
284 * assign sequence numbers to QoS-data frames but cannot do so correctly
285 * for non-QoS-data and management frames because beacons need them from
286 * that counter as well and mac80211 cannot guarantee proper sequencing.
287 * If this flag is set, the driver should instruct the hardware to
288 * assign a sequence number to the frame or assign one itself. Cf. IEEE
289 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
290 * beacons and always be clear for frames without a sequence number field.
291 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
292 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
294 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
295 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
296 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
297 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
298 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
299 * because the destination STA was in powersave mode. Note that to
300 * avoid race conditions, the filter must be set by the hardware or
301 * firmware upon receiving a frame that indicates that the station
302 * went to sleep (must be done on device to filter frames already on
303 * the queue) and may only be unset after mac80211 gives the OK for
304 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
305 * since only then is it guaranteed that no more frames are in the
307 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
308 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
309 * is for the whole aggregation.
310 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
311 * so consider using block ack request (BAR).
312 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
313 * set by rate control algorithms to indicate probe rate, will
314 * be cleared for fragmented frames (except on the last fragment)
315 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
316 * used to indicate that a pending frame requires TX processing before
317 * it can be sent out.
318 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
319 * used to indicate that a frame was already retried due to PS
320 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
321 * used to indicate frame should not be encrypted
322 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
323 * This frame is a response to a PS-poll frame and should be sent
324 * although the station is in powersave mode.
325 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
326 * transmit function after the current frame, this can be used
327 * by drivers to kick the DMA queue only if unset or when the
329 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
330 * after TX status because the destination was asleep, it must not
331 * be modified again (no seqno assignment, crypto, etc.)
332 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
333 * has a radiotap header at skb->data.
334 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
335 * MLME command (internal to mac80211 to figure out whether to send TX
336 * status to user space)
337 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
338 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
339 * frame and selects the maximum number of streams that it can use.
340 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
341 * the off-channel channel when a remain-on-channel offload is done
342 * in hardware -- normal packets still flow and are expected to be
343 * handled properly by the device.
344 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
345 * testing. It will be sent out with incorrect Michael MIC key to allow
346 * TKIP countermeasures to be tested.
348 * Note: If you have to add new flags to the enumeration, then don't
349 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
351 enum mac80211_tx_control_flags
{
352 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
353 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
354 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
355 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
356 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
357 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
358 IEEE80211_TX_CTL_AMPDU
= BIT(6),
359 IEEE80211_TX_CTL_INJECTED
= BIT(7),
360 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
361 IEEE80211_TX_STAT_ACK
= BIT(9),
362 IEEE80211_TX_STAT_AMPDU
= BIT(10),
363 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
364 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
365 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
366 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
367 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
368 IEEE80211_TX_CTL_PSPOLL_RESPONSE
= BIT(17),
369 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
370 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
371 IEEE80211_TX_INTFL_HAS_RADIOTAP
= BIT(20),
372 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
373 IEEE80211_TX_CTL_LDPC
= BIT(22),
374 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
375 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
376 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
379 #define IEEE80211_TX_CTL_STBC_SHIFT 23
382 * This definition is used as a mask to clear all temporary flags, which are
383 * set by the tx handlers for each transmission attempt by the mac80211 stack.
385 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
386 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
387 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
388 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
389 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
390 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
391 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
392 IEEE80211_TX_CTL_STBC)
395 * enum mac80211_rate_control_flags - per-rate flags set by the
396 * Rate Control algorithm.
398 * These flags are set by the Rate control algorithm for each rate during tx,
399 * in the @flags member of struct ieee80211_tx_rate.
401 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
402 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
403 * This is set if the current BSS requires ERP protection.
404 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
405 * @IEEE80211_TX_RC_MCS: HT rate.
406 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
408 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
409 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
410 * adjacent 20 MHz channels, if the current channel type is
411 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
412 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
414 enum mac80211_rate_control_flags
{
415 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
416 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
417 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
419 /* rate index is an MCS rate number instead of an index */
420 IEEE80211_TX_RC_MCS
= BIT(3),
421 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
422 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
423 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
424 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
428 /* there are 40 bytes if you don't need the rateset to be kept */
429 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
431 /* if you do need the rateset, then you have less space */
432 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
434 /* maximum number of rate stages */
435 #define IEEE80211_TX_MAX_RATES 5
438 * struct ieee80211_tx_rate - rate selection/status
440 * @idx: rate index to attempt to send with
441 * @flags: rate control flags (&enum mac80211_rate_control_flags)
442 * @count: number of tries in this rate before going to the next rate
444 * A value of -1 for @idx indicates an invalid rate and, if used
445 * in an array of retry rates, that no more rates should be tried.
447 * When used for transmit status reporting, the driver should
448 * always report the rate along with the flags it used.
450 * &struct ieee80211_tx_info contains an array of these structs
451 * in the control information, and it will be filled by the rate
452 * control algorithm according to what should be sent. For example,
453 * if this array contains, in the format { <idx>, <count> } the
455 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
456 * then this means that the frame should be transmitted
457 * up to twice at rate 3, up to twice at rate 2, and up to four
458 * times at rate 1 if it doesn't get acknowledged. Say it gets
459 * acknowledged by the peer after the fifth attempt, the status
460 * information should then contain
461 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
462 * since it was transmitted twice at rate 3, twice at rate 2
463 * and once at rate 1 after which we received an acknowledgement.
465 struct ieee80211_tx_rate
{
472 * struct ieee80211_tx_info - skb transmit information
474 * This structure is placed in skb->cb for three uses:
475 * (1) mac80211 TX control - mac80211 tells the driver what to do
476 * (2) driver internal use (if applicable)
477 * (3) TX status information - driver tells mac80211 what happened
479 * The TX control's sta pointer is only valid during the ->tx call,
482 * @flags: transmit info flags, defined above
483 * @band: the band to transmit on (use for checking for races)
484 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
485 * @pad: padding, ignore
486 * @control: union for control data
487 * @status: union for status data
488 * @driver_data: array of driver_data pointers
489 * @ampdu_ack_len: number of acked aggregated frames.
490 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
491 * @ampdu_len: number of aggregated frames.
492 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
493 * @ack_signal: signal strength of the ACK frame
495 struct ieee80211_tx_info
{
496 /* common information */
510 struct ieee80211_tx_rate rates
[
511 IEEE80211_TX_MAX_RATES
];
514 /* only needed before rate control */
515 unsigned long jiffies
;
517 /* NB: vif can be NULL for injected frames */
518 struct ieee80211_vif
*vif
;
519 struct ieee80211_key_conf
*hw_key
;
520 struct ieee80211_sta
*sta
;
523 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
530 struct ieee80211_tx_rate driver_rates
[
531 IEEE80211_TX_MAX_RATES
];
532 void *rate_driver_data
[
533 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
536 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
541 * struct ieee80211_sched_scan_ies - scheduled scan IEs
543 * This structure is used to pass the appropriate IEs to be used in scheduled
544 * scans for all bands. It contains both the IEs passed from the userspace
545 * and the ones generated by mac80211.
547 * @ie: array with the IEs for each supported band
548 * @len: array with the total length of the IEs for each band
550 struct ieee80211_sched_scan_ies
{
551 u8
*ie
[IEEE80211_NUM_BANDS
];
552 size_t len
[IEEE80211_NUM_BANDS
];
555 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
557 return (struct ieee80211_tx_info
*)skb
->cb
;
560 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
562 return (struct ieee80211_rx_status
*)skb
->cb
;
566 * ieee80211_tx_info_clear_status - clear TX status
568 * @info: The &struct ieee80211_tx_info to be cleared.
570 * When the driver passes an skb back to mac80211, it must report
571 * a number of things in TX status. This function clears everything
572 * in the TX status but the rate control information (it does clear
573 * the count since you need to fill that in anyway).
575 * NOTE: You can only use this function if you do NOT use
576 * info->driver_data! Use info->rate_driver_data
577 * instead if you need only the less space that allows.
580 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
584 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
585 offsetof(struct ieee80211_tx_info
, control
.rates
));
586 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
587 offsetof(struct ieee80211_tx_info
, driver_rates
));
588 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
589 /* clear the rate counts */
590 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
591 info
->status
.rates
[i
].count
= 0;
594 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
595 memset(&info
->status
.ampdu_ack_len
, 0,
596 sizeof(struct ieee80211_tx_info
) -
597 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
602 * enum mac80211_rx_flags - receive flags
604 * These flags are used with the @flag member of &struct ieee80211_rx_status.
605 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
606 * Use together with %RX_FLAG_MMIC_STRIPPED.
607 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
608 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
609 * verification has been done by the hardware.
610 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
611 * If this flag is set, the stack cannot do any replay detection
612 * hence the driver or hardware will have to do that.
613 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
615 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
617 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
618 * field) is valid and contains the time the first symbol of the MPDU
619 * was received. This is useful in monitor mode and for proper IBSS
621 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
622 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
623 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
624 * @RX_FLAG_SHORT_GI: Short guard interval was used
626 enum mac80211_rx_flags
{
627 RX_FLAG_MMIC_ERROR
= 1<<0,
628 RX_FLAG_DECRYPTED
= 1<<1,
629 RX_FLAG_MMIC_STRIPPED
= 1<<3,
630 RX_FLAG_IV_STRIPPED
= 1<<4,
631 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
632 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
633 RX_FLAG_MACTIME_MPDU
= 1<<7,
634 RX_FLAG_SHORTPRE
= 1<<8,
636 RX_FLAG_40MHZ
= 1<<10,
637 RX_FLAG_SHORT_GI
= 1<<11,
641 * struct ieee80211_rx_status - receive status
643 * The low-level driver should provide this information (the subset
644 * supported by hardware) to the 802.11 code with each received
645 * frame, in the skb's control buffer (cb).
647 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
648 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
649 * @band: the active band when this frame was received
650 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
651 * @signal: signal strength when receiving this frame, either in dBm, in dB or
652 * unspecified depending on the hardware capabilities flags
653 * @IEEE80211_HW_SIGNAL_*
654 * @antenna: antenna used
655 * @rate_idx: index of data rate into band's supported rates or MCS index if
656 * HT rates are use (RX_FLAG_HT)
658 * @rx_flags: internal RX flags for mac80211
660 struct ieee80211_rx_status
{
662 enum ieee80211_band band
;
668 unsigned int rx_flags
;
672 * enum ieee80211_conf_flags - configuration flags
674 * Flags to define PHY configuration options
676 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
677 * to determine for example whether to calculate timestamps for packets
678 * or not, do not use instead of filter flags!
679 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
680 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
681 * meaning that the hardware still wakes up for beacons, is able to
682 * transmit frames and receive the possible acknowledgment frames.
683 * Not to be confused with hardware specific wakeup/sleep states,
684 * driver is responsible for that. See the section "Powersave support"
686 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
687 * the driver should be prepared to handle configuration requests but
688 * may turn the device off as much as possible. Typically, this flag will
689 * be set when an interface is set UP but not associated or scanning, but
690 * it can also be unset in that case when monitor interfaces are active.
691 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
694 enum ieee80211_conf_flags
{
695 IEEE80211_CONF_MONITOR
= (1<<0),
696 IEEE80211_CONF_PS
= (1<<1),
697 IEEE80211_CONF_IDLE
= (1<<2),
698 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
703 * enum ieee80211_conf_changed - denotes which configuration changed
705 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
706 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
707 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
708 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
709 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
710 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
711 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
712 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
714 enum ieee80211_conf_changed
{
715 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
716 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
717 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
718 IEEE80211_CONF_CHANGE_PS
= BIT(4),
719 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
720 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
721 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
722 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
726 * enum ieee80211_smps_mode - spatial multiplexing power save mode
728 * @IEEE80211_SMPS_AUTOMATIC: automatic
729 * @IEEE80211_SMPS_OFF: off
730 * @IEEE80211_SMPS_STATIC: static
731 * @IEEE80211_SMPS_DYNAMIC: dynamic
732 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
734 enum ieee80211_smps_mode
{
735 IEEE80211_SMPS_AUTOMATIC
,
737 IEEE80211_SMPS_STATIC
,
738 IEEE80211_SMPS_DYNAMIC
,
741 IEEE80211_SMPS_NUM_MODES
,
745 * struct ieee80211_conf - configuration of the device
747 * This struct indicates how the driver shall configure the hardware.
749 * @flags: configuration flags defined above
751 * @listen_interval: listen interval in units of beacon interval
752 * @max_sleep_period: the maximum number of beacon intervals to sleep for
753 * before checking the beacon for a TIM bit (managed mode only); this
754 * value will be only achievable between DTIM frames, the hardware
755 * needs to check for the multicast traffic bit in DTIM beacons.
756 * This variable is valid only when the CONF_PS flag is set.
757 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
758 * in power saving. Power saving will not be enabled until a beacon
759 * has been received and the DTIM period is known.
760 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
761 * powersave documentation below. This variable is valid only when
762 * the CONF_PS flag is set.
764 * @power_level: requested transmit power (in dBm)
766 * @channel: the channel to tune to
767 * @channel_type: the channel (HT) type
769 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
770 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
771 * but actually means the number of transmissions not the number of retries
772 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
773 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
774 * number of transmissions not the number of retries
776 * @smps_mode: spatial multiplexing powersave mode; note that
777 * %IEEE80211_SMPS_STATIC is used when the device is not
778 * configured for an HT channel
780 struct ieee80211_conf
{
782 int power_level
, dynamic_ps_timeout
;
783 int max_sleep_period
;
788 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
790 struct ieee80211_channel
*channel
;
791 enum nl80211_channel_type channel_type
;
792 enum ieee80211_smps_mode smps_mode
;
796 * struct ieee80211_channel_switch - holds the channel switch data
798 * The information provided in this structure is required for channel switch
801 * @timestamp: value in microseconds of the 64-bit Time Synchronization
802 * Function (TSF) timer when the frame containing the channel switch
803 * announcement was received. This is simply the rx.mactime parameter
804 * the driver passed into mac80211.
805 * @block_tx: Indicates whether transmission must be blocked before the
806 * scheduled channel switch, as indicated by the AP.
807 * @channel: the new channel to switch to
808 * @count: the number of TBTT's until the channel switch event
810 struct ieee80211_channel_switch
{
813 struct ieee80211_channel
*channel
;
818 * struct ieee80211_vif - per-interface data
820 * Data in this structure is continually present for driver
821 * use during the life of a virtual interface.
823 * @type: type of this virtual interface
824 * @bss_conf: BSS configuration for this interface, either our own
825 * or the BSS we're associated to
826 * @addr: address of this interface
827 * @p2p: indicates whether this AP or STA interface is a p2p
828 * interface, i.e. a GO or p2p-sta respectively
829 * @drv_priv: data area for driver use, will always be aligned to
832 struct ieee80211_vif
{
833 enum nl80211_iftype type
;
834 struct ieee80211_bss_conf bss_conf
;
838 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
841 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
843 #ifdef CONFIG_MAC80211_MESH
844 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
850 * enum ieee80211_key_flags - key flags
852 * These flags are used for communication about keys between the driver
853 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
855 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
856 * that the STA this key will be used with could be using QoS.
857 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
858 * driver to indicate that it requires IV generation for this
860 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
861 * the driver for a TKIP key if it requires Michael MIC
862 * generation in software.
863 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
864 * that the key is pairwise rather then a shared key.
865 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
866 * CCMP key if it requires CCMP encryption of management frames (MFP) to
867 * be done in software.
869 enum ieee80211_key_flags
{
870 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
871 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
872 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
873 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
874 IEEE80211_KEY_FLAG_SW_MGMT
= 1<<4,
878 * struct ieee80211_key_conf - key information
880 * This key information is given by mac80211 to the driver by
881 * the set_key() callback in &struct ieee80211_ops.
883 * @hw_key_idx: To be set by the driver, this is the key index the driver
884 * wants to be given when a frame is transmitted and needs to be
885 * encrypted in hardware.
886 * @cipher: The key's cipher suite selector.
887 * @flags: key flags, see &enum ieee80211_key_flags.
888 * @keyidx: the key index (0-3)
889 * @keylen: key material length
890 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
892 * - Temporal Encryption Key (128 bits)
893 * - Temporal Authenticator Tx MIC Key (64 bits)
894 * - Temporal Authenticator Rx MIC Key (64 bits)
895 * @icv_len: The ICV length for this key type
896 * @iv_len: The IV length for this key type
898 struct ieee80211_key_conf
{
910 * enum set_key_cmd - key command
912 * Used with the set_key() callback in &struct ieee80211_ops, this
913 * indicates whether a key is being removed or added.
915 * @SET_KEY: a key is set
916 * @DISABLE_KEY: a key must be disabled
919 SET_KEY
, DISABLE_KEY
,
923 * struct ieee80211_sta - station table entry
925 * A station table entry represents a station we are possibly
926 * communicating with. Since stations are RCU-managed in
927 * mac80211, any ieee80211_sta pointer you get access to must
928 * either be protected by rcu_read_lock() explicitly or implicitly,
929 * or you must take good care to not use such a pointer after a
930 * call to your sta_remove callback that removed it.
933 * @aid: AID we assigned to the station if we're an AP
934 * @supp_rates: Bitmap of supported rates (per band)
935 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
936 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
937 * @drv_priv: data area for driver use, will always be aligned to
938 * sizeof(void *), size is determined in hw information.
940 struct ieee80211_sta
{
941 u32 supp_rates
[IEEE80211_NUM_BANDS
];
944 struct ieee80211_sta_ht_cap ht_cap
;
948 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
952 * enum sta_notify_cmd - sta notify command
954 * Used with the sta_notify() callback in &struct ieee80211_ops, this
955 * indicates if an associated station made a power state transition.
957 * @STA_NOTIFY_SLEEP: a station is now sleeping
958 * @STA_NOTIFY_AWAKE: a sleeping station woke up
960 enum sta_notify_cmd
{
961 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
965 * enum ieee80211_hw_flags - hardware flags
967 * These flags are used to indicate hardware capabilities to
968 * the stack. Generally, flags here should have their meaning
969 * done in a way that the simplest hardware doesn't need setting
970 * any particular flags. There are some exceptions to this rule,
971 * however, so you are advised to review these flags carefully.
973 * @IEEE80211_HW_HAS_RATE_CONTROL:
974 * The hardware or firmware includes rate control, and cannot be
975 * controlled by the stack. As such, no rate control algorithm
976 * should be instantiated, and the TX rate reported to userspace
977 * will be taken from the TX status instead of the rate control
979 * Note that this requires that the driver implement a number of
980 * callbacks so it has the correct information, it needs to have
981 * the @set_rts_threshold callback and must look at the BSS config
982 * @use_cts_prot for G/N protection, @use_short_slot for slot
983 * timing in 2.4 GHz and @use_short_preamble for preambles for
986 * @IEEE80211_HW_RX_INCLUDES_FCS:
987 * Indicates that received frames passed to the stack include
988 * the FCS at the end.
990 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
991 * Some wireless LAN chipsets buffer broadcast/multicast frames
992 * for power saving stations in the hardware/firmware and others
993 * rely on the host system for such buffering. This option is used
994 * to configure the IEEE 802.11 upper layer to buffer broadcast and
995 * multicast frames when there are power saving stations so that
996 * the driver can fetch them with ieee80211_get_buffered_bc().
998 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
999 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1001 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1002 * Hardware is not capable of receiving frames with short preamble on
1005 * @IEEE80211_HW_SIGNAL_UNSPEC:
1006 * Hardware can provide signal values but we don't know its units. We
1007 * expect values between 0 and @max_signal.
1008 * If possible please provide dB or dBm instead.
1010 * @IEEE80211_HW_SIGNAL_DBM:
1011 * Hardware gives signal values in dBm, decibel difference from
1012 * one milliwatt. This is the preferred method since it is standardized
1013 * between different devices. @max_signal does not need to be set.
1015 * @IEEE80211_HW_SPECTRUM_MGMT:
1016 * Hardware supports spectrum management defined in 802.11h
1017 * Measurement, Channel Switch, Quieting, TPC
1019 * @IEEE80211_HW_AMPDU_AGGREGATION:
1020 * Hardware supports 11n A-MPDU aggregation.
1022 * @IEEE80211_HW_SUPPORTS_PS:
1023 * Hardware has power save support (i.e. can go to sleep).
1025 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1026 * Hardware requires nullfunc frame handling in stack, implies
1027 * stack support for dynamic PS.
1029 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1030 * Hardware has support for dynamic PS.
1032 * @IEEE80211_HW_MFP_CAPABLE:
1033 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1035 * @IEEE80211_HW_BEACON_FILTER:
1036 * Hardware supports dropping of irrelevant beacon frames to
1037 * avoid waking up cpu.
1039 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1040 * Hardware supports static spatial multiplexing powersave,
1041 * ie. can turn off all but one chain even on HT connections
1042 * that should be using more chains.
1044 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1045 * Hardware supports dynamic spatial multiplexing powersave,
1046 * ie. can turn off all but one chain and then wake the rest
1047 * up as required after, for example, rts/cts handshake.
1049 * @IEEE80211_HW_SUPPORTS_UAPSD:
1050 * Hardware supports Unscheduled Automatic Power Save Delivery
1051 * (U-APSD) in managed mode. The mode is configured with
1052 * conf_tx() operation.
1054 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1055 * Hardware can provide ack status reports of Tx frames to
1058 * @IEEE80211_HW_CONNECTION_MONITOR:
1059 * The hardware performs its own connection monitoring, including
1060 * periodic keep-alives to the AP and probing the AP on beacon loss.
1061 * When this flag is set, signaling beacon-loss will cause an immediate
1062 * change to disassociated state.
1064 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1065 * Hardware can do connection quality monitoring - i.e. it can monitor
1066 * connection quality related parameters, such as the RSSI level and
1067 * provide notifications if configured trigger levels are reached.
1069 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1070 * This device needs to know the DTIM period for the BSS before
1073 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1074 * per-station GTKs as used by IBSS RSN or during fast transition. If
1075 * the device doesn't support per-station GTKs, but can be asked not
1076 * to decrypt group addressed frames, then IBSS RSN support is still
1077 * possible but software crypto will be used. Advertise the wiphy flag
1078 * only in that case.
1080 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1081 * autonomously manages the PS status of connected stations. When
1082 * this flag is set mac80211 will not trigger PS mode for connected
1083 * stations based on the PM bit of incoming frames.
1084 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1085 * the PS mode of connected stations.
1087 enum ieee80211_hw_flags
{
1088 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1089 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1090 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1091 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1092 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1093 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1094 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1095 IEEE80211_HW_NEED_DTIM_PERIOD
= 1<<7,
1096 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1097 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1098 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1099 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1100 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1101 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1102 IEEE80211_HW_BEACON_FILTER
= 1<<14,
1103 IEEE80211_HW_SUPPORTS_STATIC_SMPS
= 1<<15,
1104 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS
= 1<<16,
1105 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1106 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1107 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1108 IEEE80211_HW_SUPPORTS_CQM_RSSI
= 1<<20,
1109 IEEE80211_HW_SUPPORTS_PER_STA_GTK
= 1<<21,
1110 IEEE80211_HW_AP_LINK_PS
= 1<<22,
1114 * struct ieee80211_hw - hardware information and state
1116 * This structure contains the configuration and hardware
1117 * information for an 802.11 PHY.
1119 * @wiphy: This points to the &struct wiphy allocated for this
1120 * 802.11 PHY. You must fill in the @perm_addr and @dev
1121 * members of this structure using SET_IEEE80211_DEV()
1122 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1123 * bands (with channels, bitrates) are registered here.
1125 * @conf: &struct ieee80211_conf, device configuration, don't use.
1127 * @priv: pointer to private area that was allocated for driver use
1128 * along with this structure.
1130 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1132 * @extra_tx_headroom: headroom to reserve in each transmit skb
1133 * for use by the driver (e.g. for transmit headers.)
1135 * @channel_change_time: time (in microseconds) it takes to change channels.
1137 * @max_signal: Maximum value for signal (rssi) in RX information, used
1138 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1140 * @max_listen_interval: max listen interval in units of beacon interval
1143 * @queues: number of available hardware transmit queues for
1144 * data packets. WMM/QoS requires at least four, these
1145 * queues need to have configurable access parameters.
1147 * @rate_control_algorithm: rate control algorithm for this hardware.
1148 * If unset (NULL), the default algorithm will be used. Must be
1149 * set before calling ieee80211_register_hw().
1151 * @vif_data_size: size (in bytes) of the drv_priv data area
1152 * within &struct ieee80211_vif.
1153 * @sta_data_size: size (in bytes) of the drv_priv data area
1154 * within &struct ieee80211_sta.
1156 * @max_rates: maximum number of alternate rate retry stages the hw
1158 * @max_report_rates: maximum number of alternate rate retry stages
1159 * the hw can report back.
1160 * @max_rate_tries: maximum number of tries for each stage
1162 * @napi_weight: weight used for NAPI polling. You must specify an
1163 * appropriate value here if a napi_poll operation is provided
1166 * @max_rx_aggregation_subframes: maximum buffer size (number of
1167 * sub-frames) to be used for A-MPDU block ack receiver
1169 * This is only relevant if the device has restrictions on the
1170 * number of subframes, if it relies on mac80211 to do reordering
1171 * it shouldn't be set.
1173 * @max_tx_aggregation_subframes: maximum number of subframes in an
1174 * aggregate an HT driver will transmit, used by the peer as a
1175 * hint to size its reorder buffer.
1177 struct ieee80211_hw
{
1178 struct ieee80211_conf conf
;
1179 struct wiphy
*wiphy
;
1180 const char *rate_control_algorithm
;
1183 unsigned int extra_tx_headroom
;
1184 int channel_change_time
;
1189 u16 max_listen_interval
;
1192 u8 max_report_rates
;
1194 u8 max_rx_aggregation_subframes
;
1195 u8 max_tx_aggregation_subframes
;
1199 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1201 * @wiphy: the &struct wiphy which we want to query
1203 * mac80211 drivers can use this to get to their respective
1204 * &struct ieee80211_hw. Drivers wishing to get to their own private
1205 * structure can then access it via hw->priv. Note that mac802111 drivers should
1206 * not use wiphy_priv() to try to get their private driver structure as this
1207 * is already used internally by mac80211.
1209 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1212 * SET_IEEE80211_DEV - set device for 802.11 hardware
1214 * @hw: the &struct ieee80211_hw to set the device for
1215 * @dev: the &struct device of this 802.11 device
1217 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1219 set_wiphy_dev(hw
->wiphy
, dev
);
1223 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1225 * @hw: the &struct ieee80211_hw to set the MAC address for
1226 * @addr: the address to set
1228 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1230 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1233 static inline struct ieee80211_rate
*
1234 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1235 const struct ieee80211_tx_info
*c
)
1237 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
1239 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1242 static inline struct ieee80211_rate
*
1243 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1244 const struct ieee80211_tx_info
*c
)
1246 if (c
->control
.rts_cts_rate_idx
< 0)
1248 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1251 static inline struct ieee80211_rate
*
1252 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1253 const struct ieee80211_tx_info
*c
, int idx
)
1255 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1257 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1261 * DOC: Hardware crypto acceleration
1263 * mac80211 is capable of taking advantage of many hardware
1264 * acceleration designs for encryption and decryption operations.
1266 * The set_key() callback in the &struct ieee80211_ops for a given
1267 * device is called to enable hardware acceleration of encryption and
1268 * decryption. The callback takes a @sta parameter that will be NULL
1269 * for default keys or keys used for transmission only, or point to
1270 * the station information for the peer for individual keys.
1271 * Multiple transmission keys with the same key index may be used when
1272 * VLANs are configured for an access point.
1274 * When transmitting, the TX control data will use the @hw_key_idx
1275 * selected by the driver by modifying the &struct ieee80211_key_conf
1276 * pointed to by the @key parameter to the set_key() function.
1278 * The set_key() call for the %SET_KEY command should return 0 if
1279 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1280 * added; if you return 0 then hw_key_idx must be assigned to the
1281 * hardware key index, you are free to use the full u8 range.
1283 * When the cmd is %DISABLE_KEY then it must succeed.
1285 * Note that it is permissible to not decrypt a frame even if a key
1286 * for it has been uploaded to hardware, the stack will not make any
1287 * decision based on whether a key has been uploaded or not but rather
1288 * based on the receive flags.
1290 * The &struct ieee80211_key_conf structure pointed to by the @key
1291 * parameter is guaranteed to be valid until another call to set_key()
1292 * removes it, but it can only be used as a cookie to differentiate
1295 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1296 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1298 * The update_tkip_key() call updates the driver with the new phase 1 key.
1299 * This happens every time the iv16 wraps around (every 65536 packets). The
1300 * set_key() call will happen only once for each key (unless the AP did
1301 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1302 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1303 * handler is software decryption with wrap around of iv16.
1307 * DOC: Powersave support
1309 * mac80211 has support for various powersave implementations.
1311 * First, it can support hardware that handles all powersaving by itself,
1312 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1313 * flag. In that case, it will be told about the desired powersave mode
1314 * with the %IEEE80211_CONF_PS flag depending on the association status.
1315 * The hardware must take care of sending nullfunc frames when necessary,
1316 * i.e. when entering and leaving powersave mode. The hardware is required
1317 * to look at the AID in beacons and signal to the AP that it woke up when
1318 * it finds traffic directed to it.
1320 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1321 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1322 * with hardware wakeup and sleep states. Driver is responsible for waking
1323 * up the hardware before issuing commands to the hardware and putting it
1324 * back to sleep at appropriate times.
1326 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1327 * buffered multicast/broadcast frames after the beacon. Also it must be
1328 * possible to send frames and receive the acknowledment frame.
1330 * Other hardware designs cannot send nullfunc frames by themselves and also
1331 * need software support for parsing the TIM bitmap. This is also supported
1332 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1333 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1334 * required to pass up beacons. The hardware is still required to handle
1335 * waking up for multicast traffic; if it cannot the driver must handle that
1336 * as best as it can, mac80211 is too slow to do that.
1338 * Dynamic powersave is an extension to normal powersave in which the
1339 * hardware stays awake for a user-specified period of time after sending a
1340 * frame so that reply frames need not be buffered and therefore delayed to
1341 * the next wakeup. It's compromise of getting good enough latency when
1342 * there's data traffic and still saving significantly power in idle
1345 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1346 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1347 * flag and mac80211 will handle everything automatically. Additionally,
1348 * hardware having support for the dynamic PS feature may set the
1349 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1350 * dynamic PS mode itself. The driver needs to look at the
1351 * @dynamic_ps_timeout hardware configuration value and use it that value
1352 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1353 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1354 * enabled whenever user has enabled powersave.
1356 * Some hardware need to toggle a single shared antenna between WLAN and
1357 * Bluetooth to facilitate co-existence. These types of hardware set
1358 * limitations on the use of host controlled dynamic powersave whenever there
1359 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1360 * driver may request temporarily going into full power save, in order to
1361 * enable toggling the antenna between BT and WLAN. If the driver requests
1362 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1363 * temporarily set to zero until the driver re-enables dynamic powersave.
1365 * Driver informs U-APSD client support by enabling
1366 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1367 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1368 * Nullfunc frames and stay awake until the service period has ended. To
1369 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1370 * from that AC are transmitted with powersave enabled.
1372 * Note: U-APSD client mode is not yet supported with
1373 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1377 * DOC: Beacon filter support
1379 * Some hardware have beacon filter support to reduce host cpu wakeups
1380 * which will reduce system power consumption. It usuallly works so that
1381 * the firmware creates a checksum of the beacon but omits all constantly
1382 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1383 * beacon is forwarded to the host, otherwise it will be just dropped. That
1384 * way the host will only receive beacons where some relevant information
1385 * (for example ERP protection or WMM settings) have changed.
1387 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1388 * hardware capability. The driver needs to enable beacon filter support
1389 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1390 * power save is enabled, the stack will not check for beacon loss and the
1391 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1393 * The time (or number of beacons missed) until the firmware notifies the
1394 * driver of a beacon loss event (which in turn causes the driver to call
1395 * ieee80211_beacon_loss()) should be configurable and will be controlled
1396 * by mac80211 and the roaming algorithm in the future.
1398 * Since there may be constantly changing information elements that nothing
1399 * in the software stack cares about, we will, in the future, have mac80211
1400 * tell the driver which information elements are interesting in the sense
1401 * that we want to see changes in them. This will include
1402 * - a list of information element IDs
1403 * - a list of OUIs for the vendor information element
1405 * Ideally, the hardware would filter out any beacons without changes in the
1406 * requested elements, but if it cannot support that it may, at the expense
1407 * of some efficiency, filter out only a subset. For example, if the device
1408 * doesn't support checking for OUIs it should pass up all changes in all
1409 * vendor information elements.
1411 * Note that change, for the sake of simplification, also includes information
1412 * elements appearing or disappearing from the beacon.
1414 * Some hardware supports an "ignore list" instead, just make sure nothing
1415 * that was requested is on the ignore list, and include commonly changing
1416 * information element IDs in the ignore list, for example 11 (BSS load) and
1417 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1418 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1419 * it could also include some currently unused IDs.
1422 * In addition to these capabilities, hardware should support notifying the
1423 * host of changes in the beacon RSSI. This is relevant to implement roaming
1424 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1425 * the received data packets). This can consist in notifying the host when
1426 * the RSSI changes significantly or when it drops below or rises above
1427 * configurable thresholds. In the future these thresholds will also be
1428 * configured by mac80211 (which gets them from userspace) to implement
1429 * them as the roaming algorithm requires.
1431 * If the hardware cannot implement this, the driver should ask it to
1432 * periodically pass beacon frames to the host so that software can do the
1433 * signal strength threshold checking.
1437 * DOC: Spatial multiplexing power save
1439 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1440 * power in an 802.11n implementation. For details on the mechanism
1441 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1442 * "11.2.3 SM power save".
1444 * The mac80211 implementation is capable of sending action frames
1445 * to update the AP about the station's SMPS mode, and will instruct
1446 * the driver to enter the specific mode. It will also announce the
1447 * requested SMPS mode during the association handshake. Hardware
1448 * support for this feature is required, and can be indicated by
1451 * The default mode will be "automatic", which nl80211/cfg80211
1452 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1453 * turned off otherwise.
1455 * To support this feature, the driver must set the appropriate
1456 * hardware support flags, and handle the SMPS flag to the config()
1457 * operation. It will then with this mechanism be instructed to
1458 * enter the requested SMPS mode while associated to an HT AP.
1462 * DOC: Frame filtering
1464 * mac80211 requires to see many management frames for proper
1465 * operation, and users may want to see many more frames when
1466 * in monitor mode. However, for best CPU usage and power consumption,
1467 * having as few frames as possible percolate through the stack is
1468 * desirable. Hence, the hardware should filter as much as possible.
1470 * To achieve this, mac80211 uses filter flags (see below) to tell
1471 * the driver's configure_filter() function which frames should be
1472 * passed to mac80211 and which should be filtered out.
1474 * Before configure_filter() is invoked, the prepare_multicast()
1475 * callback is invoked with the parameters @mc_count and @mc_list
1476 * for the combined multicast address list of all virtual interfaces.
1477 * It's use is optional, and it returns a u64 that is passed to
1478 * configure_filter(). Additionally, configure_filter() has the
1479 * arguments @changed_flags telling which flags were changed and
1480 * @total_flags with the new flag states.
1482 * If your device has no multicast address filters your driver will
1483 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1484 * parameter to see whether multicast frames should be accepted
1487 * All unsupported flags in @total_flags must be cleared.
1488 * Hardware does not support a flag if it is incapable of _passing_
1489 * the frame to the stack. Otherwise the driver must ignore
1490 * the flag, but not clear it.
1491 * You must _only_ clear the flag (announce no support for the
1492 * flag to mac80211) if you are not able to pass the packet type
1493 * to the stack (so the hardware always filters it).
1494 * So for example, you should clear @FIF_CONTROL, if your hardware
1495 * always filters control frames. If your hardware always passes
1496 * control frames to the kernel and is incapable of filtering them,
1497 * you do _not_ clear the @FIF_CONTROL flag.
1498 * This rule applies to all other FIF flags as well.
1502 * enum ieee80211_filter_flags - hardware filter flags
1504 * These flags determine what the filter in hardware should be
1505 * programmed to let through and what should not be passed to the
1506 * stack. It is always safe to pass more frames than requested,
1507 * but this has negative impact on power consumption.
1509 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1510 * think of the BSS as your network segment and then this corresponds
1511 * to the regular ethernet device promiscuous mode.
1513 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1514 * by the user or if the hardware is not capable of filtering by
1515 * multicast address.
1517 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1518 * %RX_FLAG_FAILED_FCS_CRC for them)
1520 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1521 * the %RX_FLAG_FAILED_PLCP_CRC for them
1523 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1524 * to the hardware that it should not filter beacons or probe responses
1525 * by BSSID. Filtering them can greatly reduce the amount of processing
1526 * mac80211 needs to do and the amount of CPU wakeups, so you should
1527 * honour this flag if possible.
1529 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1530 * is not set then only those addressed to this station.
1532 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1534 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1535 * those addressed to this station.
1537 * @FIF_PROBE_REQ: pass probe request frames
1539 enum ieee80211_filter_flags
{
1540 FIF_PROMISC_IN_BSS
= 1<<0,
1541 FIF_ALLMULTI
= 1<<1,
1543 FIF_PLCPFAIL
= 1<<3,
1544 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1546 FIF_OTHER_BSS
= 1<<6,
1548 FIF_PROBE_REQ
= 1<<8,
1552 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1554 * These flags are used with the ampdu_action() callback in
1555 * &struct ieee80211_ops to indicate which action is needed.
1557 * Note that drivers MUST be able to deal with a TX aggregation
1558 * session being stopped even before they OK'ed starting it by
1559 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1560 * might receive the addBA frame and send a delBA right away!
1562 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1563 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1564 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1565 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1566 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1568 enum ieee80211_ampdu_mlme_action
{
1569 IEEE80211_AMPDU_RX_START
,
1570 IEEE80211_AMPDU_RX_STOP
,
1571 IEEE80211_AMPDU_TX_START
,
1572 IEEE80211_AMPDU_TX_STOP
,
1573 IEEE80211_AMPDU_TX_OPERATIONAL
,
1577 * struct ieee80211_ops - callbacks from mac80211 to the driver
1579 * This structure contains various callbacks that the driver may
1580 * handle or, in some cases, must handle, for example to configure
1581 * the hardware to a new channel or to transmit a frame.
1583 * @tx: Handler that 802.11 module calls for each transmitted frame.
1584 * skb contains the buffer starting from the IEEE 802.11 header.
1585 * The low-level driver should send the frame out based on
1586 * configuration in the TX control data. This handler should,
1587 * preferably, never fail and stop queues appropriately, more
1588 * importantly, however, it must never fail for A-MPDU-queues.
1589 * This function should return NETDEV_TX_OK except in very
1591 * Must be implemented and atomic.
1593 * @start: Called before the first netdevice attached to the hardware
1594 * is enabled. This should turn on the hardware and must turn on
1595 * frame reception (for possibly enabled monitor interfaces.)
1596 * Returns negative error codes, these may be seen in userspace,
1598 * When the device is started it should not have a MAC address
1599 * to avoid acknowledging frames before a non-monitor device
1601 * Must be implemented and can sleep.
1603 * @stop: Called after last netdevice attached to the hardware
1604 * is disabled. This should turn off the hardware (at least
1605 * it must turn off frame reception.)
1606 * May be called right after add_interface if that rejects
1607 * an interface. If you added any work onto the mac80211 workqueue
1608 * you should ensure to cancel it on this callback.
1609 * Must be implemented and can sleep.
1611 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1612 * stop transmitting and doing any other configuration, and then
1613 * ask the device to suspend. This is only invoked when WoWLAN is
1614 * configured, otherwise the device is deconfigured completely and
1615 * reconfigured at resume time.
1616 * The driver may also impose special conditions under which it
1617 * wants to use the "normal" suspend (deconfigure), say if it only
1618 * supports WoWLAN when the device is associated. In this case, it
1619 * must return 1 from this function.
1621 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1622 * now resuming its operation, after this the device must be fully
1623 * functional again. If this returns an error, the only way out is
1624 * to also unregister the device. If it returns 1, then mac80211
1625 * will also go through the regular complete restart on resume.
1627 * @add_interface: Called when a netdevice attached to the hardware is
1628 * enabled. Because it is not called for monitor mode devices, @start
1629 * and @stop must be implemented.
1630 * The driver should perform any initialization it needs before
1631 * the device can be enabled. The initial configuration for the
1632 * interface is given in the conf parameter.
1633 * The callback may refuse to add an interface by returning a
1634 * negative error code (which will be seen in userspace.)
1635 * Must be implemented and can sleep.
1637 * @change_interface: Called when a netdevice changes type. This callback
1638 * is optional, but only if it is supported can interface types be
1639 * switched while the interface is UP. The callback may sleep.
1640 * Note that while an interface is being switched, it will not be
1641 * found by the interface iteration callbacks.
1643 * @remove_interface: Notifies a driver that an interface is going down.
1644 * The @stop callback is called after this if it is the last interface
1645 * and no monitor interfaces are present.
1646 * When all interfaces are removed, the MAC address in the hardware
1647 * must be cleared so the device no longer acknowledges packets,
1648 * the mac_addr member of the conf structure is, however, set to the
1649 * MAC address of the device going away.
1650 * Hence, this callback must be implemented. It can sleep.
1652 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1653 * function to change hardware configuration, e.g., channel.
1654 * This function should never fail but returns a negative error code
1655 * if it does. The callback can sleep.
1657 * @bss_info_changed: Handler for configuration requests related to BSS
1658 * parameters that may vary during BSS's lifespan, and may affect low
1659 * level driver (e.g. assoc/disassoc status, erp parameters).
1660 * This function should not be used if no BSS has been set, unless
1661 * for association indication. The @changed parameter indicates which
1662 * of the bss parameters has changed when a call is made. The callback
1665 * @prepare_multicast: Prepare for multicast filter configuration.
1666 * This callback is optional, and its return value is passed
1667 * to configure_filter(). This callback must be atomic.
1669 * @configure_filter: Configure the device's RX filter.
1670 * See the section "Frame filtering" for more information.
1671 * This callback must be implemented and can sleep.
1673 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1674 * must be set or cleared for a given STA. Must be atomic.
1676 * @set_key: See the section "Hardware crypto acceleration"
1677 * This callback is only called between add_interface and
1678 * remove_interface calls, i.e. while the given virtual interface
1680 * Returns a negative error code if the key can't be added.
1681 * The callback can sleep.
1683 * @update_tkip_key: See the section "Hardware crypto acceleration"
1684 * This callback will be called in the context of Rx. Called for drivers
1685 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1686 * The callback must be atomic.
1688 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1689 * host is suspended, it can assign this callback to retrieve the data
1690 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1691 * After rekeying was done it should (for example during resume) notify
1692 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1694 * @hw_scan: Ask the hardware to service the scan request, no need to start
1695 * the scan state machine in stack. The scan must honour the channel
1696 * configuration done by the regulatory agent in the wiphy's
1697 * registered bands. The hardware (or the driver) needs to make sure
1698 * that power save is disabled.
1699 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1700 * entire IEs after the SSID, so that drivers need not look at these
1701 * at all but just send them after the SSID -- mac80211 includes the
1702 * (extended) supported rates and HT information (where applicable).
1703 * When the scan finishes, ieee80211_scan_completed() must be called;
1704 * note that it also must be called when the scan cannot finish due to
1705 * any error unless this callback returned a negative error code.
1706 * The callback can sleep.
1708 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1709 * The driver should ask the hardware to cancel the scan (if possible),
1710 * but the scan will be completed only after the driver will call
1711 * ieee80211_scan_completed().
1712 * This callback is needed for wowlan, to prevent enqueueing a new
1713 * scan_work after the low-level driver was already suspended.
1714 * The callback can sleep.
1716 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1717 * specific intervals. The driver must call the
1718 * ieee80211_sched_scan_results() function whenever it finds results.
1719 * This process will continue until sched_scan_stop is called.
1721 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1723 * @sw_scan_start: Notifier function that is called just before a software scan
1724 * is started. Can be NULL, if the driver doesn't need this notification.
1725 * The callback can sleep.
1727 * @sw_scan_complete: Notifier function that is called just after a
1728 * software scan finished. Can be NULL, if the driver doesn't need
1729 * this notification.
1730 * The callback can sleep.
1732 * @get_stats: Return low-level statistics.
1733 * Returns zero if statistics are available.
1734 * The callback can sleep.
1736 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1737 * callback should be provided to read the TKIP transmit IVs (both IV32
1738 * and IV16) for the given key from hardware.
1739 * The callback must be atomic.
1741 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1742 * if the device does fragmentation by itself; if this callback is
1743 * implemented then the stack will not do fragmentation.
1744 * The callback can sleep.
1746 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1747 * The callback can sleep.
1749 * @sta_add: Notifies low level driver about addition of an associated station,
1750 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1752 * @sta_remove: Notifies low level driver about removal of an associated
1753 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1755 * @sta_notify: Notifies low level driver about power state transition of an
1756 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1757 * in AP mode, this callback will not be called when the flag
1758 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1760 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1761 * bursting) for a hardware TX queue.
1762 * Returns a negative error code on failure.
1763 * The callback can sleep.
1765 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1766 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1767 * required function.
1768 * The callback can sleep.
1770 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1771 * Currently, this is only used for IBSS mode debugging. Is not a
1772 * required function.
1773 * The callback can sleep.
1775 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1776 * with other STAs in the IBSS. This is only used in IBSS mode. This
1777 * function is optional if the firmware/hardware takes full care of
1778 * TSF synchronization.
1779 * The callback can sleep.
1781 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1782 * This is needed only for IBSS mode and the result of this function is
1783 * used to determine whether to reply to Probe Requests.
1784 * Returns non-zero if this device sent the last beacon.
1785 * The callback can sleep.
1787 * @ampdu_action: Perform a certain A-MPDU action
1788 * The RA/TID combination determines the destination and TID we want
1789 * the ampdu action to be performed for. The action is defined through
1790 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1791 * is the first frame we expect to perform the action on. Notice
1792 * that TX/RX_STOP can pass NULL for this parameter.
1793 * The @buf_size parameter is only valid when the action is set to
1794 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1795 * buffer size (number of subframes) for this session -- the driver
1796 * may neither send aggregates containing more subframes than this
1797 * nor send aggregates in a way that lost frames would exceed the
1798 * buffer size. If just limiting the aggregate size, this would be
1799 * possible with a buf_size of 8:
1801 * - RX: 2....7 (lost frame #1)
1803 * which is invalid since #1 was now re-transmitted well past the
1804 * buffer size of 8. Correct ways to retransmit #1 would be:
1805 * - TX: 1 or 18 or 81
1806 * Even "189" would be wrong since 1 could be lost again.
1808 * Returns a negative error code on failure.
1809 * The callback can sleep.
1811 * @get_survey: Return per-channel survey information
1813 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1814 * need to set wiphy->rfkill_poll to %true before registration,
1815 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1816 * The callback can sleep.
1818 * @set_coverage_class: Set slot time for given coverage class as specified
1819 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1820 * accordingly. This callback is not required and may sleep.
1822 * @testmode_cmd: Implement a cfg80211 test mode command.
1823 * The callback can sleep.
1824 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
1826 * @flush: Flush all pending frames from the hardware queue, making sure
1827 * that the hardware queues are empty. If the parameter @drop is set
1828 * to %true, pending frames may be dropped. The callback can sleep.
1830 * @channel_switch: Drivers that need (or want) to offload the channel
1831 * switch operation for CSAs received from the AP may implement this
1832 * callback. They must then call ieee80211_chswitch_done() to indicate
1833 * completion of the channel switch.
1835 * @napi_poll: Poll Rx queue for incoming data frames.
1837 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1838 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1839 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1840 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1842 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1844 * @remain_on_channel: Starts an off-channel period on the given channel, must
1845 * call back to ieee80211_ready_on_channel() when on that channel. Note
1846 * that normal channel traffic is not stopped as this is intended for hw
1847 * offload. Frames to transmit on the off-channel channel are transmitted
1848 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1849 * duration (which will always be non-zero) expires, the driver must call
1850 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1851 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1852 * aborted before it expires. This callback may sleep.
1853 * @offchannel_tx: Transmit frame on another channel, wait for a response
1854 * and return. Reliable TX status must be reported for the frame. If the
1855 * return value is 1, then the @remain_on_channel will be used with a
1856 * regular transmission (if supported.)
1857 * @offchannel_tx_cancel_wait: cancel wait associated with offchannel TX
1859 * @set_ringparam: Set tx and rx ring sizes.
1861 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1863 * @tx_frames_pending: Check if there is any pending frame in the hardware
1864 * queues before entering power save.
1866 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1867 * when transmitting a frame. Currently only legacy rates are handled.
1868 * The callback can sleep.
1870 struct ieee80211_ops
{
1871 void (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1872 int (*start
)(struct ieee80211_hw
*hw
);
1873 void (*stop
)(struct ieee80211_hw
*hw
);
1875 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
1876 int (*resume
)(struct ieee80211_hw
*hw
);
1878 int (*add_interface
)(struct ieee80211_hw
*hw
,
1879 struct ieee80211_vif
*vif
);
1880 int (*change_interface
)(struct ieee80211_hw
*hw
,
1881 struct ieee80211_vif
*vif
,
1882 enum nl80211_iftype new_type
, bool p2p
);
1883 void (*remove_interface
)(struct ieee80211_hw
*hw
,
1884 struct ieee80211_vif
*vif
);
1885 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
1886 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
1887 struct ieee80211_vif
*vif
,
1888 struct ieee80211_bss_conf
*info
,
1890 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
1891 struct netdev_hw_addr_list
*mc_list
);
1892 void (*configure_filter
)(struct ieee80211_hw
*hw
,
1893 unsigned int changed_flags
,
1894 unsigned int *total_flags
,
1896 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
1898 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
1899 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
1900 struct ieee80211_key_conf
*key
);
1901 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
1902 struct ieee80211_vif
*vif
,
1903 struct ieee80211_key_conf
*conf
,
1904 struct ieee80211_sta
*sta
,
1905 u32 iv32
, u16
*phase1key
);
1906 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
1907 struct ieee80211_vif
*vif
,
1908 struct cfg80211_gtk_rekey_data
*data
);
1909 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1910 struct cfg80211_scan_request
*req
);
1911 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
1912 struct ieee80211_vif
*vif
);
1913 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
1914 struct ieee80211_vif
*vif
,
1915 struct cfg80211_sched_scan_request
*req
,
1916 struct ieee80211_sched_scan_ies
*ies
);
1917 void (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
1918 struct ieee80211_vif
*vif
);
1919 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
1920 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
1921 int (*get_stats
)(struct ieee80211_hw
*hw
,
1922 struct ieee80211_low_level_stats
*stats
);
1923 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
1924 u32
*iv32
, u16
*iv16
);
1925 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1926 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1927 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1928 struct ieee80211_sta
*sta
);
1929 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1930 struct ieee80211_sta
*sta
);
1931 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1932 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
1933 int (*conf_tx
)(struct ieee80211_hw
*hw
, u16 queue
,
1934 const struct ieee80211_tx_queue_params
*params
);
1935 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
1936 void (*set_tsf
)(struct ieee80211_hw
*hw
, u64 tsf
);
1937 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
1938 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
1939 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
1940 struct ieee80211_vif
*vif
,
1941 enum ieee80211_ampdu_mlme_action action
,
1942 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
,
1944 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
1945 struct survey_info
*survey
);
1946 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
1947 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, u8 coverage_class
);
1948 #ifdef CONFIG_NL80211_TESTMODE
1949 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, void *data
, int len
);
1950 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1951 struct netlink_callback
*cb
,
1952 void *data
, int len
);
1954 void (*flush
)(struct ieee80211_hw
*hw
, bool drop
);
1955 void (*channel_switch
)(struct ieee80211_hw
*hw
,
1956 struct ieee80211_channel_switch
*ch_switch
);
1957 int (*napi_poll
)(struct ieee80211_hw
*hw
, int budget
);
1958 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
1959 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
1961 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
1962 struct ieee80211_channel
*chan
,
1963 enum nl80211_channel_type channel_type
,
1965 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
1966 int (*offchannel_tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1967 struct ieee80211_channel
*chan
,
1968 enum nl80211_channel_type channel_type
,
1970 int (*offchannel_tx_cancel_wait
)(struct ieee80211_hw
*hw
);
1971 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
1972 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
1973 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
1974 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
1975 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1976 const struct cfg80211_bitrate_mask
*mask
);
1980 * ieee80211_alloc_hw - Allocate a new hardware device
1982 * This must be called once for each hardware device. The returned pointer
1983 * must be used to refer to this device when calling other functions.
1984 * mac80211 allocates a private data area for the driver pointed to by
1985 * @priv in &struct ieee80211_hw, the size of this area is given as
1988 * @priv_data_len: length of private data
1989 * @ops: callbacks for this device
1991 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
1992 const struct ieee80211_ops
*ops
);
1995 * ieee80211_register_hw - Register hardware device
1997 * You must call this function before any other functions in
1998 * mac80211. Note that before a hardware can be registered, you
1999 * need to fill the contained wiphy's information.
2001 * @hw: the device to register as returned by ieee80211_alloc_hw()
2003 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
2006 * struct ieee80211_tpt_blink - throughput blink description
2007 * @throughput: throughput in Kbit/sec
2008 * @blink_time: blink time in milliseconds
2009 * (full cycle, ie. one off + one on period)
2011 struct ieee80211_tpt_blink
{
2017 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2018 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2019 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2020 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2021 * interface is connected in some way, including being an AP
2023 enum ieee80211_tpt_led_trigger_flags
{
2024 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
2025 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
2026 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
2029 #ifdef CONFIG_MAC80211_LEDS
2030 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
2031 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
2032 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
2033 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
2034 extern char *__ieee80211_create_tpt_led_trigger(
2035 struct ieee80211_hw
*hw
, unsigned int flags
,
2036 const struct ieee80211_tpt_blink
*blink_table
,
2037 unsigned int blink_table_len
);
2040 * ieee80211_get_tx_led_name - get name of TX LED
2042 * mac80211 creates a transmit LED trigger for each wireless hardware
2043 * that can be used to drive LEDs if your driver registers a LED device.
2044 * This function returns the name (or %NULL if not configured for LEDs)
2045 * of the trigger so you can automatically link the LED device.
2047 * @hw: the hardware to get the LED trigger name for
2049 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
2051 #ifdef CONFIG_MAC80211_LEDS
2052 return __ieee80211_get_tx_led_name(hw
);
2059 * ieee80211_get_rx_led_name - get name of RX LED
2061 * mac80211 creates a receive LED trigger for each wireless hardware
2062 * that can be used to drive LEDs if your driver registers a LED device.
2063 * This function returns the name (or %NULL if not configured for LEDs)
2064 * of the trigger so you can automatically link the LED device.
2066 * @hw: the hardware to get the LED trigger name for
2068 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
2070 #ifdef CONFIG_MAC80211_LEDS
2071 return __ieee80211_get_rx_led_name(hw
);
2078 * ieee80211_get_assoc_led_name - get name of association LED
2080 * mac80211 creates a association LED trigger for each wireless hardware
2081 * that can be used to drive LEDs if your driver registers a LED device.
2082 * This function returns the name (or %NULL if not configured for LEDs)
2083 * of the trigger so you can automatically link the LED device.
2085 * @hw: the hardware to get the LED trigger name for
2087 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
2089 #ifdef CONFIG_MAC80211_LEDS
2090 return __ieee80211_get_assoc_led_name(hw
);
2097 * ieee80211_get_radio_led_name - get name of radio LED
2099 * mac80211 creates a radio change LED trigger for each wireless hardware
2100 * that can be used to drive LEDs if your driver registers a LED device.
2101 * This function returns the name (or %NULL if not configured for LEDs)
2102 * of the trigger so you can automatically link the LED device.
2104 * @hw: the hardware to get the LED trigger name for
2106 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
2108 #ifdef CONFIG_MAC80211_LEDS
2109 return __ieee80211_get_radio_led_name(hw
);
2116 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2117 * @hw: the hardware to create the trigger for
2118 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2119 * @blink_table: the blink table -- needs to be ordered by throughput
2120 * @blink_table_len: size of the blink table
2122 * This function returns %NULL (in case of error, or if no LED
2123 * triggers are configured) or the name of the new trigger.
2124 * This function must be called before ieee80211_register_hw().
2126 static inline char *
2127 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
2128 const struct ieee80211_tpt_blink
*blink_table
,
2129 unsigned int blink_table_len
)
2131 #ifdef CONFIG_MAC80211_LEDS
2132 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
2140 * ieee80211_unregister_hw - Unregister a hardware device
2142 * This function instructs mac80211 to free allocated resources
2143 * and unregister netdevices from the networking subsystem.
2145 * @hw: the hardware to unregister
2147 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
2150 * ieee80211_free_hw - free hardware descriptor
2152 * This function frees everything that was allocated, including the
2153 * private data for the driver. You must call ieee80211_unregister_hw()
2154 * before calling this function.
2156 * @hw: the hardware to free
2158 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
2161 * ieee80211_restart_hw - restart hardware completely
2163 * Call this function when the hardware was restarted for some reason
2164 * (hardware error, ...) and the driver is unable to restore its state
2165 * by itself. mac80211 assumes that at this point the driver/hardware
2166 * is completely uninitialised and stopped, it starts the process by
2167 * calling the ->start() operation. The driver will need to reset all
2168 * internal state that it has prior to calling this function.
2170 * @hw: the hardware to restart
2172 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
2174 /** ieee80211_napi_schedule - schedule NAPI poll
2176 * Use this function to schedule NAPI polling on a device.
2178 * @hw: the hardware to start polling
2180 void ieee80211_napi_schedule(struct ieee80211_hw
*hw
);
2182 /** ieee80211_napi_complete - complete NAPI polling
2184 * Use this function to finish NAPI polling on a device.
2186 * @hw: the hardware to stop polling
2188 void ieee80211_napi_complete(struct ieee80211_hw
*hw
);
2191 * ieee80211_rx - receive frame
2193 * Use this function to hand received frames to mac80211. The receive
2194 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2195 * paged @skb is used, the driver is recommended to put the ieee80211
2196 * header of the frame on the linear part of the @skb to avoid memory
2197 * allocation and/or memcpy by the stack.
2199 * This function may not be called in IRQ context. Calls to this function
2200 * for a single hardware must be synchronized against each other. Calls to
2201 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2202 * mixed for a single hardware.
2204 * In process context use instead ieee80211_rx_ni().
2206 * @hw: the hardware this frame came in on
2207 * @skb: the buffer to receive, owned by mac80211 after this call
2209 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2212 * ieee80211_rx_irqsafe - receive frame
2214 * Like ieee80211_rx() but can be called in IRQ context
2215 * (internally defers to a tasklet.)
2217 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2218 * be mixed for a single hardware.
2220 * @hw: the hardware this frame came in on
2221 * @skb: the buffer to receive, owned by mac80211 after this call
2223 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2226 * ieee80211_rx_ni - receive frame (in process context)
2228 * Like ieee80211_rx() but can be called in process context
2229 * (internally disables bottom halves).
2231 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2232 * not be mixed for a single hardware.
2234 * @hw: the hardware this frame came in on
2235 * @skb: the buffer to receive, owned by mac80211 after this call
2237 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
2238 struct sk_buff
*skb
)
2241 ieee80211_rx(hw
, skb
);
2246 * ieee80211_sta_ps_transition - PS transition for connected sta
2248 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2249 * flag set, use this function to inform mac80211 about a connected station
2250 * entering/leaving PS mode.
2252 * This function may not be called in IRQ context or with softirqs enabled.
2254 * Calls to this function for a single hardware must be synchronized against
2257 * The function returns -EINVAL when the requested PS mode is already set.
2259 * @sta: currently connected sta
2260 * @start: start or stop PS
2262 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
2265 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2266 * (in process context)
2268 * Like ieee80211_sta_ps_transition() but can be called in process context
2269 * (internally disables bottom halves). Concurrent call restriction still
2272 * @sta: currently connected sta
2273 * @start: start or stop PS
2275 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
2281 ret
= ieee80211_sta_ps_transition(sta
, start
);
2288 * The TX headroom reserved by mac80211 for its own tx_status functions.
2289 * This is enough for the radiotap header.
2291 #define IEEE80211_TX_STATUS_HEADROOM 13
2294 * ieee80211_sta_set_tim - set the TIM bit for a sleeping station
2295 * @sta: &struct ieee80211_sta pointer for the sleeping station
2297 * If a driver buffers frames for a powersave station instead of passing
2298 * them back to mac80211 for retransmission, the station needs to be told
2299 * to wake up using the TIM bitmap in the beacon.
2301 * This function sets the station's TIM bit - it will be cleared when the
2304 void ieee80211_sta_set_tim(struct ieee80211_sta
*sta
);
2307 * ieee80211_tx_status - transmit status callback
2309 * Call this function for all transmitted frames after they have been
2310 * transmitted. It is permissible to not call this function for
2311 * multicast frames but this can affect statistics.
2313 * This function may not be called in IRQ context. Calls to this function
2314 * for a single hardware must be synchronized against each other. Calls
2315 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2316 * may not be mixed for a single hardware.
2318 * @hw: the hardware the frame was transmitted by
2319 * @skb: the frame that was transmitted, owned by mac80211 after this call
2321 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
2322 struct sk_buff
*skb
);
2325 * ieee80211_tx_status_ni - transmit status callback (in process context)
2327 * Like ieee80211_tx_status() but can be called in process context.
2329 * Calls to this function, ieee80211_tx_status() and
2330 * ieee80211_tx_status_irqsafe() may not be mixed
2331 * for a single hardware.
2333 * @hw: the hardware the frame was transmitted by
2334 * @skb: the frame that was transmitted, owned by mac80211 after this call
2336 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
2337 struct sk_buff
*skb
)
2340 ieee80211_tx_status(hw
, skb
);
2345 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2347 * Like ieee80211_tx_status() but can be called in IRQ context
2348 * (internally defers to a tasklet.)
2350 * Calls to this function, ieee80211_tx_status() and
2351 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2353 * @hw: the hardware the frame was transmitted by
2354 * @skb: the frame that was transmitted, owned by mac80211 after this call
2356 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
2357 struct sk_buff
*skb
);
2360 * ieee80211_report_low_ack - report non-responding station
2362 * When operating in AP-mode, call this function to report a non-responding
2365 * @sta: the non-responding connected sta
2366 * @num_packets: number of packets sent to @sta without a response
2368 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
2371 * ieee80211_beacon_get_tim - beacon generation function
2372 * @hw: pointer obtained from ieee80211_alloc_hw().
2373 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2374 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2375 * Set to 0 if invalid (in non-AP modes).
2376 * @tim_length: pointer to variable that will receive the TIM IE length,
2377 * (including the ID and length bytes!).
2378 * Set to 0 if invalid (in non-AP modes).
2380 * If the driver implements beaconing modes, it must use this function to
2381 * obtain the beacon frame/template.
2383 * If the beacon frames are generated by the host system (i.e., not in
2384 * hardware/firmware), the driver uses this function to get each beacon
2385 * frame from mac80211 -- it is responsible for calling this function
2386 * before the beacon is needed (e.g. based on hardware interrupt).
2388 * If the beacon frames are generated by the device, then the driver
2389 * must use the returned beacon as the template and change the TIM IE
2390 * according to the current DTIM parameters/TIM bitmap.
2392 * The driver is responsible for freeing the returned skb.
2394 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
2395 struct ieee80211_vif
*vif
,
2396 u16
*tim_offset
, u16
*tim_length
);
2399 * ieee80211_beacon_get - beacon generation function
2400 * @hw: pointer obtained from ieee80211_alloc_hw().
2401 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2403 * See ieee80211_beacon_get_tim().
2405 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
2406 struct ieee80211_vif
*vif
)
2408 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
2412 * ieee80211_pspoll_get - retrieve a PS Poll template
2413 * @hw: pointer obtained from ieee80211_alloc_hw().
2414 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2416 * Creates a PS Poll a template which can, for example, uploaded to
2417 * hardware. The template must be updated after association so that correct
2418 * AID, BSSID and MAC address is used.
2420 * Note: Caller (or hardware) is responsible for setting the
2421 * &IEEE80211_FCTL_PM bit.
2423 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
2424 struct ieee80211_vif
*vif
);
2427 * ieee80211_nullfunc_get - retrieve a nullfunc template
2428 * @hw: pointer obtained from ieee80211_alloc_hw().
2429 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2431 * Creates a Nullfunc template which can, for example, uploaded to
2432 * hardware. The template must be updated after association so that correct
2433 * BSSID and address is used.
2435 * Note: Caller (or hardware) is responsible for setting the
2436 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2438 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
2439 struct ieee80211_vif
*vif
);
2442 * ieee80211_probereq_get - retrieve a Probe Request template
2443 * @hw: pointer obtained from ieee80211_alloc_hw().
2444 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2445 * @ssid: SSID buffer
2446 * @ssid_len: length of SSID
2447 * @ie: buffer containing all IEs except SSID for the template
2448 * @ie_len: length of the IE buffer
2450 * Creates a Probe Request template which can, for example, be uploaded to
2453 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
2454 struct ieee80211_vif
*vif
,
2455 const u8
*ssid
, size_t ssid_len
,
2456 const u8
*ie
, size_t ie_len
);
2459 * ieee80211_rts_get - RTS frame generation function
2460 * @hw: pointer obtained from ieee80211_alloc_hw().
2461 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2462 * @frame: pointer to the frame that is going to be protected by the RTS.
2463 * @frame_len: the frame length (in octets).
2464 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2465 * @rts: The buffer where to store the RTS frame.
2467 * If the RTS frames are generated by the host system (i.e., not in
2468 * hardware/firmware), the low-level driver uses this function to receive
2469 * the next RTS frame from the 802.11 code. The low-level is responsible
2470 * for calling this function before and RTS frame is needed.
2472 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2473 const void *frame
, size_t frame_len
,
2474 const struct ieee80211_tx_info
*frame_txctl
,
2475 struct ieee80211_rts
*rts
);
2478 * ieee80211_rts_duration - Get the duration field for an RTS frame
2479 * @hw: pointer obtained from ieee80211_alloc_hw().
2480 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2481 * @frame_len: the length of the frame that is going to be protected by the RTS.
2482 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2484 * If the RTS is generated in firmware, but the host system must provide
2485 * the duration field, the low-level driver uses this function to receive
2486 * the duration field value in little-endian byteorder.
2488 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
2489 struct ieee80211_vif
*vif
, size_t frame_len
,
2490 const struct ieee80211_tx_info
*frame_txctl
);
2493 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2494 * @hw: pointer obtained from ieee80211_alloc_hw().
2495 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2496 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2497 * @frame_len: the frame length (in octets).
2498 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2499 * @cts: The buffer where to store the CTS-to-self frame.
2501 * If the CTS-to-self frames are generated by the host system (i.e., not in
2502 * hardware/firmware), the low-level driver uses this function to receive
2503 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2504 * for calling this function before and CTS-to-self frame is needed.
2506 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
2507 struct ieee80211_vif
*vif
,
2508 const void *frame
, size_t frame_len
,
2509 const struct ieee80211_tx_info
*frame_txctl
,
2510 struct ieee80211_cts
*cts
);
2513 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2514 * @hw: pointer obtained from ieee80211_alloc_hw().
2515 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2516 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2517 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2519 * If the CTS-to-self is generated in firmware, but the host system must provide
2520 * the duration field, the low-level driver uses this function to receive
2521 * the duration field value in little-endian byteorder.
2523 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
2524 struct ieee80211_vif
*vif
,
2526 const struct ieee80211_tx_info
*frame_txctl
);
2529 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2530 * @hw: pointer obtained from ieee80211_alloc_hw().
2531 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2532 * @frame_len: the length of the frame.
2533 * @rate: the rate at which the frame is going to be transmitted.
2535 * Calculate the duration field of some generic frame, given its
2536 * length and transmission rate (in 100kbps).
2538 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
2539 struct ieee80211_vif
*vif
,
2541 struct ieee80211_rate
*rate
);
2544 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2545 * @hw: pointer as obtained from ieee80211_alloc_hw().
2546 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2548 * Function for accessing buffered broadcast and multicast frames. If
2549 * hardware/firmware does not implement buffering of broadcast/multicast
2550 * frames when power saving is used, 802.11 code buffers them in the host
2551 * memory. The low-level driver uses this function to fetch next buffered
2552 * frame. In most cases, this is used when generating beacon frame. This
2553 * function returns a pointer to the next buffered skb or NULL if no more
2554 * buffered frames are available.
2556 * Note: buffered frames are returned only after DTIM beacon frame was
2557 * generated with ieee80211_beacon_get() and the low-level driver must thus
2558 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2559 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2560 * does not need to check for DTIM beacons separately and should be able to
2561 * use common code for all beacons.
2564 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2567 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2569 * This function returns the TKIP phase 1 key for the IV32 taken
2570 * from the given packet.
2572 * @keyconf: the parameter passed with the set key
2573 * @skb: the packet to take the IV32 value from that will be encrypted
2575 * @p1k: a buffer to which the key will be written, as 5 u16 values
2577 void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
2578 struct sk_buff
*skb
, u16
*p1k
);
2581 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2583 * This function computes the TKIP RC4 key for the IV values
2586 * @keyconf: the parameter passed with the set key
2587 * @skb: the packet to take the IV32/IV16 values from that will be
2588 * encrypted with this key
2589 * @p2k: a buffer to which the key will be written, 16 bytes
2591 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
2592 struct sk_buff
*skb
, u8
*p2k
);
2595 * struct ieee80211_key_seq - key sequence counter
2597 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2598 * @ccmp: PN data, most significant byte first (big endian,
2599 * reverse order than in packet)
2600 * @aes_cmac: PN data, most significant byte first (big endian,
2601 * reverse order than in packet)
2603 struct ieee80211_key_seq
{
2619 * ieee80211_get_key_tx_seq - get key TX sequence counter
2621 * @keyconf: the parameter passed with the set key
2622 * @seq: buffer to receive the sequence data
2624 * This function allows a driver to retrieve the current TX IV/PN
2625 * for the given key. It must not be called if IV generation is
2626 * offloaded to the device.
2628 * Note that this function may only be called when no TX processing
2629 * can be done concurrently, for example when queues are stopped
2630 * and the stop has been synchronized.
2632 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
2633 struct ieee80211_key_seq
*seq
);
2636 * ieee80211_get_key_rx_seq - get key RX sequence counter
2638 * @keyconf: the parameter passed with the set key
2639 * @tid: The TID, or -1 for the management frame value (CCMP only);
2640 * the value on TID 0 is also used for non-QoS frames. For
2641 * CMAC, only TID 0 is valid.
2642 * @seq: buffer to receive the sequence data
2644 * This function allows a driver to retrieve the current RX IV/PNs
2645 * for the given key. It must not be called if IV checking is done
2646 * by the device and not by mac80211.
2648 * Note that this function may only be called when no RX processing
2649 * can be done concurrently.
2651 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
2652 int tid
, struct ieee80211_key_seq
*seq
);
2655 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2656 * @vif: virtual interface the rekeying was done on
2657 * @bssid: The BSSID of the AP, for checking association
2658 * @replay_ctr: the new replay counter after GTK rekeying
2659 * @gfp: allocation flags
2661 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
2662 const u8
*replay_ctr
, gfp_t gfp
);
2665 * ieee80211_wake_queue - wake specific queue
2666 * @hw: pointer as obtained from ieee80211_alloc_hw().
2667 * @queue: queue number (counted from zero).
2669 * Drivers should use this function instead of netif_wake_queue.
2671 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
2674 * ieee80211_stop_queue - stop specific queue
2675 * @hw: pointer as obtained from ieee80211_alloc_hw().
2676 * @queue: queue number (counted from zero).
2678 * Drivers should use this function instead of netif_stop_queue.
2680 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
2683 * ieee80211_queue_stopped - test status of the queue
2684 * @hw: pointer as obtained from ieee80211_alloc_hw().
2685 * @queue: queue number (counted from zero).
2687 * Drivers should use this function instead of netif_stop_queue.
2690 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
2693 * ieee80211_stop_queues - stop all queues
2694 * @hw: pointer as obtained from ieee80211_alloc_hw().
2696 * Drivers should use this function instead of netif_stop_queue.
2698 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
2701 * ieee80211_wake_queues - wake all queues
2702 * @hw: pointer as obtained from ieee80211_alloc_hw().
2704 * Drivers should use this function instead of netif_wake_queue.
2706 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
2709 * ieee80211_scan_completed - completed hardware scan
2711 * When hardware scan offload is used (i.e. the hw_scan() callback is
2712 * assigned) this function needs to be called by the driver to notify
2713 * mac80211 that the scan finished. This function can be called from
2714 * any context, including hardirq context.
2716 * @hw: the hardware that finished the scan
2717 * @aborted: set to true if scan was aborted
2719 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
2722 * ieee80211_sched_scan_results - got results from scheduled scan
2724 * When a scheduled scan is running, this function needs to be called by the
2725 * driver whenever there are new scan results available.
2727 * @hw: the hardware that is performing scheduled scans
2729 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
2732 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2734 * When a scheduled scan is running, this function can be called by
2735 * the driver if it needs to stop the scan to perform another task.
2736 * Usual scenarios are drivers that cannot continue the scheduled scan
2737 * while associating, for instance.
2739 * @hw: the hardware that is performing scheduled scans
2741 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
2744 * ieee80211_iterate_active_interfaces - iterate active interfaces
2746 * This function iterates over the interfaces associated with a given
2747 * hardware that are currently active and calls the callback for them.
2748 * This function allows the iterator function to sleep, when the iterator
2749 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2751 * Does not iterate over a new interface during add_interface()
2753 * @hw: the hardware struct of which the interfaces should be iterated over
2754 * @iterator: the iterator function to call
2755 * @data: first argument of the iterator function
2757 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
2758 void (*iterator
)(void *data
, u8
*mac
,
2759 struct ieee80211_vif
*vif
),
2763 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2765 * This function iterates over the interfaces associated with a given
2766 * hardware that are currently active and calls the callback for them.
2767 * This function requires the iterator callback function to be atomic,
2768 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2769 * Does not iterate over a new interface during add_interface()
2771 * @hw: the hardware struct of which the interfaces should be iterated over
2772 * @iterator: the iterator function to call, cannot sleep
2773 * @data: first argument of the iterator function
2775 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
2776 void (*iterator
)(void *data
,
2778 struct ieee80211_vif
*vif
),
2782 * ieee80211_queue_work - add work onto the mac80211 workqueue
2784 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2785 * This helper ensures drivers are not queueing work when they should not be.
2787 * @hw: the hardware struct for the interface we are adding work for
2788 * @work: the work we want to add onto the mac80211 workqueue
2790 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
2793 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2795 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2798 * @hw: the hardware struct for the interface we are adding work for
2799 * @dwork: delayable work to queue onto the mac80211 workqueue
2800 * @delay: number of jiffies to wait before queueing
2802 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
2803 struct delayed_work
*dwork
,
2804 unsigned long delay
);
2807 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2808 * @sta: the station for which to start a BA session
2809 * @tid: the TID to BA on.
2810 * @timeout: session timeout value (in TUs)
2812 * Return: success if addBA request was sent, failure otherwise
2814 * Although mac80211/low level driver/user space application can estimate
2815 * the need to start aggregation on a certain RA/TID, the session level
2816 * will be managed by the mac80211.
2818 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
2822 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2823 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2824 * @ra: receiver address of the BA session recipient.
2825 * @tid: the TID to BA on.
2827 * This function must be called by low level driver once it has
2828 * finished with preparations for the BA session. It can be called
2831 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
2835 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2836 * @sta: the station whose BA session to stop
2837 * @tid: the TID to stop BA.
2839 * Return: negative error if the TID is invalid, or no aggregation active
2841 * Although mac80211/low level driver/user space application can estimate
2842 * the need to stop aggregation on a certain RA/TID, the session level
2843 * will be managed by the mac80211.
2845 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
2848 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2849 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2850 * @ra: receiver address of the BA session recipient.
2851 * @tid: the desired TID to BA on.
2853 * This function must be called by low level driver once it has
2854 * finished with preparations for the BA session tear down. It
2855 * can be called from any context.
2857 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
2861 * ieee80211_find_sta - find a station
2863 * @vif: virtual interface to look for station on
2864 * @addr: station's address
2866 * This function must be called under RCU lock and the
2867 * resulting pointer is only valid under RCU lock as well.
2869 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
2873 * ieee80211_find_sta_by_ifaddr - find a station on hardware
2875 * @hw: pointer as obtained from ieee80211_alloc_hw()
2876 * @addr: remote station's address
2877 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
2879 * This function must be called under RCU lock and the
2880 * resulting pointer is only valid under RCU lock as well.
2882 * NOTE: You may pass NULL for localaddr, but then you will just get
2883 * the first STA that matches the remote address 'addr'.
2884 * We can have multiple STA associated with multiple
2885 * logical stations (e.g. consider a station connecting to another
2886 * BSSID on the same AP hardware without disconnecting first).
2887 * In this case, the result of this method with localaddr NULL
2890 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
2892 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
2894 const u8
*localaddr
);
2897 * ieee80211_sta_block_awake - block station from waking up
2899 * @pubsta: the station
2900 * @block: whether to block or unblock
2902 * Some devices require that all frames that are on the queues
2903 * for a specific station that went to sleep are flushed before
2904 * a poll response or frames after the station woke up can be
2905 * delivered to that it. Note that such frames must be rejected
2906 * by the driver as filtered, with the appropriate status flag.
2908 * This function allows implementing this mode in a race-free
2911 * To do this, a driver must keep track of the number of frames
2912 * still enqueued for a specific station. If this number is not
2913 * zero when the station goes to sleep, the driver must call
2914 * this function to force mac80211 to consider the station to
2915 * be asleep regardless of the station's actual state. Once the
2916 * number of outstanding frames reaches zero, the driver must
2917 * call this function again to unblock the station. That will
2918 * cause mac80211 to be able to send ps-poll responses, and if
2919 * the station queried in the meantime then frames will also
2920 * be sent out as a result of this. Additionally, the driver
2921 * will be notified that the station woke up some time after
2922 * it is unblocked, regardless of whether the station actually
2923 * woke up while blocked or not.
2925 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
2926 struct ieee80211_sta
*pubsta
, bool block
);
2929 * ieee80211_iter_keys - iterate keys programmed into the device
2930 * @hw: pointer obtained from ieee80211_alloc_hw()
2931 * @vif: virtual interface to iterate, may be %NULL for all
2932 * @iter: iterator function that will be called for each key
2933 * @iter_data: custom data to pass to the iterator function
2935 * This function can be used to iterate all the keys known to
2936 * mac80211, even those that weren't previously programmed into
2937 * the device. This is intended for use in WoWLAN if the device
2938 * needs reprogramming of the keys during suspend. Note that due
2939 * to locking reasons, it is also only safe to call this at few
2940 * spots since it must hold the RTNL and be able to sleep.
2942 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
2943 struct ieee80211_vif
*vif
,
2944 void (*iter
)(struct ieee80211_hw
*hw
,
2945 struct ieee80211_vif
*vif
,
2946 struct ieee80211_sta
*sta
,
2947 struct ieee80211_key_conf
*key
,
2952 * ieee80211_ap_probereq_get - retrieve a Probe Request template
2953 * @hw: pointer obtained from ieee80211_alloc_hw().
2954 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2956 * Creates a Probe Request template which can, for example, be uploaded to
2957 * hardware. The template is filled with bssid, ssid and supported rate
2958 * information. This function must only be called from within the
2959 * .bss_info_changed callback function and only in managed mode. The function
2960 * is only useful when the interface is associated, otherwise it will return
2963 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
2964 struct ieee80211_vif
*vif
);
2967 * ieee80211_beacon_loss - inform hardware does not receive beacons
2969 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2971 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
2972 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2973 * hardware is not receiving beacons with this function.
2975 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
2978 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2980 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2982 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
2983 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2984 * needs to inform if the connection to the AP has been lost.
2986 * This function will cause immediate change to disassociated state,
2987 * without connection recovery attempts.
2989 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
2992 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2994 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2996 * Some hardware require full power save to manage simultaneous BT traffic
2997 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2998 * burst of BT traffic. The hardware gets information of BT traffic via
2999 * hardware co-existence lines, and consequentially requests mac80211 to
3000 * (temporarily) enter full psm.
3001 * This function will only temporarily disable dynamic PS, not enable PSM if
3002 * it was not already enabled.
3003 * The driver must make sure to re-enable dynamic PS using
3004 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3007 void ieee80211_disable_dyn_ps(struct ieee80211_vif
*vif
);
3010 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3012 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3014 * This function restores dynamic PS after being temporarily disabled via
3015 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3016 * be coupled with an eventual call to this function.
3019 void ieee80211_enable_dyn_ps(struct ieee80211_vif
*vif
);
3022 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3023 * rssi threshold triggered
3025 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3026 * @rssi_event: the RSSI trigger event type
3027 * @gfp: context flags
3029 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3030 * monitoring is configured with an rssi threshold, the driver will inform
3031 * whenever the rssi level reaches the threshold.
3033 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
3034 enum nl80211_cqm_rssi_threshold_event rssi_event
,
3038 * ieee80211_get_operstate - get the operstate of the vif
3040 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3042 * The driver might need to know the operstate of the net_device
3043 * (specifically, whether the link is IF_OPER_UP after resume)
3045 unsigned char ieee80211_get_operstate(struct ieee80211_vif
*vif
);
3048 * ieee80211_chswitch_done - Complete channel switch process
3049 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3050 * @success: make the channel switch successful or not
3052 * Complete the channel switch post-process: set the new operational channel
3053 * and wake up the suspended queues.
3055 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
3058 * ieee80211_request_smps - request SM PS transition
3059 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3060 * @smps_mode: new SM PS mode
3062 * This allows the driver to request an SM PS transition in managed
3063 * mode. This is useful when the driver has more information than
3064 * the stack about possible interference, for example by bluetooth.
3066 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
3067 enum ieee80211_smps_mode smps_mode
);
3070 * ieee80211_key_removed - disable hw acceleration for key
3071 * @key_conf: The key hw acceleration should be disabled for
3073 * This allows drivers to indicate that the given key has been
3074 * removed from hardware acceleration, due to a new key that
3075 * was added. Don't use this if the key can continue to be used
3076 * for TX, if the key restriction is on RX only it is permitted
3077 * to keep the key for TX only and not call this function.
3079 * Due to locking constraints, it may only be called during
3080 * @set_key. This function must be allowed to sleep, and the
3081 * key it tries to disable may still be used until it returns.
3083 void ieee80211_key_removed(struct ieee80211_key_conf
*key_conf
);
3086 * ieee80211_ready_on_channel - notification of remain-on-channel start
3087 * @hw: pointer as obtained from ieee80211_alloc_hw()
3089 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
3092 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3093 * @hw: pointer as obtained from ieee80211_alloc_hw()
3095 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
3098 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3100 * in order not to harm the system performance and user experience, the device
3101 * may request not to allow any rx ba session and tear down existing rx ba
3102 * sessions based on system constraints such as periodic BT activity that needs
3103 * to limit wlan activity (eg.sco or a2dp)."
3104 * in such cases, the intention is to limit the duration of the rx ppdu and
3105 * therefore prevent the peer device to use a-mpdu aggregation.
3107 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3108 * @ba_rx_bitmap: Bit map of open rx ba per tid
3109 * @addr: & to bssid mac address
3111 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
3114 /* Rate control API */
3117 * enum rate_control_changed - flags to indicate which parameter changed
3119 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3120 * changed, rate control algorithm can update its internal state if needed.
3122 enum rate_control_changed
{
3123 IEEE80211_RC_HT_CHANGED
= BIT(0)
3127 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3129 * @hw: The hardware the algorithm is invoked for.
3130 * @sband: The band this frame is being transmitted on.
3131 * @bss_conf: the current BSS configuration
3132 * @reported_rate: The rate control algorithm can fill this in to indicate
3133 * which rate should be reported to userspace as the current rate and
3134 * used for rate calculations in the mesh network.
3135 * @rts: whether RTS will be used for this frame because it is longer than the
3137 * @short_preamble: whether mac80211 will request short-preamble transmission
3138 * if the selected rate supports it
3139 * @max_rate_idx: user-requested maximum rate (not MCS for now)
3140 * (deprecated; this will be removed once drivers get updated to use
3142 * @rate_idx_mask: user-requested rate mask (not MCS for now)
3143 * @skb: the skb that will be transmitted, the control information in it needs
3145 * @bss: whether this frame is sent out in AP or IBSS mode
3147 struct ieee80211_tx_rate_control
{
3148 struct ieee80211_hw
*hw
;
3149 struct ieee80211_supported_band
*sband
;
3150 struct ieee80211_bss_conf
*bss_conf
;
3151 struct sk_buff
*skb
;
3152 struct ieee80211_tx_rate reported_rate
;
3153 bool rts
, short_preamble
;
3159 struct rate_control_ops
{
3160 struct module
*module
;
3162 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
3163 void (*free
)(void *priv
);
3165 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
3166 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
3167 struct ieee80211_sta
*sta
, void *priv_sta
);
3168 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
3169 struct ieee80211_sta
*sta
,
3170 void *priv_sta
, u32 changed
,
3171 enum nl80211_channel_type oper_chan_type
);
3172 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
3175 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
3176 struct ieee80211_sta
*sta
, void *priv_sta
,
3177 struct sk_buff
*skb
);
3178 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
3179 struct ieee80211_tx_rate_control
*txrc
);
3181 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
3182 struct dentry
*dir
);
3183 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
3186 static inline int rate_supported(struct ieee80211_sta
*sta
,
3187 enum ieee80211_band band
,
3190 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
3194 * rate_control_send_low - helper for drivers for management/no-ack frames
3196 * Rate control algorithms that agree to use the lowest rate to
3197 * send management frames and NO_ACK data with the respective hw
3198 * retries should use this in the beginning of their mac80211 get_rate
3199 * callback. If true is returned the rate control can simply return.
3200 * If false is returned we guarantee that sta and sta and priv_sta is
3203 * Rate control algorithms wishing to do more intelligent selection of
3204 * rate for multicast/broadcast frames may choose to not use this.
3206 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3207 * that this may be null.
3208 * @priv_sta: private rate control structure. This may be null.
3209 * @txrc: rate control information we sholud populate for mac80211.
3211 bool rate_control_send_low(struct ieee80211_sta
*sta
,
3213 struct ieee80211_tx_rate_control
*txrc
);
3217 rate_lowest_index(struct ieee80211_supported_band
*sband
,
3218 struct ieee80211_sta
*sta
)
3222 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3223 if (rate_supported(sta
, sband
->band
, i
))
3226 /* warn when we cannot find a rate. */
3233 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
3234 struct ieee80211_sta
*sta
)
3238 for (i
= 0; i
< sband
->n_bitrates
; i
++)
3239 if (rate_supported(sta
, sband
->band
, i
))
3244 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
3245 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
3248 conf_is_ht20(struct ieee80211_conf
*conf
)
3250 return conf
->channel_type
== NL80211_CHAN_HT20
;
3254 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
3256 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
3260 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
3262 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
3266 conf_is_ht40(struct ieee80211_conf
*conf
)
3268 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
3272 conf_is_ht(struct ieee80211_conf
*conf
)
3274 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
3277 static inline enum nl80211_iftype
3278 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
3282 case NL80211_IFTYPE_STATION
:
3283 return NL80211_IFTYPE_P2P_CLIENT
;
3284 case NL80211_IFTYPE_AP
:
3285 return NL80211_IFTYPE_P2P_GO
;
3293 static inline enum nl80211_iftype
3294 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
3296 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
3299 #endif /* MAC80211_H */