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: the value of radio_enabled changed
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),
550 * struct ieee80211_conf - configuration of the device
552 * This struct indicates how the driver shall configure the hardware.
554 * @flags: configuration flags defined above
556 * @radio_enabled: when zero, driver is required to switch off the radio.
557 * @beacon_int: DEPRECATED, DO NOT USE
559 * @listen_interval: listen interval in units of beacon interval
560 * @max_sleep_period: the maximum number of beacon intervals to sleep for
561 * before checking the beacon for a TIM bit (managed mode only); this
562 * value will be only achievable between DTIM frames, the hardware
563 * needs to check for the multicast traffic bit in DTIM beacons.
564 * This variable is valid only when the CONF_PS flag is set.
565 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
566 * powersave documentation below. This variable is valid only when
567 * the CONF_PS flag is set.
569 * @power_level: requested transmit power (in dBm)
571 * @channel: the channel to tune to
572 * @channel_type: the channel (HT) type
574 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
575 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
576 * but actually means the number of transmissions not the number of retries
577 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
578 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
579 * number of transmissions not the number of retries
581 struct ieee80211_conf {
582 int __deprecated beacon_int;
584 int power_level, dynamic_ps_timeout;
585 int max_sleep_period;
590 u8 long_frame_max_tx_count, short_frame_max_tx_count;
592 struct ieee80211_channel *channel;
593 enum nl80211_channel_type channel_type;
597 * struct ieee80211_vif - per-interface data
599 * Data in this structure is continually present for driver
600 * use during the life of a virtual interface.
602 * @type: type of this virtual interface
603 * @bss_conf: BSS configuration for this interface, either our own
604 * or the BSS we're associated to
605 * @drv_priv: data area for driver use, will always be aligned to
608 struct ieee80211_vif {
609 enum nl80211_iftype type;
610 struct ieee80211_bss_conf bss_conf;
612 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
615 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
617 #ifdef CONFIG_MAC80211_MESH
618 return vif->type == NL80211_IFTYPE_MESH_POINT;
624 * struct ieee80211_if_init_conf - initial configuration of an interface
626 * @vif: pointer to a driver-use per-interface structure. The pointer
627 * itself is also used for various functions including
628 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
629 * @type: one of &enum nl80211_iftype constants. Determines the type of
630 * added/removed interface.
631 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
632 * until the interface is removed (i.e. it cannot be used after
633 * remove_interface() callback was called for this interface).
635 * This structure is used in add_interface() and remove_interface()
636 * callbacks of &struct ieee80211_hw.
638 * When you allow multiple interfaces to be added to your PHY, take care
639 * that the hardware can actually handle multiple MAC addresses. However,
640 * also take care that when there's no interface left with mac_addr != %NULL
641 * you remove the MAC address from the device to avoid acknowledging packets
642 * in pure monitor mode.
644 struct ieee80211_if_init_conf {
645 enum nl80211_iftype type;
646 struct ieee80211_vif *vif;
651 * enum ieee80211_key_alg - key algorithm
652 * @ALG_WEP: WEP40 or WEP104
654 * @ALG_CCMP: CCMP (AES)
655 * @ALG_AES_CMAC: AES-128-CMAC
657 enum ieee80211_key_alg {
665 * enum ieee80211_key_flags - key flags
667 * These flags are used for communication about keys between the driver
668 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
670 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
671 * that the STA this key will be used with could be using QoS.
672 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
673 * driver to indicate that it requires IV generation for this
675 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
676 * the driver for a TKIP key if it requires Michael MIC
677 * generation in software.
678 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
679 * that the key is pairwise rather then a shared key.
680 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
681 * CCMP key if it requires CCMP encryption of management frames (MFP) to
682 * be done in software.
684 enum ieee80211_key_flags {
685 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
686 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
687 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
688 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
689 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
693 * struct ieee80211_key_conf - key information
695 * This key information is given by mac80211 to the driver by
696 * the set_key() callback in &struct ieee80211_ops.
698 * @hw_key_idx: To be set by the driver, this is the key index the driver
699 * wants to be given when a frame is transmitted and needs to be
700 * encrypted in hardware.
701 * @alg: The key algorithm.
702 * @flags: key flags, see &enum ieee80211_key_flags.
703 * @keyidx: the key index (0-3)
704 * @keylen: key material length
705 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
707 * - Temporal Encryption Key (128 bits)
708 * - Temporal Authenticator Tx MIC Key (64 bits)
709 * - Temporal Authenticator Rx MIC Key (64 bits)
710 * @icv_len: The ICV length for this key type
711 * @iv_len: The IV length for this key type
713 struct ieee80211_key_conf {
714 enum ieee80211_key_alg alg;
725 * enum set_key_cmd - key command
727 * Used with the set_key() callback in &struct ieee80211_ops, this
728 * indicates whether a key is being removed or added.
730 * @SET_KEY: a key is set
731 * @DISABLE_KEY: a key must be disabled
734 SET_KEY, DISABLE_KEY,
738 * struct ieee80211_sta - station table entry
740 * A station table entry represents a station we are possibly
741 * communicating with. Since stations are RCU-managed in
742 * mac80211, any ieee80211_sta pointer you get access to must
743 * either be protected by rcu_read_lock() explicitly or implicitly,
744 * or you must take good care to not use such a pointer after a
745 * call to your sta_notify callback that removed it.
748 * @aid: AID we assigned to the station if we're an AP
749 * @supp_rates: Bitmap of supported rates (per band)
750 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
751 * @drv_priv: data area for driver use, will always be aligned to
752 * sizeof(void *), size is determined in hw information.
754 struct ieee80211_sta {
755 u32 supp_rates[IEEE80211_NUM_BANDS];
758 struct ieee80211_sta_ht_cap ht_cap;
761 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
765 * enum sta_notify_cmd - sta notify command
767 * Used with the sta_notify() callback in &struct ieee80211_ops, this
768 * indicates addition and removal of a station to station table,
769 * or if a associated station made a power state transition.
771 * @STA_NOTIFY_ADD: a station was added to the station table
772 * @STA_NOTIFY_REMOVE: a station being removed from the station table
773 * @STA_NOTIFY_SLEEP: a station is now sleeping
774 * @STA_NOTIFY_AWAKE: a sleeping station woke up
776 enum sta_notify_cmd {
777 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
778 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
782 * enum ieee80211_tkip_key_type - get tkip key
784 * Used by drivers which need to get a tkip key for skb. Some drivers need a
785 * phase 1 key, others need a phase 2 key. A single function allows the driver
786 * to get the key, this enum indicates what type of key is required.
788 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
789 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
791 enum ieee80211_tkip_key_type {
792 IEEE80211_TKIP_P1_KEY,
793 IEEE80211_TKIP_P2_KEY,
797 * enum ieee80211_hw_flags - hardware flags
799 * These flags are used to indicate hardware capabilities to
800 * the stack. Generally, flags here should have their meaning
801 * done in a way that the simplest hardware doesn't need setting
802 * any particular flags. There are some exceptions to this rule,
803 * however, so you are advised to review these flags carefully.
805 * @IEEE80211_HW_RX_INCLUDES_FCS:
806 * Indicates that received frames passed to the stack include
807 * the FCS at the end.
809 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
810 * Some wireless LAN chipsets buffer broadcast/multicast frames
811 * for power saving stations in the hardware/firmware and others
812 * rely on the host system for such buffering. This option is used
813 * to configure the IEEE 802.11 upper layer to buffer broadcast and
814 * multicast frames when there are power saving stations so that
815 * the driver can fetch them with ieee80211_get_buffered_bc().
817 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
818 * Hardware is not capable of short slot operation on the 2.4 GHz band.
820 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
821 * Hardware is not capable of receiving frames with short preamble on
824 * @IEEE80211_HW_SIGNAL_UNSPEC:
825 * Hardware can provide signal values but we don't know its units. We
826 * expect values between 0 and @max_signal.
827 * If possible please provide dB or dBm instead.
829 * @IEEE80211_HW_SIGNAL_DBM:
830 * Hardware gives signal values in dBm, decibel difference from
831 * one milliwatt. This is the preferred method since it is standardized
832 * between different devices. @max_signal does not need to be set.
834 * @IEEE80211_HW_NOISE_DBM:
835 * Hardware can provide noise (radio interference) values in units dBm,
836 * decibel difference from one milliwatt.
838 * @IEEE80211_HW_SPECTRUM_MGMT:
839 * Hardware supports spectrum management defined in 802.11h
840 * Measurement, Channel Switch, Quieting, TPC
842 * @IEEE80211_HW_AMPDU_AGGREGATION:
843 * Hardware supports 11n A-MPDU aggregation.
845 * @IEEE80211_HW_SUPPORTS_PS:
846 * Hardware has power save support (i.e. can go to sleep).
848 * @IEEE80211_HW_PS_NULLFUNC_STACK:
849 * Hardware requires nullfunc frame handling in stack, implies
850 * stack support for dynamic PS.
852 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
853 * Hardware has support for dynamic PS.
855 * @IEEE80211_HW_MFP_CAPABLE:
856 * Hardware supports management frame protection (MFP, IEEE 802.11w).
858 * @IEEE80211_HW_BEACON_FILTER:
859 * Hardware supports dropping of irrelevant beacon frames to
860 * avoid waking up cpu.
862 enum ieee80211_hw_flags {
863 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
864 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
865 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
866 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
867 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
868 IEEE80211_HW_SIGNAL_DBM = 1<<6,
869 IEEE80211_HW_NOISE_DBM = 1<<7,
870 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
871 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
872 IEEE80211_HW_SUPPORTS_PS = 1<<10,
873 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
874 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
875 IEEE80211_HW_MFP_CAPABLE = 1<<13,
876 IEEE80211_HW_BEACON_FILTER = 1<<14,
880 * struct ieee80211_hw - hardware information and state
882 * This structure contains the configuration and hardware
883 * information for an 802.11 PHY.
885 * @wiphy: This points to the &struct wiphy allocated for this
886 * 802.11 PHY. You must fill in the @perm_addr and @dev
887 * members of this structure using SET_IEEE80211_DEV()
888 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
889 * bands (with channels, bitrates) are registered here.
891 * @conf: &struct ieee80211_conf, device configuration, don't use.
893 * @workqueue: single threaded workqueue available for driver use,
894 * allocated by mac80211 on registration and flushed when an
895 * interface is removed.
896 * NOTICE: All work performed on this workqueue must not
897 * acquire the RTNL lock.
899 * @priv: pointer to private area that was allocated for driver use
900 * along with this structure.
902 * @flags: hardware flags, see &enum ieee80211_hw_flags.
904 * @extra_tx_headroom: headroom to reserve in each transmit skb
905 * for use by the driver (e.g. for transmit headers.)
907 * @channel_change_time: time (in microseconds) it takes to change channels.
909 * @max_signal: Maximum value for signal (rssi) in RX information, used
910 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
912 * @max_listen_interval: max listen interval in units of beacon interval
915 * @queues: number of available hardware transmit queues for
916 * data packets. WMM/QoS requires at least four, these
917 * queues need to have configurable access parameters.
919 * @rate_control_algorithm: rate control algorithm for this hardware.
920 * If unset (NULL), the default algorithm will be used. Must be
921 * set before calling ieee80211_register_hw().
923 * @vif_data_size: size (in bytes) of the drv_priv data area
924 * within &struct ieee80211_vif.
925 * @sta_data_size: size (in bytes) of the drv_priv data area
926 * within &struct ieee80211_sta.
928 * @max_rates: maximum number of alternate rate retry stages
929 * @max_rate_tries: maximum number of tries for each stage
931 struct ieee80211_hw {
932 struct ieee80211_conf conf;
934 struct workqueue_struct *workqueue;
935 const char *rate_control_algorithm;
938 unsigned int extra_tx_headroom;
939 int channel_change_time;
943 u16 max_listen_interval;
950 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
952 * @wiphy: the &struct wiphy which we want to query
954 * mac80211 drivers can use this to get to their respective
955 * &struct ieee80211_hw. Drivers wishing to get to their own private
956 * structure can then access it via hw->priv. Note that mac802111 drivers should
957 * not use wiphy_priv() to try to get their private driver structure as this
958 * is already used internally by mac80211.
960 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
963 * SET_IEEE80211_DEV - set device for 802.11 hardware
965 * @hw: the &struct ieee80211_hw to set the device for
966 * @dev: the &struct device of this 802.11 device
968 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
970 set_wiphy_dev(hw->wiphy, dev);
974 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
976 * @hw: the &struct ieee80211_hw to set the MAC address for
977 * @addr: the address to set
979 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
981 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
984 static inline struct ieee80211_rate *
985 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
986 const struct ieee80211_tx_info *c)
988 if (WARN_ON(c->control.rates[0].idx < 0))
990 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
993 static inline struct ieee80211_rate *
994 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
995 const struct ieee80211_tx_info *c)
997 if (c->control.rts_cts_rate_idx < 0)
999 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1002 static inline struct ieee80211_rate *
1003 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1004 const struct ieee80211_tx_info *c, int idx)
1006 if (c->control.rates[idx + 1].idx < 0)
1008 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1012 * DOC: Hardware crypto acceleration
1014 * mac80211 is capable of taking advantage of many hardware
1015 * acceleration designs for encryption and decryption operations.
1017 * The set_key() callback in the &struct ieee80211_ops for a given
1018 * device is called to enable hardware acceleration of encryption and
1019 * decryption. The callback takes a @sta parameter that will be NULL
1020 * for default keys or keys used for transmission only, or point to
1021 * the station information for the peer for individual keys.
1022 * Multiple transmission keys with the same key index may be used when
1023 * VLANs are configured for an access point.
1025 * When transmitting, the TX control data will use the @hw_key_idx
1026 * selected by the driver by modifying the &struct ieee80211_key_conf
1027 * pointed to by the @key parameter to the set_key() function.
1029 * The set_key() call for the %SET_KEY command should return 0 if
1030 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1031 * added; if you return 0 then hw_key_idx must be assigned to the
1032 * hardware key index, you are free to use the full u8 range.
1034 * When the cmd is %DISABLE_KEY then it must succeed.
1036 * Note that it is permissible to not decrypt a frame even if a key
1037 * for it has been uploaded to hardware, the stack will not make any
1038 * decision based on whether a key has been uploaded or not but rather
1039 * based on the receive flags.
1041 * The &struct ieee80211_key_conf structure pointed to by the @key
1042 * parameter is guaranteed to be valid until another call to set_key()
1043 * removes it, but it can only be used as a cookie to differentiate
1046 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1047 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1049 * The update_tkip_key() call updates the driver with the new phase 1 key.
1050 * This happens everytime the iv16 wraps around (every 65536 packets). The
1051 * set_key() call will happen only once for each key (unless the AP did
1052 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1053 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1054 * handler is software decryption with wrap around of iv16.
1058 * DOC: Powersave support
1060 * mac80211 has support for various powersave implementations.
1062 * First, it can support hardware that handles all powersaving by
1063 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1064 * hardware flag. In that case, it will be told about the desired
1065 * powersave mode depending on the association status, and the driver
1066 * must take care of sending nullfunc frames when necessary, i.e. when
1067 * entering and leaving powersave mode. The driver is required to look at
1068 * the AID in beacons and signal to the AP that it woke up when it finds
1069 * traffic directed to it. This mode supports dynamic PS by simply
1070 * enabling/disabling PS.
1072 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1073 * flag to indicate that it can support dynamic PS mode itself (see below).
1075 * Other hardware designs cannot send nullfunc frames by themselves and also
1076 * need software support for parsing the TIM bitmap. This is also supported
1077 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1078 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1079 * required to pass up beacons. The hardware is still required to handle
1080 * waking up for multicast traffic; if it cannot the driver must handle that
1081 * as best as it can, mac80211 is too slow.
1083 * Dynamic powersave mode is an extension to normal powersave mode in which
1084 * the hardware stays awake for a user-specified period of time after sending
1085 * a frame so that reply frames need not be buffered and therefore delayed
1086 * to the next wakeup. This can either be supported by hardware, in which case
1087 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1088 * value, or by the stack if all nullfunc handling is in the stack.
1092 * DOC: Beacon filter support
1094 * Some hardware have beacon filter support to reduce host cpu wakeups
1095 * which will reduce system power consumption. It usuallly works so that
1096 * the firmware creates a checksum of the beacon but omits all constantly
1097 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1098 * beacon is forwarded to the host, otherwise it will be just dropped. That
1099 * way the host will only receive beacons where some relevant information
1100 * (for example ERP protection or WMM settings) have changed.
1102 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1103 * hardware capability. The driver needs to enable beacon filter support
1104 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1105 * power save is enabled, the stack will not check for beacon loss and the
1106 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1108 * The time (or number of beacons missed) until the firmware notifies the
1109 * driver of a beacon loss event (which in turn causes the driver to call
1110 * ieee80211_beacon_loss()) should be configurable and will be controlled
1111 * by mac80211 and the roaming algorithm in the future.
1113 * Since there may be constantly changing information elements that nothing
1114 * in the software stack cares about, we will, in the future, have mac80211
1115 * tell the driver which information elements are interesting in the sense
1116 * that we want to see changes in them. This will include
1117 * - a list of information element IDs
1118 * - a list of OUIs for the vendor information element
1120 * Ideally, the hardware would filter out any beacons without changes in the
1121 * requested elements, but if it cannot support that it may, at the expense
1122 * of some efficiency, filter out only a subset. For example, if the device
1123 * doesn't support checking for OUIs it should pass up all changes in all
1124 * vendor information elements.
1126 * Note that change, for the sake of simplification, also includes information
1127 * elements appearing or disappearing from the beacon.
1129 * Some hardware supports an "ignore list" instead, just make sure nothing
1130 * that was requested is on the ignore list, and include commonly changing
1131 * information element IDs in the ignore list, for example 11 (BSS load) and
1132 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1133 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1134 * it could also include some currently unused IDs.
1137 * In addition to these capabilities, hardware should support notifying the
1138 * host of changes in the beacon RSSI. This is relevant to implement roaming
1139 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1140 * the received data packets). This can consist in notifying the host when
1141 * the RSSI changes significantly or when it drops below or rises above
1142 * configurable thresholds. In the future these thresholds will also be
1143 * configured by mac80211 (which gets them from userspace) to implement
1144 * them as the roaming algorithm requires.
1146 * If the hardware cannot implement this, the driver should ask it to
1147 * periodically pass beacon frames to the host so that software can do the
1148 * signal strength threshold checking.
1152 * DOC: Frame filtering
1154 * mac80211 requires to see many management frames for proper
1155 * operation, and users may want to see many more frames when
1156 * in monitor mode. However, for best CPU usage and power consumption,
1157 * having as few frames as possible percolate through the stack is
1158 * desirable. Hence, the hardware should filter as much as possible.
1160 * To achieve this, mac80211 uses filter flags (see below) to tell
1161 * the driver's configure_filter() function which frames should be
1162 * passed to mac80211 and which should be filtered out.
1164 * The configure_filter() callback is invoked with the parameters
1165 * @mc_count and @mc_list for the combined multicast address list
1166 * of all virtual interfaces, @changed_flags telling which flags
1167 * were changed and @total_flags with the new flag states.
1169 * If your device has no multicast address filters your driver will
1170 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1171 * parameter to see whether multicast frames should be accepted
1174 * All unsupported flags in @total_flags must be cleared.
1175 * Hardware does not support a flag if it is incapable of _passing_
1176 * the frame to the stack. Otherwise the driver must ignore
1177 * the flag, but not clear it.
1178 * You must _only_ clear the flag (announce no support for the
1179 * flag to mac80211) if you are not able to pass the packet type
1180 * to the stack (so the hardware always filters it).
1181 * So for example, you should clear @FIF_CONTROL, if your hardware
1182 * always filters control frames. If your hardware always passes
1183 * control frames to the kernel and is incapable of filtering them,
1184 * you do _not_ clear the @FIF_CONTROL flag.
1185 * This rule applies to all other FIF flags as well.
1189 * enum ieee80211_filter_flags - hardware filter flags
1191 * These flags determine what the filter in hardware should be
1192 * programmed to let through and what should not be passed to the
1193 * stack. It is always safe to pass more frames than requested,
1194 * but this has negative impact on power consumption.
1196 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1197 * think of the BSS as your network segment and then this corresponds
1198 * to the regular ethernet device promiscuous mode.
1200 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1201 * by the user or if the hardware is not capable of filtering by
1202 * multicast address.
1204 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1205 * %RX_FLAG_FAILED_FCS_CRC for them)
1207 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1208 * the %RX_FLAG_FAILED_PLCP_CRC for them
1210 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1211 * to the hardware that it should not filter beacons or probe responses
1212 * by BSSID. Filtering them can greatly reduce the amount of processing
1213 * mac80211 needs to do and the amount of CPU wakeups, so you should
1214 * honour this flag if possible.
1216 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1217 * only those addressed to this station
1219 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1221 enum ieee80211_filter_flags {
1222 FIF_PROMISC_IN_BSS = 1<<0,
1223 FIF_ALLMULTI = 1<<1,
1225 FIF_PLCPFAIL = 1<<3,
1226 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1228 FIF_OTHER_BSS = 1<<6,
1232 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1234 * These flags are used with the ampdu_action() callback in
1235 * &struct ieee80211_ops to indicate which action is needed.
1236 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1237 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1238 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1239 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1240 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1242 enum ieee80211_ampdu_mlme_action {
1243 IEEE80211_AMPDU_RX_START,
1244 IEEE80211_AMPDU_RX_STOP,
1245 IEEE80211_AMPDU_TX_START,
1246 IEEE80211_AMPDU_TX_STOP,
1247 IEEE80211_AMPDU_TX_OPERATIONAL,
1251 * struct ieee80211_ops - callbacks from mac80211 to the driver
1253 * This structure contains various callbacks that the driver may
1254 * handle or, in some cases, must handle, for example to configure
1255 * the hardware to a new channel or to transmit a frame.
1257 * @tx: Handler that 802.11 module calls for each transmitted frame.
1258 * skb contains the buffer starting from the IEEE 802.11 header.
1259 * The low-level driver should send the frame out based on
1260 * configuration in the TX control data. This handler should,
1261 * preferably, never fail and stop queues appropriately, more
1262 * importantly, however, it must never fail for A-MPDU-queues.
1263 * This function should return NETDEV_TX_OK except in very
1265 * Must be implemented and atomic.
1267 * @start: Called before the first netdevice attached to the hardware
1268 * is enabled. This should turn on the hardware and must turn on
1269 * frame reception (for possibly enabled monitor interfaces.)
1270 * Returns negative error codes, these may be seen in userspace,
1272 * When the device is started it should not have a MAC address
1273 * to avoid acknowledging frames before a non-monitor device
1275 * Must be implemented.
1277 * @stop: Called after last netdevice attached to the hardware
1278 * is disabled. This should turn off the hardware (at least
1279 * it must turn off frame reception.)
1280 * May be called right after add_interface if that rejects
1282 * Must be implemented.
1284 * @add_interface: Called when a netdevice attached to the hardware is
1285 * enabled. Because it is not called for monitor mode devices, @start
1286 * and @stop must be implemented.
1287 * The driver should perform any initialization it needs before
1288 * the device can be enabled. The initial configuration for the
1289 * interface is given in the conf parameter.
1290 * The callback may refuse to add an interface by returning a
1291 * negative error code (which will be seen in userspace.)
1292 * Must be implemented.
1294 * @remove_interface: Notifies a driver that an interface is going down.
1295 * The @stop callback is called after this if it is the last interface
1296 * and no monitor interfaces are present.
1297 * When all interfaces are removed, the MAC address in the hardware
1298 * must be cleared so the device no longer acknowledges packets,
1299 * the mac_addr member of the conf structure is, however, set to the
1300 * MAC address of the device going away.
1301 * Hence, this callback must be implemented.
1303 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1304 * function to change hardware configuration, e.g., channel.
1305 * This function should never fail but returns a negative error code
1308 * @bss_info_changed: Handler for configuration requests related to BSS
1309 * parameters that may vary during BSS's lifespan, and may affect low
1310 * level driver (e.g. assoc/disassoc status, erp parameters).
1311 * This function should not be used if no BSS has been set, unless
1312 * for association indication. The @changed parameter indicates which
1313 * of the bss parameters has changed when a call is made.
1315 * @configure_filter: Configure the device's RX filter.
1316 * See the section "Frame filtering" for more information.
1317 * This callback must be implemented and atomic.
1319 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1320 * must be set or cleared for a given STA. Must be atomic.
1322 * @set_key: See the section "Hardware crypto acceleration"
1323 * This callback can sleep, and is only called between add_interface
1324 * and remove_interface calls, i.e. while the given virtual interface
1326 * Returns a negative error code if the key can't be added.
1328 * @update_tkip_key: See the section "Hardware crypto acceleration"
1329 * This callback will be called in the context of Rx. Called for drivers
1330 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1332 * @hw_scan: Ask the hardware to service the scan request, no need to start
1333 * the scan state machine in stack. The scan must honour the channel
1334 * configuration done by the regulatory agent in the wiphy's
1335 * registered bands. The hardware (or the driver) needs to make sure
1336 * that power save is disabled.
1337 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1338 * entire IEs after the SSID, so that drivers need not look at these
1339 * at all but just send them after the SSID -- mac80211 includes the
1340 * (extended) supported rates and HT information (where applicable).
1341 * When the scan finishes, ieee80211_scan_completed() must be called;
1342 * note that it also must be called when the scan cannot finish due to
1343 * any error unless this callback returned a negative error code.
1345 * @sw_scan_start: Notifier function that is called just before a software scan
1346 * is started. Can be NULL, if the driver doesn't need this notification.
1348 * @sw_scan_complete: Notifier function that is called just after a software scan
1349 * finished. Can be NULL, if the driver doesn't need this notification.
1351 * @get_stats: Return low-level statistics.
1352 * Returns zero if statistics are available.
1354 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1355 * callback should be provided to read the TKIP transmit IVs (both IV32
1356 * and IV16) for the given key from hardware.
1358 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1360 * @sta_notify: Notifies low level driver about addition, removal or power
1361 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1364 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1365 * bursting) for a hardware TX queue.
1366 * Returns a negative error code on failure.
1368 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1369 * to get number of currently queued packets (queue length), maximum queue
1370 * size (limit), and total number of packets sent using each TX queue
1371 * (count). The 'stats' pointer points to an array that has hw->queues
1374 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1375 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1376 * required function.
1378 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1379 * Currently, this is only used for IBSS mode debugging. Is not a
1380 * required function.
1382 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1383 * with other STAs in the IBSS. This is only used in IBSS mode. This
1384 * function is optional if the firmware/hardware takes full care of
1385 * TSF synchronization.
1387 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1388 * This is needed only for IBSS mode and the result of this function is
1389 * used to determine whether to reply to Probe Requests.
1390 * Returns non-zero if this device sent the last beacon.
1392 * @ampdu_action: Perform a certain A-MPDU action
1393 * The RA/TID combination determines the destination and TID we want
1394 * the ampdu action to be performed for. The action is defined through
1395 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1396 * is the first frame we expect to perform the action on. Notice
1397 * that TX/RX_STOP can pass NULL for this parameter.
1398 * Returns a negative error code on failure.
1400 struct ieee80211_ops {
1401 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1402 int (*start)(struct ieee80211_hw *hw);
1403 void (*stop)(struct ieee80211_hw *hw);
1404 int (*add_interface)(struct ieee80211_hw *hw,
1405 struct ieee80211_if_init_conf *conf);
1406 void (*remove_interface)(struct ieee80211_hw *hw,
1407 struct ieee80211_if_init_conf *conf);
1408 int (*config)(struct ieee80211_hw *hw, u32 changed);
1409 void (*bss_info_changed)(struct ieee80211_hw *hw,
1410 struct ieee80211_vif *vif,
1411 struct ieee80211_bss_conf *info,
1413 void (*configure_filter)(struct ieee80211_hw *hw,
1414 unsigned int changed_flags,
1415 unsigned int *total_flags,
1416 int mc_count, struct dev_addr_list *mc_list);
1417 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1419 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1420 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1421 struct ieee80211_key_conf *key);
1422 void (*update_tkip_key)(struct ieee80211_hw *hw,
1423 struct ieee80211_key_conf *conf, const u8 *address,
1424 u32 iv32, u16 *phase1key);
1425 int (*hw_scan)(struct ieee80211_hw *hw,
1426 struct cfg80211_scan_request *req);
1427 void (*sw_scan_start)(struct ieee80211_hw *hw);
1428 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1429 int (*get_stats)(struct ieee80211_hw *hw,
1430 struct ieee80211_low_level_stats *stats);
1431 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1432 u32 *iv32, u16 *iv16);
1433 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1434 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1435 enum sta_notify_cmd, struct ieee80211_sta *sta);
1436 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1437 const struct ieee80211_tx_queue_params *params);
1438 int (*get_tx_stats)(struct ieee80211_hw *hw,
1439 struct ieee80211_tx_queue_stats *stats);
1440 u64 (*get_tsf)(struct ieee80211_hw *hw);
1441 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1442 void (*reset_tsf)(struct ieee80211_hw *hw);
1443 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1444 int (*ampdu_action)(struct ieee80211_hw *hw,
1445 enum ieee80211_ampdu_mlme_action action,
1446 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1450 * ieee80211_alloc_hw - Allocate a new hardware device
1452 * This must be called once for each hardware device. The returned pointer
1453 * must be used to refer to this device when calling other functions.
1454 * mac80211 allocates a private data area for the driver pointed to by
1455 * @priv in &struct ieee80211_hw, the size of this area is given as
1458 * @priv_data_len: length of private data
1459 * @ops: callbacks for this device
1461 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1462 const struct ieee80211_ops *ops);
1465 * ieee80211_register_hw - Register hardware device
1467 * You must call this function before any other functions in
1468 * mac80211. Note that before a hardware can be registered, you
1469 * need to fill the contained wiphy's information.
1471 * @hw: the device to register as returned by ieee80211_alloc_hw()
1473 int ieee80211_register_hw(struct ieee80211_hw *hw);
1475 #ifdef CONFIG_MAC80211_LEDS
1476 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1477 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1478 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1479 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1482 * ieee80211_get_tx_led_name - get name of TX LED
1484 * mac80211 creates a transmit LED trigger for each wireless hardware
1485 * that can be used to drive LEDs if your driver registers a LED device.
1486 * This function returns the name (or %NULL if not configured for LEDs)
1487 * of the trigger so you can automatically link the LED device.
1489 * @hw: the hardware to get the LED trigger name for
1491 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1493 #ifdef CONFIG_MAC80211_LEDS
1494 return __ieee80211_get_tx_led_name(hw);
1501 * ieee80211_get_rx_led_name - get name of RX LED
1503 * mac80211 creates a receive LED trigger for each wireless hardware
1504 * that can be used to drive LEDs if your driver registers a LED device.
1505 * This function returns the name (or %NULL if not configured for LEDs)
1506 * of the trigger so you can automatically link the LED device.
1508 * @hw: the hardware to get the LED trigger name for
1510 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1512 #ifdef CONFIG_MAC80211_LEDS
1513 return __ieee80211_get_rx_led_name(hw);
1520 * ieee80211_get_assoc_led_name - get name of association LED
1522 * mac80211 creates a association LED trigger for each wireless hardware
1523 * that can be used to drive LEDs if your driver registers a LED device.
1524 * This function returns the name (or %NULL if not configured for LEDs)
1525 * of the trigger so you can automatically link the LED device.
1527 * @hw: the hardware to get the LED trigger name for
1529 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1531 #ifdef CONFIG_MAC80211_LEDS
1532 return __ieee80211_get_assoc_led_name(hw);
1539 * ieee80211_get_radio_led_name - get name of radio LED
1541 * mac80211 creates a radio change LED trigger for each wireless hardware
1542 * that can be used to drive LEDs if your driver registers a LED device.
1543 * This function returns the name (or %NULL if not configured for LEDs)
1544 * of the trigger so you can automatically link the LED device.
1546 * @hw: the hardware to get the LED trigger name for
1548 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1550 #ifdef CONFIG_MAC80211_LEDS
1551 return __ieee80211_get_radio_led_name(hw);
1558 * ieee80211_unregister_hw - Unregister a hardware device
1560 * This function instructs mac80211 to free allocated resources
1561 * and unregister netdevices from the networking subsystem.
1563 * @hw: the hardware to unregister
1565 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1568 * ieee80211_free_hw - free hardware descriptor
1570 * This function frees everything that was allocated, including the
1571 * private data for the driver. You must call ieee80211_unregister_hw()
1572 * before calling this function.
1574 * @hw: the hardware to free
1576 void ieee80211_free_hw(struct ieee80211_hw *hw);
1579 * ieee80211_restart_hw - restart hardware completely
1581 * Call this function when the hardware was restarted for some reason
1582 * (hardware error, ...) and the driver is unable to restore its state
1583 * by itself. mac80211 assumes that at this point the driver/hardware
1584 * is completely uninitialised and stopped, it starts the process by
1585 * calling the ->start() operation. The driver will need to reset all
1586 * internal state that it has prior to calling this function.
1588 * @hw: the hardware to restart
1590 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1592 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1593 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1594 struct ieee80211_rx_status *status);
1597 * ieee80211_rx - receive frame
1599 * Use this function to hand received frames to mac80211. The receive
1600 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1601 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1603 * This function may not be called in IRQ context. Calls to this function
1604 * for a single hardware must be synchronized against each other. Calls
1605 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1608 * @hw: the hardware this frame came in on
1609 * @skb: the buffer to receive, owned by mac80211 after this call
1610 * @status: status of this frame; the status pointer need not be valid
1611 * after this function returns
1613 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1614 struct ieee80211_rx_status *status)
1616 __ieee80211_rx(hw, skb, status);
1620 * ieee80211_rx_irqsafe - receive frame
1622 * Like ieee80211_rx() but can be called in IRQ context
1623 * (internally defers to a tasklet.)
1625 * Calls to this function and ieee80211_rx() may not be mixed for a
1628 * @hw: the hardware this frame came in on
1629 * @skb: the buffer to receive, owned by mac80211 after this call
1630 * @status: status of this frame; the status pointer need not be valid
1631 * after this function returns and is not freed by mac80211,
1632 * it is recommended that it points to a stack area
1634 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1635 struct sk_buff *skb,
1636 struct ieee80211_rx_status *status);
1639 * ieee80211_tx_status - transmit status callback
1641 * Call this function for all transmitted frames after they have been
1642 * transmitted. It is permissible to not call this function for
1643 * multicast frames but this can affect statistics.
1645 * This function may not be called in IRQ context. Calls to this function
1646 * for a single hardware must be synchronized against each other. Calls
1647 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1648 * for a single hardware.
1650 * @hw: the hardware the frame was transmitted by
1651 * @skb: the frame that was transmitted, owned by mac80211 after this call
1653 void ieee80211_tx_status(struct ieee80211_hw *hw,
1654 struct sk_buff *skb);
1657 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1659 * Like ieee80211_tx_status() but can be called in IRQ context
1660 * (internally defers to a tasklet.)
1662 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1665 * @hw: the hardware the frame was transmitted by
1666 * @skb: the frame that was transmitted, owned by mac80211 after this call
1668 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1669 struct sk_buff *skb);
1672 * ieee80211_beacon_get - beacon generation function
1673 * @hw: pointer obtained from ieee80211_alloc_hw().
1674 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1676 * If the beacon frames are generated by the host system (i.e., not in
1677 * hardware/firmware), the low-level driver uses this function to receive
1678 * the next beacon frame from the 802.11 code. The low-level is responsible
1679 * for calling this function before beacon data is needed (e.g., based on
1680 * hardware interrupt). Returned skb is used only once and low-level driver
1681 * is responsible for freeing it.
1683 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1684 struct ieee80211_vif *vif);
1687 * ieee80211_rts_get - RTS frame generation function
1688 * @hw: pointer obtained from ieee80211_alloc_hw().
1689 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1690 * @frame: pointer to the frame that is going to be protected by the RTS.
1691 * @frame_len: the frame length (in octets).
1692 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1693 * @rts: The buffer where to store the RTS frame.
1695 * If the RTS frames are generated by the host system (i.e., not in
1696 * hardware/firmware), the low-level driver uses this function to receive
1697 * the next RTS frame from the 802.11 code. The low-level is responsible
1698 * for calling this function before and RTS frame is needed.
1700 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1701 const void *frame, size_t frame_len,
1702 const struct ieee80211_tx_info *frame_txctl,
1703 struct ieee80211_rts *rts);
1706 * ieee80211_rts_duration - Get the duration field for an RTS frame
1707 * @hw: pointer obtained from ieee80211_alloc_hw().
1708 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1709 * @frame_len: the length of the frame that is going to be protected by the RTS.
1710 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1712 * If the RTS is generated in firmware, but the host system must provide
1713 * the duration field, the low-level driver uses this function to receive
1714 * the duration field value in little-endian byteorder.
1716 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1717 struct ieee80211_vif *vif, size_t frame_len,
1718 const struct ieee80211_tx_info *frame_txctl);
1721 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1722 * @hw: pointer obtained from ieee80211_alloc_hw().
1723 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1724 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1725 * @frame_len: the frame length (in octets).
1726 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1727 * @cts: The buffer where to store the CTS-to-self frame.
1729 * If the CTS-to-self frames are generated by the host system (i.e., not in
1730 * hardware/firmware), the low-level driver uses this function to receive
1731 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1732 * for calling this function before and CTS-to-self frame is needed.
1734 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1735 struct ieee80211_vif *vif,
1736 const void *frame, size_t frame_len,
1737 const struct ieee80211_tx_info *frame_txctl,
1738 struct ieee80211_cts *cts);
1741 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1742 * @hw: pointer obtained from ieee80211_alloc_hw().
1743 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1744 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1745 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1747 * If the CTS-to-self is generated in firmware, but the host system must provide
1748 * the duration field, the low-level driver uses this function to receive
1749 * the duration field value in little-endian byteorder.
1751 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1752 struct ieee80211_vif *vif,
1754 const struct ieee80211_tx_info *frame_txctl);
1757 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1758 * @hw: pointer obtained from ieee80211_alloc_hw().
1759 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1760 * @frame_len: the length of the frame.
1761 * @rate: the rate at which the frame is going to be transmitted.
1763 * Calculate the duration field of some generic frame, given its
1764 * length and transmission rate (in 100kbps).
1766 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1767 struct ieee80211_vif *vif,
1769 struct ieee80211_rate *rate);
1772 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1773 * @hw: pointer as obtained from ieee80211_alloc_hw().
1774 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1776 * Function for accessing buffered broadcast and multicast frames. If
1777 * hardware/firmware does not implement buffering of broadcast/multicast
1778 * frames when power saving is used, 802.11 code buffers them in the host
1779 * memory. The low-level driver uses this function to fetch next buffered
1780 * frame. In most cases, this is used when generating beacon frame. This
1781 * function returns a pointer to the next buffered skb or NULL if no more
1782 * buffered frames are available.
1784 * Note: buffered frames are returned only after DTIM beacon frame was
1785 * generated with ieee80211_beacon_get() and the low-level driver must thus
1786 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1787 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1788 * does not need to check for DTIM beacons separately and should be able to
1789 * use common code for all beacons.
1792 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1795 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1797 * This function computes a TKIP rc4 key for an skb. It computes
1798 * a phase 1 key if needed (iv16 wraps around). This function is to
1799 * be used by drivers which can do HW encryption but need to compute
1800 * to phase 1/2 key in SW.
1802 * @keyconf: the parameter passed with the set key
1803 * @skb: the skb for which the key is needed
1805 * @key: a buffer to which the key will be written
1807 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1808 struct sk_buff *skb,
1809 enum ieee80211_tkip_key_type type, u8 *key);
1811 * ieee80211_wake_queue - wake specific queue
1812 * @hw: pointer as obtained from ieee80211_alloc_hw().
1813 * @queue: queue number (counted from zero).
1815 * Drivers should use this function instead of netif_wake_queue.
1817 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1820 * ieee80211_stop_queue - stop specific queue
1821 * @hw: pointer as obtained from ieee80211_alloc_hw().
1822 * @queue: queue number (counted from zero).
1824 * Drivers should use this function instead of netif_stop_queue.
1826 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1829 * ieee80211_queue_stopped - test status of the queue
1830 * @hw: pointer as obtained from ieee80211_alloc_hw().
1831 * @queue: queue number (counted from zero).
1833 * Drivers should use this function instead of netif_stop_queue.
1836 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1839 * ieee80211_stop_queues - stop all queues
1840 * @hw: pointer as obtained from ieee80211_alloc_hw().
1842 * Drivers should use this function instead of netif_stop_queue.
1844 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1847 * ieee80211_wake_queues - wake all queues
1848 * @hw: pointer as obtained from ieee80211_alloc_hw().
1850 * Drivers should use this function instead of netif_wake_queue.
1852 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1855 * ieee80211_scan_completed - completed hardware scan
1857 * When hardware scan offload is used (i.e. the hw_scan() callback is
1858 * assigned) this function needs to be called by the driver to notify
1859 * mac80211 that the scan finished.
1861 * @hw: the hardware that finished the scan
1862 * @aborted: set to true if scan was aborted
1864 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
1867 * ieee80211_iterate_active_interfaces - iterate active interfaces
1869 * This function iterates over the interfaces associated with a given
1870 * hardware that are currently active and calls the callback for them.
1871 * This function allows the iterator function to sleep, when the iterator
1872 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1875 * @hw: the hardware struct of which the interfaces should be iterated over
1876 * @iterator: the iterator function to call
1877 * @data: first argument of the iterator function
1879 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1880 void (*iterator)(void *data, u8 *mac,
1881 struct ieee80211_vif *vif),
1885 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1887 * This function iterates over the interfaces associated with a given
1888 * hardware that are currently active and calls the callback for them.
1889 * This function requires the iterator callback function to be atomic,
1890 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1892 * @hw: the hardware struct of which the interfaces should be iterated over
1893 * @iterator: the iterator function to call, cannot sleep
1894 * @data: first argument of the iterator function
1896 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1897 void (*iterator)(void *data,
1899 struct ieee80211_vif *vif),
1903 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1904 * @hw: pointer as obtained from ieee80211_alloc_hw().
1905 * @ra: receiver address of the BA session recipient
1906 * @tid: the TID to BA on.
1908 * Return: success if addBA request was sent, failure otherwise
1910 * Although mac80211/low level driver/user space application can estimate
1911 * the need to start aggregation on a certain RA/TID, the session level
1912 * will be managed by the mac80211.
1914 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1917 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
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 * This function must be called by low level driver once it has
1923 * finished with preparations for the BA session.
1925 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1928 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1929 * @hw: pointer as obtained from ieee80211_alloc_hw().
1930 * @ra: receiver address of the BA session recipient.
1931 * @tid: the TID to BA on.
1933 * This function must be called by low level driver once it has
1934 * finished with preparations for the BA session.
1935 * This version of the function is IRQ-safe.
1937 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1941 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1942 * @hw: pointer as obtained from ieee80211_alloc_hw().
1943 * @ra: receiver address of the BA session recipient
1944 * @tid: the TID to stop BA.
1945 * @initiator: if indicates initiator DELBA frame will be sent.
1947 * Return: error if no sta with matching da found, success otherwise
1949 * Although mac80211/low level driver/user space application can estimate
1950 * the need to stop aggregation on a certain RA/TID, the session level
1951 * will be managed by the mac80211.
1953 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1955 enum ieee80211_back_parties initiator);
1958 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1959 * @hw: pointer as obtained from ieee80211_alloc_hw().
1960 * @ra: receiver address of the BA session recipient.
1961 * @tid: the desired TID to BA on.
1963 * This function must be called by low level driver once it has
1964 * finished with preparations for the BA session tear down.
1966 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1969 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1970 * @hw: pointer as obtained from ieee80211_alloc_hw().
1971 * @ra: receiver address of the BA session recipient.
1972 * @tid: the desired TID to BA on.
1974 * This function must be called by low level driver once it has
1975 * finished with preparations for the BA session tear down.
1976 * This version of the function is IRQ-safe.
1978 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1982 * ieee80211_find_sta - find a station
1984 * @hw: pointer as obtained from ieee80211_alloc_hw()
1985 * @addr: station's address
1987 * This function must be called under RCU lock and the
1988 * resulting pointer is only valid under RCU lock as well.
1990 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1994 * ieee80211_beacon_loss - inform hardware does not receive beacons
1996 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1998 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
1999 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2000 * hardware is not receiving beacons with this function.
2002 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2004 /* Rate control API */
2007 * enum rate_control_changed - flags to indicate which parameter changed
2009 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2010 * changed, rate control algorithm can update its internal state if needed.
2012 enum rate_control_changed {
2013 IEEE80211_RC_HT_CHANGED = BIT(0)
2017 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2019 * @hw: The hardware the algorithm is invoked for.
2020 * @sband: The band this frame is being transmitted on.
2021 * @bss_conf: the current BSS configuration
2022 * @reported_rate: The rate control algorithm can fill this in to indicate
2023 * which rate should be reported to userspace as the current rate and
2024 * used for rate calculations in the mesh network.
2025 * @rts: whether RTS will be used for this frame because it is longer than the
2027 * @short_preamble: whether mac80211 will request short-preamble transmission
2028 * if the selected rate supports it
2029 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2030 * @skb: the skb that will be transmitted, the control information in it needs
2033 struct ieee80211_tx_rate_control {
2034 struct ieee80211_hw *hw;
2035 struct ieee80211_supported_band *sband;
2036 struct ieee80211_bss_conf *bss_conf;
2037 struct sk_buff *skb;
2038 struct ieee80211_tx_rate reported_rate;
2039 bool rts, short_preamble;
2043 struct rate_control_ops {
2044 struct module *module;
2046 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2047 void (*free)(void *priv);
2049 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2050 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2051 struct ieee80211_sta *sta, void *priv_sta);
2052 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2053 struct ieee80211_sta *sta,
2054 void *priv_sta, u32 changed);
2055 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2058 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2059 struct ieee80211_sta *sta, void *priv_sta,
2060 struct sk_buff *skb);
2061 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2062 struct ieee80211_tx_rate_control *txrc);
2064 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2065 struct dentry *dir);
2066 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2069 static inline int rate_supported(struct ieee80211_sta *sta,
2070 enum ieee80211_band band,
2073 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2077 rate_lowest_index(struct ieee80211_supported_band *sband,
2078 struct ieee80211_sta *sta)
2082 for (i = 0; i < sband->n_bitrates; i++)
2083 if (rate_supported(sta, sband->band, i))
2086 /* warn when we cannot find a rate. */
2093 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2094 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2097 conf_is_ht20(struct ieee80211_conf *conf)
2099 return conf->channel_type == NL80211_CHAN_HT20;
2103 conf_is_ht40_minus(struct ieee80211_conf *conf)
2105 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2109 conf_is_ht40_plus(struct ieee80211_conf *conf)
2111 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2115 conf_is_ht40(struct ieee80211_conf *conf)
2117 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2121 conf_is_ht(struct ieee80211_conf *conf)
2123 return conf->channel_type != NL80211_CHAN_NO_HT;
2126 #endif /* MAC80211_H */