2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/wireless.h>
23 #include <net/cfg80211.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
79 * This structure describes most essential parameters needed
80 * to describe 802.11n HT characteristics in a BSS.
82 * @primary_channel: channel number of primery channel
83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
86 struct ieee80211_ht_bss_info {
88 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
89 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
97 * for A-MPDU operation.
99 enum ieee80211_max_queues {
100 IEEE80211_MAX_QUEUES = 4,
101 IEEE80211_MAX_AMPDU_QUEUES = 16,
105 * struct ieee80211_tx_queue_params - transmit queue configuration
107 * The information provided in this structure is required for QoS
108 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
110 * @aifs: arbitration interframe space [0..255]
111 * @cw_min: minimum contention window [a value of the form
112 * 2^n-1 in the range 1..32767]
113 * @cw_max: maximum contention window [like @cw_min]
114 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
116 struct ieee80211_tx_queue_params {
124 * struct ieee80211_tx_queue_stats - transmit queue statistics
126 * @len: number of packets in queue
127 * @limit: queue length limit
128 * @count: number of frames sent
130 struct ieee80211_tx_queue_stats {
136 struct ieee80211_low_level_stats {
137 unsigned int dot11ACKFailureCount;
138 unsigned int dot11RTSFailureCount;
139 unsigned int dot11FCSErrorCount;
140 unsigned int dot11RTSSuccessCount;
144 * enum ieee80211_bss_change - BSS change notification flags
146 * These flags are used with the bss_info_changed() callback
147 * to indicate which BSS parameter changed.
149 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
150 * also implies a change in the AID.
151 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
152 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
153 * @BSS_CHANGED_ERP_SLOT: slot timing changed
154 * @BSS_CHANGED_HT: 802.11n parameters changed
155 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
157 enum ieee80211_bss_change {
158 BSS_CHANGED_ASSOC = 1<<0,
159 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
160 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
161 BSS_CHANGED_ERP_SLOT = 1<<3,
162 BSS_CHANGED_HT = 1<<4,
163 BSS_CHANGED_BASIC_RATES = 1<<5,
167 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
168 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
170 struct ieee80211_bss_ht_conf {
175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
183 * @use_short_preamble: use 802.11b short preamble;
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186 * @use_short_slot: use short slot time (only relevant for ERP);
187 * if the hardware cannot handle this it must set the
188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
189 * @dtim_period: num of beacons before the next DTIM, for PSM
190 * @timestamp: beacon timestamp
191 * @beacon_int: beacon interval
192 * @assoc_capability: capabilities taken from assoc resp
193 * @ht: BSS's HT configuration
194 * @basic_rates: bitmap of basic rates, each bit stands for an
195 * index into the rate table configured by the driver in
198 struct ieee80211_bss_conf {
199 /* association related data */
202 /* erp related data */
204 bool use_short_preamble;
208 u16 assoc_capability;
211 struct ieee80211_bss_ht_conf ht;
215 * enum mac80211_tx_control_flags - flags to describe transmission information/status
217 * These flags are used with the @flags member of &ieee80211_tx_info.
219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221 * number to this frame, taking care of not overwriting the fragment
222 * number and increasing the sequence number only when the
223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224 * assign sequence numbers to QoS-data frames but cannot do so correctly
225 * for non-QoS-data and management frames because beacons need them from
226 * that counter as well and mac80211 cannot guarantee proper sequencing.
227 * If this flag is set, the driver should instruct the hardware to
228 * assign a sequence number to the frame or assign one itself. Cf. IEEE
229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230 * beacons and always be clear for frames without a sequence number field.
231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode.
240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246 * set by rate control algorithms to indicate probe rate, will
247 * be cleared for fragmented frames (except on the last fragment)
248 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
249 * set this flag in the driver; indicates that the rate control
250 * algorithm was used and should be notified of TX status
251 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
252 * used to indicate that a pending frame requires TX processing before
253 * it can be sent out.
255 enum mac80211_tx_control_flags {
256 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
257 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
258 IEEE80211_TX_CTL_NO_ACK = BIT(2),
259 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
260 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
261 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
262 IEEE80211_TX_CTL_AMPDU = BIT(6),
263 IEEE80211_TX_CTL_INJECTED = BIT(7),
264 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
265 IEEE80211_TX_STAT_ACK = BIT(9),
266 IEEE80211_TX_STAT_AMPDU = BIT(10),
267 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
268 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
269 IEEE80211_TX_INTFL_RCALGO = BIT(13),
270 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
274 * enum mac80211_rate_control_flags - per-rate flags set by the
275 * Rate Control algorithm.
277 * These flags are set by the Rate control algorithm for each rate during tx,
278 * in the @flags member of struct ieee80211_tx_rate.
280 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
281 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
282 * This is set if the current BSS requires ERP protection.
283 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
284 * @IEEE80211_TX_RC_MCS: HT rate.
285 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
287 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
288 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
289 * adjacent 20 MHz channels, if the current channel type is
290 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
291 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
293 enum mac80211_rate_control_flags {
294 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
295 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
296 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
298 /* rate index is an MCS rate number instead of an index */
299 IEEE80211_TX_RC_MCS = BIT(3),
300 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
301 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
302 IEEE80211_TX_RC_DUP_DATA = BIT(6),
303 IEEE80211_TX_RC_SHORT_GI = BIT(7),
307 /* there are 40 bytes if you don't need the rateset to be kept */
308 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
310 /* if you do need the rateset, then you have less space */
311 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
313 /* maximum number of rate stages */
314 #define IEEE80211_TX_MAX_RATES 5
317 * struct ieee80211_tx_rate - rate selection/status
319 * @idx: rate index to attempt to send with
320 * @flags: rate control flags (&enum mac80211_rate_control_flags)
321 * @count: number of tries in this rate before going to the next rate
323 * A value of -1 for @idx indicates an invalid rate and, if used
324 * in an array of retry rates, that no more rates should be tried.
326 * When used for transmit status reporting, the driver should
327 * always report the rate along with the flags it used.
329 struct ieee80211_tx_rate {
333 } __attribute__((packed));
336 * struct ieee80211_tx_info - skb transmit information
338 * This structure is placed in skb->cb for three uses:
339 * (1) mac80211 TX control - mac80211 tells the driver what to do
340 * (2) driver internal use (if applicable)
341 * (3) TX status information - driver tells mac80211 what happened
343 * The TX control's sta pointer is only valid during the ->tx call,
346 * @flags: transmit info flags, defined above
347 * @band: the band to transmit on (use for checking for races)
348 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
349 * @pad: padding, ignore
350 * @control: union for control data
351 * @status: union for status data
352 * @driver_data: array of driver_data pointers
353 * @ampdu_ack_len: number of aggregated frames.
354 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
355 * @ampdu_ack_map: block ack bit map for the aggregation.
356 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
357 * @ack_signal: signal strength of the ACK frame
359 struct ieee80211_tx_info {
360 /* common information */
374 struct ieee80211_tx_rate rates[
375 IEEE80211_TX_MAX_RATES];
378 /* only needed before rate control */
379 unsigned long jiffies;
381 /* NB: vif can be NULL for injected frames */
382 struct ieee80211_vif *vif;
383 struct ieee80211_key_conf *hw_key;
384 struct ieee80211_sta *sta;
387 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
394 struct ieee80211_tx_rate driver_rates[
395 IEEE80211_TX_MAX_RATES];
396 void *rate_driver_data[
397 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
400 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
404 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
406 return (struct ieee80211_tx_info *)skb->cb;
410 * ieee80211_tx_info_clear_status - clear TX status
412 * @info: The &struct ieee80211_tx_info to be cleared.
414 * When the driver passes an skb back to mac80211, it must report
415 * a number of things in TX status. This function clears everything
416 * in the TX status but the rate control information (it does clear
417 * the count since you need to fill that in anyway).
419 * NOTE: You can only use this function if you do NOT use
420 * info->driver_data! Use info->rate_driver_data
421 * instead if you need only the less space that allows.
424 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
428 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
429 offsetof(struct ieee80211_tx_info, control.rates));
430 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
431 offsetof(struct ieee80211_tx_info, driver_rates));
432 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
433 /* clear the rate counts */
434 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
435 info->status.rates[i].count = 0;
438 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
439 memset(&info->status.ampdu_ack_len, 0,
440 sizeof(struct ieee80211_tx_info) -
441 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
446 * enum mac80211_rx_flags - receive flags
448 * These flags are used with the @flag member of &struct ieee80211_rx_status.
449 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
450 * Use together with %RX_FLAG_MMIC_STRIPPED.
451 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
452 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
453 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
454 * verification has been done by the hardware.
455 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
456 * If this flag is set, the stack cannot do any replay detection
457 * hence the driver or hardware will have to do that.
458 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
460 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
462 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
463 * is valid. This is useful in monitor mode and necessary for beacon frames
464 * to enable IBSS merging.
465 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
466 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
467 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
468 * @RX_FLAG_SHORT_GI: Short guard interval was used
470 enum mac80211_rx_flags {
471 RX_FLAG_MMIC_ERROR = 1<<0,
472 RX_FLAG_DECRYPTED = 1<<1,
473 RX_FLAG_RADIOTAP = 1<<2,
474 RX_FLAG_MMIC_STRIPPED = 1<<3,
475 RX_FLAG_IV_STRIPPED = 1<<4,
476 RX_FLAG_FAILED_FCS_CRC = 1<<5,
477 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
479 RX_FLAG_SHORTPRE = 1<<8,
481 RX_FLAG_40MHZ = 1<<10,
482 RX_FLAG_SHORT_GI = 1<<11,
486 * struct ieee80211_rx_status - receive status
488 * The low-level driver should provide this information (the subset
489 * supported by hardware) to the 802.11 code with each received
492 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
493 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
494 * @band: the active band when this frame was received
495 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
496 * @signal: signal strength when receiving this frame, either in dBm, in dB or
497 * unspecified depending on the hardware capabilities flags
498 * @IEEE80211_HW_SIGNAL_*
499 * @noise: noise when receiving this frame, in dBm.
500 * @qual: overall signal quality indication, in percent (0-100).
501 * @antenna: antenna used
502 * @rate_idx: index of data rate into band's supported rates or MCS index if
503 * HT rates are use (RX_FLAG_HT)
506 struct ieee80211_rx_status {
508 enum ieee80211_band band;
519 * enum ieee80211_conf_flags - configuration flags
521 * Flags to define PHY configuration options
523 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
524 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
526 enum ieee80211_conf_flags {
527 IEEE80211_CONF_RADIOTAP = (1<<0),
528 IEEE80211_CONF_PS = (1<<1),
533 * enum ieee80211_conf_changed - denotes which configuration changed
535 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
536 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
537 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
538 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
539 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
540 * @IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT: the dynamic PS timeout changed
541 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
542 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
543 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
545 enum ieee80211_conf_changed {
546 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
547 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1),
548 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
549 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
550 IEEE80211_CONF_CHANGE_PS = BIT(4),
551 IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT = BIT(5),
552 IEEE80211_CONF_CHANGE_POWER = BIT(6),
553 IEEE80211_CONF_CHANGE_CHANNEL = BIT(7),
554 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(8),
558 * struct ieee80211_conf - configuration of the device
560 * This struct indicates how the driver shall configure the hardware.
562 * @radio_enabled: when zero, driver is required to switch off the radio.
563 * @beacon_int: beacon interval (TODO make interface config)
564 * @listen_interval: listen interval in units of beacon interval
565 * @flags: configuration flags defined above
566 * @power_level: requested transmit power (in dBm)
567 * @dynamic_ps_timeout: dynamic powersave timeout (in ms)
568 * @channel: the channel to tune to
569 * @channel_type: the channel (HT) type
570 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
571 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
572 * but actually means the number of transmissions not the number of retries
573 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
574 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
575 * number of transmissions not the number of retries
577 struct ieee80211_conf {
580 int power_level, dynamic_ps_timeout;
585 u8 long_frame_max_tx_count, short_frame_max_tx_count;
587 struct ieee80211_channel *channel;
588 enum nl80211_channel_type channel_type;
592 * struct ieee80211_vif - per-interface data
594 * Data in this structure is continually present for driver
595 * use during the life of a virtual interface.
597 * @type: type of this virtual interface
598 * @bss_conf: BSS configuration for this interface, either our own
599 * or the BSS we're associated to
600 * @drv_priv: data area for driver use, will always be aligned to
603 struct ieee80211_vif {
604 enum nl80211_iftype type;
605 struct ieee80211_bss_conf bss_conf;
607 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
610 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
612 #ifdef CONFIG_MAC80211_MESH
613 return vif->type == NL80211_IFTYPE_MESH_POINT;
619 * struct ieee80211_if_init_conf - initial configuration of an interface
621 * @vif: pointer to a driver-use per-interface structure. The pointer
622 * itself is also used for various functions including
623 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
624 * @type: one of &enum nl80211_iftype constants. Determines the type of
625 * added/removed interface.
626 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
627 * until the interface is removed (i.e. it cannot be used after
628 * remove_interface() callback was called for this interface).
630 * This structure is used in add_interface() and remove_interface()
631 * callbacks of &struct ieee80211_hw.
633 * When you allow multiple interfaces to be added to your PHY, take care
634 * that the hardware can actually handle multiple MAC addresses. However,
635 * also take care that when there's no interface left with mac_addr != %NULL
636 * you remove the MAC address from the device to avoid acknowledging packets
637 * in pure monitor mode.
639 struct ieee80211_if_init_conf {
640 enum nl80211_iftype type;
641 struct ieee80211_vif *vif;
646 * enum ieee80211_if_conf_change - interface config change flags
648 * @IEEE80211_IFCC_BSSID: The BSSID changed.
649 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
650 * (currently AP and MESH only), use ieee80211_beacon_get().
651 * @IEEE80211_IFCC_BEACON_ENABLED: The enable_beacon value changed.
653 enum ieee80211_if_conf_change {
654 IEEE80211_IFCC_BSSID = BIT(0),
655 IEEE80211_IFCC_BEACON = BIT(1),
656 IEEE80211_IFCC_BEACON_ENABLED = BIT(2),
660 * struct ieee80211_if_conf - configuration of an interface
662 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
663 * @bssid: BSSID of the network we are associated to/creating.
664 * @enable_beacon: Indicates whether beacons can be sent.
665 * This is valid only for AP/IBSS/MESH modes.
667 * This structure is passed to the config_interface() callback of
668 * &struct ieee80211_hw.
670 struct ieee80211_if_conf {
677 * enum ieee80211_key_alg - key algorithm
678 * @ALG_WEP: WEP40 or WEP104
680 * @ALG_CCMP: CCMP (AES)
681 * @ALG_AES_CMAC: AES-128-CMAC
683 enum ieee80211_key_alg {
691 * enum ieee80211_key_len - key length
692 * @LEN_WEP40: WEP 5-byte long key
693 * @LEN_WEP104: WEP 13-byte long key
695 enum ieee80211_key_len {
701 * enum ieee80211_key_flags - key flags
703 * These flags are used for communication about keys between the driver
704 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
706 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
707 * that the STA this key will be used with could be using QoS.
708 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
709 * driver to indicate that it requires IV generation for this
711 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
712 * the driver for a TKIP key if it requires Michael MIC
713 * generation in software.
714 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
715 * that the key is pairwise rather then a shared key.
716 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
717 * CCMP key if it requires CCMP encryption of management frames (MFP) to
718 * be done in software.
720 enum ieee80211_key_flags {
721 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
722 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
723 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
724 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
725 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
729 * struct ieee80211_key_conf - key information
731 * This key information is given by mac80211 to the driver by
732 * the set_key() callback in &struct ieee80211_ops.
734 * @hw_key_idx: To be set by the driver, this is the key index the driver
735 * wants to be given when a frame is transmitted and needs to be
736 * encrypted in hardware.
737 * @alg: The key algorithm.
738 * @flags: key flags, see &enum ieee80211_key_flags.
739 * @keyidx: the key index (0-3)
740 * @keylen: key material length
741 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
743 * - Temporal Encryption Key (128 bits)
744 * - Temporal Authenticator Tx MIC Key (64 bits)
745 * - Temporal Authenticator Rx MIC Key (64 bits)
746 * @icv_len: The ICV length for this key type
747 * @iv_len: The IV length for this key type
749 struct ieee80211_key_conf {
750 enum ieee80211_key_alg alg;
761 * enum set_key_cmd - key command
763 * Used with the set_key() callback in &struct ieee80211_ops, this
764 * indicates whether a key is being removed or added.
766 * @SET_KEY: a key is set
767 * @DISABLE_KEY: a key must be disabled
770 SET_KEY, DISABLE_KEY,
774 * struct ieee80211_sta - station table entry
776 * A station table entry represents a station we are possibly
777 * communicating with. Since stations are RCU-managed in
778 * mac80211, any ieee80211_sta pointer you get access to must
779 * either be protected by rcu_read_lock() explicitly or implicitly,
780 * or you must take good care to not use such a pointer after a
781 * call to your sta_notify callback that removed it.
784 * @aid: AID we assigned to the station if we're an AP
785 * @supp_rates: Bitmap of supported rates (per band)
786 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
787 * @drv_priv: data area for driver use, will always be aligned to
788 * sizeof(void *), size is determined in hw information.
790 struct ieee80211_sta {
791 u32 supp_rates[IEEE80211_NUM_BANDS];
794 struct ieee80211_sta_ht_cap ht_cap;
797 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
801 * enum sta_notify_cmd - sta notify command
803 * Used with the sta_notify() callback in &struct ieee80211_ops, this
804 * indicates addition and removal of a station to station table,
805 * or if a associated station made a power state transition.
807 * @STA_NOTIFY_ADD: a station was added to the station table
808 * @STA_NOTIFY_REMOVE: a station being removed from the station table
809 * @STA_NOTIFY_SLEEP: a station is now sleeping
810 * @STA_NOTIFY_AWAKE: a sleeping station woke up
812 enum sta_notify_cmd {
813 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
814 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
818 * enum ieee80211_tkip_key_type - get tkip key
820 * Used by drivers which need to get a tkip key for skb. Some drivers need a
821 * phase 1 key, others need a phase 2 key. A single function allows the driver
822 * to get the key, this enum indicates what type of key is required.
824 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
825 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
827 enum ieee80211_tkip_key_type {
828 IEEE80211_TKIP_P1_KEY,
829 IEEE80211_TKIP_P2_KEY,
833 * enum ieee80211_hw_flags - hardware flags
835 * These flags are used to indicate hardware capabilities to
836 * the stack. Generally, flags here should have their meaning
837 * done in a way that the simplest hardware doesn't need setting
838 * any particular flags. There are some exceptions to this rule,
839 * however, so you are advised to review these flags carefully.
841 * @IEEE80211_HW_RX_INCLUDES_FCS:
842 * Indicates that received frames passed to the stack include
843 * the FCS at the end.
845 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
846 * Some wireless LAN chipsets buffer broadcast/multicast frames
847 * for power saving stations in the hardware/firmware and others
848 * rely on the host system for such buffering. This option is used
849 * to configure the IEEE 802.11 upper layer to buffer broadcast and
850 * multicast frames when there are power saving stations so that
851 * the driver can fetch them with ieee80211_get_buffered_bc().
853 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
854 * Hardware is not capable of short slot operation on the 2.4 GHz band.
856 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
857 * Hardware is not capable of receiving frames with short preamble on
860 * @IEEE80211_HW_SIGNAL_UNSPEC:
861 * Hardware can provide signal values but we don't know its units. We
862 * expect values between 0 and @max_signal.
863 * If possible please provide dB or dBm instead.
865 * @IEEE80211_HW_SIGNAL_DBM:
866 * Hardware gives signal values in dBm, decibel difference from
867 * one milliwatt. This is the preferred method since it is standardized
868 * between different devices. @max_signal does not need to be set.
870 * @IEEE80211_HW_NOISE_DBM:
871 * Hardware can provide noise (radio interference) values in units dBm,
872 * decibel difference from one milliwatt.
874 * @IEEE80211_HW_SPECTRUM_MGMT:
875 * Hardware supports spectrum management defined in 802.11h
876 * Measurement, Channel Switch, Quieting, TPC
878 * @IEEE80211_HW_AMPDU_AGGREGATION:
879 * Hardware supports 11n A-MPDU aggregation.
881 * @IEEE80211_HW_SUPPORTS_PS:
882 * Hardware has power save support (i.e. can go to sleep).
884 * @IEEE80211_HW_PS_NULLFUNC_STACK:
885 * Hardware requires nullfunc frame handling in stack, implies
886 * stack support for dynamic PS.
888 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
889 * Hardware has support for dynamic PS.
891 * @IEEE80211_HW_MFP_CAPABLE:
892 * Hardware supports management frame protection (MFP, IEEE 802.11w).
894 * @IEEE80211_HW_BEACON_FILTER:
895 * Hardware supports dropping of irrelevant beacon frames to
896 * avoid waking up cpu.
898 enum ieee80211_hw_flags {
899 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
900 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
901 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
902 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
903 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
904 IEEE80211_HW_SIGNAL_DBM = 1<<6,
905 IEEE80211_HW_NOISE_DBM = 1<<7,
906 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
907 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
908 IEEE80211_HW_SUPPORTS_PS = 1<<10,
909 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
910 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
911 IEEE80211_HW_MFP_CAPABLE = 1<<13,
912 IEEE80211_HW_BEACON_FILTER = 1<<14,
916 * struct ieee80211_hw - hardware information and state
918 * This structure contains the configuration and hardware
919 * information for an 802.11 PHY.
921 * @wiphy: This points to the &struct wiphy allocated for this
922 * 802.11 PHY. You must fill in the @perm_addr and @dev
923 * members of this structure using SET_IEEE80211_DEV()
924 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
925 * bands (with channels, bitrates) are registered here.
927 * @conf: &struct ieee80211_conf, device configuration, don't use.
929 * @workqueue: single threaded workqueue available for driver use,
930 * allocated by mac80211 on registration and flushed when an
931 * interface is removed.
932 * NOTICE: All work performed on this workqueue must not
933 * acquire the RTNL lock.
935 * @priv: pointer to private area that was allocated for driver use
936 * along with this structure.
938 * @flags: hardware flags, see &enum ieee80211_hw_flags.
940 * @extra_tx_headroom: headroom to reserve in each transmit skb
941 * for use by the driver (e.g. for transmit headers.)
943 * @channel_change_time: time (in microseconds) it takes to change channels.
945 * @max_signal: Maximum value for signal (rssi) in RX information, used
946 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
948 * @max_listen_interval: max listen interval in units of beacon interval
951 * @queues: number of available hardware transmit queues for
952 * data packets. WMM/QoS requires at least four, these
953 * queues need to have configurable access parameters.
955 * @ampdu_queues: number of available hardware transmit queues
956 * for A-MPDU packets, these have no access parameters
957 * because they're used only for A-MPDU frames. Note that
958 * mac80211 will not currently use any of the regular queues
961 * @rate_control_algorithm: rate control algorithm for this hardware.
962 * If unset (NULL), the default algorithm will be used. Must be
963 * set before calling ieee80211_register_hw().
965 * @vif_data_size: size (in bytes) of the drv_priv data area
966 * within &struct ieee80211_vif.
967 * @sta_data_size: size (in bytes) of the drv_priv data area
968 * within &struct ieee80211_sta.
970 * @max_rates: maximum number of alternate rate retry stages
971 * @max_rate_tries: maximum number of tries for each stage
973 struct ieee80211_hw {
974 struct ieee80211_conf conf;
976 struct workqueue_struct *workqueue;
977 const char *rate_control_algorithm;
980 unsigned int extra_tx_headroom;
981 int channel_change_time;
986 u16 max_listen_interval;
993 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
995 * @wiphy: the &struct wiphy which we want to query
997 * mac80211 drivers can use this to get to their respective
998 * &struct ieee80211_hw. Drivers wishing to get to their own private
999 * structure can then access it via hw->priv. Note that mac802111 drivers should
1000 * not use wiphy_priv() to try to get their private driver structure as this
1001 * is already used internally by mac80211.
1003 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1006 * SET_IEEE80211_DEV - set device for 802.11 hardware
1008 * @hw: the &struct ieee80211_hw to set the device for
1009 * @dev: the &struct device of this 802.11 device
1011 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1013 set_wiphy_dev(hw->wiphy, dev);
1017 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1019 * @hw: the &struct ieee80211_hw to set the MAC address for
1020 * @addr: the address to set
1022 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1024 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1027 static inline struct ieee80211_rate *
1028 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1029 const struct ieee80211_tx_info *c)
1031 if (WARN_ON(c->control.rates[0].idx < 0))
1033 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1036 static inline struct ieee80211_rate *
1037 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1038 const struct ieee80211_tx_info *c)
1040 if (c->control.rts_cts_rate_idx < 0)
1042 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1045 static inline struct ieee80211_rate *
1046 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1047 const struct ieee80211_tx_info *c, int idx)
1049 if (c->control.rates[idx + 1].idx < 0)
1051 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1055 * DOC: Hardware crypto acceleration
1057 * mac80211 is capable of taking advantage of many hardware
1058 * acceleration designs for encryption and decryption operations.
1060 * The set_key() callback in the &struct ieee80211_ops for a given
1061 * device is called to enable hardware acceleration of encryption and
1062 * decryption. The callback takes a @sta parameter that will be NULL
1063 * for default keys or keys used for transmission only, or point to
1064 * the station information for the peer for individual keys.
1065 * Multiple transmission keys with the same key index may be used when
1066 * VLANs are configured for an access point.
1068 * When transmitting, the TX control data will use the @hw_key_idx
1069 * selected by the driver by modifying the &struct ieee80211_key_conf
1070 * pointed to by the @key parameter to the set_key() function.
1072 * The set_key() call for the %SET_KEY command should return 0 if
1073 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1074 * added; if you return 0 then hw_key_idx must be assigned to the
1075 * hardware key index, you are free to use the full u8 range.
1077 * When the cmd is %DISABLE_KEY then it must succeed.
1079 * Note that it is permissible to not decrypt a frame even if a key
1080 * for it has been uploaded to hardware, the stack will not make any
1081 * decision based on whether a key has been uploaded or not but rather
1082 * based on the receive flags.
1084 * The &struct ieee80211_key_conf structure pointed to by the @key
1085 * parameter is guaranteed to be valid until another call to set_key()
1086 * removes it, but it can only be used as a cookie to differentiate
1089 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1090 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1092 * The update_tkip_key() call updates the driver with the new phase 1 key.
1093 * This happens everytime the iv16 wraps around (every 65536 packets). The
1094 * set_key() call will happen only once for each key (unless the AP did
1095 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1096 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1097 * handler is software decryption with wrap around of iv16.
1101 * DOC: Powersave support
1103 * mac80211 has support for various powersave implementations.
1105 * First, it can support hardware that handles all powersaving by
1106 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1107 * hardware flag. In that case, it will be told about the desired
1108 * powersave mode depending on the association status, and the driver
1109 * must take care of sending nullfunc frames when necessary, i.e. when
1110 * entering and leaving powersave mode. The driver is required to look at
1111 * the AID in beacons and signal to the AP that it woke up when it finds
1112 * traffic directed to it. This mode supports dynamic PS by simply
1113 * enabling/disabling PS.
1115 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1116 * flag to indicate that it can support dynamic PS mode itself (see below).
1118 * Other hardware designs cannot send nullfunc frames by themselves and also
1119 * need software support for parsing the TIM bitmap. This is also supported
1120 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1121 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1122 * required to pass up beacons. Additionally, in this case, mac80211 will
1123 * wake up the hardware when multicast traffic is announced in the beacon.
1125 * FIXME: I don't think we can be fast enough in software when we want to
1126 * receive multicast traffic?
1128 * Dynamic powersave mode is an extension to normal powersave mode in which
1129 * the hardware stays awake for a user-specified period of time after sending
1130 * a frame so that reply frames need not be buffered and therefore delayed
1131 * to the next wakeup. This can either be supported by hardware, in which case
1132 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1133 * value, or by the stack if all nullfunc handling is in the stack.
1137 * DOC: Beacon filter support
1139 * Some hardware have beacon filter support to reduce host cpu wakeups
1140 * which will reduce system power consumption. It usuallly works so that
1141 * the firmware creates a checksum of the beacon but omits all constantly
1142 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1143 * beacon is forwarded to the host, otherwise it will be just dropped. That
1144 * way the host will only receive beacons where some relevant information
1145 * (for example ERP protection or WMM settings) have changed.
1147 * Beacon filter support is informed with %IEEE80211_HW_BEACON_FILTER flag.
1148 * The driver needs to enable beacon filter support whenever power save is
1149 * enabled, that is %IEEE80211_CONF_PS is set. When power save is enabled,
1150 * the stack will not check for beacon miss at all and the driver needs to
1151 * notify about complete loss of beacons with ieee80211_beacon_loss().
1155 * DOC: Frame filtering
1157 * mac80211 requires to see many management frames for proper
1158 * operation, and users may want to see many more frames when
1159 * in monitor mode. However, for best CPU usage and power consumption,
1160 * having as few frames as possible percolate through the stack is
1161 * desirable. Hence, the hardware should filter as much as possible.
1163 * To achieve this, mac80211 uses filter flags (see below) to tell
1164 * the driver's configure_filter() function which frames should be
1165 * passed to mac80211 and which should be filtered out.
1167 * The configure_filter() callback is invoked with the parameters
1168 * @mc_count and @mc_list for the combined multicast address list
1169 * of all virtual interfaces, @changed_flags telling which flags
1170 * were changed and @total_flags with the new flag states.
1172 * If your device has no multicast address filters your driver will
1173 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1174 * parameter to see whether multicast frames should be accepted
1177 * All unsupported flags in @total_flags must be cleared.
1178 * Hardware does not support a flag if it is incapable of _passing_
1179 * the frame to the stack. Otherwise the driver must ignore
1180 * the flag, but not clear it.
1181 * You must _only_ clear the flag (announce no support for the
1182 * flag to mac80211) if you are not able to pass the packet type
1183 * to the stack (so the hardware always filters it).
1184 * So for example, you should clear @FIF_CONTROL, if your hardware
1185 * always filters control frames. If your hardware always passes
1186 * control frames to the kernel and is incapable of filtering them,
1187 * you do _not_ clear the @FIF_CONTROL flag.
1188 * This rule applies to all other FIF flags as well.
1192 * enum ieee80211_filter_flags - hardware filter flags
1194 * These flags determine what the filter in hardware should be
1195 * programmed to let through and what should not be passed to the
1196 * stack. It is always safe to pass more frames than requested,
1197 * but this has negative impact on power consumption.
1199 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1200 * think of the BSS as your network segment and then this corresponds
1201 * to the regular ethernet device promiscuous mode.
1203 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1204 * by the user or if the hardware is not capable of filtering by
1205 * multicast address.
1207 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1208 * %RX_FLAG_FAILED_FCS_CRC for them)
1210 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1211 * the %RX_FLAG_FAILED_PLCP_CRC for them
1213 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1214 * to the hardware that it should not filter beacons or probe responses
1215 * by BSSID. Filtering them can greatly reduce the amount of processing
1216 * mac80211 needs to do and the amount of CPU wakeups, so you should
1217 * honour this flag if possible.
1219 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1220 * only those addressed to this station
1222 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1224 enum ieee80211_filter_flags {
1225 FIF_PROMISC_IN_BSS = 1<<0,
1226 FIF_ALLMULTI = 1<<1,
1228 FIF_PLCPFAIL = 1<<3,
1229 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1231 FIF_OTHER_BSS = 1<<6,
1235 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1237 * These flags are used with the ampdu_action() callback in
1238 * &struct ieee80211_ops to indicate which action is needed.
1239 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1240 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1241 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1242 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1243 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1245 enum ieee80211_ampdu_mlme_action {
1246 IEEE80211_AMPDU_RX_START,
1247 IEEE80211_AMPDU_RX_STOP,
1248 IEEE80211_AMPDU_TX_START,
1249 IEEE80211_AMPDU_TX_STOP,
1250 IEEE80211_AMPDU_TX_OPERATIONAL,
1254 * struct ieee80211_ops - callbacks from mac80211 to the driver
1256 * This structure contains various callbacks that the driver may
1257 * handle or, in some cases, must handle, for example to configure
1258 * the hardware to a new channel or to transmit a frame.
1260 * @tx: Handler that 802.11 module calls for each transmitted frame.
1261 * skb contains the buffer starting from the IEEE 802.11 header.
1262 * The low-level driver should send the frame out based on
1263 * configuration in the TX control data. This handler should,
1264 * preferably, never fail and stop queues appropriately, more
1265 * importantly, however, it must never fail for A-MPDU-queues.
1266 * This function should return NETDEV_TX_OK except in very
1268 * Must be implemented and atomic.
1270 * @start: Called before the first netdevice attached to the hardware
1271 * is enabled. This should turn on the hardware and must turn on
1272 * frame reception (for possibly enabled monitor interfaces.)
1273 * Returns negative error codes, these may be seen in userspace,
1275 * When the device is started it should not have a MAC address
1276 * to avoid acknowledging frames before a non-monitor device
1278 * Must be implemented.
1280 * @stop: Called after last netdevice attached to the hardware
1281 * is disabled. This should turn off the hardware (at least
1282 * it must turn off frame reception.)
1283 * May be called right after add_interface if that rejects
1285 * Must be implemented.
1287 * @add_interface: Called when a netdevice attached to the hardware is
1288 * enabled. Because it is not called for monitor mode devices, @start
1289 * and @stop must be implemented.
1290 * The driver should perform any initialization it needs before
1291 * the device can be enabled. The initial configuration for the
1292 * interface is given in the conf parameter.
1293 * The callback may refuse to add an interface by returning a
1294 * negative error code (which will be seen in userspace.)
1295 * Must be implemented.
1297 * @remove_interface: Notifies a driver that an interface is going down.
1298 * The @stop callback is called after this if it is the last interface
1299 * and no monitor interfaces are present.
1300 * When all interfaces are removed, the MAC address in the hardware
1301 * must be cleared so the device no longer acknowledges packets,
1302 * the mac_addr member of the conf structure is, however, set to the
1303 * MAC address of the device going away.
1304 * Hence, this callback must be implemented.
1306 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1307 * function to change hardware configuration, e.g., channel.
1308 * This function should never fail but returns a negative error code
1311 * @config_interface: Handler for configuration requests related to interfaces
1312 * (e.g. BSSID changes.)
1313 * Returns a negative error code which will be seen in userspace.
1315 * @bss_info_changed: Handler for configuration requests related to BSS
1316 * parameters that may vary during BSS's lifespan, and may affect low
1317 * level driver (e.g. assoc/disassoc status, erp parameters).
1318 * This function should not be used if no BSS has been set, unless
1319 * for association indication. The @changed parameter indicates which
1320 * of the bss parameters has changed when a call is made.
1322 * @configure_filter: Configure the device's RX filter.
1323 * See the section "Frame filtering" for more information.
1324 * This callback must be implemented and atomic.
1326 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1327 * must be set or cleared for a given STA. Must be atomic.
1329 * @set_key: See the section "Hardware crypto acceleration"
1330 * This callback can sleep, and is only called between add_interface
1331 * and remove_interface calls, i.e. while the given virtual interface
1333 * Returns a negative error code if the key can't be added.
1335 * @update_tkip_key: See the section "Hardware crypto acceleration"
1336 * This callback will be called in the context of Rx. Called for drivers
1337 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1339 * @hw_scan: Ask the hardware to service the scan request, no need to start
1340 * the scan state machine in stack. The scan must honour the channel
1341 * configuration done by the regulatory agent in the wiphy's
1342 * registered bands. The hardware (or the driver) needs to make sure
1343 * that power save is disabled. When the scan finishes,
1344 * ieee80211_scan_completed() must be called; note that it also must
1345 * be called when the scan cannot finish because the hardware is
1346 * turned off! Anything else is a bug! Returns a negative error code
1347 * which will be seen in userspace.
1349 * @sw_scan_start: Notifier function that is called just before a software scan
1350 * is started. Can be NULL, if the driver doesn't need this notification.
1352 * @sw_scan_complete: Notifier function that is called just after a software scan
1353 * finished. Can be NULL, if the driver doesn't need this notification.
1355 * @get_stats: Return low-level statistics.
1356 * Returns zero if statistics are available.
1358 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1359 * callback should be provided to read the TKIP transmit IVs (both IV32
1360 * and IV16) for the given key from hardware.
1362 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1364 * @sta_notify: Notifies low level driver about addition, removal or power
1365 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1368 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1369 * bursting) for a hardware TX queue.
1370 * Returns a negative error code on failure.
1372 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1373 * to get number of currently queued packets (queue length), maximum queue
1374 * size (limit), and total number of packets sent using each TX queue
1375 * (count). The 'stats' pointer points to an array that has hw->queues +
1376 * hw->ampdu_queues items.
1378 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1379 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1380 * required function.
1382 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1383 * Currently, this is only used for IBSS mode debugging. Is not a
1384 * required function.
1386 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1387 * with other STAs in the IBSS. This is only used in IBSS mode. This
1388 * function is optional if the firmware/hardware takes full care of
1389 * TSF synchronization.
1391 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1392 * This is needed only for IBSS mode and the result of this function is
1393 * used to determine whether to reply to Probe Requests.
1394 * Returns non-zero if this device sent the last beacon.
1396 * @ampdu_action: Perform a certain A-MPDU action
1397 * The RA/TID combination determines the destination and TID we want
1398 * the ampdu action to be performed for. The action is defined through
1399 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1400 * is the first frame we expect to perform the action on. Notice
1401 * that TX/RX_STOP can pass NULL for this parameter.
1402 * Returns a negative error code on failure.
1404 struct ieee80211_ops {
1405 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1406 int (*start)(struct ieee80211_hw *hw);
1407 void (*stop)(struct ieee80211_hw *hw);
1408 int (*add_interface)(struct ieee80211_hw *hw,
1409 struct ieee80211_if_init_conf *conf);
1410 void (*remove_interface)(struct ieee80211_hw *hw,
1411 struct ieee80211_if_init_conf *conf);
1412 int (*config)(struct ieee80211_hw *hw, u32 changed);
1413 int (*config_interface)(struct ieee80211_hw *hw,
1414 struct ieee80211_vif *vif,
1415 struct ieee80211_if_conf *conf);
1416 void (*bss_info_changed)(struct ieee80211_hw *hw,
1417 struct ieee80211_vif *vif,
1418 struct ieee80211_bss_conf *info,
1420 void (*configure_filter)(struct ieee80211_hw *hw,
1421 unsigned int changed_flags,
1422 unsigned int *total_flags,
1423 int mc_count, struct dev_addr_list *mc_list);
1424 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1426 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1427 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1428 struct ieee80211_key_conf *key);
1429 void (*update_tkip_key)(struct ieee80211_hw *hw,
1430 struct ieee80211_key_conf *conf, const u8 *address,
1431 u32 iv32, u16 *phase1key);
1432 int (*hw_scan)(struct ieee80211_hw *hw,
1433 struct cfg80211_scan_request *req);
1434 void (*sw_scan_start)(struct ieee80211_hw *hw);
1435 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1436 int (*get_stats)(struct ieee80211_hw *hw,
1437 struct ieee80211_low_level_stats *stats);
1438 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1439 u32 *iv32, u16 *iv16);
1440 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1441 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1442 enum sta_notify_cmd, struct ieee80211_sta *sta);
1443 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1444 const struct ieee80211_tx_queue_params *params);
1445 int (*get_tx_stats)(struct ieee80211_hw *hw,
1446 struct ieee80211_tx_queue_stats *stats);
1447 u64 (*get_tsf)(struct ieee80211_hw *hw);
1448 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1449 void (*reset_tsf)(struct ieee80211_hw *hw);
1450 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1451 int (*ampdu_action)(struct ieee80211_hw *hw,
1452 enum ieee80211_ampdu_mlme_action action,
1453 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1457 * ieee80211_alloc_hw - Allocate a new hardware device
1459 * This must be called once for each hardware device. The returned pointer
1460 * must be used to refer to this device when calling other functions.
1461 * mac80211 allocates a private data area for the driver pointed to by
1462 * @priv in &struct ieee80211_hw, the size of this area is given as
1465 * @priv_data_len: length of private data
1466 * @ops: callbacks for this device
1468 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1469 const struct ieee80211_ops *ops);
1472 * ieee80211_register_hw - Register hardware device
1474 * You must call this function before any other functions in
1475 * mac80211. Note that before a hardware can be registered, you
1476 * need to fill the contained wiphy's information.
1478 * @hw: the device to register as returned by ieee80211_alloc_hw()
1480 int ieee80211_register_hw(struct ieee80211_hw *hw);
1482 #ifdef CONFIG_MAC80211_LEDS
1483 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1484 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1485 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1486 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1489 * ieee80211_get_tx_led_name - get name of TX LED
1491 * mac80211 creates a transmit LED trigger for each wireless hardware
1492 * that can be used to drive LEDs if your driver registers a LED device.
1493 * This function returns the name (or %NULL if not configured for LEDs)
1494 * of the trigger so you can automatically link the LED device.
1496 * @hw: the hardware to get the LED trigger name for
1498 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1500 #ifdef CONFIG_MAC80211_LEDS
1501 return __ieee80211_get_tx_led_name(hw);
1508 * ieee80211_get_rx_led_name - get name of RX LED
1510 * mac80211 creates a receive LED trigger for each wireless hardware
1511 * that can be used to drive LEDs if your driver registers a LED device.
1512 * This function returns the name (or %NULL if not configured for LEDs)
1513 * of the trigger so you can automatically link the LED device.
1515 * @hw: the hardware to get the LED trigger name for
1517 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1519 #ifdef CONFIG_MAC80211_LEDS
1520 return __ieee80211_get_rx_led_name(hw);
1527 * ieee80211_get_assoc_led_name - get name of association LED
1529 * mac80211 creates a association LED trigger for each wireless hardware
1530 * that can be used to drive LEDs if your driver registers a LED device.
1531 * This function returns the name (or %NULL if not configured for LEDs)
1532 * of the trigger so you can automatically link the LED device.
1534 * @hw: the hardware to get the LED trigger name for
1536 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1538 #ifdef CONFIG_MAC80211_LEDS
1539 return __ieee80211_get_assoc_led_name(hw);
1546 * ieee80211_get_radio_led_name - get name of radio LED
1548 * mac80211 creates a radio change LED trigger for each wireless hardware
1549 * that can be used to drive LEDs if your driver registers a LED device.
1550 * This function returns the name (or %NULL if not configured for LEDs)
1551 * of the trigger so you can automatically link the LED device.
1553 * @hw: the hardware to get the LED trigger name for
1555 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1557 #ifdef CONFIG_MAC80211_LEDS
1558 return __ieee80211_get_radio_led_name(hw);
1565 * ieee80211_unregister_hw - Unregister a hardware device
1567 * This function instructs mac80211 to free allocated resources
1568 * and unregister netdevices from the networking subsystem.
1570 * @hw: the hardware to unregister
1572 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1575 * ieee80211_free_hw - free hardware descriptor
1577 * This function frees everything that was allocated, including the
1578 * private data for the driver. You must call ieee80211_unregister_hw()
1579 * before calling this function.
1581 * @hw: the hardware to free
1583 void ieee80211_free_hw(struct ieee80211_hw *hw);
1585 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1586 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1587 struct ieee80211_rx_status *status);
1590 * ieee80211_rx - receive frame
1592 * Use this function to hand received frames to mac80211. The receive
1593 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1594 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1596 * This function may not be called in IRQ context. Calls to this function
1597 * for a single hardware must be synchronized against each other. Calls
1598 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1601 * @hw: the hardware this frame came in on
1602 * @skb: the buffer to receive, owned by mac80211 after this call
1603 * @status: status of this frame; the status pointer need not be valid
1604 * after this function returns
1606 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1607 struct ieee80211_rx_status *status)
1609 __ieee80211_rx(hw, skb, status);
1613 * ieee80211_rx_irqsafe - receive frame
1615 * Like ieee80211_rx() but can be called in IRQ context
1616 * (internally defers to a tasklet.)
1618 * Calls to this function and ieee80211_rx() may not be mixed for a
1621 * @hw: the hardware this frame came in on
1622 * @skb: the buffer to receive, owned by mac80211 after this call
1623 * @status: status of this frame; the status pointer need not be valid
1624 * after this function returns and is not freed by mac80211,
1625 * it is recommended that it points to a stack area
1627 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1628 struct sk_buff *skb,
1629 struct ieee80211_rx_status *status);
1632 * ieee80211_tx_status - transmit status callback
1634 * Call this function for all transmitted frames after they have been
1635 * transmitted. It is permissible to not call this function for
1636 * multicast frames but this can affect statistics.
1638 * This function may not be called in IRQ context. Calls to this function
1639 * for a single hardware must be synchronized against each other. Calls
1640 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1641 * for a single hardware.
1643 * @hw: the hardware the frame was transmitted by
1644 * @skb: the frame that was transmitted, owned by mac80211 after this call
1646 void ieee80211_tx_status(struct ieee80211_hw *hw,
1647 struct sk_buff *skb);
1650 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1652 * Like ieee80211_tx_status() but can be called in IRQ context
1653 * (internally defers to a tasklet.)
1655 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1658 * @hw: the hardware the frame was transmitted by
1659 * @skb: the frame that was transmitted, owned by mac80211 after this call
1661 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1662 struct sk_buff *skb);
1665 * ieee80211_beacon_get - beacon generation function
1666 * @hw: pointer obtained from ieee80211_alloc_hw().
1667 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1669 * If the beacon frames are generated by the host system (i.e., not in
1670 * hardware/firmware), the low-level driver uses this function to receive
1671 * the next beacon frame from the 802.11 code. The low-level is responsible
1672 * for calling this function before beacon data is needed (e.g., based on
1673 * hardware interrupt). Returned skb is used only once and low-level driver
1674 * is responsible for freeing it.
1676 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1677 struct ieee80211_vif *vif);
1680 * ieee80211_rts_get - RTS frame generation function
1681 * @hw: pointer obtained from ieee80211_alloc_hw().
1682 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1683 * @frame: pointer to the frame that is going to be protected by the RTS.
1684 * @frame_len: the frame length (in octets).
1685 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1686 * @rts: The buffer where to store the RTS frame.
1688 * If the RTS frames are generated by the host system (i.e., not in
1689 * hardware/firmware), the low-level driver uses this function to receive
1690 * the next RTS frame from the 802.11 code. The low-level is responsible
1691 * for calling this function before and RTS frame is needed.
1693 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1694 const void *frame, size_t frame_len,
1695 const struct ieee80211_tx_info *frame_txctl,
1696 struct ieee80211_rts *rts);
1699 * ieee80211_rts_duration - Get the duration field for an RTS frame
1700 * @hw: pointer obtained from ieee80211_alloc_hw().
1701 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1702 * @frame_len: the length of the frame that is going to be protected by the RTS.
1703 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1705 * If the RTS is generated in firmware, but the host system must provide
1706 * the duration field, the low-level driver uses this function to receive
1707 * the duration field value in little-endian byteorder.
1709 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1710 struct ieee80211_vif *vif, size_t frame_len,
1711 const struct ieee80211_tx_info *frame_txctl);
1714 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1715 * @hw: pointer obtained from ieee80211_alloc_hw().
1716 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1717 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1718 * @frame_len: the frame length (in octets).
1719 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1720 * @cts: The buffer where to store the CTS-to-self frame.
1722 * If the CTS-to-self frames are generated by the host system (i.e., not in
1723 * hardware/firmware), the low-level driver uses this function to receive
1724 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1725 * for calling this function before and CTS-to-self frame is needed.
1727 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1728 struct ieee80211_vif *vif,
1729 const void *frame, size_t frame_len,
1730 const struct ieee80211_tx_info *frame_txctl,
1731 struct ieee80211_cts *cts);
1734 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1735 * @hw: pointer obtained from ieee80211_alloc_hw().
1736 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1737 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1738 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1740 * If the CTS-to-self is generated in firmware, but the host system must provide
1741 * the duration field, the low-level driver uses this function to receive
1742 * the duration field value in little-endian byteorder.
1744 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1745 struct ieee80211_vif *vif,
1747 const struct ieee80211_tx_info *frame_txctl);
1750 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1751 * @hw: pointer obtained from ieee80211_alloc_hw().
1752 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1753 * @frame_len: the length of the frame.
1754 * @rate: the rate at which the frame is going to be transmitted.
1756 * Calculate the duration field of some generic frame, given its
1757 * length and transmission rate (in 100kbps).
1759 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1760 struct ieee80211_vif *vif,
1762 struct ieee80211_rate *rate);
1765 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1766 * @hw: pointer as obtained from ieee80211_alloc_hw().
1767 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1769 * Function for accessing buffered broadcast and multicast frames. If
1770 * hardware/firmware does not implement buffering of broadcast/multicast
1771 * frames when power saving is used, 802.11 code buffers them in the host
1772 * memory. The low-level driver uses this function to fetch next buffered
1773 * frame. In most cases, this is used when generating beacon frame. This
1774 * function returns a pointer to the next buffered skb or NULL if no more
1775 * buffered frames are available.
1777 * Note: buffered frames are returned only after DTIM beacon frame was
1778 * generated with ieee80211_beacon_get() and the low-level driver must thus
1779 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1780 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1781 * does not need to check for DTIM beacons separately and should be able to
1782 * use common code for all beacons.
1785 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1788 * ieee80211_get_hdrlen_from_skb - get header length from data
1790 * Given an skb with a raw 802.11 header at the data pointer this function
1791 * returns the 802.11 header length in bytes (not including encryption
1792 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1793 * header the function returns 0.
1797 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1800 * ieee80211_hdrlen - get header length in bytes from frame control
1801 * @fc: frame control field in little-endian format
1803 unsigned int ieee80211_hdrlen(__le16 fc);
1806 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1808 * This function computes a TKIP rc4 key for an skb. It computes
1809 * a phase 1 key if needed (iv16 wraps around). This function is to
1810 * be used by drivers which can do HW encryption but need to compute
1811 * to phase 1/2 key in SW.
1813 * @keyconf: the parameter passed with the set key
1814 * @skb: the skb for which the key is needed
1816 * @key: a buffer to which the key will be written
1818 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1819 struct sk_buff *skb,
1820 enum ieee80211_tkip_key_type type, u8 *key);
1822 * ieee80211_wake_queue - wake specific queue
1823 * @hw: pointer as obtained from ieee80211_alloc_hw().
1824 * @queue: queue number (counted from zero).
1826 * Drivers should use this function instead of netif_wake_queue.
1828 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1831 * ieee80211_stop_queue - stop specific queue
1832 * @hw: pointer as obtained from ieee80211_alloc_hw().
1833 * @queue: queue number (counted from zero).
1835 * Drivers should use this function instead of netif_stop_queue.
1837 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1840 * ieee80211_queue_stopped - test status of the queue
1841 * @hw: pointer as obtained from ieee80211_alloc_hw().
1842 * @queue: queue number (counted from zero).
1844 * Drivers should use this function instead of netif_stop_queue.
1847 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1850 * ieee80211_stop_queues - stop all queues
1851 * @hw: pointer as obtained from ieee80211_alloc_hw().
1853 * Drivers should use this function instead of netif_stop_queue.
1855 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1858 * ieee80211_wake_queues - wake all queues
1859 * @hw: pointer as obtained from ieee80211_alloc_hw().
1861 * Drivers should use this function instead of netif_wake_queue.
1863 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1866 * ieee80211_scan_completed - completed hardware scan
1868 * When hardware scan offload is used (i.e. the hw_scan() callback is
1869 * assigned) this function needs to be called by the driver to notify
1870 * mac80211 that the scan finished.
1872 * @hw: the hardware that finished the scan
1873 * @aborted: set to true if scan was aborted
1875 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
1878 * ieee80211_iterate_active_interfaces - iterate active interfaces
1880 * This function iterates over the interfaces associated with a given
1881 * hardware that are currently active and calls the callback for them.
1882 * This function allows the iterator function to sleep, when the iterator
1883 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1886 * @hw: the hardware struct of which the interfaces should be iterated over
1887 * @iterator: the iterator function to call
1888 * @data: first argument of the iterator function
1890 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1891 void (*iterator)(void *data, u8 *mac,
1892 struct ieee80211_vif *vif),
1896 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1898 * This function iterates over the interfaces associated with a given
1899 * hardware that are currently active and calls the callback for them.
1900 * This function requires the iterator callback function to be atomic,
1901 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1903 * @hw: the hardware struct of which the interfaces should be iterated over
1904 * @iterator: the iterator function to call, cannot sleep
1905 * @data: first argument of the iterator function
1907 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1908 void (*iterator)(void *data,
1910 struct ieee80211_vif *vif),
1914 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1915 * @hw: pointer as obtained from ieee80211_alloc_hw().
1916 * @ra: receiver address of the BA session recipient
1917 * @tid: the TID to BA on.
1919 * Return: success if addBA request was sent, failure otherwise
1921 * Although mac80211/low level driver/user space application can estimate
1922 * the need to start aggregation on a certain RA/TID, the session level
1923 * will be managed by the mac80211.
1925 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1928 * ieee80211_start_tx_ba_cb - 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.
1936 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1939 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1940 * @hw: pointer as obtained from ieee80211_alloc_hw().
1941 * @ra: receiver address of the BA session recipient.
1942 * @tid: the TID to BA on.
1944 * This function must be called by low level driver once it has
1945 * finished with preparations for the BA session.
1946 * This version of the function is IRQ-safe.
1948 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1952 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1953 * @hw: pointer as obtained from ieee80211_alloc_hw().
1954 * @ra: receiver address of the BA session recipient
1955 * @tid: the TID to stop BA.
1956 * @initiator: if indicates initiator DELBA frame will be sent.
1958 * Return: error if no sta with matching da found, success otherwise
1960 * Although mac80211/low level driver/user space application can estimate
1961 * the need to stop aggregation on a certain RA/TID, the session level
1962 * will be managed by the mac80211.
1964 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1966 enum ieee80211_back_parties initiator);
1969 * ieee80211_stop_tx_ba_cb - 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.
1977 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1980 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1981 * @hw: pointer as obtained from ieee80211_alloc_hw().
1982 * @ra: receiver address of the BA session recipient.
1983 * @tid: the desired TID to BA on.
1985 * This function must be called by low level driver once it has
1986 * finished with preparations for the BA session tear down.
1987 * This version of the function is IRQ-safe.
1989 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1993 * ieee80211_find_sta - find a station
1995 * @hw: pointer as obtained from ieee80211_alloc_hw()
1996 * @addr: station's address
1998 * This function must be called under RCU lock and the
1999 * resulting pointer is only valid under RCU lock as well.
2001 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
2005 * ieee80211_beacon_loss - inform hardware does not receive beacons
2007 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2009 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2010 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2011 * hardware is not receiving beacons with this function.
2013 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2015 /* Rate control API */
2018 * enum rate_control_changed - flags to indicate which parameter changed
2020 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2021 * changed, rate control algorithm can update its internal state if needed.
2023 enum rate_control_changed {
2024 IEEE80211_RC_HT_CHANGED = BIT(0)
2028 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2030 * @hw: The hardware the algorithm is invoked for.
2031 * @sband: The band this frame is being transmitted on.
2032 * @bss_conf: the current BSS configuration
2033 * @reported_rate: The rate control algorithm can fill this in to indicate
2034 * which rate should be reported to userspace as the current rate and
2035 * used for rate calculations in the mesh network.
2036 * @rts: whether RTS will be used for this frame because it is longer than the
2038 * @short_preamble: whether mac80211 will request short-preamble transmission
2039 * if the selected rate supports it
2040 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2041 * @skb: the skb that will be transmitted, the control information in it needs
2044 struct ieee80211_tx_rate_control {
2045 struct ieee80211_hw *hw;
2046 struct ieee80211_supported_band *sband;
2047 struct ieee80211_bss_conf *bss_conf;
2048 struct sk_buff *skb;
2049 struct ieee80211_tx_rate reported_rate;
2050 bool rts, short_preamble;
2054 struct rate_control_ops {
2055 struct module *module;
2057 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2058 void (*free)(void *priv);
2060 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2061 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2062 struct ieee80211_sta *sta, void *priv_sta);
2063 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2064 struct ieee80211_sta *sta,
2065 void *priv_sta, u32 changed);
2066 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2069 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2070 struct ieee80211_sta *sta, void *priv_sta,
2071 struct sk_buff *skb);
2072 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2073 struct ieee80211_tx_rate_control *txrc);
2075 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2076 struct dentry *dir);
2077 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2080 static inline int rate_supported(struct ieee80211_sta *sta,
2081 enum ieee80211_band band,
2084 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2088 rate_lowest_index(struct ieee80211_supported_band *sband,
2089 struct ieee80211_sta *sta)
2093 for (i = 0; i < sband->n_bitrates; i++)
2094 if (rate_supported(sta, sband->band, i))
2097 /* warn when we cannot find a rate. */
2104 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2105 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2108 conf_is_ht20(struct ieee80211_conf *conf)
2110 return conf->channel_type == NL80211_CHAN_HT20;
2114 conf_is_ht40_minus(struct ieee80211_conf *conf)
2116 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2120 conf_is_ht40_plus(struct ieee80211_conf *conf)
2122 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2126 conf_is_ht40(struct ieee80211_conf *conf)
2128 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2132 conf_is_ht(struct ieee80211_conf *conf)
2134 return conf->channel_type != NL80211_CHAN_NO_HT;
2137 #endif /* MAC80211_H */