2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2008 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 * enum ieee80211_max_queues - maximum number of queues
78 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
80 enum ieee80211_max_queues
{
81 IEEE80211_MAX_QUEUES
= 4,
85 * struct ieee80211_tx_queue_params - transmit queue configuration
87 * The information provided in this structure is required for QoS
88 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
90 * @aifs: arbitration interframe space [0..255]
91 * @cw_min: minimum contention window [a value of the form
92 * 2^n-1 in the range 1..32767]
93 * @cw_max: maximum contention window [like @cw_min]
94 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
96 struct ieee80211_tx_queue_params
{
104 * struct ieee80211_tx_queue_stats - transmit queue statistics
106 * @len: number of packets in queue
107 * @limit: queue length limit
108 * @count: number of frames sent
110 struct ieee80211_tx_queue_stats
{
116 struct ieee80211_low_level_stats
{
117 unsigned int dot11ACKFailureCount
;
118 unsigned int dot11RTSFailureCount
;
119 unsigned int dot11FCSErrorCount
;
120 unsigned int dot11RTSSuccessCount
;
124 * enum ieee80211_bss_change - BSS change notification flags
126 * These flags are used with the bss_info_changed() callback
127 * to indicate which BSS parameter changed.
129 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
130 * also implies a change in the AID.
131 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
132 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
133 * @BSS_CHANGED_ERP_SLOT: slot timing changed
134 * @BSS_CHANGED_HT: 802.11n parameters changed
135 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
136 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
137 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
138 * reason (IBSS and managed mode)
139 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
140 * new beacon (beaconing modes)
141 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
142 * enabled/disabled (beaconing modes)
144 enum ieee80211_bss_change
{
145 BSS_CHANGED_ASSOC
= 1<<0,
146 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
147 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
148 BSS_CHANGED_ERP_SLOT
= 1<<3,
149 BSS_CHANGED_HT
= 1<<4,
150 BSS_CHANGED_BASIC_RATES
= 1<<5,
151 BSS_CHANGED_BEACON_INT
= 1<<6,
152 BSS_CHANGED_BSSID
= 1<<7,
153 BSS_CHANGED_BEACON
= 1<<8,
154 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
158 * struct ieee80211_bss_conf - holds the BSS's changing parameters
160 * This structure keeps information about a BSS (and an association
161 * to that BSS) that can change during the lifetime of the BSS.
163 * @assoc: association status
164 * @aid: association ID number, valid only when @assoc is true
165 * @use_cts_prot: use CTS protection
166 * @use_short_preamble: use 802.11b short preamble;
167 * if the hardware cannot handle this it must set the
168 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
169 * @use_short_slot: use short slot time (only relevant for ERP);
170 * if the hardware cannot handle this it must set the
171 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
172 * @dtim_period: num of beacons before the next DTIM, for PSM
173 * @timestamp: beacon timestamp
174 * @beacon_int: beacon interval
175 * @assoc_capability: capabilities taken from assoc resp
176 * @basic_rates: bitmap of basic rates, each bit stands for an
177 * index into the rate table configured by the driver in
179 * @bssid: The BSSID for this BSS
180 * @enable_beacon: whether beaconing should be enabled or not
181 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
182 * This field is only valid when the channel type is one of the HT types.
184 struct ieee80211_bss_conf
{
186 /* association related data */
189 /* erp related data */
191 bool use_short_preamble
;
196 u16 assoc_capability
;
199 u16 ht_operation_mode
;
203 * enum mac80211_tx_control_flags - flags to describe transmission information/status
205 * These flags are used with the @flags member of &ieee80211_tx_info.
207 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
208 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
209 * number to this frame, taking care of not overwriting the fragment
210 * number and increasing the sequence number only when the
211 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
212 * assign sequence numbers to QoS-data frames but cannot do so correctly
213 * for non-QoS-data and management frames because beacons need them from
214 * that counter as well and mac80211 cannot guarantee proper sequencing.
215 * If this flag is set, the driver should instruct the hardware to
216 * assign a sequence number to the frame or assign one itself. Cf. IEEE
217 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
218 * beacons and always be clear for frames without a sequence number field.
219 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
220 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
222 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
225 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
226 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
227 * because the destination STA was in powersave mode.
228 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
229 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
230 * is for the whole aggregation.
231 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
232 * so consider using block ack request (BAR).
233 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
234 * set by rate control algorithms to indicate probe rate, will
235 * be cleared for fragmented frames (except on the last fragment)
236 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
237 * set this flag in the driver; indicates that the rate control
238 * algorithm was used and should be notified of TX status
239 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
240 * used to indicate that a pending frame requires TX processing before
241 * it can be sent out.
243 enum mac80211_tx_control_flags
{
244 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
245 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
246 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
247 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
248 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
249 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
250 IEEE80211_TX_CTL_AMPDU
= BIT(6),
251 IEEE80211_TX_CTL_INJECTED
= BIT(7),
252 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
253 IEEE80211_TX_STAT_ACK
= BIT(9),
254 IEEE80211_TX_STAT_AMPDU
= BIT(10),
255 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
256 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
257 IEEE80211_TX_INTFL_RCALGO
= BIT(13),
258 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
262 * enum mac80211_rate_control_flags - per-rate flags set by the
263 * Rate Control algorithm.
265 * These flags are set by the Rate control algorithm for each rate during tx,
266 * in the @flags member of struct ieee80211_tx_rate.
268 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
269 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
270 * This is set if the current BSS requires ERP protection.
271 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
272 * @IEEE80211_TX_RC_MCS: HT rate.
273 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
275 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
276 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
277 * adjacent 20 MHz channels, if the current channel type is
278 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
279 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
281 enum mac80211_rate_control_flags
{
282 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
283 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
284 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
286 /* rate index is an MCS rate number instead of an index */
287 IEEE80211_TX_RC_MCS
= BIT(3),
288 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
289 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
290 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
291 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
295 /* there are 40 bytes if you don't need the rateset to be kept */
296 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
298 /* if you do need the rateset, then you have less space */
299 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
301 /* maximum number of rate stages */
302 #define IEEE80211_TX_MAX_RATES 5
305 * struct ieee80211_tx_rate - rate selection/status
307 * @idx: rate index to attempt to send with
308 * @flags: rate control flags (&enum mac80211_rate_control_flags)
309 * @count: number of tries in this rate before going to the next rate
311 * A value of -1 for @idx indicates an invalid rate and, if used
312 * in an array of retry rates, that no more rates should be tried.
314 * When used for transmit status reporting, the driver should
315 * always report the rate along with the flags it used.
317 struct ieee80211_tx_rate
{
321 } __attribute__((packed
));
324 * struct ieee80211_tx_info - skb transmit information
326 * This structure is placed in skb->cb for three uses:
327 * (1) mac80211 TX control - mac80211 tells the driver what to do
328 * (2) driver internal use (if applicable)
329 * (3) TX status information - driver tells mac80211 what happened
331 * The TX control's sta pointer is only valid during the ->tx call,
334 * @flags: transmit info flags, defined above
335 * @band: the band to transmit on (use for checking for races)
336 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
337 * @pad: padding, ignore
338 * @control: union for control data
339 * @status: union for status data
340 * @driver_data: array of driver_data pointers
341 * @ampdu_ack_len: number of aggregated frames.
342 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
343 * @ampdu_ack_map: block ack bit map for the aggregation.
344 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
345 * @ack_signal: signal strength of the ACK frame
347 struct ieee80211_tx_info
{
348 /* common information */
362 struct ieee80211_tx_rate rates
[
363 IEEE80211_TX_MAX_RATES
];
366 /* only needed before rate control */
367 unsigned long jiffies
;
369 /* NB: vif can be NULL for injected frames */
370 struct ieee80211_vif
*vif
;
371 struct ieee80211_key_conf
*hw_key
;
372 struct ieee80211_sta
*sta
;
375 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
382 struct ieee80211_tx_rate driver_rates
[
383 IEEE80211_TX_MAX_RATES
];
384 void *rate_driver_data
[
385 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
388 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
392 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
394 return (struct ieee80211_tx_info
*)skb
->cb
;
398 * ieee80211_tx_info_clear_status - clear TX status
400 * @info: The &struct ieee80211_tx_info to be cleared.
402 * When the driver passes an skb back to mac80211, it must report
403 * a number of things in TX status. This function clears everything
404 * in the TX status but the rate control information (it does clear
405 * the count since you need to fill that in anyway).
407 * NOTE: You can only use this function if you do NOT use
408 * info->driver_data! Use info->rate_driver_data
409 * instead if you need only the less space that allows.
412 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
416 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
417 offsetof(struct ieee80211_tx_info
, control
.rates
));
418 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
419 offsetof(struct ieee80211_tx_info
, driver_rates
));
420 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
421 /* clear the rate counts */
422 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
423 info
->status
.rates
[i
].count
= 0;
426 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
427 memset(&info
->status
.ampdu_ack_len
, 0,
428 sizeof(struct ieee80211_tx_info
) -
429 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
434 * enum mac80211_rx_flags - receive flags
436 * These flags are used with the @flag member of &struct ieee80211_rx_status.
437 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
438 * Use together with %RX_FLAG_MMIC_STRIPPED.
439 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
440 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
441 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
442 * verification has been done by the hardware.
443 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
444 * If this flag is set, the stack cannot do any replay detection
445 * hence the driver or hardware will have to do that.
446 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
448 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
450 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
451 * is valid. This is useful in monitor mode and necessary for beacon frames
452 * to enable IBSS merging.
453 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
454 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
455 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
456 * @RX_FLAG_SHORT_GI: Short guard interval was used
458 enum mac80211_rx_flags
{
459 RX_FLAG_MMIC_ERROR
= 1<<0,
460 RX_FLAG_DECRYPTED
= 1<<1,
461 RX_FLAG_RADIOTAP
= 1<<2,
462 RX_FLAG_MMIC_STRIPPED
= 1<<3,
463 RX_FLAG_IV_STRIPPED
= 1<<4,
464 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
465 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
467 RX_FLAG_SHORTPRE
= 1<<8,
469 RX_FLAG_40MHZ
= 1<<10,
470 RX_FLAG_SHORT_GI
= 1<<11,
474 * struct ieee80211_rx_status - receive status
476 * The low-level driver should provide this information (the subset
477 * supported by hardware) to the 802.11 code with each received
480 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
481 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
482 * @band: the active band when this frame was received
483 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
484 * @signal: signal strength when receiving this frame, either in dBm, in dB or
485 * unspecified depending on the hardware capabilities flags
486 * @IEEE80211_HW_SIGNAL_*
487 * @noise: noise when receiving this frame, in dBm.
488 * @qual: overall signal quality indication, in percent (0-100).
489 * @antenna: antenna used
490 * @rate_idx: index of data rate into band's supported rates or MCS index if
491 * HT rates are use (RX_FLAG_HT)
494 struct ieee80211_rx_status
{
496 enum ieee80211_band band
;
507 * enum ieee80211_conf_flags - configuration flags
509 * Flags to define PHY configuration options
511 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
512 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
513 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
514 * the driver should be prepared to handle configuration requests but
515 * may turn the device off as much as possible. Typically, this flag will
516 * be set when an interface is set UP but not associated or scanning, but
517 * it can also be unset in that case when monitor interfaces are active.
519 enum ieee80211_conf_flags
{
520 IEEE80211_CONF_RADIOTAP
= (1<<0),
521 IEEE80211_CONF_PS
= (1<<1),
522 IEEE80211_CONF_IDLE
= (1<<2),
527 * enum ieee80211_conf_changed - denotes which configuration changed
529 * @_IEEE80211_CONF_CHANGE_RADIO_ENABLED: DEPRECATED
530 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
531 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
532 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
533 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
534 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
535 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
536 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
538 enum ieee80211_conf_changed
{
539 _IEEE80211_CONF_CHANGE_RADIO_ENABLED
= BIT(0),
540 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
541 IEEE80211_CONF_CHANGE_RADIOTAP
= BIT(3),
542 IEEE80211_CONF_CHANGE_PS
= BIT(4),
543 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
544 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
545 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
546 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
549 static inline __deprecated
enum ieee80211_conf_changed
550 __IEEE80211_CONF_CHANGE_RADIO_ENABLED(void)
552 return _IEEE80211_CONF_CHANGE_RADIO_ENABLED
;
554 #define IEEE80211_CONF_CHANGE_RADIO_ENABLED \
555 __IEEE80211_CONF_CHANGE_RADIO_ENABLED()
558 * struct ieee80211_conf - configuration of the device
560 * This struct indicates how the driver shall configure the hardware.
562 * @flags: configuration flags defined above
564 * @radio_enabled: when zero, driver is required to switch off the radio.
565 * @beacon_int: DEPRECATED, DO NOT USE
567 * @listen_interval: listen interval in units of beacon interval
568 * @max_sleep_period: the maximum number of beacon intervals to sleep for
569 * before checking the beacon for a TIM bit (managed mode only); this
570 * value will be only achievable between DTIM frames, the hardware
571 * needs to check for the multicast traffic bit in DTIM beacons.
572 * This variable is valid only when the CONF_PS flag is set.
573 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
574 * powersave documentation below. This variable is valid only when
575 * the CONF_PS flag is set.
577 * @power_level: requested transmit power (in dBm)
579 * @channel: the channel to tune to
580 * @channel_type: the channel (HT) type
582 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
583 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
584 * but actually means the number of transmissions not the number of retries
585 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
586 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
587 * number of transmissions not the number of retries
589 struct ieee80211_conf
{
590 int __deprecated beacon_int
;
592 int power_level
, dynamic_ps_timeout
;
593 int max_sleep_period
;
596 bool __deprecated radio_enabled
;
598 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
600 struct ieee80211_channel
*channel
;
601 enum nl80211_channel_type channel_type
;
605 * struct ieee80211_vif - per-interface data
607 * Data in this structure is continually present for driver
608 * use during the life of a virtual interface.
610 * @type: type of this virtual interface
611 * @bss_conf: BSS configuration for this interface, either our own
612 * or the BSS we're associated to
613 * @drv_priv: data area for driver use, will always be aligned to
616 struct ieee80211_vif
{
617 enum nl80211_iftype type
;
618 struct ieee80211_bss_conf bss_conf
;
620 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
623 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
625 #ifdef CONFIG_MAC80211_MESH
626 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
632 * struct ieee80211_if_init_conf - initial configuration of an interface
634 * @vif: pointer to a driver-use per-interface structure. The pointer
635 * itself is also used for various functions including
636 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
637 * @type: one of &enum nl80211_iftype constants. Determines the type of
638 * added/removed interface.
639 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
640 * until the interface is removed (i.e. it cannot be used after
641 * remove_interface() callback was called for this interface).
643 * This structure is used in add_interface() and remove_interface()
644 * callbacks of &struct ieee80211_hw.
646 * When you allow multiple interfaces to be added to your PHY, take care
647 * that the hardware can actually handle multiple MAC addresses. However,
648 * also take care that when there's no interface left with mac_addr != %NULL
649 * you remove the MAC address from the device to avoid acknowledging packets
650 * in pure monitor mode.
652 struct ieee80211_if_init_conf
{
653 enum nl80211_iftype type
;
654 struct ieee80211_vif
*vif
;
659 * enum ieee80211_key_alg - key algorithm
660 * @ALG_WEP: WEP40 or WEP104
662 * @ALG_CCMP: CCMP (AES)
663 * @ALG_AES_CMAC: AES-128-CMAC
665 enum ieee80211_key_alg
{
673 * enum ieee80211_key_flags - key flags
675 * These flags are used for communication about keys between the driver
676 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
678 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
679 * that the STA this key will be used with could be using QoS.
680 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
681 * driver to indicate that it requires IV generation for this
683 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
684 * the driver for a TKIP key if it requires Michael MIC
685 * generation in software.
686 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
687 * that the key is pairwise rather then a shared key.
688 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
689 * CCMP key if it requires CCMP encryption of management frames (MFP) to
690 * be done in software.
692 enum ieee80211_key_flags
{
693 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
694 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
695 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
696 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
697 IEEE80211_KEY_FLAG_SW_MGMT
= 1<<4,
701 * struct ieee80211_key_conf - key information
703 * This key information is given by mac80211 to the driver by
704 * the set_key() callback in &struct ieee80211_ops.
706 * @hw_key_idx: To be set by the driver, this is the key index the driver
707 * wants to be given when a frame is transmitted and needs to be
708 * encrypted in hardware.
709 * @alg: The key algorithm.
710 * @flags: key flags, see &enum ieee80211_key_flags.
711 * @keyidx: the key index (0-3)
712 * @keylen: key material length
713 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
715 * - Temporal Encryption Key (128 bits)
716 * - Temporal Authenticator Tx MIC Key (64 bits)
717 * - Temporal Authenticator Rx MIC Key (64 bits)
718 * @icv_len: The ICV length for this key type
719 * @iv_len: The IV length for this key type
721 struct ieee80211_key_conf
{
722 enum ieee80211_key_alg alg
;
733 * enum set_key_cmd - key command
735 * Used with the set_key() callback in &struct ieee80211_ops, this
736 * indicates whether a key is being removed or added.
738 * @SET_KEY: a key is set
739 * @DISABLE_KEY: a key must be disabled
742 SET_KEY
, DISABLE_KEY
,
746 * struct ieee80211_sta - station table entry
748 * A station table entry represents a station we are possibly
749 * communicating with. Since stations are RCU-managed in
750 * mac80211, any ieee80211_sta pointer you get access to must
751 * either be protected by rcu_read_lock() explicitly or implicitly,
752 * or you must take good care to not use such a pointer after a
753 * call to your sta_notify callback that removed it.
756 * @aid: AID we assigned to the station if we're an AP
757 * @supp_rates: Bitmap of supported rates (per band)
758 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
759 * @drv_priv: data area for driver use, will always be aligned to
760 * sizeof(void *), size is determined in hw information.
762 struct ieee80211_sta
{
763 u32 supp_rates
[IEEE80211_NUM_BANDS
];
766 struct ieee80211_sta_ht_cap ht_cap
;
769 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
773 * enum sta_notify_cmd - sta notify command
775 * Used with the sta_notify() callback in &struct ieee80211_ops, this
776 * indicates addition and removal of a station to station table,
777 * or if a associated station made a power state transition.
779 * @STA_NOTIFY_ADD: a station was added to the station table
780 * @STA_NOTIFY_REMOVE: a station being removed from the station table
781 * @STA_NOTIFY_SLEEP: a station is now sleeping
782 * @STA_NOTIFY_AWAKE: a sleeping station woke up
784 enum sta_notify_cmd
{
785 STA_NOTIFY_ADD
, STA_NOTIFY_REMOVE
,
786 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
790 * enum ieee80211_tkip_key_type - get tkip key
792 * Used by drivers which need to get a tkip key for skb. Some drivers need a
793 * phase 1 key, others need a phase 2 key. A single function allows the driver
794 * to get the key, this enum indicates what type of key is required.
796 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
797 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
799 enum ieee80211_tkip_key_type
{
800 IEEE80211_TKIP_P1_KEY
,
801 IEEE80211_TKIP_P2_KEY
,
805 * enum ieee80211_hw_flags - hardware flags
807 * These flags are used to indicate hardware capabilities to
808 * the stack. Generally, flags here should have their meaning
809 * done in a way that the simplest hardware doesn't need setting
810 * any particular flags. There are some exceptions to this rule,
811 * however, so you are advised to review these flags carefully.
813 * @IEEE80211_HW_RX_INCLUDES_FCS:
814 * Indicates that received frames passed to the stack include
815 * the FCS at the end.
817 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
818 * Some wireless LAN chipsets buffer broadcast/multicast frames
819 * for power saving stations in the hardware/firmware and others
820 * rely on the host system for such buffering. This option is used
821 * to configure the IEEE 802.11 upper layer to buffer broadcast and
822 * multicast frames when there are power saving stations so that
823 * the driver can fetch them with ieee80211_get_buffered_bc().
825 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
826 * Hardware is not capable of short slot operation on the 2.4 GHz band.
828 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
829 * Hardware is not capable of receiving frames with short preamble on
832 * @IEEE80211_HW_SIGNAL_UNSPEC:
833 * Hardware can provide signal values but we don't know its units. We
834 * expect values between 0 and @max_signal.
835 * If possible please provide dB or dBm instead.
837 * @IEEE80211_HW_SIGNAL_DBM:
838 * Hardware gives signal values in dBm, decibel difference from
839 * one milliwatt. This is the preferred method since it is standardized
840 * between different devices. @max_signal does not need to be set.
842 * @IEEE80211_HW_NOISE_DBM:
843 * Hardware can provide noise (radio interference) values in units dBm,
844 * decibel difference from one milliwatt.
846 * @IEEE80211_HW_SPECTRUM_MGMT:
847 * Hardware supports spectrum management defined in 802.11h
848 * Measurement, Channel Switch, Quieting, TPC
850 * @IEEE80211_HW_AMPDU_AGGREGATION:
851 * Hardware supports 11n A-MPDU aggregation.
853 * @IEEE80211_HW_SUPPORTS_PS:
854 * Hardware has power save support (i.e. can go to sleep).
856 * @IEEE80211_HW_PS_NULLFUNC_STACK:
857 * Hardware requires nullfunc frame handling in stack, implies
858 * stack support for dynamic PS.
860 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
861 * Hardware has support for dynamic PS.
863 * @IEEE80211_HW_MFP_CAPABLE:
864 * Hardware supports management frame protection (MFP, IEEE 802.11w).
866 * @IEEE80211_HW_BEACON_FILTER:
867 * Hardware supports dropping of irrelevant beacon frames to
868 * avoid waking up cpu.
870 enum ieee80211_hw_flags
{
871 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
872 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
873 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
874 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
875 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
876 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
877 IEEE80211_HW_NOISE_DBM
= 1<<7,
878 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
879 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
880 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
881 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
882 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
883 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
884 IEEE80211_HW_BEACON_FILTER
= 1<<14,
888 * struct ieee80211_hw - hardware information and state
890 * This structure contains the configuration and hardware
891 * information for an 802.11 PHY.
893 * @wiphy: This points to the &struct wiphy allocated for this
894 * 802.11 PHY. You must fill in the @perm_addr and @dev
895 * members of this structure using SET_IEEE80211_DEV()
896 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
897 * bands (with channels, bitrates) are registered here.
899 * @conf: &struct ieee80211_conf, device configuration, don't use.
901 * @workqueue: single threaded workqueue available for driver use,
902 * allocated by mac80211 on registration and flushed when an
903 * interface is removed.
904 * NOTICE: All work performed on this workqueue must not
905 * acquire the RTNL lock.
907 * @priv: pointer to private area that was allocated for driver use
908 * along with this structure.
910 * @flags: hardware flags, see &enum ieee80211_hw_flags.
912 * @extra_tx_headroom: headroom to reserve in each transmit skb
913 * for use by the driver (e.g. for transmit headers.)
915 * @channel_change_time: time (in microseconds) it takes to change channels.
917 * @max_signal: Maximum value for signal (rssi) in RX information, used
918 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
920 * @max_listen_interval: max listen interval in units of beacon interval
923 * @queues: number of available hardware transmit queues for
924 * data packets. WMM/QoS requires at least four, these
925 * queues need to have configurable access parameters.
927 * @rate_control_algorithm: rate control algorithm for this hardware.
928 * If unset (NULL), the default algorithm will be used. Must be
929 * set before calling ieee80211_register_hw().
931 * @vif_data_size: size (in bytes) of the drv_priv data area
932 * within &struct ieee80211_vif.
933 * @sta_data_size: size (in bytes) of the drv_priv data area
934 * within &struct ieee80211_sta.
936 * @max_rates: maximum number of alternate rate retry stages
937 * @max_rate_tries: maximum number of tries for each stage
939 struct ieee80211_hw
{
940 struct ieee80211_conf conf
;
942 struct workqueue_struct
*workqueue
;
943 const char *rate_control_algorithm
;
946 unsigned int extra_tx_headroom
;
947 int channel_change_time
;
951 u16 max_listen_interval
;
958 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
960 * @wiphy: the &struct wiphy which we want to query
962 * mac80211 drivers can use this to get to their respective
963 * &struct ieee80211_hw. Drivers wishing to get to their own private
964 * structure can then access it via hw->priv. Note that mac802111 drivers should
965 * not use wiphy_priv() to try to get their private driver structure as this
966 * is already used internally by mac80211.
968 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
971 * SET_IEEE80211_DEV - set device for 802.11 hardware
973 * @hw: the &struct ieee80211_hw to set the device for
974 * @dev: the &struct device of this 802.11 device
976 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
978 set_wiphy_dev(hw
->wiphy
, dev
);
982 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
984 * @hw: the &struct ieee80211_hw to set the MAC address for
985 * @addr: the address to set
987 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
989 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
992 static inline struct ieee80211_rate
*
993 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
994 const struct ieee80211_tx_info
*c
)
996 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
998 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1001 static inline struct ieee80211_rate
*
1002 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1003 const struct ieee80211_tx_info
*c
)
1005 if (c
->control
.rts_cts_rate_idx
< 0)
1007 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1010 static inline struct ieee80211_rate
*
1011 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1012 const struct ieee80211_tx_info
*c
, int idx
)
1014 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1016 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1020 * DOC: Hardware crypto acceleration
1022 * mac80211 is capable of taking advantage of many hardware
1023 * acceleration designs for encryption and decryption operations.
1025 * The set_key() callback in the &struct ieee80211_ops for a given
1026 * device is called to enable hardware acceleration of encryption and
1027 * decryption. The callback takes a @sta parameter that will be NULL
1028 * for default keys or keys used for transmission only, or point to
1029 * the station information for the peer for individual keys.
1030 * Multiple transmission keys with the same key index may be used when
1031 * VLANs are configured for an access point.
1033 * When transmitting, the TX control data will use the @hw_key_idx
1034 * selected by the driver by modifying the &struct ieee80211_key_conf
1035 * pointed to by the @key parameter to the set_key() function.
1037 * The set_key() call for the %SET_KEY command should return 0 if
1038 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1039 * added; if you return 0 then hw_key_idx must be assigned to the
1040 * hardware key index, you are free to use the full u8 range.
1042 * When the cmd is %DISABLE_KEY then it must succeed.
1044 * Note that it is permissible to not decrypt a frame even if a key
1045 * for it has been uploaded to hardware, the stack will not make any
1046 * decision based on whether a key has been uploaded or not but rather
1047 * based on the receive flags.
1049 * The &struct ieee80211_key_conf structure pointed to by the @key
1050 * parameter is guaranteed to be valid until another call to set_key()
1051 * removes it, but it can only be used as a cookie to differentiate
1054 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1055 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1057 * The update_tkip_key() call updates the driver with the new phase 1 key.
1058 * This happens everytime the iv16 wraps around (every 65536 packets). The
1059 * set_key() call will happen only once for each key (unless the AP did
1060 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1061 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1062 * handler is software decryption with wrap around of iv16.
1066 * DOC: Powersave support
1068 * mac80211 has support for various powersave implementations.
1070 * First, it can support hardware that handles all powersaving by
1071 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1072 * hardware flag. In that case, it will be told about the desired
1073 * powersave mode depending on the association status, and the driver
1074 * must take care of sending nullfunc frames when necessary, i.e. when
1075 * entering and leaving powersave mode. The driver is required to look at
1076 * the AID in beacons and signal to the AP that it woke up when it finds
1077 * traffic directed to it. This mode supports dynamic PS by simply
1078 * enabling/disabling PS.
1080 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1081 * flag to indicate that it can support dynamic PS mode itself (see below).
1083 * Other hardware designs cannot send nullfunc frames by themselves and also
1084 * need software support for parsing the TIM bitmap. This is also supported
1085 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1086 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1087 * required to pass up beacons. The hardware is still required to handle
1088 * waking up for multicast traffic; if it cannot the driver must handle that
1089 * as best as it can, mac80211 is too slow.
1091 * Dynamic powersave mode is an extension to normal powersave mode in which
1092 * the hardware stays awake for a user-specified period of time after sending
1093 * a frame so that reply frames need not be buffered and therefore delayed
1094 * to the next wakeup. This can either be supported by hardware, in which case
1095 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1096 * value, or by the stack if all nullfunc handling is in the stack.
1100 * DOC: Beacon filter support
1102 * Some hardware have beacon filter support to reduce host cpu wakeups
1103 * which will reduce system power consumption. It usuallly works so that
1104 * the firmware creates a checksum of the beacon but omits all constantly
1105 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1106 * beacon is forwarded to the host, otherwise it will be just dropped. That
1107 * way the host will only receive beacons where some relevant information
1108 * (for example ERP protection or WMM settings) have changed.
1110 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1111 * hardware capability. The driver needs to enable beacon filter support
1112 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1113 * power save is enabled, the stack will not check for beacon loss and the
1114 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1116 * The time (or number of beacons missed) until the firmware notifies the
1117 * driver of a beacon loss event (which in turn causes the driver to call
1118 * ieee80211_beacon_loss()) should be configurable and will be controlled
1119 * by mac80211 and the roaming algorithm in the future.
1121 * Since there may be constantly changing information elements that nothing
1122 * in the software stack cares about, we will, in the future, have mac80211
1123 * tell the driver which information elements are interesting in the sense
1124 * that we want to see changes in them. This will include
1125 * - a list of information element IDs
1126 * - a list of OUIs for the vendor information element
1128 * Ideally, the hardware would filter out any beacons without changes in the
1129 * requested elements, but if it cannot support that it may, at the expense
1130 * of some efficiency, filter out only a subset. For example, if the device
1131 * doesn't support checking for OUIs it should pass up all changes in all
1132 * vendor information elements.
1134 * Note that change, for the sake of simplification, also includes information
1135 * elements appearing or disappearing from the beacon.
1137 * Some hardware supports an "ignore list" instead, just make sure nothing
1138 * that was requested is on the ignore list, and include commonly changing
1139 * information element IDs in the ignore list, for example 11 (BSS load) and
1140 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1141 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1142 * it could also include some currently unused IDs.
1145 * In addition to these capabilities, hardware should support notifying the
1146 * host of changes in the beacon RSSI. This is relevant to implement roaming
1147 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1148 * the received data packets). This can consist in notifying the host when
1149 * the RSSI changes significantly or when it drops below or rises above
1150 * configurable thresholds. In the future these thresholds will also be
1151 * configured by mac80211 (which gets them from userspace) to implement
1152 * them as the roaming algorithm requires.
1154 * If the hardware cannot implement this, the driver should ask it to
1155 * periodically pass beacon frames to the host so that software can do the
1156 * signal strength threshold checking.
1160 * DOC: Frame filtering
1162 * mac80211 requires to see many management frames for proper
1163 * operation, and users may want to see many more frames when
1164 * in monitor mode. However, for best CPU usage and power consumption,
1165 * having as few frames as possible percolate through the stack is
1166 * desirable. Hence, the hardware should filter as much as possible.
1168 * To achieve this, mac80211 uses filter flags (see below) to tell
1169 * the driver's configure_filter() function which frames should be
1170 * passed to mac80211 and which should be filtered out.
1172 * The configure_filter() callback is invoked with the parameters
1173 * @mc_count and @mc_list for the combined multicast address list
1174 * of all virtual interfaces, @changed_flags telling which flags
1175 * were changed and @total_flags with the new flag states.
1177 * If your device has no multicast address filters your driver will
1178 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1179 * parameter to see whether multicast frames should be accepted
1182 * All unsupported flags in @total_flags must be cleared.
1183 * Hardware does not support a flag if it is incapable of _passing_
1184 * the frame to the stack. Otherwise the driver must ignore
1185 * the flag, but not clear it.
1186 * You must _only_ clear the flag (announce no support for the
1187 * flag to mac80211) if you are not able to pass the packet type
1188 * to the stack (so the hardware always filters it).
1189 * So for example, you should clear @FIF_CONTROL, if your hardware
1190 * always filters control frames. If your hardware always passes
1191 * control frames to the kernel and is incapable of filtering them,
1192 * you do _not_ clear the @FIF_CONTROL flag.
1193 * This rule applies to all other FIF flags as well.
1197 * enum ieee80211_filter_flags - hardware filter flags
1199 * These flags determine what the filter in hardware should be
1200 * programmed to let through and what should not be passed to the
1201 * stack. It is always safe to pass more frames than requested,
1202 * but this has negative impact on power consumption.
1204 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1205 * think of the BSS as your network segment and then this corresponds
1206 * to the regular ethernet device promiscuous mode.
1208 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1209 * by the user or if the hardware is not capable of filtering by
1210 * multicast address.
1212 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1213 * %RX_FLAG_FAILED_FCS_CRC for them)
1215 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1216 * the %RX_FLAG_FAILED_PLCP_CRC for them
1218 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1219 * to the hardware that it should not filter beacons or probe responses
1220 * by BSSID. Filtering them can greatly reduce the amount of processing
1221 * mac80211 needs to do and the amount of CPU wakeups, so you should
1222 * honour this flag if possible.
1224 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1225 * only those addressed to this station
1227 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1229 enum ieee80211_filter_flags
{
1230 FIF_PROMISC_IN_BSS
= 1<<0,
1231 FIF_ALLMULTI
= 1<<1,
1233 FIF_PLCPFAIL
= 1<<3,
1234 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1236 FIF_OTHER_BSS
= 1<<6,
1240 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1242 * These flags are used with the ampdu_action() callback in
1243 * &struct ieee80211_ops to indicate which action is needed.
1244 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1245 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1246 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1247 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1248 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1250 enum ieee80211_ampdu_mlme_action
{
1251 IEEE80211_AMPDU_RX_START
,
1252 IEEE80211_AMPDU_RX_STOP
,
1253 IEEE80211_AMPDU_TX_START
,
1254 IEEE80211_AMPDU_TX_STOP
,
1255 IEEE80211_AMPDU_TX_OPERATIONAL
,
1259 * struct ieee80211_ops - callbacks from mac80211 to the driver
1261 * This structure contains various callbacks that the driver may
1262 * handle or, in some cases, must handle, for example to configure
1263 * the hardware to a new channel or to transmit a frame.
1265 * @tx: Handler that 802.11 module calls for each transmitted frame.
1266 * skb contains the buffer starting from the IEEE 802.11 header.
1267 * The low-level driver should send the frame out based on
1268 * configuration in the TX control data. This handler should,
1269 * preferably, never fail and stop queues appropriately, more
1270 * importantly, however, it must never fail for A-MPDU-queues.
1271 * This function should return NETDEV_TX_OK except in very
1273 * Must be implemented and atomic.
1275 * @start: Called before the first netdevice attached to the hardware
1276 * is enabled. This should turn on the hardware and must turn on
1277 * frame reception (for possibly enabled monitor interfaces.)
1278 * Returns negative error codes, these may be seen in userspace,
1280 * When the device is started it should not have a MAC address
1281 * to avoid acknowledging frames before a non-monitor device
1283 * Must be implemented.
1285 * @stop: Called after last netdevice attached to the hardware
1286 * is disabled. This should turn off the hardware (at least
1287 * it must turn off frame reception.)
1288 * May be called right after add_interface if that rejects
1290 * Must be implemented.
1292 * @add_interface: Called when a netdevice attached to the hardware is
1293 * enabled. Because it is not called for monitor mode devices, @start
1294 * and @stop must be implemented.
1295 * The driver should perform any initialization it needs before
1296 * the device can be enabled. The initial configuration for the
1297 * interface is given in the conf parameter.
1298 * The callback may refuse to add an interface by returning a
1299 * negative error code (which will be seen in userspace.)
1300 * Must be implemented.
1302 * @remove_interface: Notifies a driver that an interface is going down.
1303 * The @stop callback is called after this if it is the last interface
1304 * and no monitor interfaces are present.
1305 * When all interfaces are removed, the MAC address in the hardware
1306 * must be cleared so the device no longer acknowledges packets,
1307 * the mac_addr member of the conf structure is, however, set to the
1308 * MAC address of the device going away.
1309 * Hence, this callback must be implemented.
1311 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1312 * function to change hardware configuration, e.g., channel.
1313 * This function should never fail but returns a negative error code
1316 * @bss_info_changed: Handler for configuration requests related to BSS
1317 * parameters that may vary during BSS's lifespan, and may affect low
1318 * level driver (e.g. assoc/disassoc status, erp parameters).
1319 * This function should not be used if no BSS has been set, unless
1320 * for association indication. The @changed parameter indicates which
1321 * of the bss parameters has changed when a call is made.
1323 * @configure_filter: Configure the device's RX filter.
1324 * See the section "Frame filtering" for more information.
1325 * This callback must be implemented and atomic.
1327 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1328 * must be set or cleared for a given STA. Must be atomic.
1330 * @set_key: See the section "Hardware crypto acceleration"
1331 * This callback can sleep, and is only called between add_interface
1332 * and remove_interface calls, i.e. while the given virtual interface
1334 * Returns a negative error code if the key can't be added.
1336 * @update_tkip_key: See the section "Hardware crypto acceleration"
1337 * This callback will be called in the context of Rx. Called for drivers
1338 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1340 * @hw_scan: Ask the hardware to service the scan request, no need to start
1341 * the scan state machine in stack. The scan must honour the channel
1342 * configuration done by the regulatory agent in the wiphy's
1343 * registered bands. The hardware (or the driver) needs to make sure
1344 * that power save is disabled.
1345 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1346 * entire IEs after the SSID, so that drivers need not look at these
1347 * at all but just send them after the SSID -- mac80211 includes the
1348 * (extended) supported rates and HT information (where applicable).
1349 * When the scan finishes, ieee80211_scan_completed() must be called;
1350 * note that it also must be called when the scan cannot finish due to
1351 * any error unless this callback returned a negative error code.
1353 * @sw_scan_start: Notifier function that is called just before a software scan
1354 * is started. Can be NULL, if the driver doesn't need this notification.
1356 * @sw_scan_complete: Notifier function that is called just after a software scan
1357 * finished. Can be NULL, if the driver doesn't need this notification.
1359 * @get_stats: Return low-level statistics.
1360 * Returns zero if statistics are available.
1362 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1363 * callback should be provided to read the TKIP transmit IVs (both IV32
1364 * and IV16) for the given key from hardware.
1366 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1368 * @sta_notify: Notifies low level driver about addition, removal or power
1369 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1372 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1373 * bursting) for a hardware TX queue.
1374 * Returns a negative error code on failure.
1376 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1377 * to get number of currently queued packets (queue length), maximum queue
1378 * size (limit), and total number of packets sent using each TX queue
1379 * (count). The 'stats' pointer points to an array that has hw->queues
1382 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1383 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1384 * required function.
1386 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1387 * Currently, this is only used for IBSS mode debugging. Is not a
1388 * required function.
1390 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1391 * with other STAs in the IBSS. This is only used in IBSS mode. This
1392 * function is optional if the firmware/hardware takes full care of
1393 * TSF synchronization.
1395 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1396 * This is needed only for IBSS mode and the result of this function is
1397 * used to determine whether to reply to Probe Requests.
1398 * Returns non-zero if this device sent the last beacon.
1400 * @ampdu_action: Perform a certain A-MPDU action
1401 * The RA/TID combination determines the destination and TID we want
1402 * the ampdu action to be performed for. The action is defined through
1403 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1404 * is the first frame we expect to perform the action on. Notice
1405 * that TX/RX_STOP can pass NULL for this parameter.
1406 * Returns a negative error code on failure.
1408 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1409 * need to set wiphy->rfkill_poll to %true before registration,
1410 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1412 struct ieee80211_ops
{
1413 int (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1414 int (*start
)(struct ieee80211_hw
*hw
);
1415 void (*stop
)(struct ieee80211_hw
*hw
);
1416 int (*add_interface
)(struct ieee80211_hw
*hw
,
1417 struct ieee80211_if_init_conf
*conf
);
1418 void (*remove_interface
)(struct ieee80211_hw
*hw
,
1419 struct ieee80211_if_init_conf
*conf
);
1420 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
1421 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
1422 struct ieee80211_vif
*vif
,
1423 struct ieee80211_bss_conf
*info
,
1425 void (*configure_filter
)(struct ieee80211_hw
*hw
,
1426 unsigned int changed_flags
,
1427 unsigned int *total_flags
,
1428 int mc_count
, struct dev_addr_list
*mc_list
);
1429 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
1431 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
1432 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
1433 struct ieee80211_key_conf
*key
);
1434 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
1435 struct ieee80211_key_conf
*conf
, const u8
*address
,
1436 u32 iv32
, u16
*phase1key
);
1437 int (*hw_scan
)(struct ieee80211_hw
*hw
,
1438 struct cfg80211_scan_request
*req
);
1439 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
1440 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
1441 int (*get_stats
)(struct ieee80211_hw
*hw
,
1442 struct ieee80211_low_level_stats
*stats
);
1443 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
1444 u32
*iv32
, u16
*iv16
);
1445 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1446 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1447 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
1448 int (*conf_tx
)(struct ieee80211_hw
*hw
, u16 queue
,
1449 const struct ieee80211_tx_queue_params
*params
);
1450 int (*get_tx_stats
)(struct ieee80211_hw
*hw
,
1451 struct ieee80211_tx_queue_stats
*stats
);
1452 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
1453 void (*set_tsf
)(struct ieee80211_hw
*hw
, u64 tsf
);
1454 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
1455 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
1456 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
1457 enum ieee80211_ampdu_mlme_action action
,
1458 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
);
1460 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
1464 * ieee80211_alloc_hw - Allocate a new hardware device
1466 * This must be called once for each hardware device. The returned pointer
1467 * must be used to refer to this device when calling other functions.
1468 * mac80211 allocates a private data area for the driver pointed to by
1469 * @priv in &struct ieee80211_hw, the size of this area is given as
1472 * @priv_data_len: length of private data
1473 * @ops: callbacks for this device
1475 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
1476 const struct ieee80211_ops
*ops
);
1479 * ieee80211_register_hw - Register hardware device
1481 * You must call this function before any other functions in
1482 * mac80211. Note that before a hardware can be registered, you
1483 * need to fill the contained wiphy's information.
1485 * @hw: the device to register as returned by ieee80211_alloc_hw()
1487 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
1489 #ifdef CONFIG_MAC80211_LEDS
1490 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
1491 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
1492 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
1493 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
1496 * ieee80211_get_tx_led_name - get name of TX LED
1498 * mac80211 creates a transmit LED trigger for each wireless hardware
1499 * that can be used to drive LEDs if your driver registers a LED device.
1500 * This function returns the name (or %NULL if not configured for LEDs)
1501 * of the trigger so you can automatically link the LED device.
1503 * @hw: the hardware to get the LED trigger name for
1505 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
1507 #ifdef CONFIG_MAC80211_LEDS
1508 return __ieee80211_get_tx_led_name(hw
);
1515 * ieee80211_get_rx_led_name - get name of RX LED
1517 * mac80211 creates a receive LED trigger for each wireless hardware
1518 * that can be used to drive LEDs if your driver registers a LED device.
1519 * This function returns the name (or %NULL if not configured for LEDs)
1520 * of the trigger so you can automatically link the LED device.
1522 * @hw: the hardware to get the LED trigger name for
1524 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
1526 #ifdef CONFIG_MAC80211_LEDS
1527 return __ieee80211_get_rx_led_name(hw
);
1534 * ieee80211_get_assoc_led_name - get name of association LED
1536 * mac80211 creates a association LED trigger for each wireless hardware
1537 * that can be used to drive LEDs if your driver registers a LED device.
1538 * This function returns the name (or %NULL if not configured for LEDs)
1539 * of the trigger so you can automatically link the LED device.
1541 * @hw: the hardware to get the LED trigger name for
1543 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
1545 #ifdef CONFIG_MAC80211_LEDS
1546 return __ieee80211_get_assoc_led_name(hw
);
1553 * ieee80211_get_radio_led_name - get name of radio LED
1555 * mac80211 creates a radio change LED trigger for each wireless hardware
1556 * that can be used to drive LEDs if your driver registers a LED device.
1557 * This function returns the name (or %NULL if not configured for LEDs)
1558 * of the trigger so you can automatically link the LED device.
1560 * @hw: the hardware to get the LED trigger name for
1562 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
1564 #ifdef CONFIG_MAC80211_LEDS
1565 return __ieee80211_get_radio_led_name(hw
);
1572 * ieee80211_unregister_hw - Unregister a hardware device
1574 * This function instructs mac80211 to free allocated resources
1575 * and unregister netdevices from the networking subsystem.
1577 * @hw: the hardware to unregister
1579 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
1582 * ieee80211_free_hw - free hardware descriptor
1584 * This function frees everything that was allocated, including the
1585 * private data for the driver. You must call ieee80211_unregister_hw()
1586 * before calling this function.
1588 * @hw: the hardware to free
1590 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
1593 * ieee80211_restart_hw - restart hardware completely
1595 * Call this function when the hardware was restarted for some reason
1596 * (hardware error, ...) and the driver is unable to restore its state
1597 * by itself. mac80211 assumes that at this point the driver/hardware
1598 * is completely uninitialised and stopped, it starts the process by
1599 * calling the ->start() operation. The driver will need to reset all
1600 * internal state that it has prior to calling this function.
1602 * @hw: the hardware to restart
1604 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
1606 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1607 void __ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1608 struct ieee80211_rx_status
*status
);
1611 * ieee80211_rx - receive frame
1613 * Use this function to hand received frames to mac80211. The receive
1614 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1615 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1617 * This function may not be called in IRQ context. Calls to this function
1618 * for a single hardware must be synchronized against each other. Calls
1619 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1622 * @hw: the hardware this frame came in on
1623 * @skb: the buffer to receive, owned by mac80211 after this call
1624 * @status: status of this frame; the status pointer need not be valid
1625 * after this function returns
1627 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1628 struct ieee80211_rx_status
*status
)
1630 __ieee80211_rx(hw
, skb
, status
);
1634 * ieee80211_rx_irqsafe - receive frame
1636 * Like ieee80211_rx() but can be called in IRQ context
1637 * (internally defers to a tasklet.)
1639 * Calls to this function and ieee80211_rx() may not be mixed for a
1642 * @hw: the hardware this frame came in on
1643 * @skb: the buffer to receive, owned by mac80211 after this call
1644 * @status: status of this frame; the status pointer need not be valid
1645 * after this function returns and is not freed by mac80211,
1646 * it is recommended that it points to a stack area
1648 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
,
1649 struct sk_buff
*skb
,
1650 struct ieee80211_rx_status
*status
);
1653 * ieee80211_tx_status - transmit status callback
1655 * Call this function for all transmitted frames after they have been
1656 * transmitted. It is permissible to not call this function for
1657 * multicast frames but this can affect statistics.
1659 * This function may not be called in IRQ context. Calls to this function
1660 * for a single hardware must be synchronized against each other. Calls
1661 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1662 * for a single hardware.
1664 * @hw: the hardware the frame was transmitted by
1665 * @skb: the frame that was transmitted, owned by mac80211 after this call
1667 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
1668 struct sk_buff
*skb
);
1671 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1673 * Like ieee80211_tx_status() but can be called in IRQ context
1674 * (internally defers to a tasklet.)
1676 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1679 * @hw: the hardware the frame was transmitted by
1680 * @skb: the frame that was transmitted, owned by mac80211 after this call
1682 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
1683 struct sk_buff
*skb
);
1686 * ieee80211_beacon_get - beacon generation function
1687 * @hw: pointer obtained from ieee80211_alloc_hw().
1688 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1690 * If the beacon frames are generated by the host system (i.e., not in
1691 * hardware/firmware), the low-level driver uses this function to receive
1692 * the next beacon frame from the 802.11 code. The low-level is responsible
1693 * for calling this function before beacon data is needed (e.g., based on
1694 * hardware interrupt). Returned skb is used only once and low-level driver
1695 * is responsible for freeing it.
1697 struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
1698 struct ieee80211_vif
*vif
);
1701 * ieee80211_rts_get - RTS frame generation function
1702 * @hw: pointer obtained from ieee80211_alloc_hw().
1703 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1704 * @frame: pointer to the frame that is going to be protected by the RTS.
1705 * @frame_len: the frame length (in octets).
1706 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1707 * @rts: The buffer where to store the RTS frame.
1709 * If the RTS frames are generated by the host system (i.e., not in
1710 * hardware/firmware), the low-level driver uses this function to receive
1711 * the next RTS frame from the 802.11 code. The low-level is responsible
1712 * for calling this function before and RTS frame is needed.
1714 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1715 const void *frame
, size_t frame_len
,
1716 const struct ieee80211_tx_info
*frame_txctl
,
1717 struct ieee80211_rts
*rts
);
1720 * ieee80211_rts_duration - Get the duration field for an RTS frame
1721 * @hw: pointer obtained from ieee80211_alloc_hw().
1722 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1723 * @frame_len: the length of the frame that is going to be protected by the RTS.
1724 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1726 * If the RTS is generated in firmware, but the host system must provide
1727 * the duration field, the low-level driver uses this function to receive
1728 * the duration field value in little-endian byteorder.
1730 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
1731 struct ieee80211_vif
*vif
, size_t frame_len
,
1732 const struct ieee80211_tx_info
*frame_txctl
);
1735 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1736 * @hw: pointer obtained from ieee80211_alloc_hw().
1737 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1738 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1739 * @frame_len: the frame length (in octets).
1740 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1741 * @cts: The buffer where to store the CTS-to-self frame.
1743 * If the CTS-to-self frames are generated by the host system (i.e., not in
1744 * hardware/firmware), the low-level driver uses this function to receive
1745 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1746 * for calling this function before and CTS-to-self frame is needed.
1748 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
1749 struct ieee80211_vif
*vif
,
1750 const void *frame
, size_t frame_len
,
1751 const struct ieee80211_tx_info
*frame_txctl
,
1752 struct ieee80211_cts
*cts
);
1755 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1756 * @hw: pointer obtained from ieee80211_alloc_hw().
1757 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1758 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1759 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1761 * If the CTS-to-self is generated in firmware, but the host system must provide
1762 * the duration field, the low-level driver uses this function to receive
1763 * the duration field value in little-endian byteorder.
1765 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
1766 struct ieee80211_vif
*vif
,
1768 const struct ieee80211_tx_info
*frame_txctl
);
1771 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1772 * @hw: pointer obtained from ieee80211_alloc_hw().
1773 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1774 * @frame_len: the length of the frame.
1775 * @rate: the rate at which the frame is going to be transmitted.
1777 * Calculate the duration field of some generic frame, given its
1778 * length and transmission rate (in 100kbps).
1780 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
1781 struct ieee80211_vif
*vif
,
1783 struct ieee80211_rate
*rate
);
1786 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1787 * @hw: pointer as obtained from ieee80211_alloc_hw().
1788 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1790 * Function for accessing buffered broadcast and multicast frames. If
1791 * hardware/firmware does not implement buffering of broadcast/multicast
1792 * frames when power saving is used, 802.11 code buffers them in the host
1793 * memory. The low-level driver uses this function to fetch next buffered
1794 * frame. In most cases, this is used when generating beacon frame. This
1795 * function returns a pointer to the next buffered skb or NULL if no more
1796 * buffered frames are available.
1798 * Note: buffered frames are returned only after DTIM beacon frame was
1799 * generated with ieee80211_beacon_get() and the low-level driver must thus
1800 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1801 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1802 * does not need to check for DTIM beacons separately and should be able to
1803 * use common code for all beacons.
1806 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
1809 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1811 * This function computes a TKIP rc4 key for an skb. It computes
1812 * a phase 1 key if needed (iv16 wraps around). This function is to
1813 * be used by drivers which can do HW encryption but need to compute
1814 * to phase 1/2 key in SW.
1816 * @keyconf: the parameter passed with the set key
1817 * @skb: the skb for which the key is needed
1819 * @key: a buffer to which the key will be written
1821 void ieee80211_get_tkip_key(struct ieee80211_key_conf
*keyconf
,
1822 struct sk_buff
*skb
,
1823 enum ieee80211_tkip_key_type type
, u8
*key
);
1825 * ieee80211_wake_queue - wake specific queue
1826 * @hw: pointer as obtained from ieee80211_alloc_hw().
1827 * @queue: queue number (counted from zero).
1829 * Drivers should use this function instead of netif_wake_queue.
1831 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
1834 * ieee80211_stop_queue - stop specific queue
1835 * @hw: pointer as obtained from ieee80211_alloc_hw().
1836 * @queue: queue number (counted from zero).
1838 * Drivers should use this function instead of netif_stop_queue.
1840 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
1843 * ieee80211_queue_stopped - test status of the queue
1844 * @hw: pointer as obtained from ieee80211_alloc_hw().
1845 * @queue: queue number (counted from zero).
1847 * Drivers should use this function instead of netif_stop_queue.
1850 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
1853 * ieee80211_stop_queues - stop all queues
1854 * @hw: pointer as obtained from ieee80211_alloc_hw().
1856 * Drivers should use this function instead of netif_stop_queue.
1858 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
1861 * ieee80211_wake_queues - wake all queues
1862 * @hw: pointer as obtained from ieee80211_alloc_hw().
1864 * Drivers should use this function instead of netif_wake_queue.
1866 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
1869 * ieee80211_scan_completed - completed hardware scan
1871 * When hardware scan offload is used (i.e. the hw_scan() callback is
1872 * assigned) this function needs to be called by the driver to notify
1873 * mac80211 that the scan finished.
1875 * @hw: the hardware that finished the scan
1876 * @aborted: set to true if scan was aborted
1878 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
1881 * ieee80211_iterate_active_interfaces - iterate active interfaces
1883 * This function iterates over the interfaces associated with a given
1884 * hardware that are currently active and calls the callback for them.
1885 * This function allows the iterator function to sleep, when the iterator
1886 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1889 * @hw: the hardware struct of which the interfaces should be iterated over
1890 * @iterator: the iterator function to call
1891 * @data: first argument of the iterator function
1893 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
1894 void (*iterator
)(void *data
, u8
*mac
,
1895 struct ieee80211_vif
*vif
),
1899 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1901 * This function iterates over the interfaces associated with a given
1902 * hardware that are currently active and calls the callback for them.
1903 * This function requires the iterator callback function to be atomic,
1904 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1906 * @hw: the hardware struct of which the interfaces should be iterated over
1907 * @iterator: the iterator function to call, cannot sleep
1908 * @data: first argument of the iterator function
1910 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
1911 void (*iterator
)(void *data
,
1913 struct ieee80211_vif
*vif
),
1917 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1918 * @hw: pointer as obtained from ieee80211_alloc_hw().
1919 * @ra: receiver address of the BA session recipient
1920 * @tid: the TID to BA on.
1922 * Return: success if addBA request was sent, failure otherwise
1924 * Although mac80211/low level driver/user space application can estimate
1925 * the need to start aggregation on a certain RA/TID, the session level
1926 * will be managed by the mac80211.
1928 int ieee80211_start_tx_ba_session(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1931 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1932 * @hw: pointer as obtained from ieee80211_alloc_hw().
1933 * @ra: receiver address of the BA session recipient.
1934 * @tid: the TID to BA on.
1936 * This function must be called by low level driver once it has
1937 * finished with preparations for the BA session.
1939 void ieee80211_start_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1942 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1943 * @hw: pointer as obtained from ieee80211_alloc_hw().
1944 * @ra: receiver address of the BA session recipient.
1945 * @tid: the TID to BA on.
1947 * This function must be called by low level driver once it has
1948 * finished with preparations for the BA session.
1949 * This version of the function is IRQ-safe.
1951 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1955 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1956 * @hw: pointer as obtained from ieee80211_alloc_hw().
1957 * @ra: receiver address of the BA session recipient
1958 * @tid: the TID to stop BA.
1959 * @initiator: if indicates initiator DELBA frame will be sent.
1961 * Return: error if no sta with matching da found, success otherwise
1963 * Although mac80211/low level driver/user space application can estimate
1964 * the need to stop aggregation on a certain RA/TID, the session level
1965 * will be managed by the mac80211.
1967 int ieee80211_stop_tx_ba_session(struct ieee80211_hw
*hw
,
1969 enum ieee80211_back_parties initiator
);
1972 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1973 * @hw: pointer as obtained from ieee80211_alloc_hw().
1974 * @ra: receiver address of the BA session recipient.
1975 * @tid: the desired TID to BA on.
1977 * This function must be called by low level driver once it has
1978 * finished with preparations for the BA session tear down.
1980 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u8 tid
);
1983 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1984 * @hw: pointer as obtained from ieee80211_alloc_hw().
1985 * @ra: receiver address of the BA session recipient.
1986 * @tid: the desired TID to BA on.
1988 * This function must be called by low level driver once it has
1989 * finished with preparations for the BA session tear down.
1990 * This version of the function is IRQ-safe.
1992 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1996 * ieee80211_find_sta - find a station
1998 * @hw: pointer as obtained from ieee80211_alloc_hw()
1999 * @addr: station's address
2001 * This function must be called under RCU lock and the
2002 * resulting pointer is only valid under RCU lock as well.
2004 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_hw
*hw
,
2008 * ieee80211_beacon_loss - inform hardware does not receive beacons
2010 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2012 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2013 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2014 * hardware is not receiving beacons with this function.
2016 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
2018 /* Rate control API */
2021 * enum rate_control_changed - flags to indicate which parameter changed
2023 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2024 * changed, rate control algorithm can update its internal state if needed.
2026 enum rate_control_changed
{
2027 IEEE80211_RC_HT_CHANGED
= BIT(0)
2031 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2033 * @hw: The hardware the algorithm is invoked for.
2034 * @sband: The band this frame is being transmitted on.
2035 * @bss_conf: the current BSS configuration
2036 * @reported_rate: The rate control algorithm can fill this in to indicate
2037 * which rate should be reported to userspace as the current rate and
2038 * used for rate calculations in the mesh network.
2039 * @rts: whether RTS will be used for this frame because it is longer than the
2041 * @short_preamble: whether mac80211 will request short-preamble transmission
2042 * if the selected rate supports it
2043 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2044 * @skb: the skb that will be transmitted, the control information in it needs
2047 struct ieee80211_tx_rate_control
{
2048 struct ieee80211_hw
*hw
;
2049 struct ieee80211_supported_band
*sband
;
2050 struct ieee80211_bss_conf
*bss_conf
;
2051 struct sk_buff
*skb
;
2052 struct ieee80211_tx_rate reported_rate
;
2053 bool rts
, short_preamble
;
2057 struct rate_control_ops
{
2058 struct module
*module
;
2060 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
2061 void (*free
)(void *priv
);
2063 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
2064 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
2065 struct ieee80211_sta
*sta
, void *priv_sta
);
2066 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
2067 struct ieee80211_sta
*sta
,
2068 void *priv_sta
, u32 changed
);
2069 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
2072 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
2073 struct ieee80211_sta
*sta
, void *priv_sta
,
2074 struct sk_buff
*skb
);
2075 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
2076 struct ieee80211_tx_rate_control
*txrc
);
2078 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
2079 struct dentry
*dir
);
2080 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
2083 static inline int rate_supported(struct ieee80211_sta
*sta
,
2084 enum ieee80211_band band
,
2087 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
2091 rate_lowest_index(struct ieee80211_supported_band
*sband
,
2092 struct ieee80211_sta
*sta
)
2096 for (i
= 0; i
< sband
->n_bitrates
; i
++)
2097 if (rate_supported(sta
, sband
->band
, i
))
2100 /* warn when we cannot find a rate. */
2107 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
2108 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
2111 conf_is_ht20(struct ieee80211_conf
*conf
)
2113 return conf
->channel_type
== NL80211_CHAN_HT20
;
2117 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
2119 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
2123 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
2125 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
2129 conf_is_ht40(struct ieee80211_conf
*conf
)
2131 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
2135 conf_is_ht(struct ieee80211_conf
*conf
)
2137 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
2140 #endif /* MAC80211_H */