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/wireless.h>
23 #include <net/cfg80211.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
79 * This structure describes most essential parameters needed
80 * to describe 802.11n HT characteristics in a BSS.
82 * @primary_channel: channel number of primery channel
83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
86 struct ieee80211_ht_bss_info
{
88 u8 bss_cap
; /* use IEEE80211_HT_IE_CHA_ */
89 u8 bss_op_mode
; /* use IEEE80211_HT_IE_ */
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
97 * for A-MPDU operation.
99 enum ieee80211_max_queues
{
100 IEEE80211_MAX_QUEUES
= 16,
101 IEEE80211_MAX_AMPDU_QUEUES
= 16,
105 * struct ieee80211_tx_queue_params - transmit queue configuration
107 * The information provided in this structure is required for QoS
108 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
110 * @aifs: arbitration interframe space [0..255]
111 * @cw_min: minimum contention window [a value of the form
112 * 2^n-1 in the range 1..32767]
113 * @cw_max: maximum contention window [like @cw_min]
114 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
116 struct ieee80211_tx_queue_params
{
124 * struct ieee80211_tx_queue_stats - transmit queue statistics
126 * @len: number of packets in queue
127 * @limit: queue length limit
128 * @count: number of frames sent
130 struct ieee80211_tx_queue_stats
{
136 struct ieee80211_low_level_stats
{
137 unsigned int dot11ACKFailureCount
;
138 unsigned int dot11RTSFailureCount
;
139 unsigned int dot11FCSErrorCount
;
140 unsigned int dot11RTSSuccessCount
;
144 * enum ieee80211_bss_change - BSS change notification flags
146 * These flags are used with the bss_info_changed() callback
147 * to indicate which BSS parameter changed.
149 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
150 * also implies a change in the AID.
151 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
152 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
153 * @BSS_CHANGED_ERP_SLOT: slot timing changed
154 * @BSS_CHANGED_HT: 802.11n parameters changed
155 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
157 enum ieee80211_bss_change
{
158 BSS_CHANGED_ASSOC
= 1<<0,
159 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
160 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
161 BSS_CHANGED_ERP_SLOT
= 1<<3,
162 BSS_CHANGED_HT
= 1<<4,
163 BSS_CHANGED_BASIC_RATES
= 1<<5,
167 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
168 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
170 struct ieee80211_bss_ht_conf
{
175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
183 * @use_short_preamble: use 802.11b short preamble;
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186 * @use_short_slot: use short slot time (only relevant for ERP);
187 * if the hardware cannot handle this it must set the
188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
189 * @dtim_period: num of beacons before the next DTIM, for PSM
190 * @timestamp: beacon timestamp
191 * @beacon_int: beacon interval
192 * @assoc_capability: capabilities taken from assoc resp
193 * @ht: BSS's HT configuration
194 * @basic_rates: bitmap of basic rates, each bit stands for an
195 * index into the rate table configured by the driver in
198 struct ieee80211_bss_conf
{
199 /* association related data */
202 /* erp related data */
204 bool use_short_preamble
;
208 u16 assoc_capability
;
211 struct ieee80211_bss_ht_conf ht
;
215 * enum mac80211_tx_control_flags - flags to describe transmission information/status
217 * These flags are used with the @flags member of &ieee80211_tx_info.
219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221 * number to this frame, taking care of not overwriting the fragment
222 * number and increasing the sequence number only when the
223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224 * assign sequence numbers to QoS-data frames but cannot do so correctly
225 * for non-QoS-data and management frames because beacons need them from
226 * that counter as well and mac80211 cannot guarantee proper sequencing.
227 * If this flag is set, the driver should instruct the hardware to
228 * assign a sequence number to the frame or assign one itself. Cf. IEEE
229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230 * beacons and always be clear for frames without a sequence number field.
231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode.
240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246 * set by rate control algorithms to indicate probe rate, will
247 * be cleared for fragmented frames (except on the last fragment)
249 enum mac80211_tx_control_flags
{
250 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
251 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
252 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
253 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
254 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
255 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
256 IEEE80211_TX_CTL_AMPDU
= BIT(6),
257 IEEE80211_TX_CTL_INJECTED
= BIT(7),
258 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
259 IEEE80211_TX_STAT_ACK
= BIT(9),
260 IEEE80211_TX_STAT_AMPDU
= BIT(10),
261 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
262 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
265 enum mac80211_rate_control_flags
{
266 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
267 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
268 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
270 /* rate index is an MCS rate number instead of an index */
271 IEEE80211_TX_RC_MCS
= BIT(3),
272 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
273 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
274 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
275 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
279 /* there are 40 bytes if you don't need the rateset to be kept */
280 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
282 /* if you do need the rateset, then you have less space */
283 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
285 /* maximum number of rate stages */
286 #define IEEE80211_TX_MAX_RATES 5
289 * struct ieee80211_tx_rate - rate selection/status
291 * @idx: rate index to attempt to send with
292 * @flags: rate control flags (&enum mac80211_rate_control_flags)
293 * @count: number of tries in this rate before going to the next rate
295 * A value of -1 for @idx indicates an invalid rate and, if used
296 * in an array of retry rates, that no more rates should be tried.
298 * When used for transmit status reporting, the driver should
299 * always report the rate along with the flags it used.
301 struct ieee80211_tx_rate
{
305 } __attribute__((packed
));
308 * struct ieee80211_tx_info - skb transmit information
310 * This structure is placed in skb->cb for three uses:
311 * (1) mac80211 TX control - mac80211 tells the driver what to do
312 * (2) driver internal use (if applicable)
313 * (3) TX status information - driver tells mac80211 what happened
315 * The TX control's sta pointer is only valid during the ->tx call,
318 * @flags: transmit info flags, defined above
319 * @band: the band to transmit on (use for checking for races)
320 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
321 * @pad: padding, ignore
322 * @control: union for control data
323 * @status: union for status data
324 * @driver_data: array of driver_data pointers
325 * @ampdu_ack_len: number of aggregated frames.
326 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
327 * @ampdu_ack_map: block ack bit map for the aggregation.
328 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
329 * @ack_signal: signal strength of the ACK frame
331 struct ieee80211_tx_info
{
332 /* common information */
346 struct ieee80211_tx_rate rates
[
347 IEEE80211_TX_MAX_RATES
];
350 /* only needed before rate control */
351 unsigned long jiffies
;
353 /* NB: vif can be NULL for injected frames */
354 struct ieee80211_vif
*vif
;
355 struct ieee80211_key_conf
*hw_key
;
356 struct ieee80211_sta
*sta
;
359 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
366 struct ieee80211_tx_rate driver_rates
[
367 IEEE80211_TX_MAX_RATES
];
368 void *rate_driver_data
[
369 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
372 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
376 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
378 return (struct ieee80211_tx_info
*)skb
->cb
;
382 * ieee80211_tx_info_clear_status - clear TX status
384 * @info: The &struct ieee80211_tx_info to be cleared.
386 * When the driver passes an skb back to mac80211, it must report
387 * a number of things in TX status. This function clears everything
388 * in the TX status but the rate control information (it does clear
389 * the count since you need to fill that in anyway).
391 * NOTE: You can only use this function if you do NOT use
392 * info->driver_data! Use info->rate_driver_data
393 * instead if you need only the less space that allows.
396 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
400 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
401 offsetof(struct ieee80211_tx_info
, control
.rates
));
402 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
403 offsetof(struct ieee80211_tx_info
, driver_rates
));
404 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
405 /* clear the rate counts */
406 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
407 info
->status
.rates
[i
].count
= 0;
410 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
411 memset(&info
->status
.ampdu_ack_len
, 0,
412 sizeof(struct ieee80211_tx_info
) -
413 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
418 * enum mac80211_rx_flags - receive flags
420 * These flags are used with the @flag member of &struct ieee80211_rx_status.
421 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
422 * Use together with %RX_FLAG_MMIC_STRIPPED.
423 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
424 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
425 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
426 * verification has been done by the hardware.
427 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
428 * If this flag is set, the stack cannot do any replay detection
429 * hence the driver or hardware will have to do that.
430 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
432 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
434 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
435 * is valid. This is useful in monitor mode and necessary for beacon frames
436 * to enable IBSS merging.
437 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
438 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
439 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
440 * @RX_FLAG_SHORT_GI: Short guard interval was used
442 enum mac80211_rx_flags
{
443 RX_FLAG_MMIC_ERROR
= 1<<0,
444 RX_FLAG_DECRYPTED
= 1<<1,
445 RX_FLAG_RADIOTAP
= 1<<2,
446 RX_FLAG_MMIC_STRIPPED
= 1<<3,
447 RX_FLAG_IV_STRIPPED
= 1<<4,
448 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
449 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
451 RX_FLAG_SHORTPRE
= 1<<8,
453 RX_FLAG_40MHZ
= 1<<10,
454 RX_FLAG_SHORT_GI
= 1<<11,
458 * struct ieee80211_rx_status - receive status
460 * The low-level driver should provide this information (the subset
461 * supported by hardware) to the 802.11 code with each received
464 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
465 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
466 * @band: the active band when this frame was received
467 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
468 * @signal: signal strength when receiving this frame, either in dBm, in dB or
469 * unspecified depending on the hardware capabilities flags
470 * @IEEE80211_HW_SIGNAL_*
471 * @noise: noise when receiving this frame, in dBm.
472 * @qual: overall signal quality indication, in percent (0-100).
473 * @antenna: antenna used
474 * @rate_idx: index of data rate into band's supported rates or MCS index if
475 * HT rates are use (RX_FLAG_HT)
478 struct ieee80211_rx_status
{
480 enum ieee80211_band band
;
491 * enum ieee80211_conf_flags - configuration flags
493 * Flags to define PHY configuration options
495 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
496 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
498 enum ieee80211_conf_flags
{
499 IEEE80211_CONF_RADIOTAP
= (1<<0),
500 IEEE80211_CONF_PS
= (1<<1),
503 /* XXX: remove all this once drivers stop trying to use it */
504 static inline int __deprecated
__IEEE80211_CONF_SHORT_SLOT_TIME(void)
508 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
511 * enum ieee80211_conf_changed - denotes which configuration changed
513 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
514 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
515 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
516 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
517 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
518 * @IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT: the dynamic PS timeout changed
519 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
520 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
521 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
523 enum ieee80211_conf_changed
{
524 IEEE80211_CONF_CHANGE_RADIO_ENABLED
= BIT(0),
525 IEEE80211_CONF_CHANGE_BEACON_INTERVAL
= BIT(1),
526 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
527 IEEE80211_CONF_CHANGE_RADIOTAP
= BIT(3),
528 IEEE80211_CONF_CHANGE_PS
= BIT(4),
529 IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT
= BIT(5),
530 IEEE80211_CONF_CHANGE_POWER
= BIT(6),
531 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(7),
532 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(8),
536 * struct ieee80211_conf - configuration of the device
538 * This struct indicates how the driver shall configure the hardware.
540 * @radio_enabled: when zero, driver is required to switch off the radio.
541 * @beacon_int: beacon interval (TODO make interface config)
542 * @listen_interval: listen interval in units of beacon interval
543 * @flags: configuration flags defined above
544 * @power_level: requested transmit power (in dBm)
545 * @dynamic_ps_timeout: dynamic powersave timeout (in ms)
546 * @channel: the channel to tune to
547 * @channel_type: the channel (HT) type
548 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
549 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
550 * but actually means the number of transmissions not the number of retries
551 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
552 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
553 * number of transmissions not the number of retries
555 struct ieee80211_conf
{
558 int power_level
, dynamic_ps_timeout
;
563 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
565 struct ieee80211_channel
*channel
;
566 enum nl80211_channel_type channel_type
;
570 * struct ieee80211_vif - per-interface data
572 * Data in this structure is continually present for driver
573 * use during the life of a virtual interface.
575 * @type: type of this virtual interface
576 * @bss_conf: BSS configuration for this interface, either our own
577 * or the BSS we're associated to
578 * @drv_priv: data area for driver use, will always be aligned to
581 struct ieee80211_vif
{
582 enum nl80211_iftype type
;
583 struct ieee80211_bss_conf bss_conf
;
585 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
588 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
590 #ifdef CONFIG_MAC80211_MESH
591 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
597 * struct ieee80211_if_init_conf - initial configuration of an interface
599 * @vif: pointer to a driver-use per-interface structure. The pointer
600 * itself is also used for various functions including
601 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
602 * @type: one of &enum nl80211_iftype constants. Determines the type of
603 * added/removed interface.
604 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
605 * until the interface is removed (i.e. it cannot be used after
606 * remove_interface() callback was called for this interface).
608 * This structure is used in add_interface() and remove_interface()
609 * callbacks of &struct ieee80211_hw.
611 * When you allow multiple interfaces to be added to your PHY, take care
612 * that the hardware can actually handle multiple MAC addresses. However,
613 * also take care that when there's no interface left with mac_addr != %NULL
614 * you remove the MAC address from the device to avoid acknowledging packets
615 * in pure monitor mode.
617 struct ieee80211_if_init_conf
{
618 enum nl80211_iftype type
;
619 struct ieee80211_vif
*vif
;
624 * enum ieee80211_if_conf_change - interface config change flags
626 * @IEEE80211_IFCC_BSSID: The BSSID changed.
627 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
628 * (currently AP and MESH only), use ieee80211_beacon_get().
630 enum ieee80211_if_conf_change
{
631 IEEE80211_IFCC_BSSID
= BIT(0),
632 IEEE80211_IFCC_BEACON
= BIT(1),
636 * struct ieee80211_if_conf - configuration of an interface
638 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
639 * @bssid: BSSID of the network we are associated to/creating.
641 * This structure is passed to the config_interface() callback of
642 * &struct ieee80211_hw.
644 struct ieee80211_if_conf
{
650 * enum ieee80211_key_alg - key algorithm
651 * @ALG_WEP: WEP40 or WEP104
653 * @ALG_CCMP: CCMP (AES)
654 * @ALG_AES_CMAC: AES-128-CMAC
656 enum ieee80211_key_alg
{
664 * enum ieee80211_key_len - key length
665 * @LEN_WEP40: WEP 5-byte long key
666 * @LEN_WEP104: WEP 13-byte long key
668 enum ieee80211_key_len
{
674 * enum ieee80211_key_flags - key flags
676 * These flags are used for communication about keys between the driver
677 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
679 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
680 * that the STA this key will be used with could be using QoS.
681 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
682 * driver to indicate that it requires IV generation for this
684 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
685 * the driver for a TKIP key if it requires Michael MIC
686 * generation in software.
687 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
688 * that the key is pairwise rather then a shared key.
689 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
690 * CCMP key if it requires CCMP encryption of management frames (MFP) to
691 * be done in software.
693 enum ieee80211_key_flags
{
694 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
695 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
696 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
697 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
698 IEEE80211_KEY_FLAG_SW_MGMT
= 1<<4,
702 * struct ieee80211_key_conf - key information
704 * This key information is given by mac80211 to the driver by
705 * the set_key() callback in &struct ieee80211_ops.
707 * @hw_key_idx: To be set by the driver, this is the key index the driver
708 * wants to be given when a frame is transmitted and needs to be
709 * encrypted in hardware.
710 * @alg: The key algorithm.
711 * @flags: key flags, see &enum ieee80211_key_flags.
712 * @keyidx: the key index (0-3)
713 * @keylen: key material length
714 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
716 * - Temporal Encryption Key (128 bits)
717 * - Temporal Authenticator Tx MIC Key (64 bits)
718 * - Temporal Authenticator Rx MIC Key (64 bits)
719 * @icv_len: The ICV length for this key type
720 * @iv_len: The IV length for this key type
722 struct ieee80211_key_conf
{
723 enum ieee80211_key_alg alg
;
734 * enum set_key_cmd - key command
736 * Used with the set_key() callback in &struct ieee80211_ops, this
737 * indicates whether a key is being removed or added.
739 * @SET_KEY: a key is set
740 * @DISABLE_KEY: a key must be disabled
743 SET_KEY
, DISABLE_KEY
,
747 * struct ieee80211_sta - station table entry
749 * A station table entry represents a station we are possibly
750 * communicating with. Since stations are RCU-managed in
751 * mac80211, any ieee80211_sta pointer you get access to must
752 * either be protected by rcu_read_lock() explicitly or implicitly,
753 * or you must take good care to not use such a pointer after a
754 * call to your sta_notify callback that removed it.
757 * @aid: AID we assigned to the station if we're an AP
758 * @supp_rates: Bitmap of supported rates (per band)
759 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
760 * @drv_priv: data area for driver use, will always be aligned to
761 * sizeof(void *), size is determined in hw information.
763 struct ieee80211_sta
{
764 u64 supp_rates
[IEEE80211_NUM_BANDS
];
767 struct ieee80211_sta_ht_cap ht_cap
;
770 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
774 * enum sta_notify_cmd - sta notify command
776 * Used with the sta_notify() callback in &struct ieee80211_ops, this
777 * indicates addition and removal of a station to station table,
778 * or if a associated station made a power state transition.
780 * @STA_NOTIFY_ADD: a station was added to the station table
781 * @STA_NOTIFY_REMOVE: a station being removed from the station table
782 * @STA_NOTIFY_SLEEP: a station is now sleeping
783 * @STA_NOTIFY_AWAKE: a sleeping station woke up
785 enum sta_notify_cmd
{
786 STA_NOTIFY_ADD
, STA_NOTIFY_REMOVE
,
787 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
791 * enum ieee80211_tkip_key_type - get tkip key
793 * Used by drivers which need to get a tkip key for skb. Some drivers need a
794 * phase 1 key, others need a phase 2 key. A single function allows the driver
795 * to get the key, this enum indicates what type of key is required.
797 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
798 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
800 enum ieee80211_tkip_key_type
{
801 IEEE80211_TKIP_P1_KEY
,
802 IEEE80211_TKIP_P2_KEY
,
806 * enum ieee80211_hw_flags - hardware flags
808 * These flags are used to indicate hardware capabilities to
809 * the stack. Generally, flags here should have their meaning
810 * done in a way that the simplest hardware doesn't need setting
811 * any particular flags. There are some exceptions to this rule,
812 * however, so you are advised to review these flags carefully.
814 * @IEEE80211_HW_RX_INCLUDES_FCS:
815 * Indicates that received frames passed to the stack include
816 * the FCS at the end.
818 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
819 * Some wireless LAN chipsets buffer broadcast/multicast frames
820 * for power saving stations in the hardware/firmware and others
821 * rely on the host system for such buffering. This option is used
822 * to configure the IEEE 802.11 upper layer to buffer broadcast and
823 * multicast frames when there are power saving stations so that
824 * the driver can fetch them with ieee80211_get_buffered_bc().
826 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
827 * Hardware is not capable of short slot operation on the 2.4 GHz band.
829 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
830 * Hardware is not capable of receiving frames with short preamble on
833 * @IEEE80211_HW_SIGNAL_UNSPEC:
834 * Hardware can provide signal values but we don't know its units. We
835 * expect values between 0 and @max_signal.
836 * If possible please provide dB or dBm instead.
838 * @IEEE80211_HW_SIGNAL_DB:
839 * Hardware gives signal values in dB, decibel difference from an
840 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
841 * If possible please provide dBm instead.
843 * @IEEE80211_HW_SIGNAL_DBM:
844 * Hardware gives signal values in dBm, decibel difference from
845 * one milliwatt. This is the preferred method since it is standardized
846 * between different devices. @max_signal does not need to be set.
848 * @IEEE80211_HW_NOISE_DBM:
849 * Hardware can provide noise (radio interference) values in units dBm,
850 * decibel difference from one milliwatt.
852 * @IEEE80211_HW_SPECTRUM_MGMT:
853 * Hardware supports spectrum management defined in 802.11h
854 * Measurement, Channel Switch, Quieting, TPC
856 * @IEEE80211_HW_AMPDU_AGGREGATION:
857 * Hardware supports 11n A-MPDU aggregation.
859 * @IEEE80211_HW_SUPPORTS_PS:
860 * Hardware has power save support (i.e. can go to sleep).
862 * @IEEE80211_HW_PS_NULLFUNC_STACK:
863 * Hardware requires nullfunc frame handling in stack, implies
864 * stack support for dynamic PS.
866 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
867 * Hardware has support for dynamic PS.
869 * @IEEE80211_HW_MFP_CAPABLE:
870 * Hardware supports management frame protection (MFP, IEEE 802.11w).
872 enum ieee80211_hw_flags
{
873 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
874 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
875 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
876 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
877 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
878 IEEE80211_HW_SIGNAL_DB
= 1<<6,
879 IEEE80211_HW_SIGNAL_DBM
= 1<<7,
880 IEEE80211_HW_NOISE_DBM
= 1<<8,
881 IEEE80211_HW_SPECTRUM_MGMT
= 1<<9,
882 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<10,
883 IEEE80211_HW_SUPPORTS_PS
= 1<<11,
884 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<12,
885 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<13,
886 IEEE80211_HW_MFP_CAPABLE
= 1<<14,
890 * struct ieee80211_hw - hardware information and state
892 * This structure contains the configuration and hardware
893 * information for an 802.11 PHY.
895 * @wiphy: This points to the &struct wiphy allocated for this
896 * 802.11 PHY. You must fill in the @perm_addr and @dev
897 * members of this structure using SET_IEEE80211_DEV()
898 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
899 * bands (with channels, bitrates) are registered here.
901 * @conf: &struct ieee80211_conf, device configuration, don't use.
903 * @workqueue: single threaded workqueue available for driver use,
904 * allocated by mac80211 on registration and flushed when an
905 * interface is removed.
906 * NOTICE: All work performed on this workqueue should NEVER
907 * acquire the RTNL lock (i.e. Don't use the function
908 * ieee80211_iterate_active_interfaces())
910 * @priv: pointer to private area that was allocated for driver use
911 * along with this structure.
913 * @flags: hardware flags, see &enum ieee80211_hw_flags.
915 * @extra_tx_headroom: headroom to reserve in each transmit skb
916 * for use by the driver (e.g. for transmit headers.)
918 * @channel_change_time: time (in microseconds) it takes to change channels.
920 * @max_signal: Maximum value for signal (rssi) in RX information, used
921 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
923 * @max_listen_interval: max listen interval in units of beacon interval
926 * @queues: number of available hardware transmit queues for
927 * data packets. WMM/QoS requires at least four, these
928 * queues need to have configurable access parameters.
930 * @ampdu_queues: number of available hardware transmit queues
931 * for A-MPDU packets, these have no access parameters
932 * because they're used only for A-MPDU frames. Note that
933 * mac80211 will not currently use any of the regular queues
936 * @rate_control_algorithm: rate control algorithm for this hardware.
937 * If unset (NULL), the default algorithm will be used. Must be
938 * set before calling ieee80211_register_hw().
940 * @vif_data_size: size (in bytes) of the drv_priv data area
941 * within &struct ieee80211_vif.
942 * @sta_data_size: size (in bytes) of the drv_priv data area
943 * within &struct ieee80211_sta.
945 * @max_rates: maximum number of alternate rate retry stages
946 * @max_rate_tries: maximum number of tries for each stage
948 struct ieee80211_hw
{
949 struct ieee80211_conf conf
;
951 struct workqueue_struct
*workqueue
;
952 const char *rate_control_algorithm
;
955 unsigned int extra_tx_headroom
;
956 int channel_change_time
;
961 u16 max_listen_interval
;
968 * SET_IEEE80211_DEV - set device for 802.11 hardware
970 * @hw: the &struct ieee80211_hw to set the device for
971 * @dev: the &struct device of this 802.11 device
973 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
975 set_wiphy_dev(hw
->wiphy
, dev
);
979 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
981 * @hw: the &struct ieee80211_hw to set the MAC address for
982 * @addr: the address to set
984 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
986 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
989 static inline int ieee80211_num_regular_queues(struct ieee80211_hw
*hw
)
994 static inline int ieee80211_num_queues(struct ieee80211_hw
*hw
)
996 return hw
->queues
+ hw
->ampdu_queues
;
999 static inline struct ieee80211_rate
*
1000 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1001 const struct ieee80211_tx_info
*c
)
1003 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
1005 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1008 static inline struct ieee80211_rate
*
1009 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1010 const struct ieee80211_tx_info
*c
)
1012 if (c
->control
.rts_cts_rate_idx
< 0)
1014 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1017 static inline struct ieee80211_rate
*
1018 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1019 const struct ieee80211_tx_info
*c
, int idx
)
1021 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1023 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1027 * DOC: Hardware crypto acceleration
1029 * mac80211 is capable of taking advantage of many hardware
1030 * acceleration designs for encryption and decryption operations.
1032 * The set_key() callback in the &struct ieee80211_ops for a given
1033 * device is called to enable hardware acceleration of encryption and
1034 * decryption. The callback takes a @sta parameter that will be NULL
1035 * for default keys or keys used for transmission only, or point to
1036 * the station information for the peer for individual keys.
1037 * Multiple transmission keys with the same key index may be used when
1038 * VLANs are configured for an access point.
1040 * When transmitting, the TX control data will use the @hw_key_idx
1041 * selected by the driver by modifying the &struct ieee80211_key_conf
1042 * pointed to by the @key parameter to the set_key() function.
1044 * The set_key() call for the %SET_KEY command should return 0 if
1045 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1046 * added; if you return 0 then hw_key_idx must be assigned to the
1047 * hardware key index, you are free to use the full u8 range.
1049 * When the cmd is %DISABLE_KEY then it must succeed.
1051 * Note that it is permissible to not decrypt a frame even if a key
1052 * for it has been uploaded to hardware, the stack will not make any
1053 * decision based on whether a key has been uploaded or not but rather
1054 * based on the receive flags.
1056 * The &struct ieee80211_key_conf structure pointed to by the @key
1057 * parameter is guaranteed to be valid until another call to set_key()
1058 * removes it, but it can only be used as a cookie to differentiate
1061 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1062 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1064 * The update_tkip_key() call updates the driver with the new phase 1 key.
1065 * This happens everytime the iv16 wraps around (every 65536 packets). The
1066 * set_key() call will happen only once for each key (unless the AP did
1067 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1068 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1069 * handler is software decryption with wrap around of iv16.
1073 * DOC: Powersave support
1075 * mac80211 has support for various powersave implementations.
1077 * First, it can support hardware that handles all powersaving by
1078 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1079 * hardware flag. In that case, it will be told about the desired
1080 * powersave mode depending on the association status, and the driver
1081 * must take care of sending nullfunc frames when necessary, i.e. when
1082 * entering and leaving powersave mode. The driver is required to look at
1083 * the AID in beacons and signal to the AP that it woke up when it finds
1084 * traffic directed to it. This mode supports dynamic PS by simply
1085 * enabling/disabling PS.
1087 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1088 * flag to indicate that it can support dynamic PS mode itself (see below).
1090 * Other hardware designs cannot send nullfunc frames by themselves and also
1091 * need software support for parsing the TIM bitmap. This is also supported
1092 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1093 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1094 * required to pass up beacons. Additionally, in this case, mac80211 will
1095 * wake up the hardware when multicast traffic is announced in the beacon.
1097 * FIXME: I don't think we can be fast enough in software when we want to
1098 * receive multicast traffic?
1100 * Dynamic powersave mode is an extension to normal powersave mode in which
1101 * the hardware stays awake for a user-specified period of time after sending
1102 * a frame so that reply frames need not be buffered and therefore delayed
1103 * to the next wakeup. This can either be supported by hardware, in which case
1104 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1105 * value, or by the stack if all nullfunc handling is in the stack.
1109 * DOC: Frame filtering
1111 * mac80211 requires to see many management frames for proper
1112 * operation, and users may want to see many more frames when
1113 * in monitor mode. However, for best CPU usage and power consumption,
1114 * having as few frames as possible percolate through the stack is
1115 * desirable. Hence, the hardware should filter as much as possible.
1117 * To achieve this, mac80211 uses filter flags (see below) to tell
1118 * the driver's configure_filter() function which frames should be
1119 * passed to mac80211 and which should be filtered out.
1121 * The configure_filter() callback is invoked with the parameters
1122 * @mc_count and @mc_list for the combined multicast address list
1123 * of all virtual interfaces, @changed_flags telling which flags
1124 * were changed and @total_flags with the new flag states.
1126 * If your device has no multicast address filters your driver will
1127 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1128 * parameter to see whether multicast frames should be accepted
1131 * All unsupported flags in @total_flags must be cleared.
1132 * Hardware does not support a flag if it is incapable of _passing_
1133 * the frame to the stack. Otherwise the driver must ignore
1134 * the flag, but not clear it.
1135 * You must _only_ clear the flag (announce no support for the
1136 * flag to mac80211) if you are not able to pass the packet type
1137 * to the stack (so the hardware always filters it).
1138 * So for example, you should clear @FIF_CONTROL, if your hardware
1139 * always filters control frames. If your hardware always passes
1140 * control frames to the kernel and is incapable of filtering them,
1141 * you do _not_ clear the @FIF_CONTROL flag.
1142 * This rule applies to all other FIF flags as well.
1146 * enum ieee80211_filter_flags - hardware filter flags
1148 * These flags determine what the filter in hardware should be
1149 * programmed to let through and what should not be passed to the
1150 * stack. It is always safe to pass more frames than requested,
1151 * but this has negative impact on power consumption.
1153 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1154 * think of the BSS as your network segment and then this corresponds
1155 * to the regular ethernet device promiscuous mode.
1157 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1158 * by the user or if the hardware is not capable of filtering by
1159 * multicast address.
1161 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1162 * %RX_FLAG_FAILED_FCS_CRC for them)
1164 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1165 * the %RX_FLAG_FAILED_PLCP_CRC for them
1167 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1168 * to the hardware that it should not filter beacons or probe responses
1169 * by BSSID. Filtering them can greatly reduce the amount of processing
1170 * mac80211 needs to do and the amount of CPU wakeups, so you should
1171 * honour this flag if possible.
1173 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1174 * only those addressed to this station
1176 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1178 enum ieee80211_filter_flags
{
1179 FIF_PROMISC_IN_BSS
= 1<<0,
1180 FIF_ALLMULTI
= 1<<1,
1182 FIF_PLCPFAIL
= 1<<3,
1183 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1185 FIF_OTHER_BSS
= 1<<6,
1189 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1191 * These flags are used with the ampdu_action() callback in
1192 * &struct ieee80211_ops to indicate which action is needed.
1193 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1194 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1195 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1196 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1197 * @IEEE80211_AMPDU_TX_RESUME: resume TX aggregation
1199 enum ieee80211_ampdu_mlme_action
{
1200 IEEE80211_AMPDU_RX_START
,
1201 IEEE80211_AMPDU_RX_STOP
,
1202 IEEE80211_AMPDU_TX_START
,
1203 IEEE80211_AMPDU_TX_STOP
,
1204 IEEE80211_AMPDU_TX_RESUME
,
1208 * struct ieee80211_ops - callbacks from mac80211 to the driver
1210 * This structure contains various callbacks that the driver may
1211 * handle or, in some cases, must handle, for example to configure
1212 * the hardware to a new channel or to transmit a frame.
1214 * @tx: Handler that 802.11 module calls for each transmitted frame.
1215 * skb contains the buffer starting from the IEEE 802.11 header.
1216 * The low-level driver should send the frame out based on
1217 * configuration in the TX control data. This handler should,
1218 * preferably, never fail and stop queues appropriately, more
1219 * importantly, however, it must never fail for A-MPDU-queues.
1220 * This function should return NETDEV_TX_OK except in very
1222 * Must be implemented and atomic.
1224 * @start: Called before the first netdevice attached to the hardware
1225 * is enabled. This should turn on the hardware and must turn on
1226 * frame reception (for possibly enabled monitor interfaces.)
1227 * Returns negative error codes, these may be seen in userspace,
1229 * When the device is started it should not have a MAC address
1230 * to avoid acknowledging frames before a non-monitor device
1232 * Must be implemented.
1234 * @stop: Called after last netdevice attached to the hardware
1235 * is disabled. This should turn off the hardware (at least
1236 * it must turn off frame reception.)
1237 * May be called right after add_interface if that rejects
1239 * Must be implemented.
1241 * @add_interface: Called when a netdevice attached to the hardware is
1242 * enabled. Because it is not called for monitor mode devices, @start
1243 * and @stop must be implemented.
1244 * The driver should perform any initialization it needs before
1245 * the device can be enabled. The initial configuration for the
1246 * interface is given in the conf parameter.
1247 * The callback may refuse to add an interface by returning a
1248 * negative error code (which will be seen in userspace.)
1249 * Must be implemented.
1251 * @remove_interface: Notifies a driver that an interface is going down.
1252 * The @stop callback is called after this if it is the last interface
1253 * and no monitor interfaces are present.
1254 * When all interfaces are removed, the MAC address in the hardware
1255 * must be cleared so the device no longer acknowledges packets,
1256 * the mac_addr member of the conf structure is, however, set to the
1257 * MAC address of the device going away.
1258 * Hence, this callback must be implemented.
1260 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1261 * function to change hardware configuration, e.g., channel.
1262 * This function should never fail but returns a negative error code
1265 * @config_interface: Handler for configuration requests related to interfaces
1266 * (e.g. BSSID changes.)
1267 * Returns a negative error code which will be seen in userspace.
1269 * @bss_info_changed: Handler for configuration requests related to BSS
1270 * parameters that may vary during BSS's lifespan, and may affect low
1271 * level driver (e.g. assoc/disassoc status, erp parameters).
1272 * This function should not be used if no BSS has been set, unless
1273 * for association indication. The @changed parameter indicates which
1274 * of the bss parameters has changed when a call is made.
1276 * @configure_filter: Configure the device's RX filter.
1277 * See the section "Frame filtering" for more information.
1278 * This callback must be implemented and atomic.
1280 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1281 * must be set or cleared for a given STA. Must be atomic.
1283 * @set_key: See the section "Hardware crypto acceleration"
1284 * This callback can sleep, and is only called between add_interface
1285 * and remove_interface calls, i.e. while the given virtual interface
1287 * Returns a negative error code if the key can't be added.
1289 * @update_tkip_key: See the section "Hardware crypto acceleration"
1290 * This callback will be called in the context of Rx. Called for drivers
1291 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1293 * @hw_scan: Ask the hardware to service the scan request, no need to start
1294 * the scan state machine in stack. The scan must honour the channel
1295 * configuration done by the regulatory agent in the wiphy's registered
1296 * bands. When the scan finishes, ieee80211_scan_completed() must be
1297 * called; note that it also must be called when the scan cannot finish
1298 * because the hardware is turned off! Anything else is a bug!
1299 * Returns a negative error code which will be seen in userspace.
1301 * @get_stats: Return low-level statistics.
1302 * Returns zero if statistics are available.
1304 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1305 * callback should be provided to read the TKIP transmit IVs (both IV32
1306 * and IV16) for the given key from hardware.
1308 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1310 * @sta_notify: Notifies low level driver about addition, removal or power
1311 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1314 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1315 * bursting) for a hardware TX queue.
1316 * Returns a negative error code on failure.
1318 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1319 * to get number of currently queued packets (queue length), maximum queue
1320 * size (limit), and total number of packets sent using each TX queue
1321 * (count). The 'stats' pointer points to an array that has hw->queues +
1322 * hw->ampdu_queues items.
1324 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1325 * this is only used for IBSS mode debugging and, as such, is not a
1326 * required function. Must be atomic.
1328 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1329 * with other STAs in the IBSS. This is only used in IBSS mode. This
1330 * function is optional if the firmware/hardware takes full care of
1331 * TSF synchronization.
1333 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1334 * This is needed only for IBSS mode and the result of this function is
1335 * used to determine whether to reply to Probe Requests.
1336 * Returns non-zero if this device sent the last beacon.
1338 * @ampdu_action: Perform a certain A-MPDU action
1339 * The RA/TID combination determines the destination and TID we want
1340 * the ampdu action to be performed for. The action is defined through
1341 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1342 * is the first frame we expect to perform the action on. Notice
1343 * that TX/RX_STOP can pass NULL for this parameter.
1344 * Returns a negative error code on failure.
1346 struct ieee80211_ops
{
1347 int (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1348 int (*start
)(struct ieee80211_hw
*hw
);
1349 void (*stop
)(struct ieee80211_hw
*hw
);
1350 int (*add_interface
)(struct ieee80211_hw
*hw
,
1351 struct ieee80211_if_init_conf
*conf
);
1352 void (*remove_interface
)(struct ieee80211_hw
*hw
,
1353 struct ieee80211_if_init_conf
*conf
);
1354 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
1355 int (*config_interface
)(struct ieee80211_hw
*hw
,
1356 struct ieee80211_vif
*vif
,
1357 struct ieee80211_if_conf
*conf
);
1358 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
1359 struct ieee80211_vif
*vif
,
1360 struct ieee80211_bss_conf
*info
,
1362 void (*configure_filter
)(struct ieee80211_hw
*hw
,
1363 unsigned int changed_flags
,
1364 unsigned int *total_flags
,
1365 int mc_count
, struct dev_addr_list
*mc_list
);
1366 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
1368 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
1369 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
1370 struct ieee80211_key_conf
*key
);
1371 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
1372 struct ieee80211_key_conf
*conf
, const u8
*address
,
1373 u32 iv32
, u16
*phase1key
);
1374 int (*hw_scan
)(struct ieee80211_hw
*hw
, u8
*ssid
, size_t len
);
1375 int (*get_stats
)(struct ieee80211_hw
*hw
,
1376 struct ieee80211_low_level_stats
*stats
);
1377 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
1378 u32
*iv32
, u16
*iv16
);
1379 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1380 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1381 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
1382 int (*conf_tx
)(struct ieee80211_hw
*hw
, u16 queue
,
1383 const struct ieee80211_tx_queue_params
*params
);
1384 int (*get_tx_stats
)(struct ieee80211_hw
*hw
,
1385 struct ieee80211_tx_queue_stats
*stats
);
1386 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
1387 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
1388 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
1389 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
1390 enum ieee80211_ampdu_mlme_action action
,
1391 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
);
1395 * ieee80211_alloc_hw - Allocate a new hardware device
1397 * This must be called once for each hardware device. The returned pointer
1398 * must be used to refer to this device when calling other functions.
1399 * mac80211 allocates a private data area for the driver pointed to by
1400 * @priv in &struct ieee80211_hw, the size of this area is given as
1403 * @priv_data_len: length of private data
1404 * @ops: callbacks for this device
1406 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
1407 const struct ieee80211_ops
*ops
);
1410 * ieee80211_register_hw - Register hardware device
1412 * You must call this function before any other functions in
1413 * mac80211. Note that before a hardware can be registered, you
1414 * need to fill the contained wiphy's information.
1416 * @hw: the device to register as returned by ieee80211_alloc_hw()
1418 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
1420 #ifdef CONFIG_MAC80211_LEDS
1421 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
1422 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
1423 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
1424 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
1427 * ieee80211_get_tx_led_name - get name of TX LED
1429 * mac80211 creates a transmit LED trigger for each wireless hardware
1430 * that can be used to drive LEDs if your driver registers a LED device.
1431 * This function returns the name (or %NULL if not configured for LEDs)
1432 * of the trigger so you can automatically link the LED device.
1434 * @hw: the hardware to get the LED trigger name for
1436 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
1438 #ifdef CONFIG_MAC80211_LEDS
1439 return __ieee80211_get_tx_led_name(hw
);
1446 * ieee80211_get_rx_led_name - get name of RX LED
1448 * mac80211 creates a receive LED trigger for each wireless hardware
1449 * that can be used to drive LEDs if your driver registers a LED device.
1450 * This function returns the name (or %NULL if not configured for LEDs)
1451 * of the trigger so you can automatically link the LED device.
1453 * @hw: the hardware to get the LED trigger name for
1455 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
1457 #ifdef CONFIG_MAC80211_LEDS
1458 return __ieee80211_get_rx_led_name(hw
);
1465 * ieee80211_get_assoc_led_name - get name of association LED
1467 * mac80211 creates a association LED trigger for each wireless hardware
1468 * that can be used to drive LEDs if your driver registers a LED device.
1469 * This function returns the name (or %NULL if not configured for LEDs)
1470 * of the trigger so you can automatically link the LED device.
1472 * @hw: the hardware to get the LED trigger name for
1474 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
1476 #ifdef CONFIG_MAC80211_LEDS
1477 return __ieee80211_get_assoc_led_name(hw
);
1484 * ieee80211_get_radio_led_name - get name of radio LED
1486 * mac80211 creates a radio change LED trigger for each wireless hardware
1487 * that can be used to drive LEDs if your driver registers a LED device.
1488 * This function returns the name (or %NULL if not configured for LEDs)
1489 * of the trigger so you can automatically link the LED device.
1491 * @hw: the hardware to get the LED trigger name for
1493 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
1495 #ifdef CONFIG_MAC80211_LEDS
1496 return __ieee80211_get_radio_led_name(hw
);
1503 * ieee80211_unregister_hw - Unregister a hardware device
1505 * This function instructs mac80211 to free allocated resources
1506 * and unregister netdevices from the networking subsystem.
1508 * @hw: the hardware to unregister
1510 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
1513 * ieee80211_free_hw - free hardware descriptor
1515 * This function frees everything that was allocated, including the
1516 * private data for the driver. You must call ieee80211_unregister_hw()
1517 * before calling this function.
1519 * @hw: the hardware to free
1521 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
1523 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1524 void __ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1525 struct ieee80211_rx_status
*status
);
1528 * ieee80211_rx - receive frame
1530 * Use this function to hand received frames to mac80211. The receive
1531 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1532 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1534 * This function may not be called in IRQ context. Calls to this function
1535 * for a single hardware must be synchronized against each other. Calls
1536 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1539 * @hw: the hardware this frame came in on
1540 * @skb: the buffer to receive, owned by mac80211 after this call
1541 * @status: status of this frame; the status pointer need not be valid
1542 * after this function returns
1544 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1545 struct ieee80211_rx_status
*status
)
1547 __ieee80211_rx(hw
, skb
, status
);
1551 * ieee80211_rx_irqsafe - receive frame
1553 * Like ieee80211_rx() but can be called in IRQ context
1554 * (internally defers to a tasklet.)
1556 * Calls to this function and ieee80211_rx() may not be mixed for a
1559 * @hw: the hardware this frame came in on
1560 * @skb: the buffer to receive, owned by mac80211 after this call
1561 * @status: status of this frame; the status pointer need not be valid
1562 * after this function returns and is not freed by mac80211,
1563 * it is recommended that it points to a stack area
1565 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
,
1566 struct sk_buff
*skb
,
1567 struct ieee80211_rx_status
*status
);
1570 * ieee80211_tx_status - transmit status callback
1572 * Call this function for all transmitted frames after they have been
1573 * transmitted. It is permissible to not call this function for
1574 * multicast frames but this can affect statistics.
1576 * This function may not be called in IRQ context. Calls to this function
1577 * for a single hardware must be synchronized against each other. Calls
1578 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1579 * for a single hardware.
1581 * @hw: the hardware the frame was transmitted by
1582 * @skb: the frame that was transmitted, owned by mac80211 after this call
1584 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
1585 struct sk_buff
*skb
);
1588 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1590 * Like ieee80211_tx_status() but can be called in IRQ context
1591 * (internally defers to a tasklet.)
1593 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1596 * @hw: the hardware the frame was transmitted by
1597 * @skb: the frame that was transmitted, owned by mac80211 after this call
1599 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
1600 struct sk_buff
*skb
);
1603 * ieee80211_beacon_get - beacon generation function
1604 * @hw: pointer obtained from ieee80211_alloc_hw().
1605 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1607 * If the beacon frames are generated by the host system (i.e., not in
1608 * hardware/firmware), the low-level driver uses this function to receive
1609 * the next beacon frame from the 802.11 code. The low-level is responsible
1610 * for calling this function before beacon data is needed (e.g., based on
1611 * hardware interrupt). Returned skb is used only once and low-level driver
1612 * is responsible for freeing it.
1614 struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
1615 struct ieee80211_vif
*vif
);
1618 * ieee80211_rts_get - RTS frame generation function
1619 * @hw: pointer obtained from ieee80211_alloc_hw().
1620 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1621 * @frame: pointer to the frame that is going to be protected by the RTS.
1622 * @frame_len: the frame length (in octets).
1623 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1624 * @rts: The buffer where to store the RTS frame.
1626 * If the RTS frames are generated by the host system (i.e., not in
1627 * hardware/firmware), the low-level driver uses this function to receive
1628 * the next RTS frame from the 802.11 code. The low-level is responsible
1629 * for calling this function before and RTS frame is needed.
1631 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1632 const void *frame
, size_t frame_len
,
1633 const struct ieee80211_tx_info
*frame_txctl
,
1634 struct ieee80211_rts
*rts
);
1637 * ieee80211_rts_duration - Get the duration field for an RTS frame
1638 * @hw: pointer obtained from ieee80211_alloc_hw().
1639 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1640 * @frame_len: the length of the frame that is going to be protected by the RTS.
1641 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1643 * If the RTS is generated in firmware, but the host system must provide
1644 * the duration field, the low-level driver uses this function to receive
1645 * the duration field value in little-endian byteorder.
1647 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
1648 struct ieee80211_vif
*vif
, size_t frame_len
,
1649 const struct ieee80211_tx_info
*frame_txctl
);
1652 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1653 * @hw: pointer obtained from ieee80211_alloc_hw().
1654 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1655 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1656 * @frame_len: the frame length (in octets).
1657 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1658 * @cts: The buffer where to store the CTS-to-self frame.
1660 * If the CTS-to-self frames are generated by the host system (i.e., not in
1661 * hardware/firmware), the low-level driver uses this function to receive
1662 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1663 * for calling this function before and CTS-to-self frame is needed.
1665 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
1666 struct ieee80211_vif
*vif
,
1667 const void *frame
, size_t frame_len
,
1668 const struct ieee80211_tx_info
*frame_txctl
,
1669 struct ieee80211_cts
*cts
);
1672 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1673 * @hw: pointer obtained from ieee80211_alloc_hw().
1674 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1675 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1676 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1678 * If the CTS-to-self is generated in firmware, but the host system must provide
1679 * the duration field, the low-level driver uses this function to receive
1680 * the duration field value in little-endian byteorder.
1682 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
1683 struct ieee80211_vif
*vif
,
1685 const struct ieee80211_tx_info
*frame_txctl
);
1688 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1689 * @hw: pointer obtained from ieee80211_alloc_hw().
1690 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1691 * @frame_len: the length of the frame.
1692 * @rate: the rate at which the frame is going to be transmitted.
1694 * Calculate the duration field of some generic frame, given its
1695 * length and transmission rate (in 100kbps).
1697 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
1698 struct ieee80211_vif
*vif
,
1700 struct ieee80211_rate
*rate
);
1703 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1704 * @hw: pointer as obtained from ieee80211_alloc_hw().
1705 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1707 * Function for accessing buffered broadcast and multicast frames. If
1708 * hardware/firmware does not implement buffering of broadcast/multicast
1709 * frames when power saving is used, 802.11 code buffers them in the host
1710 * memory. The low-level driver uses this function to fetch next buffered
1711 * frame. In most cases, this is used when generating beacon frame. This
1712 * function returns a pointer to the next buffered skb or NULL if no more
1713 * buffered frames are available.
1715 * Note: buffered frames are returned only after DTIM beacon frame was
1716 * generated with ieee80211_beacon_get() and the low-level driver must thus
1717 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1718 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1719 * does not need to check for DTIM beacons separately and should be able to
1720 * use common code for all beacons.
1723 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
1726 * ieee80211_get_hdrlen_from_skb - get header length from data
1728 * Given an skb with a raw 802.11 header at the data pointer this function
1729 * returns the 802.11 header length in bytes (not including encryption
1730 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1731 * header the function returns 0.
1735 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
1738 * ieee80211_hdrlen - get header length in bytes from frame control
1739 * @fc: frame control field in little-endian format
1741 unsigned int ieee80211_hdrlen(__le16 fc
);
1744 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1746 * This function computes a TKIP rc4 key for an skb. It computes
1747 * a phase 1 key if needed (iv16 wraps around). This function is to
1748 * be used by drivers which can do HW encryption but need to compute
1749 * to phase 1/2 key in SW.
1751 * @keyconf: the parameter passed with the set key
1752 * @skb: the skb for which the key is needed
1754 * @key: a buffer to which the key will be written
1756 void ieee80211_get_tkip_key(struct ieee80211_key_conf
*keyconf
,
1757 struct sk_buff
*skb
,
1758 enum ieee80211_tkip_key_type type
, u8
*key
);
1760 * ieee80211_wake_queue - wake specific queue
1761 * @hw: pointer as obtained from ieee80211_alloc_hw().
1762 * @queue: queue number (counted from zero).
1764 * Drivers should use this function instead of netif_wake_queue.
1766 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
1769 * ieee80211_stop_queue - stop specific queue
1770 * @hw: pointer as obtained from ieee80211_alloc_hw().
1771 * @queue: queue number (counted from zero).
1773 * Drivers should use this function instead of netif_stop_queue.
1775 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
1778 * ieee80211_queue_stopped - test status of the queue
1779 * @hw: pointer as obtained from ieee80211_alloc_hw().
1780 * @queue: queue number (counted from zero).
1782 * Drivers should use this function instead of netif_stop_queue.
1785 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
1788 * ieee80211_stop_queues - stop all queues
1789 * @hw: pointer as obtained from ieee80211_alloc_hw().
1791 * Drivers should use this function instead of netif_stop_queue.
1793 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
1796 * ieee80211_wake_queues - wake all queues
1797 * @hw: pointer as obtained from ieee80211_alloc_hw().
1799 * Drivers should use this function instead of netif_wake_queue.
1801 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
1804 * ieee80211_scan_completed - completed hardware scan
1806 * When hardware scan offload is used (i.e. the hw_scan() callback is
1807 * assigned) this function needs to be called by the driver to notify
1808 * mac80211 that the scan finished.
1810 * @hw: the hardware that finished the scan
1812 void ieee80211_scan_completed(struct ieee80211_hw
*hw
);
1815 * ieee80211_iterate_active_interfaces - iterate active interfaces
1817 * This function iterates over the interfaces associated with a given
1818 * hardware that are currently active and calls the callback for them.
1819 * This function allows the iterator function to sleep, when the iterator
1820 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1823 * @hw: the hardware struct of which the interfaces should be iterated over
1824 * @iterator: the iterator function to call
1825 * @data: first argument of the iterator function
1827 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
1828 void (*iterator
)(void *data
, u8
*mac
,
1829 struct ieee80211_vif
*vif
),
1833 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1835 * This function iterates over the interfaces associated with a given
1836 * hardware that are currently active and calls the callback for them.
1837 * This function requires the iterator callback function to be atomic,
1838 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1840 * @hw: the hardware struct of which the interfaces should be iterated over
1841 * @iterator: the iterator function to call, cannot sleep
1842 * @data: first argument of the iterator function
1844 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
1845 void (*iterator
)(void *data
,
1847 struct ieee80211_vif
*vif
),
1851 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1852 * @hw: pointer as obtained from ieee80211_alloc_hw().
1853 * @ra: receiver address of the BA session recipient
1854 * @tid: the TID to BA on.
1856 * Return: success if addBA request was sent, failure otherwise
1858 * Although mac80211/low level driver/user space application can estimate
1859 * the need to start aggregation on a certain RA/TID, the session level
1860 * will be managed by the mac80211.
1862 int ieee80211_start_tx_ba_session(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1865 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1866 * @hw: pointer as obtained from ieee80211_alloc_hw().
1867 * @ra: receiver address of the BA session recipient.
1868 * @tid: the TID to BA on.
1870 * This function must be called by low level driver once it has
1871 * finished with preparations for the BA session.
1873 void ieee80211_start_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1876 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1877 * @hw: pointer as obtained from ieee80211_alloc_hw().
1878 * @ra: receiver address of the BA session recipient.
1879 * @tid: the TID to BA on.
1881 * This function must be called by low level driver once it has
1882 * finished with preparations for the BA session.
1883 * This version of the function is IRQ-safe.
1885 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1889 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1890 * @hw: pointer as obtained from ieee80211_alloc_hw().
1891 * @ra: receiver address of the BA session recipient
1892 * @tid: the TID to stop BA.
1893 * @initiator: if indicates initiator DELBA frame will be sent.
1895 * Return: error if no sta with matching da found, success otherwise
1897 * Although mac80211/low level driver/user space application can estimate
1898 * the need to stop aggregation on a certain RA/TID, the session level
1899 * will be managed by the mac80211.
1901 int ieee80211_stop_tx_ba_session(struct ieee80211_hw
*hw
,
1903 enum ieee80211_back_parties initiator
);
1906 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1907 * @hw: pointer as obtained from ieee80211_alloc_hw().
1908 * @ra: receiver address of the BA session recipient.
1909 * @tid: the desired TID to BA on.
1911 * This function must be called by low level driver once it has
1912 * finished with preparations for the BA session tear down.
1914 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u8 tid
);
1917 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1918 * @hw: pointer as obtained from ieee80211_alloc_hw().
1919 * @ra: receiver address of the BA session recipient.
1920 * @tid: the desired TID to BA on.
1922 * This function must be called by low level driver once it has
1923 * finished with preparations for the BA session tear down.
1924 * This version of the function is IRQ-safe.
1926 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1930 * ieee80211_find_sta - find a station
1932 * @hw: pointer as obtained from ieee80211_alloc_hw()
1933 * @addr: station's address
1935 * This function must be called under RCU lock and the
1936 * resulting pointer is only valid under RCU lock as well.
1938 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_hw
*hw
,
1942 /* Rate control API */
1945 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
1947 * @hw: The hardware the algorithm is invoked for.
1948 * @sband: The band this frame is being transmitted on.
1949 * @bss_conf: the current BSS configuration
1950 * @reported_rate: The rate control algorithm can fill this in to indicate
1951 * which rate should be reported to userspace as the current rate and
1952 * used for rate calculations in the mesh network.
1953 * @rts: whether RTS will be used for this frame because it is longer than the
1955 * @short_preamble: whether mac80211 will request short-preamble transmission
1956 * if the selected rate supports it
1957 * @max_rate_idx: user-requested maximum rate (not MCS for now)
1958 * @skb: the skb that will be transmitted, the control information in it needs
1961 struct ieee80211_tx_rate_control
{
1962 struct ieee80211_hw
*hw
;
1963 struct ieee80211_supported_band
*sband
;
1964 struct ieee80211_bss_conf
*bss_conf
;
1965 struct sk_buff
*skb
;
1966 struct ieee80211_tx_rate reported_rate
;
1967 bool rts
, short_preamble
;
1971 struct rate_control_ops
{
1972 struct module
*module
;
1974 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
1975 void (*free
)(void *priv
);
1977 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
1978 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
1979 struct ieee80211_sta
*sta
, void *priv_sta
);
1980 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
1983 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
1984 struct ieee80211_sta
*sta
, void *priv_sta
,
1985 struct sk_buff
*skb
);
1986 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
1987 struct ieee80211_tx_rate_control
*txrc
);
1989 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
1990 struct dentry
*dir
);
1991 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
1994 static inline int rate_supported(struct ieee80211_sta
*sta
,
1995 enum ieee80211_band band
,
1998 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
2002 rate_lowest_index(struct ieee80211_supported_band
*sband
,
2003 struct ieee80211_sta
*sta
)
2007 for (i
= 0; i
< sband
->n_bitrates
; i
++)
2008 if (rate_supported(sta
, sband
->band
, i
))
2011 /* warn when we cannot find a rate. */
2018 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
2019 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
2022 conf_is_ht20(struct ieee80211_conf
*conf
)
2024 return conf
->channel_type
== NL80211_CHAN_HT20
;
2028 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
2030 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
2034 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
2036 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
2040 conf_is_ht40(struct ieee80211_conf
*conf
)
2042 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
2046 conf_is_ht(struct ieee80211_conf
*conf
)
2048 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
2051 #endif /* MAC80211_H */