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.
97 enum ieee80211_max_queues {
98 IEEE80211_MAX_QUEUES = 4,
102 * struct ieee80211_tx_queue_params - transmit queue configuration
104 * The information provided in this structure is required for QoS
105 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
107 * @aifs: arbitration interframe space [0..255]
108 * @cw_min: minimum contention window [a value of the form
109 * 2^n-1 in the range 1..32767]
110 * @cw_max: maximum contention window [like @cw_min]
111 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
113 struct ieee80211_tx_queue_params {
121 * struct ieee80211_tx_queue_stats - transmit queue statistics
123 * @len: number of packets in queue
124 * @limit: queue length limit
125 * @count: number of frames sent
127 struct ieee80211_tx_queue_stats {
133 struct ieee80211_low_level_stats {
134 unsigned int dot11ACKFailureCount;
135 unsigned int dot11RTSFailureCount;
136 unsigned int dot11FCSErrorCount;
137 unsigned int dot11RTSSuccessCount;
141 * enum ieee80211_bss_change - BSS change notification flags
143 * These flags are used with the bss_info_changed() callback
144 * to indicate which BSS parameter changed.
146 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
147 * also implies a change in the AID.
148 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
149 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
150 * @BSS_CHANGED_ERP_SLOT: slot timing changed
151 * @BSS_CHANGED_HT: 802.11n parameters changed
152 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
154 enum ieee80211_bss_change {
155 BSS_CHANGED_ASSOC = 1<<0,
156 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
157 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
158 BSS_CHANGED_ERP_SLOT = 1<<3,
159 BSS_CHANGED_HT = 1<<4,
160 BSS_CHANGED_BASIC_RATES = 1<<5,
164 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
165 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
167 struct ieee80211_bss_ht_conf {
172 * struct ieee80211_bss_conf - holds the BSS's changing parameters
174 * This structure keeps information about a BSS (and an association
175 * to that BSS) that can change during the lifetime of the BSS.
177 * @assoc: association status
178 * @aid: association ID number, valid only when @assoc is true
179 * @use_cts_prot: use CTS protection
180 * @use_short_preamble: use 802.11b short preamble;
181 * if the hardware cannot handle this it must set the
182 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
183 * @use_short_slot: use short slot time (only relevant for ERP);
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
186 * @dtim_period: num of beacons before the next DTIM, for PSM
187 * @timestamp: beacon timestamp
188 * @beacon_int: beacon interval
189 * @assoc_capability: capabilities taken from assoc resp
190 * @ht: BSS's HT configuration
191 * @basic_rates: bitmap of basic rates, each bit stands for an
192 * index into the rate table configured by the driver in
195 struct ieee80211_bss_conf {
196 /* association related data */
199 /* erp related data */
201 bool use_short_preamble;
205 u16 assoc_capability;
208 struct ieee80211_bss_ht_conf ht;
212 * enum mac80211_tx_control_flags - flags to describe transmission information/status
214 * These flags are used with the @flags member of &ieee80211_tx_info.
216 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
217 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
218 * number to this frame, taking care of not overwriting the fragment
219 * number and increasing the sequence number only when the
220 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
221 * assign sequence numbers to QoS-data frames but cannot do so correctly
222 * for non-QoS-data and management frames because beacons need them from
223 * that counter as well and mac80211 cannot guarantee proper sequencing.
224 * If this flag is set, the driver should instruct the hardware to
225 * assign a sequence number to the frame or assign one itself. Cf. IEEE
226 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
227 * beacons and always be clear for frames without a sequence number field.
228 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
229 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
231 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
232 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
233 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
234 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
235 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
236 * because the destination STA was in powersave mode.
237 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
238 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
239 * is for the whole aggregation.
240 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
241 * so consider using block ack request (BAR).
242 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
243 * set by rate control algorithms to indicate probe rate, will
244 * be cleared for fragmented frames (except on the last fragment)
245 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
246 * set this flag in the driver; indicates that the rate control
247 * algorithm was used and should be notified of TX status
248 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
249 * used to indicate that a pending frame requires TX processing before
250 * it can be sent out.
252 enum mac80211_tx_control_flags {
253 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
254 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
255 IEEE80211_TX_CTL_NO_ACK = BIT(2),
256 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
257 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
258 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
259 IEEE80211_TX_CTL_AMPDU = BIT(6),
260 IEEE80211_TX_CTL_INJECTED = BIT(7),
261 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
262 IEEE80211_TX_STAT_ACK = BIT(9),
263 IEEE80211_TX_STAT_AMPDU = BIT(10),
264 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
265 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
266 IEEE80211_TX_INTFL_RCALGO = BIT(13),
267 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
271 * enum mac80211_rate_control_flags - per-rate flags set by the
272 * Rate Control algorithm.
274 * These flags are set by the Rate control algorithm for each rate during tx,
275 * in the @flags member of struct ieee80211_tx_rate.
277 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
278 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
279 * This is set if the current BSS requires ERP protection.
280 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
281 * @IEEE80211_TX_RC_MCS: HT rate.
282 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
284 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
285 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
286 * adjacent 20 MHz channels, if the current channel type is
287 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
288 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
290 enum mac80211_rate_control_flags {
291 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
292 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
293 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
295 /* rate index is an MCS rate number instead of an index */
296 IEEE80211_TX_RC_MCS = BIT(3),
297 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
298 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
299 IEEE80211_TX_RC_DUP_DATA = BIT(6),
300 IEEE80211_TX_RC_SHORT_GI = BIT(7),
304 /* there are 40 bytes if you don't need the rateset to be kept */
305 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
307 /* if you do need the rateset, then you have less space */
308 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
310 /* maximum number of rate stages */
311 #define IEEE80211_TX_MAX_RATES 5
314 * struct ieee80211_tx_rate - rate selection/status
316 * @idx: rate index to attempt to send with
317 * @flags: rate control flags (&enum mac80211_rate_control_flags)
318 * @count: number of tries in this rate before going to the next rate
320 * A value of -1 for @idx indicates an invalid rate and, if used
321 * in an array of retry rates, that no more rates should be tried.
323 * When used for transmit status reporting, the driver should
324 * always report the rate along with the flags it used.
326 struct ieee80211_tx_rate {
330 } __attribute__((packed));
333 * struct ieee80211_tx_info - skb transmit information
335 * This structure is placed in skb->cb for three uses:
336 * (1) mac80211 TX control - mac80211 tells the driver what to do
337 * (2) driver internal use (if applicable)
338 * (3) TX status information - driver tells mac80211 what happened
340 * The TX control's sta pointer is only valid during the ->tx call,
343 * @flags: transmit info flags, defined above
344 * @band: the band to transmit on (use for checking for races)
345 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
346 * @pad: padding, ignore
347 * @control: union for control data
348 * @status: union for status data
349 * @driver_data: array of driver_data pointers
350 * @ampdu_ack_len: number of aggregated frames.
351 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
352 * @ampdu_ack_map: block ack bit map for the aggregation.
353 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
354 * @ack_signal: signal strength of the ACK frame
356 struct ieee80211_tx_info {
357 /* common information */
371 struct ieee80211_tx_rate rates[
372 IEEE80211_TX_MAX_RATES];
375 /* only needed before rate control */
376 unsigned long jiffies;
378 /* NB: vif can be NULL for injected frames */
379 struct ieee80211_vif *vif;
380 struct ieee80211_key_conf *hw_key;
381 struct ieee80211_sta *sta;
384 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
391 struct ieee80211_tx_rate driver_rates[
392 IEEE80211_TX_MAX_RATES];
393 void *rate_driver_data[
394 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
397 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
401 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
403 return (struct ieee80211_tx_info *)skb->cb;
407 * ieee80211_tx_info_clear_status - clear TX status
409 * @info: The &struct ieee80211_tx_info to be cleared.
411 * When the driver passes an skb back to mac80211, it must report
412 * a number of things in TX status. This function clears everything
413 * in the TX status but the rate control information (it does clear
414 * the count since you need to fill that in anyway).
416 * NOTE: You can only use this function if you do NOT use
417 * info->driver_data! Use info->rate_driver_data
418 * instead if you need only the less space that allows.
421 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
425 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
426 offsetof(struct ieee80211_tx_info, control.rates));
427 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
428 offsetof(struct ieee80211_tx_info, driver_rates));
429 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
430 /* clear the rate counts */
431 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
432 info->status.rates[i].count = 0;
435 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
436 memset(&info->status.ampdu_ack_len, 0,
437 sizeof(struct ieee80211_tx_info) -
438 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
443 * enum mac80211_rx_flags - receive flags
445 * These flags are used with the @flag member of &struct ieee80211_rx_status.
446 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
447 * Use together with %RX_FLAG_MMIC_STRIPPED.
448 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
449 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
450 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
451 * verification has been done by the hardware.
452 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
453 * If this flag is set, the stack cannot do any replay detection
454 * hence the driver or hardware will have to do that.
455 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
457 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
459 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
460 * is valid. This is useful in monitor mode and necessary for beacon frames
461 * to enable IBSS merging.
462 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
463 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
464 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
465 * @RX_FLAG_SHORT_GI: Short guard interval was used
467 enum mac80211_rx_flags {
468 RX_FLAG_MMIC_ERROR = 1<<0,
469 RX_FLAG_DECRYPTED = 1<<1,
470 RX_FLAG_RADIOTAP = 1<<2,
471 RX_FLAG_MMIC_STRIPPED = 1<<3,
472 RX_FLAG_IV_STRIPPED = 1<<4,
473 RX_FLAG_FAILED_FCS_CRC = 1<<5,
474 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
476 RX_FLAG_SHORTPRE = 1<<8,
478 RX_FLAG_40MHZ = 1<<10,
479 RX_FLAG_SHORT_GI = 1<<11,
483 * struct ieee80211_rx_status - receive status
485 * The low-level driver should provide this information (the subset
486 * supported by hardware) to the 802.11 code with each received
489 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
490 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
491 * @band: the active band when this frame was received
492 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
493 * @signal: signal strength when receiving this frame, either in dBm, in dB or
494 * unspecified depending on the hardware capabilities flags
495 * @IEEE80211_HW_SIGNAL_*
496 * @noise: noise when receiving this frame, in dBm.
497 * @qual: overall signal quality indication, in percent (0-100).
498 * @antenna: antenna used
499 * @rate_idx: index of data rate into band's supported rates or MCS index if
500 * HT rates are use (RX_FLAG_HT)
503 struct ieee80211_rx_status {
505 enum ieee80211_band band;
516 * enum ieee80211_conf_flags - configuration flags
518 * Flags to define PHY configuration options
520 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
521 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
523 enum ieee80211_conf_flags {
524 IEEE80211_CONF_RADIOTAP = (1<<0),
525 IEEE80211_CONF_PS = (1<<1),
530 * enum ieee80211_conf_changed - denotes which configuration changed
532 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
533 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
534 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
535 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
536 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
537 * @IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT: the dynamic PS timeout changed
538 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
539 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
540 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
542 enum ieee80211_conf_changed {
543 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
544 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1),
545 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
546 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
547 IEEE80211_CONF_CHANGE_PS = BIT(4),
548 IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT = BIT(5),
549 IEEE80211_CONF_CHANGE_POWER = BIT(6),
550 IEEE80211_CONF_CHANGE_CHANNEL = BIT(7),
551 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(8),
555 * struct ieee80211_conf - configuration of the device
557 * This struct indicates how the driver shall configure the hardware.
559 * @radio_enabled: when zero, driver is required to switch off the radio.
560 * @beacon_int: beacon interval (TODO make interface config)
561 * @listen_interval: listen interval in units of beacon interval
562 * @flags: configuration flags defined above
563 * @power_level: requested transmit power (in dBm)
564 * @dynamic_ps_timeout: dynamic powersave timeout (in ms)
565 * @channel: the channel to tune to
566 * @channel_type: the channel (HT) type
567 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
568 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
569 * but actually means the number of transmissions not the number of retries
570 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
571 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
572 * number of transmissions not the number of retries
574 struct ieee80211_conf {
577 int power_level, dynamic_ps_timeout;
582 u8 long_frame_max_tx_count, short_frame_max_tx_count;
584 struct ieee80211_channel *channel;
585 enum nl80211_channel_type channel_type;
589 * struct ieee80211_vif - per-interface data
591 * Data in this structure is continually present for driver
592 * use during the life of a virtual interface.
594 * @type: type of this virtual interface
595 * @bss_conf: BSS configuration for this interface, either our own
596 * or the BSS we're associated to
597 * @drv_priv: data area for driver use, will always be aligned to
600 struct ieee80211_vif {
601 enum nl80211_iftype type;
602 struct ieee80211_bss_conf bss_conf;
604 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
607 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
609 #ifdef CONFIG_MAC80211_MESH
610 return vif->type == NL80211_IFTYPE_MESH_POINT;
616 * struct ieee80211_if_init_conf - initial configuration of an interface
618 * @vif: pointer to a driver-use per-interface structure. The pointer
619 * itself is also used for various functions including
620 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
621 * @type: one of &enum nl80211_iftype constants. Determines the type of
622 * added/removed interface.
623 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
624 * until the interface is removed (i.e. it cannot be used after
625 * remove_interface() callback was called for this interface).
627 * This structure is used in add_interface() and remove_interface()
628 * callbacks of &struct ieee80211_hw.
630 * When you allow multiple interfaces to be added to your PHY, take care
631 * that the hardware can actually handle multiple MAC addresses. However,
632 * also take care that when there's no interface left with mac_addr != %NULL
633 * you remove the MAC address from the device to avoid acknowledging packets
634 * in pure monitor mode.
636 struct ieee80211_if_init_conf {
637 enum nl80211_iftype type;
638 struct ieee80211_vif *vif;
643 * enum ieee80211_if_conf_change - interface config change flags
645 * @IEEE80211_IFCC_BSSID: The BSSID changed.
646 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
647 * (currently AP and MESH only), use ieee80211_beacon_get().
648 * @IEEE80211_IFCC_BEACON_ENABLED: The enable_beacon value changed.
650 enum ieee80211_if_conf_change {
651 IEEE80211_IFCC_BSSID = BIT(0),
652 IEEE80211_IFCC_BEACON = BIT(1),
653 IEEE80211_IFCC_BEACON_ENABLED = BIT(2),
657 * struct ieee80211_if_conf - configuration of an interface
659 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
660 * @bssid: BSSID of the network we are associated to/creating.
661 * @enable_beacon: Indicates whether beacons can be sent.
662 * This is valid only for AP/IBSS/MESH modes.
664 * This structure is passed to the config_interface() callback of
665 * &struct ieee80211_hw.
667 struct ieee80211_if_conf {
674 * enum ieee80211_key_alg - key algorithm
675 * @ALG_WEP: WEP40 or WEP104
677 * @ALG_CCMP: CCMP (AES)
678 * @ALG_AES_CMAC: AES-128-CMAC
680 enum ieee80211_key_alg {
688 * enum ieee80211_key_len - key length
689 * @LEN_WEP40: WEP 5-byte long key
690 * @LEN_WEP104: WEP 13-byte long key
692 enum ieee80211_key_len {
698 * enum ieee80211_key_flags - key flags
700 * These flags are used for communication about keys between the driver
701 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
703 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
704 * that the STA this key will be used with could be using QoS.
705 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
706 * driver to indicate that it requires IV generation for this
708 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
709 * the driver for a TKIP key if it requires Michael MIC
710 * generation in software.
711 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
712 * that the key is pairwise rather then a shared key.
713 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
714 * CCMP key if it requires CCMP encryption of management frames (MFP) to
715 * be done in software.
717 enum ieee80211_key_flags {
718 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
719 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
720 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
721 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
722 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
726 * struct ieee80211_key_conf - key information
728 * This key information is given by mac80211 to the driver by
729 * the set_key() callback in &struct ieee80211_ops.
731 * @hw_key_idx: To be set by the driver, this is the key index the driver
732 * wants to be given when a frame is transmitted and needs to be
733 * encrypted in hardware.
734 * @alg: The key algorithm.
735 * @flags: key flags, see &enum ieee80211_key_flags.
736 * @keyidx: the key index (0-3)
737 * @keylen: key material length
738 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
740 * - Temporal Encryption Key (128 bits)
741 * - Temporal Authenticator Tx MIC Key (64 bits)
742 * - Temporal Authenticator Rx MIC Key (64 bits)
743 * @icv_len: The ICV length for this key type
744 * @iv_len: The IV length for this key type
746 struct ieee80211_key_conf {
747 enum ieee80211_key_alg alg;
758 * enum set_key_cmd - key command
760 * Used with the set_key() callback in &struct ieee80211_ops, this
761 * indicates whether a key is being removed or added.
763 * @SET_KEY: a key is set
764 * @DISABLE_KEY: a key must be disabled
767 SET_KEY, DISABLE_KEY,
771 * struct ieee80211_sta - station table entry
773 * A station table entry represents a station we are possibly
774 * communicating with. Since stations are RCU-managed in
775 * mac80211, any ieee80211_sta pointer you get access to must
776 * either be protected by rcu_read_lock() explicitly or implicitly,
777 * or you must take good care to not use such a pointer after a
778 * call to your sta_notify callback that removed it.
781 * @aid: AID we assigned to the station if we're an AP
782 * @supp_rates: Bitmap of supported rates (per band)
783 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
784 * @drv_priv: data area for driver use, will always be aligned to
785 * sizeof(void *), size is determined in hw information.
787 struct ieee80211_sta {
788 u32 supp_rates[IEEE80211_NUM_BANDS];
791 struct ieee80211_sta_ht_cap ht_cap;
794 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
798 * enum sta_notify_cmd - sta notify command
800 * Used with the sta_notify() callback in &struct ieee80211_ops, this
801 * indicates addition and removal of a station to station table,
802 * or if a associated station made a power state transition.
804 * @STA_NOTIFY_ADD: a station was added to the station table
805 * @STA_NOTIFY_REMOVE: a station being removed from the station table
806 * @STA_NOTIFY_SLEEP: a station is now sleeping
807 * @STA_NOTIFY_AWAKE: a sleeping station woke up
809 enum sta_notify_cmd {
810 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
811 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
815 * enum ieee80211_tkip_key_type - get tkip key
817 * Used by drivers which need to get a tkip key for skb. Some drivers need a
818 * phase 1 key, others need a phase 2 key. A single function allows the driver
819 * to get the key, this enum indicates what type of key is required.
821 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
822 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
824 enum ieee80211_tkip_key_type {
825 IEEE80211_TKIP_P1_KEY,
826 IEEE80211_TKIP_P2_KEY,
830 * enum ieee80211_hw_flags - hardware flags
832 * These flags are used to indicate hardware capabilities to
833 * the stack. Generally, flags here should have their meaning
834 * done in a way that the simplest hardware doesn't need setting
835 * any particular flags. There are some exceptions to this rule,
836 * however, so you are advised to review these flags carefully.
838 * @IEEE80211_HW_RX_INCLUDES_FCS:
839 * Indicates that received frames passed to the stack include
840 * the FCS at the end.
842 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
843 * Some wireless LAN chipsets buffer broadcast/multicast frames
844 * for power saving stations in the hardware/firmware and others
845 * rely on the host system for such buffering. This option is used
846 * to configure the IEEE 802.11 upper layer to buffer broadcast and
847 * multicast frames when there are power saving stations so that
848 * the driver can fetch them with ieee80211_get_buffered_bc().
850 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
851 * Hardware is not capable of short slot operation on the 2.4 GHz band.
853 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
854 * Hardware is not capable of receiving frames with short preamble on
857 * @IEEE80211_HW_SIGNAL_UNSPEC:
858 * Hardware can provide signal values but we don't know its units. We
859 * expect values between 0 and @max_signal.
860 * If possible please provide dB or dBm instead.
862 * @IEEE80211_HW_SIGNAL_DBM:
863 * Hardware gives signal values in dBm, decibel difference from
864 * one milliwatt. This is the preferred method since it is standardized
865 * between different devices. @max_signal does not need to be set.
867 * @IEEE80211_HW_NOISE_DBM:
868 * Hardware can provide noise (radio interference) values in units dBm,
869 * decibel difference from one milliwatt.
871 * @IEEE80211_HW_SPECTRUM_MGMT:
872 * Hardware supports spectrum management defined in 802.11h
873 * Measurement, Channel Switch, Quieting, TPC
875 * @IEEE80211_HW_AMPDU_AGGREGATION:
876 * Hardware supports 11n A-MPDU aggregation.
878 * @IEEE80211_HW_SUPPORTS_PS:
879 * Hardware has power save support (i.e. can go to sleep).
881 * @IEEE80211_HW_PS_NULLFUNC_STACK:
882 * Hardware requires nullfunc frame handling in stack, implies
883 * stack support for dynamic PS.
885 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
886 * Hardware has support for dynamic PS.
888 * @IEEE80211_HW_MFP_CAPABLE:
889 * Hardware supports management frame protection (MFP, IEEE 802.11w).
891 * @IEEE80211_HW_BEACON_FILTER:
892 * Hardware supports dropping of irrelevant beacon frames to
893 * avoid waking up cpu.
895 enum ieee80211_hw_flags {
896 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
897 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
898 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
899 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
900 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
901 IEEE80211_HW_SIGNAL_DBM = 1<<6,
902 IEEE80211_HW_NOISE_DBM = 1<<7,
903 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
904 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
905 IEEE80211_HW_SUPPORTS_PS = 1<<10,
906 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
907 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
908 IEEE80211_HW_MFP_CAPABLE = 1<<13,
909 IEEE80211_HW_BEACON_FILTER = 1<<14,
913 * struct ieee80211_hw - hardware information and state
915 * This structure contains the configuration and hardware
916 * information for an 802.11 PHY.
918 * @wiphy: This points to the &struct wiphy allocated for this
919 * 802.11 PHY. You must fill in the @perm_addr and @dev
920 * members of this structure using SET_IEEE80211_DEV()
921 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
922 * bands (with channels, bitrates) are registered here.
924 * @conf: &struct ieee80211_conf, device configuration, don't use.
926 * @workqueue: single threaded workqueue available for driver use,
927 * allocated by mac80211 on registration and flushed when an
928 * interface is removed.
929 * NOTICE: All work performed on this workqueue must not
930 * acquire the RTNL lock.
932 * @priv: pointer to private area that was allocated for driver use
933 * along with this structure.
935 * @flags: hardware flags, see &enum ieee80211_hw_flags.
937 * @extra_tx_headroom: headroom to reserve in each transmit skb
938 * for use by the driver (e.g. for transmit headers.)
940 * @channel_change_time: time (in microseconds) it takes to change channels.
942 * @max_signal: Maximum value for signal (rssi) in RX information, used
943 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
945 * @max_listen_interval: max listen interval in units of beacon interval
948 * @queues: number of available hardware transmit queues for
949 * data packets. WMM/QoS requires at least four, these
950 * queues need to have configurable access parameters.
952 * @rate_control_algorithm: rate control algorithm for this hardware.
953 * If unset (NULL), the default algorithm will be used. Must be
954 * set before calling ieee80211_register_hw().
956 * @vif_data_size: size (in bytes) of the drv_priv data area
957 * within &struct ieee80211_vif.
958 * @sta_data_size: size (in bytes) of the drv_priv data area
959 * within &struct ieee80211_sta.
961 * @max_rates: maximum number of alternate rate retry stages
962 * @max_rate_tries: maximum number of tries for each stage
964 struct ieee80211_hw {
965 struct ieee80211_conf conf;
967 struct workqueue_struct *workqueue;
968 const char *rate_control_algorithm;
971 unsigned int extra_tx_headroom;
972 int channel_change_time;
976 u16 max_listen_interval;
983 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
985 * @wiphy: the &struct wiphy which we want to query
987 * mac80211 drivers can use this to get to their respective
988 * &struct ieee80211_hw. Drivers wishing to get to their own private
989 * structure can then access it via hw->priv. Note that mac802111 drivers should
990 * not use wiphy_priv() to try to get their private driver structure as this
991 * is already used internally by mac80211.
993 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
996 * SET_IEEE80211_DEV - set device for 802.11 hardware
998 * @hw: the &struct ieee80211_hw to set the device for
999 * @dev: the &struct device of this 802.11 device
1001 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1003 set_wiphy_dev(hw->wiphy, dev);
1007 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1009 * @hw: the &struct ieee80211_hw to set the MAC address for
1010 * @addr: the address to set
1012 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1014 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1017 static inline struct ieee80211_rate *
1018 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1019 const struct ieee80211_tx_info *c)
1021 if (WARN_ON(c->control.rates[0].idx < 0))
1023 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1026 static inline struct ieee80211_rate *
1027 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1028 const struct ieee80211_tx_info *c)
1030 if (c->control.rts_cts_rate_idx < 0)
1032 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1035 static inline struct ieee80211_rate *
1036 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1037 const struct ieee80211_tx_info *c, int idx)
1039 if (c->control.rates[idx + 1].idx < 0)
1041 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1045 * DOC: Hardware crypto acceleration
1047 * mac80211 is capable of taking advantage of many hardware
1048 * acceleration designs for encryption and decryption operations.
1050 * The set_key() callback in the &struct ieee80211_ops for a given
1051 * device is called to enable hardware acceleration of encryption and
1052 * decryption. The callback takes a @sta parameter that will be NULL
1053 * for default keys or keys used for transmission only, or point to
1054 * the station information for the peer for individual keys.
1055 * Multiple transmission keys with the same key index may be used when
1056 * VLANs are configured for an access point.
1058 * When transmitting, the TX control data will use the @hw_key_idx
1059 * selected by the driver by modifying the &struct ieee80211_key_conf
1060 * pointed to by the @key parameter to the set_key() function.
1062 * The set_key() call for the %SET_KEY command should return 0 if
1063 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1064 * added; if you return 0 then hw_key_idx must be assigned to the
1065 * hardware key index, you are free to use the full u8 range.
1067 * When the cmd is %DISABLE_KEY then it must succeed.
1069 * Note that it is permissible to not decrypt a frame even if a key
1070 * for it has been uploaded to hardware, the stack will not make any
1071 * decision based on whether a key has been uploaded or not but rather
1072 * based on the receive flags.
1074 * The &struct ieee80211_key_conf structure pointed to by the @key
1075 * parameter is guaranteed to be valid until another call to set_key()
1076 * removes it, but it can only be used as a cookie to differentiate
1079 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1080 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1082 * The update_tkip_key() call updates the driver with the new phase 1 key.
1083 * This happens everytime the iv16 wraps around (every 65536 packets). The
1084 * set_key() call will happen only once for each key (unless the AP did
1085 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1086 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1087 * handler is software decryption with wrap around of iv16.
1091 * DOC: Powersave support
1093 * mac80211 has support for various powersave implementations.
1095 * First, it can support hardware that handles all powersaving by
1096 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1097 * hardware flag. In that case, it will be told about the desired
1098 * powersave mode depending on the association status, and the driver
1099 * must take care of sending nullfunc frames when necessary, i.e. when
1100 * entering and leaving powersave mode. The driver is required to look at
1101 * the AID in beacons and signal to the AP that it woke up when it finds
1102 * traffic directed to it. This mode supports dynamic PS by simply
1103 * enabling/disabling PS.
1105 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1106 * flag to indicate that it can support dynamic PS mode itself (see below).
1108 * Other hardware designs cannot send nullfunc frames by themselves and also
1109 * need software support for parsing the TIM bitmap. This is also supported
1110 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1111 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1112 * required to pass up beacons. The hardware is still required to handle
1113 * waking up for multicast traffic; if it cannot the driver must handle that
1114 * as best as it can, mac80211 is too slow.
1116 * Dynamic powersave mode is an extension to normal powersave mode in which
1117 * the hardware stays awake for a user-specified period of time after sending
1118 * a frame so that reply frames need not be buffered and therefore delayed
1119 * to the next wakeup. This can either be supported by hardware, in which case
1120 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1121 * value, or by the stack if all nullfunc handling is in the stack.
1125 * DOC: Beacon filter support
1127 * Some hardware have beacon filter support to reduce host cpu wakeups
1128 * which will reduce system power consumption. It usuallly works so that
1129 * the firmware creates a checksum of the beacon but omits all constantly
1130 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1131 * beacon is forwarded to the host, otherwise it will be just dropped. That
1132 * way the host will only receive beacons where some relevant information
1133 * (for example ERP protection or WMM settings) have changed.
1135 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1136 * hardware capability. The driver needs to enable beacon filter support
1137 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1138 * power save is enabled, the stack will not check for beacon loss and the
1139 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1141 * The time (or number of beacons missed) until the firmware notifies the
1142 * driver of a beacon loss event (which in turn causes the driver to call
1143 * ieee80211_beacon_loss()) should be configurable and will be controlled
1144 * by mac80211 and the roaming algorithm in the future.
1146 * Since there may be constantly changing information elements that nothing
1147 * in the software stack cares about, we will, in the future, have mac80211
1148 * tell the driver which information elements are interesting in the sense
1149 * that we want to see changes in them. This will include
1150 * - a list of information element IDs
1151 * - a list of OUIs for the vendor information element
1153 * Ideally, the hardware would filter out any beacons without changes in the
1154 * requested elements, but if it cannot support that it may, at the expense
1155 * of some efficiency, filter out only a subset. For example, if the device
1156 * doesn't support checking for OUIs it should pass up all changes in all
1157 * vendor information elements.
1159 * Note that change, for the sake of simplification, also includes information
1160 * elements appearing or disappearing from the beacon.
1162 * Some hardware supports an "ignore list" instead, just make sure nothing
1163 * that was requested is on the ignore list, and include commonly changing
1164 * information element IDs in the ignore list, for example 11 (BSS load) and
1165 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1166 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1167 * it could also include some currently unused IDs.
1170 * In addition to these capabilities, hardware should support notifying the
1171 * host of changes in the beacon RSSI. This is relevant to implement roaming
1172 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1173 * the received data packets). This can consist in notifying the host when
1174 * the RSSI changes significantly or when it drops below or rises above
1175 * configurable thresholds. In the future these thresholds will also be
1176 * configured by mac80211 (which gets them from userspace) to implement
1177 * them as the roaming algorithm requires.
1179 * If the hardware cannot implement this, the driver should ask it to
1180 * periodically pass beacon frames to the host so that software can do the
1181 * signal strength threshold checking.
1185 * DOC: Frame filtering
1187 * mac80211 requires to see many management frames for proper
1188 * operation, and users may want to see many more frames when
1189 * in monitor mode. However, for best CPU usage and power consumption,
1190 * having as few frames as possible percolate through the stack is
1191 * desirable. Hence, the hardware should filter as much as possible.
1193 * To achieve this, mac80211 uses filter flags (see below) to tell
1194 * the driver's configure_filter() function which frames should be
1195 * passed to mac80211 and which should be filtered out.
1197 * The configure_filter() callback is invoked with the parameters
1198 * @mc_count and @mc_list for the combined multicast address list
1199 * of all virtual interfaces, @changed_flags telling which flags
1200 * were changed and @total_flags with the new flag states.
1202 * If your device has no multicast address filters your driver will
1203 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1204 * parameter to see whether multicast frames should be accepted
1207 * All unsupported flags in @total_flags must be cleared.
1208 * Hardware does not support a flag if it is incapable of _passing_
1209 * the frame to the stack. Otherwise the driver must ignore
1210 * the flag, but not clear it.
1211 * You must _only_ clear the flag (announce no support for the
1212 * flag to mac80211) if you are not able to pass the packet type
1213 * to the stack (so the hardware always filters it).
1214 * So for example, you should clear @FIF_CONTROL, if your hardware
1215 * always filters control frames. If your hardware always passes
1216 * control frames to the kernel and is incapable of filtering them,
1217 * you do _not_ clear the @FIF_CONTROL flag.
1218 * This rule applies to all other FIF flags as well.
1222 * enum ieee80211_filter_flags - hardware filter flags
1224 * These flags determine what the filter in hardware should be
1225 * programmed to let through and what should not be passed to the
1226 * stack. It is always safe to pass more frames than requested,
1227 * but this has negative impact on power consumption.
1229 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1230 * think of the BSS as your network segment and then this corresponds
1231 * to the regular ethernet device promiscuous mode.
1233 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1234 * by the user or if the hardware is not capable of filtering by
1235 * multicast address.
1237 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1238 * %RX_FLAG_FAILED_FCS_CRC for them)
1240 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1241 * the %RX_FLAG_FAILED_PLCP_CRC for them
1243 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1244 * to the hardware that it should not filter beacons or probe responses
1245 * by BSSID. Filtering them can greatly reduce the amount of processing
1246 * mac80211 needs to do and the amount of CPU wakeups, so you should
1247 * honour this flag if possible.
1249 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1250 * only those addressed to this station
1252 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1254 enum ieee80211_filter_flags {
1255 FIF_PROMISC_IN_BSS = 1<<0,
1256 FIF_ALLMULTI = 1<<1,
1258 FIF_PLCPFAIL = 1<<3,
1259 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1261 FIF_OTHER_BSS = 1<<6,
1265 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1267 * These flags are used with the ampdu_action() callback in
1268 * &struct ieee80211_ops to indicate which action is needed.
1269 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1270 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1271 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1272 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1273 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1275 enum ieee80211_ampdu_mlme_action {
1276 IEEE80211_AMPDU_RX_START,
1277 IEEE80211_AMPDU_RX_STOP,
1278 IEEE80211_AMPDU_TX_START,
1279 IEEE80211_AMPDU_TX_STOP,
1280 IEEE80211_AMPDU_TX_OPERATIONAL,
1284 * struct ieee80211_ops - callbacks from mac80211 to the driver
1286 * This structure contains various callbacks that the driver may
1287 * handle or, in some cases, must handle, for example to configure
1288 * the hardware to a new channel or to transmit a frame.
1290 * @tx: Handler that 802.11 module calls for each transmitted frame.
1291 * skb contains the buffer starting from the IEEE 802.11 header.
1292 * The low-level driver should send the frame out based on
1293 * configuration in the TX control data. This handler should,
1294 * preferably, never fail and stop queues appropriately, more
1295 * importantly, however, it must never fail for A-MPDU-queues.
1296 * This function should return NETDEV_TX_OK except in very
1298 * Must be implemented and atomic.
1300 * @start: Called before the first netdevice attached to the hardware
1301 * is enabled. This should turn on the hardware and must turn on
1302 * frame reception (for possibly enabled monitor interfaces.)
1303 * Returns negative error codes, these may be seen in userspace,
1305 * When the device is started it should not have a MAC address
1306 * to avoid acknowledging frames before a non-monitor device
1308 * Must be implemented.
1310 * @stop: Called after last netdevice attached to the hardware
1311 * is disabled. This should turn off the hardware (at least
1312 * it must turn off frame reception.)
1313 * May be called right after add_interface if that rejects
1315 * Must be implemented.
1317 * @add_interface: Called when a netdevice attached to the hardware is
1318 * enabled. Because it is not called for monitor mode devices, @start
1319 * and @stop must be implemented.
1320 * The driver should perform any initialization it needs before
1321 * the device can be enabled. The initial configuration for the
1322 * interface is given in the conf parameter.
1323 * The callback may refuse to add an interface by returning a
1324 * negative error code (which will be seen in userspace.)
1325 * Must be implemented.
1327 * @remove_interface: Notifies a driver that an interface is going down.
1328 * The @stop callback is called after this if it is the last interface
1329 * and no monitor interfaces are present.
1330 * When all interfaces are removed, the MAC address in the hardware
1331 * must be cleared so the device no longer acknowledges packets,
1332 * the mac_addr member of the conf structure is, however, set to the
1333 * MAC address of the device going away.
1334 * Hence, this callback must be implemented.
1336 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1337 * function to change hardware configuration, e.g., channel.
1338 * This function should never fail but returns a negative error code
1341 * @config_interface: Handler for configuration requests related to interfaces
1342 * (e.g. BSSID changes.)
1343 * Returns a negative error code which will be seen in userspace.
1345 * @bss_info_changed: Handler for configuration requests related to BSS
1346 * parameters that may vary during BSS's lifespan, and may affect low
1347 * level driver (e.g. assoc/disassoc status, erp parameters).
1348 * This function should not be used if no BSS has been set, unless
1349 * for association indication. The @changed parameter indicates which
1350 * of the bss parameters has changed when a call is made.
1352 * @configure_filter: Configure the device's RX filter.
1353 * See the section "Frame filtering" for more information.
1354 * This callback must be implemented and atomic.
1356 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1357 * must be set or cleared for a given STA. Must be atomic.
1359 * @set_key: See the section "Hardware crypto acceleration"
1360 * This callback can sleep, and is only called between add_interface
1361 * and remove_interface calls, i.e. while the given virtual interface
1363 * Returns a negative error code if the key can't be added.
1365 * @update_tkip_key: See the section "Hardware crypto acceleration"
1366 * This callback will be called in the context of Rx. Called for drivers
1367 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1369 * @hw_scan: Ask the hardware to service the scan request, no need to start
1370 * the scan state machine in stack. The scan must honour the channel
1371 * configuration done by the regulatory agent in the wiphy's
1372 * registered bands. The hardware (or the driver) needs to make sure
1373 * that power save is disabled.
1374 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1375 * entire IEs after the SSID, so that drivers need not look at these
1376 * at all but just send them after the SSID -- mac80211 includes the
1377 * (extended) supported rates and HT information (where applicable).
1378 * When the scan finishes, ieee80211_scan_completed() must be called;
1379 * note that it also must be called when the scan cannot finish due to
1380 * any error unless this callback returned a negative error code.
1382 * @sw_scan_start: Notifier function that is called just before a software scan
1383 * is started. Can be NULL, if the driver doesn't need this notification.
1385 * @sw_scan_complete: Notifier function that is called just after a software scan
1386 * finished. Can be NULL, if the driver doesn't need this notification.
1388 * @get_stats: Return low-level statistics.
1389 * Returns zero if statistics are available.
1391 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1392 * callback should be provided to read the TKIP transmit IVs (both IV32
1393 * and IV16) for the given key from hardware.
1395 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1397 * @sta_notify: Notifies low level driver about addition, removal or power
1398 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1401 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1402 * bursting) for a hardware TX queue.
1403 * Returns a negative error code on failure.
1405 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1406 * to get number of currently queued packets (queue length), maximum queue
1407 * size (limit), and total number of packets sent using each TX queue
1408 * (count). The 'stats' pointer points to an array that has hw->queues
1411 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1412 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1413 * required function.
1415 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1416 * Currently, this is only used for IBSS mode debugging. Is not a
1417 * required function.
1419 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1420 * with other STAs in the IBSS. This is only used in IBSS mode. This
1421 * function is optional if the firmware/hardware takes full care of
1422 * TSF synchronization.
1424 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1425 * This is needed only for IBSS mode and the result of this function is
1426 * used to determine whether to reply to Probe Requests.
1427 * Returns non-zero if this device sent the last beacon.
1429 * @ampdu_action: Perform a certain A-MPDU action
1430 * The RA/TID combination determines the destination and TID we want
1431 * the ampdu action to be performed for. The action is defined through
1432 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1433 * is the first frame we expect to perform the action on. Notice
1434 * that TX/RX_STOP can pass NULL for this parameter.
1435 * Returns a negative error code on failure.
1437 struct ieee80211_ops {
1438 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1439 int (*start)(struct ieee80211_hw *hw);
1440 void (*stop)(struct ieee80211_hw *hw);
1441 int (*add_interface)(struct ieee80211_hw *hw,
1442 struct ieee80211_if_init_conf *conf);
1443 void (*remove_interface)(struct ieee80211_hw *hw,
1444 struct ieee80211_if_init_conf *conf);
1445 int (*config)(struct ieee80211_hw *hw, u32 changed);
1446 int (*config_interface)(struct ieee80211_hw *hw,
1447 struct ieee80211_vif *vif,
1448 struct ieee80211_if_conf *conf);
1449 void (*bss_info_changed)(struct ieee80211_hw *hw,
1450 struct ieee80211_vif *vif,
1451 struct ieee80211_bss_conf *info,
1453 void (*configure_filter)(struct ieee80211_hw *hw,
1454 unsigned int changed_flags,
1455 unsigned int *total_flags,
1456 int mc_count, struct dev_addr_list *mc_list);
1457 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1459 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1460 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1461 struct ieee80211_key_conf *key);
1462 void (*update_tkip_key)(struct ieee80211_hw *hw,
1463 struct ieee80211_key_conf *conf, const u8 *address,
1464 u32 iv32, u16 *phase1key);
1465 int (*hw_scan)(struct ieee80211_hw *hw,
1466 struct cfg80211_scan_request *req);
1467 void (*sw_scan_start)(struct ieee80211_hw *hw);
1468 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1469 int (*get_stats)(struct ieee80211_hw *hw,
1470 struct ieee80211_low_level_stats *stats);
1471 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1472 u32 *iv32, u16 *iv16);
1473 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1474 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1475 enum sta_notify_cmd, struct ieee80211_sta *sta);
1476 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1477 const struct ieee80211_tx_queue_params *params);
1478 int (*get_tx_stats)(struct ieee80211_hw *hw,
1479 struct ieee80211_tx_queue_stats *stats);
1480 u64 (*get_tsf)(struct ieee80211_hw *hw);
1481 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1482 void (*reset_tsf)(struct ieee80211_hw *hw);
1483 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1484 int (*ampdu_action)(struct ieee80211_hw *hw,
1485 enum ieee80211_ampdu_mlme_action action,
1486 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1490 * ieee80211_alloc_hw - Allocate a new hardware device
1492 * This must be called once for each hardware device. The returned pointer
1493 * must be used to refer to this device when calling other functions.
1494 * mac80211 allocates a private data area for the driver pointed to by
1495 * @priv in &struct ieee80211_hw, the size of this area is given as
1498 * @priv_data_len: length of private data
1499 * @ops: callbacks for this device
1501 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1502 const struct ieee80211_ops *ops);
1505 * ieee80211_register_hw - Register hardware device
1507 * You must call this function before any other functions in
1508 * mac80211. Note that before a hardware can be registered, you
1509 * need to fill the contained wiphy's information.
1511 * @hw: the device to register as returned by ieee80211_alloc_hw()
1513 int ieee80211_register_hw(struct ieee80211_hw *hw);
1515 #ifdef CONFIG_MAC80211_LEDS
1516 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1517 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1518 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1519 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1522 * ieee80211_get_tx_led_name - get name of TX LED
1524 * mac80211 creates a transmit LED trigger for each wireless hardware
1525 * that can be used to drive LEDs if your driver registers a LED device.
1526 * This function returns the name (or %NULL if not configured for LEDs)
1527 * of the trigger so you can automatically link the LED device.
1529 * @hw: the hardware to get the LED trigger name for
1531 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1533 #ifdef CONFIG_MAC80211_LEDS
1534 return __ieee80211_get_tx_led_name(hw);
1541 * ieee80211_get_rx_led_name - get name of RX LED
1543 * mac80211 creates a receive LED trigger for each wireless hardware
1544 * that can be used to drive LEDs if your driver registers a LED device.
1545 * This function returns the name (or %NULL if not configured for LEDs)
1546 * of the trigger so you can automatically link the LED device.
1548 * @hw: the hardware to get the LED trigger name for
1550 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1552 #ifdef CONFIG_MAC80211_LEDS
1553 return __ieee80211_get_rx_led_name(hw);
1560 * ieee80211_get_assoc_led_name - get name of association LED
1562 * mac80211 creates a association LED trigger for each wireless hardware
1563 * that can be used to drive LEDs if your driver registers a LED device.
1564 * This function returns the name (or %NULL if not configured for LEDs)
1565 * of the trigger so you can automatically link the LED device.
1567 * @hw: the hardware to get the LED trigger name for
1569 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1571 #ifdef CONFIG_MAC80211_LEDS
1572 return __ieee80211_get_assoc_led_name(hw);
1579 * ieee80211_get_radio_led_name - get name of radio LED
1581 * mac80211 creates a radio change LED trigger for each wireless hardware
1582 * that can be used to drive LEDs if your driver registers a LED device.
1583 * This function returns the name (or %NULL if not configured for LEDs)
1584 * of the trigger so you can automatically link the LED device.
1586 * @hw: the hardware to get the LED trigger name for
1588 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1590 #ifdef CONFIG_MAC80211_LEDS
1591 return __ieee80211_get_radio_led_name(hw);
1598 * ieee80211_unregister_hw - Unregister a hardware device
1600 * This function instructs mac80211 to free allocated resources
1601 * and unregister netdevices from the networking subsystem.
1603 * @hw: the hardware to unregister
1605 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1608 * ieee80211_free_hw - free hardware descriptor
1610 * This function frees everything that was allocated, including the
1611 * private data for the driver. You must call ieee80211_unregister_hw()
1612 * before calling this function.
1614 * @hw: the hardware to free
1616 void ieee80211_free_hw(struct ieee80211_hw *hw);
1619 * ieee80211_restart_hw - restart hardware completely
1621 * Call this function when the hardware was restarted for some reason
1622 * (hardware error, ...) and the driver is unable to restore its state
1623 * by itself. mac80211 assumes that at this point the driver/hardware
1624 * is completely uninitialised and stopped, it starts the process by
1625 * calling the ->start() operation. The driver will need to reset all
1626 * internal state that it has prior to calling this function.
1628 * @hw: the hardware to restart
1630 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1632 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1633 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1634 struct ieee80211_rx_status *status);
1637 * ieee80211_rx - receive frame
1639 * Use this function to hand received frames to mac80211. The receive
1640 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1641 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1643 * This function may not be called in IRQ context. Calls to this function
1644 * for a single hardware must be synchronized against each other. Calls
1645 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1648 * @hw: the hardware this frame came in on
1649 * @skb: the buffer to receive, owned by mac80211 after this call
1650 * @status: status of this frame; the status pointer need not be valid
1651 * after this function returns
1653 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1654 struct ieee80211_rx_status *status)
1656 __ieee80211_rx(hw, skb, status);
1660 * ieee80211_rx_irqsafe - receive frame
1662 * Like ieee80211_rx() but can be called in IRQ context
1663 * (internally defers to a tasklet.)
1665 * Calls to this function and ieee80211_rx() may not be mixed for a
1668 * @hw: the hardware this frame came in on
1669 * @skb: the buffer to receive, owned by mac80211 after this call
1670 * @status: status of this frame; the status pointer need not be valid
1671 * after this function returns and is not freed by mac80211,
1672 * it is recommended that it points to a stack area
1674 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1675 struct sk_buff *skb,
1676 struct ieee80211_rx_status *status);
1679 * ieee80211_tx_status - transmit status callback
1681 * Call this function for all transmitted frames after they have been
1682 * transmitted. It is permissible to not call this function for
1683 * multicast frames but this can affect statistics.
1685 * This function may not be called in IRQ context. Calls to this function
1686 * for a single hardware must be synchronized against each other. Calls
1687 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1688 * for a single hardware.
1690 * @hw: the hardware the frame was transmitted by
1691 * @skb: the frame that was transmitted, owned by mac80211 after this call
1693 void ieee80211_tx_status(struct ieee80211_hw *hw,
1694 struct sk_buff *skb);
1697 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1699 * Like ieee80211_tx_status() but can be called in IRQ context
1700 * (internally defers to a tasklet.)
1702 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1705 * @hw: the hardware the frame was transmitted by
1706 * @skb: the frame that was transmitted, owned by mac80211 after this call
1708 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1709 struct sk_buff *skb);
1712 * ieee80211_beacon_get - beacon generation function
1713 * @hw: pointer obtained from ieee80211_alloc_hw().
1714 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1716 * If the beacon frames are generated by the host system (i.e., not in
1717 * hardware/firmware), the low-level driver uses this function to receive
1718 * the next beacon frame from the 802.11 code. The low-level is responsible
1719 * for calling this function before beacon data is needed (e.g., based on
1720 * hardware interrupt). Returned skb is used only once and low-level driver
1721 * is responsible for freeing it.
1723 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1724 struct ieee80211_vif *vif);
1727 * ieee80211_rts_get - RTS frame generation function
1728 * @hw: pointer obtained from ieee80211_alloc_hw().
1729 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1730 * @frame: pointer to the frame that is going to be protected by the RTS.
1731 * @frame_len: the frame length (in octets).
1732 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1733 * @rts: The buffer where to store the RTS frame.
1735 * If the RTS frames are generated by the host system (i.e., not in
1736 * hardware/firmware), the low-level driver uses this function to receive
1737 * the next RTS frame from the 802.11 code. The low-level is responsible
1738 * for calling this function before and RTS frame is needed.
1740 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1741 const void *frame, size_t frame_len,
1742 const struct ieee80211_tx_info *frame_txctl,
1743 struct ieee80211_rts *rts);
1746 * ieee80211_rts_duration - Get the duration field for an RTS frame
1747 * @hw: pointer obtained from ieee80211_alloc_hw().
1748 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1749 * @frame_len: the length of the frame that is going to be protected by the RTS.
1750 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1752 * If the RTS is generated in firmware, but the host system must provide
1753 * the duration field, the low-level driver uses this function to receive
1754 * the duration field value in little-endian byteorder.
1756 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1757 struct ieee80211_vif *vif, size_t frame_len,
1758 const struct ieee80211_tx_info *frame_txctl);
1761 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1762 * @hw: pointer obtained from ieee80211_alloc_hw().
1763 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1764 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1765 * @frame_len: the frame length (in octets).
1766 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1767 * @cts: The buffer where to store the CTS-to-self frame.
1769 * If the CTS-to-self frames are generated by the host system (i.e., not in
1770 * hardware/firmware), the low-level driver uses this function to receive
1771 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1772 * for calling this function before and CTS-to-self frame is needed.
1774 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1775 struct ieee80211_vif *vif,
1776 const void *frame, size_t frame_len,
1777 const struct ieee80211_tx_info *frame_txctl,
1778 struct ieee80211_cts *cts);
1781 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1782 * @hw: pointer obtained from ieee80211_alloc_hw().
1783 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1784 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1785 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1787 * If the CTS-to-self is generated in firmware, but the host system must provide
1788 * the duration field, the low-level driver uses this function to receive
1789 * the duration field value in little-endian byteorder.
1791 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1792 struct ieee80211_vif *vif,
1794 const struct ieee80211_tx_info *frame_txctl);
1797 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1798 * @hw: pointer obtained from ieee80211_alloc_hw().
1799 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1800 * @frame_len: the length of the frame.
1801 * @rate: the rate at which the frame is going to be transmitted.
1803 * Calculate the duration field of some generic frame, given its
1804 * length and transmission rate (in 100kbps).
1806 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1807 struct ieee80211_vif *vif,
1809 struct ieee80211_rate *rate);
1812 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1813 * @hw: pointer as obtained from ieee80211_alloc_hw().
1814 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1816 * Function for accessing buffered broadcast and multicast frames. If
1817 * hardware/firmware does not implement buffering of broadcast/multicast
1818 * frames when power saving is used, 802.11 code buffers them in the host
1819 * memory. The low-level driver uses this function to fetch next buffered
1820 * frame. In most cases, this is used when generating beacon frame. This
1821 * function returns a pointer to the next buffered skb or NULL if no more
1822 * buffered frames are available.
1824 * Note: buffered frames are returned only after DTIM beacon frame was
1825 * generated with ieee80211_beacon_get() and the low-level driver must thus
1826 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1827 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1828 * does not need to check for DTIM beacons separately and should be able to
1829 * use common code for all beacons.
1832 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1835 * ieee80211_get_hdrlen_from_skb - get header length from data
1837 * Given an skb with a raw 802.11 header at the data pointer this function
1838 * returns the 802.11 header length in bytes (not including encryption
1839 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1840 * header the function returns 0.
1844 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1847 * ieee80211_hdrlen - get header length in bytes from frame control
1848 * @fc: frame control field in little-endian format
1850 unsigned int ieee80211_hdrlen(__le16 fc);
1853 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1855 * This function computes a TKIP rc4 key for an skb. It computes
1856 * a phase 1 key if needed (iv16 wraps around). This function is to
1857 * be used by drivers which can do HW encryption but need to compute
1858 * to phase 1/2 key in SW.
1860 * @keyconf: the parameter passed with the set key
1861 * @skb: the skb for which the key is needed
1863 * @key: a buffer to which the key will be written
1865 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1866 struct sk_buff *skb,
1867 enum ieee80211_tkip_key_type type, u8 *key);
1869 * ieee80211_wake_queue - wake specific queue
1870 * @hw: pointer as obtained from ieee80211_alloc_hw().
1871 * @queue: queue number (counted from zero).
1873 * Drivers should use this function instead of netif_wake_queue.
1875 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1878 * ieee80211_stop_queue - stop specific queue
1879 * @hw: pointer as obtained from ieee80211_alloc_hw().
1880 * @queue: queue number (counted from zero).
1882 * Drivers should use this function instead of netif_stop_queue.
1884 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1887 * ieee80211_queue_stopped - test status of the queue
1888 * @hw: pointer as obtained from ieee80211_alloc_hw().
1889 * @queue: queue number (counted from zero).
1891 * Drivers should use this function instead of netif_stop_queue.
1894 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1897 * ieee80211_stop_queues - stop all queues
1898 * @hw: pointer as obtained from ieee80211_alloc_hw().
1900 * Drivers should use this function instead of netif_stop_queue.
1902 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1905 * ieee80211_wake_queues - wake all queues
1906 * @hw: pointer as obtained from ieee80211_alloc_hw().
1908 * Drivers should use this function instead of netif_wake_queue.
1910 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1913 * ieee80211_scan_completed - completed hardware scan
1915 * When hardware scan offload is used (i.e. the hw_scan() callback is
1916 * assigned) this function needs to be called by the driver to notify
1917 * mac80211 that the scan finished.
1919 * @hw: the hardware that finished the scan
1920 * @aborted: set to true if scan was aborted
1922 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
1925 * ieee80211_iterate_active_interfaces - iterate active interfaces
1927 * This function iterates over the interfaces associated with a given
1928 * hardware that are currently active and calls the callback for them.
1929 * This function allows the iterator function to sleep, when the iterator
1930 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1933 * @hw: the hardware struct of which the interfaces should be iterated over
1934 * @iterator: the iterator function to call
1935 * @data: first argument of the iterator function
1937 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1938 void (*iterator)(void *data, u8 *mac,
1939 struct ieee80211_vif *vif),
1943 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1945 * This function iterates over the interfaces associated with a given
1946 * hardware that are currently active and calls the callback for them.
1947 * This function requires the iterator callback function to be atomic,
1948 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1950 * @hw: the hardware struct of which the interfaces should be iterated over
1951 * @iterator: the iterator function to call, cannot sleep
1952 * @data: first argument of the iterator function
1954 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1955 void (*iterator)(void *data,
1957 struct ieee80211_vif *vif),
1961 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1962 * @hw: pointer as obtained from ieee80211_alloc_hw().
1963 * @ra: receiver address of the BA session recipient
1964 * @tid: the TID to BA on.
1966 * Return: success if addBA request was sent, failure otherwise
1968 * Although mac80211/low level driver/user space application can estimate
1969 * the need to start aggregation on a certain RA/TID, the session level
1970 * will be managed by the mac80211.
1972 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1975 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1976 * @hw: pointer as obtained from ieee80211_alloc_hw().
1977 * @ra: receiver address of the BA session recipient.
1978 * @tid: the TID to BA on.
1980 * This function must be called by low level driver once it has
1981 * finished with preparations for the BA session.
1983 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1986 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1987 * @hw: pointer as obtained from ieee80211_alloc_hw().
1988 * @ra: receiver address of the BA session recipient.
1989 * @tid: the TID to BA on.
1991 * This function must be called by low level driver once it has
1992 * finished with preparations for the BA session.
1993 * This version of the function is IRQ-safe.
1995 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1999 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2000 * @hw: pointer as obtained from ieee80211_alloc_hw().
2001 * @ra: receiver address of the BA session recipient
2002 * @tid: the TID to stop BA.
2003 * @initiator: if indicates initiator DELBA frame will be sent.
2005 * Return: error if no sta with matching da found, success otherwise
2007 * Although mac80211/low level driver/user space application can estimate
2008 * the need to stop aggregation on a certain RA/TID, the session level
2009 * will be managed by the mac80211.
2011 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
2013 enum ieee80211_back_parties initiator);
2016 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2017 * @hw: pointer as obtained from ieee80211_alloc_hw().
2018 * @ra: receiver address of the BA session recipient.
2019 * @tid: the desired TID to BA on.
2021 * This function must be called by low level driver once it has
2022 * finished with preparations for the BA session tear down.
2024 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
2027 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2028 * @hw: pointer as obtained from ieee80211_alloc_hw().
2029 * @ra: receiver address of the BA session recipient.
2030 * @tid: the desired TID to BA on.
2032 * This function must be called by low level driver once it has
2033 * finished with preparations for the BA session tear down.
2034 * This version of the function is IRQ-safe.
2036 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
2040 * ieee80211_find_sta - find a station
2042 * @hw: pointer as obtained from ieee80211_alloc_hw()
2043 * @addr: station's address
2045 * This function must be called under RCU lock and the
2046 * resulting pointer is only valid under RCU lock as well.
2048 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
2052 * ieee80211_beacon_loss - inform hardware does not receive beacons
2054 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2056 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2057 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2058 * hardware is not receiving beacons with this function.
2060 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2062 /* Rate control API */
2065 * enum rate_control_changed - flags to indicate which parameter changed
2067 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2068 * changed, rate control algorithm can update its internal state if needed.
2070 enum rate_control_changed {
2071 IEEE80211_RC_HT_CHANGED = BIT(0)
2075 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2077 * @hw: The hardware the algorithm is invoked for.
2078 * @sband: The band this frame is being transmitted on.
2079 * @bss_conf: the current BSS configuration
2080 * @reported_rate: The rate control algorithm can fill this in to indicate
2081 * which rate should be reported to userspace as the current rate and
2082 * used for rate calculations in the mesh network.
2083 * @rts: whether RTS will be used for this frame because it is longer than the
2085 * @short_preamble: whether mac80211 will request short-preamble transmission
2086 * if the selected rate supports it
2087 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2088 * @skb: the skb that will be transmitted, the control information in it needs
2091 struct ieee80211_tx_rate_control {
2092 struct ieee80211_hw *hw;
2093 struct ieee80211_supported_band *sband;
2094 struct ieee80211_bss_conf *bss_conf;
2095 struct sk_buff *skb;
2096 struct ieee80211_tx_rate reported_rate;
2097 bool rts, short_preamble;
2101 struct rate_control_ops {
2102 struct module *module;
2104 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2105 void (*free)(void *priv);
2107 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2108 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2109 struct ieee80211_sta *sta, void *priv_sta);
2110 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2111 struct ieee80211_sta *sta,
2112 void *priv_sta, u32 changed);
2113 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2116 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2117 struct ieee80211_sta *sta, void *priv_sta,
2118 struct sk_buff *skb);
2119 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2120 struct ieee80211_tx_rate_control *txrc);
2122 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2123 struct dentry *dir);
2124 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2127 static inline int rate_supported(struct ieee80211_sta *sta,
2128 enum ieee80211_band band,
2131 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2135 rate_lowest_index(struct ieee80211_supported_band *sband,
2136 struct ieee80211_sta *sta)
2140 for (i = 0; i < sband->n_bitrates; i++)
2141 if (rate_supported(sta, sband->band, i))
2144 /* warn when we cannot find a rate. */
2151 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2152 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2155 conf_is_ht20(struct ieee80211_conf *conf)
2157 return conf->channel_type == NL80211_CHAN_HT20;
2161 conf_is_ht40_minus(struct ieee80211_conf *conf)
2163 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2167 conf_is_ht40_plus(struct ieee80211_conf *conf)
2169 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2173 conf_is_ht40(struct ieee80211_conf *conf)
2175 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2179 conf_is_ht(struct ieee80211_conf *conf)
2181 return conf->channel_type != NL80211_CHAN_NO_HT;
2184 #endif /* MAC80211_H */