2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
91 * enum ieee80211_max_queues - maximum number of queues
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 enum ieee80211_max_queues {
96 IEEE80211_MAX_QUEUES = 4,
100 * struct ieee80211_tx_queue_params - transmit queue configuration
102 * The information provided in this structure is required for QoS
103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
105 * @aifs: arbitration interframe space [0..255]
106 * @cw_min: minimum contention window [a value of the form
107 * 2^n-1 in the range 1..32767]
108 * @cw_max: maximum contention window [like @cw_min]
109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
110 * @uapsd: is U-APSD mode enabled for the queue
112 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
153 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
154 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
155 * reason (IBSS and managed mode)
156 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
157 * new beacon (beaconing modes)
158 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
159 * enabled/disabled (beaconing modes)
161 enum ieee80211_bss_change {
162 BSS_CHANGED_ASSOC = 1<<0,
163 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
164 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
165 BSS_CHANGED_ERP_SLOT = 1<<3,
166 BSS_CHANGED_HT = 1<<4,
167 BSS_CHANGED_BASIC_RATES = 1<<5,
168 BSS_CHANGED_BEACON_INT = 1<<6,
169 BSS_CHANGED_BSSID = 1<<7,
170 BSS_CHANGED_BEACON = 1<<8,
171 BSS_CHANGED_BEACON_ENABLED = 1<<9,
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 * @basic_rates: bitmap of basic rates, each bit stands for an
194 * index into the rate table configured by the driver in
196 * @bssid: The BSSID for this BSS
197 * @enable_beacon: whether beaconing should be enabled or not
198 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
199 * This field is only valid when the channel type is one of the HT types.
201 struct ieee80211_bss_conf {
203 /* association related data */
206 /* erp related data */
208 bool use_short_preamble;
213 u16 assoc_capability;
216 u16 ht_operation_mode;
220 * enum mac80211_tx_control_flags - flags to describe transmission information/status
222 * These flags are used with the @flags member of &ieee80211_tx_info.
224 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
225 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
226 * number to this frame, taking care of not overwriting the fragment
227 * number and increasing the sequence number only when the
228 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
229 * assign sequence numbers to QoS-data frames but cannot do so correctly
230 * for non-QoS-data and management frames because beacons need them from
231 * that counter as well and mac80211 cannot guarantee proper sequencing.
232 * If this flag is set, the driver should instruct the hardware to
233 * assign a sequence number to the frame or assign one itself. Cf. IEEE
234 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
235 * beacons and always be clear for frames without a sequence number field.
236 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
237 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
239 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
240 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
241 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
242 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
243 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
244 * because the destination STA was in powersave mode. Note that to
245 * avoid race conditions, the filter must be set by the hardware or
246 * firmware upon receiving a frame that indicates that the station
247 * went to sleep (must be done on device to filter frames already on
248 * the queue) and may only be unset after mac80211 gives the OK for
249 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
250 * since only then is it guaranteed that no more frames are in the
252 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
253 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
254 * is for the whole aggregation.
255 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
256 * so consider using block ack request (BAR).
257 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
258 * set by rate control algorithms to indicate probe rate, will
259 * be cleared for fragmented frames (except on the last fragment)
260 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
261 * used to indicate that a pending frame requires TX processing before
262 * it can be sent out.
263 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
264 * used to indicate that a frame was already retried due to PS
265 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
266 * used to indicate frame should not be encrypted
267 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
268 * This frame is a response to a PS-poll frame and should be sent
269 * although the station is in powersave mode.
270 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
271 * transmit function after the current frame, this can be used
272 * by drivers to kick the DMA queue only if unset or when the
275 enum mac80211_tx_control_flags {
276 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
277 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
278 IEEE80211_TX_CTL_NO_ACK = BIT(2),
279 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
280 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
281 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
282 IEEE80211_TX_CTL_AMPDU = BIT(6),
283 IEEE80211_TX_CTL_INJECTED = BIT(7),
284 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
285 IEEE80211_TX_STAT_ACK = BIT(9),
286 IEEE80211_TX_STAT_AMPDU = BIT(10),
287 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
288 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
289 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
290 IEEE80211_TX_INTFL_RETRIED = BIT(15),
291 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
292 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
293 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
297 * enum mac80211_rate_control_flags - per-rate flags set by the
298 * Rate Control algorithm.
300 * These flags are set by the Rate control algorithm for each rate during tx,
301 * in the @flags member of struct ieee80211_tx_rate.
303 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
304 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
305 * This is set if the current BSS requires ERP protection.
306 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
307 * @IEEE80211_TX_RC_MCS: HT rate.
308 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
310 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
311 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
312 * adjacent 20 MHz channels, if the current channel type is
313 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
314 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
316 enum mac80211_rate_control_flags {
317 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
318 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
319 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
321 /* rate index is an MCS rate number instead of an index */
322 IEEE80211_TX_RC_MCS = BIT(3),
323 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
324 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
325 IEEE80211_TX_RC_DUP_DATA = BIT(6),
326 IEEE80211_TX_RC_SHORT_GI = BIT(7),
330 /* there are 40 bytes if you don't need the rateset to be kept */
331 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
333 /* if you do need the rateset, then you have less space */
334 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
336 /* maximum number of rate stages */
337 #define IEEE80211_TX_MAX_RATES 5
340 * struct ieee80211_tx_rate - rate selection/status
342 * @idx: rate index to attempt to send with
343 * @flags: rate control flags (&enum mac80211_rate_control_flags)
344 * @count: number of tries in this rate before going to the next rate
346 * A value of -1 for @idx indicates an invalid rate and, if used
347 * in an array of retry rates, that no more rates should be tried.
349 * When used for transmit status reporting, the driver should
350 * always report the rate along with the flags it used.
352 * &struct ieee80211_tx_info contains an array of these structs
353 * in the control information, and it will be filled by the rate
354 * control algorithm according to what should be sent. For example,
355 * if this array contains, in the format { <idx>, <count> } the
357 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
358 * then this means that the frame should be transmitted
359 * up to twice at rate 3, up to twice at rate 2, and up to four
360 * times at rate 1 if it doesn't get acknowledged. Say it gets
361 * acknowledged by the peer after the fifth attempt, the status
362 * information should then contain
363 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
364 * since it was transmitted twice at rate 3, twice at rate 2
365 * and once at rate 1 after which we received an acknowledgement.
367 struct ieee80211_tx_rate {
371 } __attribute__((packed));
374 * struct ieee80211_tx_info - skb transmit information
376 * This structure is placed in skb->cb for three uses:
377 * (1) mac80211 TX control - mac80211 tells the driver what to do
378 * (2) driver internal use (if applicable)
379 * (3) TX status information - driver tells mac80211 what happened
381 * The TX control's sta pointer is only valid during the ->tx call,
384 * @flags: transmit info flags, defined above
385 * @band: the band to transmit on (use for checking for races)
386 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
387 * @pad: padding, ignore
388 * @control: union for control data
389 * @status: union for status data
390 * @driver_data: array of driver_data pointers
391 * @ampdu_ack_len: number of acked aggregated frames.
392 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
393 * @ampdu_ack_map: block ack bit map for the aggregation.
394 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
395 * @ampdu_len: number of aggregated frames.
396 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
397 * @ack_signal: signal strength of the ACK frame
399 struct ieee80211_tx_info {
400 /* common information */
414 struct ieee80211_tx_rate rates[
415 IEEE80211_TX_MAX_RATES];
418 /* only needed before rate control */
419 unsigned long jiffies;
421 /* NB: vif can be NULL for injected frames */
422 struct ieee80211_vif *vif;
423 struct ieee80211_key_conf *hw_key;
424 struct ieee80211_sta *sta;
427 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
435 struct ieee80211_tx_rate driver_rates[
436 IEEE80211_TX_MAX_RATES];
437 void *rate_driver_data[
438 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
441 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
445 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
447 return (struct ieee80211_tx_info *)skb->cb;
450 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
452 return (struct ieee80211_rx_status *)skb->cb;
456 * ieee80211_tx_info_clear_status - clear TX status
458 * @info: The &struct ieee80211_tx_info to be cleared.
460 * When the driver passes an skb back to mac80211, it must report
461 * a number of things in TX status. This function clears everything
462 * in the TX status but the rate control information (it does clear
463 * the count since you need to fill that in anyway).
465 * NOTE: You can only use this function if you do NOT use
466 * info->driver_data! Use info->rate_driver_data
467 * instead if you need only the less space that allows.
470 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
474 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
475 offsetof(struct ieee80211_tx_info, control.rates));
476 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
477 offsetof(struct ieee80211_tx_info, driver_rates));
478 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
479 /* clear the rate counts */
480 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
481 info->status.rates[i].count = 0;
484 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
485 memset(&info->status.ampdu_ack_len, 0,
486 sizeof(struct ieee80211_tx_info) -
487 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
492 * enum mac80211_rx_flags - receive flags
494 * These flags are used with the @flag member of &struct ieee80211_rx_status.
495 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
496 * Use together with %RX_FLAG_MMIC_STRIPPED.
497 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
498 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
499 * verification has been done by the hardware.
500 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
501 * If this flag is set, the stack cannot do any replay detection
502 * hence the driver or hardware will have to do that.
503 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
505 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
507 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
508 * is valid. This is useful in monitor mode and necessary for beacon frames
509 * to enable IBSS merging.
510 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
511 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
512 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
513 * @RX_FLAG_SHORT_GI: Short guard interval was used
514 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
515 * on cooked monitor to avoid double-reporting it for multiple
518 enum mac80211_rx_flags {
519 RX_FLAG_MMIC_ERROR = 1<<0,
520 RX_FLAG_DECRYPTED = 1<<1,
521 RX_FLAG_MMIC_STRIPPED = 1<<3,
522 RX_FLAG_IV_STRIPPED = 1<<4,
523 RX_FLAG_FAILED_FCS_CRC = 1<<5,
524 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
526 RX_FLAG_SHORTPRE = 1<<8,
528 RX_FLAG_40MHZ = 1<<10,
529 RX_FLAG_SHORT_GI = 1<<11,
530 RX_FLAG_INTERNAL_CMTR = 1<<12,
534 * struct ieee80211_rx_status - receive status
536 * The low-level driver should provide this information (the subset
537 * supported by hardware) to the 802.11 code with each received
538 * frame, in the skb's control buffer (cb).
540 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
541 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
542 * @band: the active band when this frame was received
543 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
544 * @signal: signal strength when receiving this frame, either in dBm, in dB or
545 * unspecified depending on the hardware capabilities flags
546 * @IEEE80211_HW_SIGNAL_*
547 * @noise: noise when receiving this frame, in dBm.
548 * @antenna: antenna used
549 * @rate_idx: index of data rate into band's supported rates or MCS index if
550 * HT rates are use (RX_FLAG_HT)
553 struct ieee80211_rx_status {
555 enum ieee80211_band band;
565 * enum ieee80211_conf_flags - configuration flags
567 * Flags to define PHY configuration options
569 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
570 * to determine for example whether to calculate timestamps for packets
571 * or not, do not use instead of filter flags!
572 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
573 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
574 * meaning that the hardware still wakes up for beacons, is able to
575 * transmit frames and receive the possible acknowledgment frames.
576 * Not to be confused with hardware specific wakeup/sleep states,
577 * driver is responsible for that. See the section "Powersave support"
579 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
580 * the driver should be prepared to handle configuration requests but
581 * may turn the device off as much as possible. Typically, this flag will
582 * be set when an interface is set UP but not associated or scanning, but
583 * it can also be unset in that case when monitor interfaces are active.
585 enum ieee80211_conf_flags {
586 IEEE80211_CONF_MONITOR = (1<<0),
587 IEEE80211_CONF_PS = (1<<1),
588 IEEE80211_CONF_IDLE = (1<<2),
593 * enum ieee80211_conf_changed - denotes which configuration changed
595 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
596 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
597 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
598 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
599 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
600 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
601 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
602 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
604 enum ieee80211_conf_changed {
605 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
606 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
607 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
608 IEEE80211_CONF_CHANGE_PS = BIT(4),
609 IEEE80211_CONF_CHANGE_POWER = BIT(5),
610 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
611 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
612 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
616 * enum ieee80211_smps_mode - spatial multiplexing power save mode
618 * @IEEE80211_SMPS_AUTOMATIC: automatic
619 * @IEEE80211_SMPS_OFF: off
620 * @IEEE80211_SMPS_STATIC: static
621 * @IEEE80211_SMPS_DYNAMIC: dynamic
622 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
624 enum ieee80211_smps_mode {
625 IEEE80211_SMPS_AUTOMATIC,
627 IEEE80211_SMPS_STATIC,
628 IEEE80211_SMPS_DYNAMIC,
631 IEEE80211_SMPS_NUM_MODES,
635 * struct ieee80211_conf - configuration of the device
637 * This struct indicates how the driver shall configure the hardware.
639 * @flags: configuration flags defined above
641 * @listen_interval: listen interval in units of beacon interval
642 * @max_sleep_period: the maximum number of beacon intervals to sleep for
643 * before checking the beacon for a TIM bit (managed mode only); this
644 * value will be only achievable between DTIM frames, the hardware
645 * needs to check for the multicast traffic bit in DTIM beacons.
646 * This variable is valid only when the CONF_PS flag is set.
647 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
648 * powersave documentation below. This variable is valid only when
649 * the CONF_PS flag is set.
651 * @power_level: requested transmit power (in dBm)
653 * @channel: the channel to tune to
654 * @channel_type: the channel (HT) type
656 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
657 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
658 * but actually means the number of transmissions not the number of retries
659 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
660 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
661 * number of transmissions not the number of retries
663 * @smps_mode: spatial multiplexing powersave mode; note that
664 * %IEEE80211_SMPS_STATIC is used when the device is not
665 * configured for an HT channel
667 struct ieee80211_conf {
669 int power_level, dynamic_ps_timeout;
670 int max_sleep_period;
674 u8 long_frame_max_tx_count, short_frame_max_tx_count;
676 struct ieee80211_channel *channel;
677 enum nl80211_channel_type channel_type;
678 enum ieee80211_smps_mode smps_mode;
682 * struct ieee80211_vif - per-interface data
684 * Data in this structure is continually present for driver
685 * use during the life of a virtual interface.
687 * @type: type of this virtual interface
688 * @bss_conf: BSS configuration for this interface, either our own
689 * or the BSS we're associated to
690 * @addr: address of this interface
691 * @drv_priv: data area for driver use, will always be aligned to
694 struct ieee80211_vif {
695 enum nl80211_iftype type;
696 struct ieee80211_bss_conf bss_conf;
699 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
702 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
704 #ifdef CONFIG_MAC80211_MESH
705 return vif->type == NL80211_IFTYPE_MESH_POINT;
711 * enum ieee80211_key_alg - key algorithm
712 * @ALG_WEP: WEP40 or WEP104
714 * @ALG_CCMP: CCMP (AES)
715 * @ALG_AES_CMAC: AES-128-CMAC
717 enum ieee80211_key_alg {
725 * enum ieee80211_key_flags - key flags
727 * These flags are used for communication about keys between the driver
728 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
730 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
731 * that the STA this key will be used with could be using QoS.
732 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
733 * driver to indicate that it requires IV generation for this
735 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
736 * the driver for a TKIP key if it requires Michael MIC
737 * generation in software.
738 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
739 * that the key is pairwise rather then a shared key.
740 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
741 * CCMP key if it requires CCMP encryption of management frames (MFP) to
742 * be done in software.
744 enum ieee80211_key_flags {
745 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
746 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
747 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
748 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
749 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
753 * struct ieee80211_key_conf - key information
755 * This key information is given by mac80211 to the driver by
756 * the set_key() callback in &struct ieee80211_ops.
758 * @hw_key_idx: To be set by the driver, this is the key index the driver
759 * wants to be given when a frame is transmitted and needs to be
760 * encrypted in hardware.
761 * @alg: The key algorithm.
762 * @flags: key flags, see &enum ieee80211_key_flags.
763 * @keyidx: the key index (0-3)
764 * @keylen: key material length
765 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
767 * - Temporal Encryption Key (128 bits)
768 * - Temporal Authenticator Tx MIC Key (64 bits)
769 * - Temporal Authenticator Rx MIC Key (64 bits)
770 * @icv_len: The ICV length for this key type
771 * @iv_len: The IV length for this key type
773 struct ieee80211_key_conf {
774 enum ieee80211_key_alg alg;
785 * enum set_key_cmd - key command
787 * Used with the set_key() callback in &struct ieee80211_ops, this
788 * indicates whether a key is being removed or added.
790 * @SET_KEY: a key is set
791 * @DISABLE_KEY: a key must be disabled
794 SET_KEY, DISABLE_KEY,
798 * struct ieee80211_sta - station table entry
800 * A station table entry represents a station we are possibly
801 * communicating with. Since stations are RCU-managed in
802 * mac80211, any ieee80211_sta pointer you get access to must
803 * either be protected by rcu_read_lock() explicitly or implicitly,
804 * or you must take good care to not use such a pointer after a
805 * call to your sta_notify callback that removed it.
808 * @aid: AID we assigned to the station if we're an AP
809 * @supp_rates: Bitmap of supported rates (per band)
810 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
811 * @drv_priv: data area for driver use, will always be aligned to
812 * sizeof(void *), size is determined in hw information.
814 struct ieee80211_sta {
815 u32 supp_rates[IEEE80211_NUM_BANDS];
818 struct ieee80211_sta_ht_cap ht_cap;
821 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
825 * enum sta_notify_cmd - sta notify command
827 * Used with the sta_notify() callback in &struct ieee80211_ops, this
828 * indicates addition and removal of a station to station table,
829 * or if a associated station made a power state transition.
831 * @STA_NOTIFY_ADD: a station was added to the station table
832 * @STA_NOTIFY_REMOVE: a station being removed from the station table
833 * @STA_NOTIFY_SLEEP: a station is now sleeping
834 * @STA_NOTIFY_AWAKE: a sleeping station woke up
836 enum sta_notify_cmd {
837 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
838 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
842 * enum ieee80211_tkip_key_type - get tkip key
844 * Used by drivers which need to get a tkip key for skb. Some drivers need a
845 * phase 1 key, others need a phase 2 key. A single function allows the driver
846 * to get the key, this enum indicates what type of key is required.
848 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
849 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
851 enum ieee80211_tkip_key_type {
852 IEEE80211_TKIP_P1_KEY,
853 IEEE80211_TKIP_P2_KEY,
857 * enum ieee80211_hw_flags - hardware flags
859 * These flags are used to indicate hardware capabilities to
860 * the stack. Generally, flags here should have their meaning
861 * done in a way that the simplest hardware doesn't need setting
862 * any particular flags. There are some exceptions to this rule,
863 * however, so you are advised to review these flags carefully.
865 * @IEEE80211_HW_HAS_RATE_CONTROL:
866 * The hardware or firmware includes rate control, and cannot be
867 * controlled by the stack. As such, no rate control algorithm
868 * should be instantiated, and the TX rate reported to userspace
869 * will be taken from the TX status instead of the rate control
871 * Note that this requires that the driver implement a number of
872 * callbacks so it has the correct information, it needs to have
873 * the @set_rts_threshold callback and must look at the BSS config
874 * @use_cts_prot for G/N protection, @use_short_slot for slot
875 * timing in 2.4 GHz and @use_short_preamble for preambles for
878 * @IEEE80211_HW_RX_INCLUDES_FCS:
879 * Indicates that received frames passed to the stack include
880 * the FCS at the end.
882 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
883 * Some wireless LAN chipsets buffer broadcast/multicast frames
884 * for power saving stations in the hardware/firmware and others
885 * rely on the host system for such buffering. This option is used
886 * to configure the IEEE 802.11 upper layer to buffer broadcast and
887 * multicast frames when there are power saving stations so that
888 * the driver can fetch them with ieee80211_get_buffered_bc().
890 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
891 * Hardware is not capable of short slot operation on the 2.4 GHz band.
893 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
894 * Hardware is not capable of receiving frames with short preamble on
897 * @IEEE80211_HW_SIGNAL_UNSPEC:
898 * Hardware can provide signal values but we don't know its units. We
899 * expect values between 0 and @max_signal.
900 * If possible please provide dB or dBm instead.
902 * @IEEE80211_HW_SIGNAL_DBM:
903 * Hardware gives signal values in dBm, decibel difference from
904 * one milliwatt. This is the preferred method since it is standardized
905 * between different devices. @max_signal does not need to be set.
907 * @IEEE80211_HW_NOISE_DBM:
908 * Hardware can provide noise (radio interference) values in units dBm,
909 * decibel difference from one milliwatt.
911 * @IEEE80211_HW_SPECTRUM_MGMT:
912 * Hardware supports spectrum management defined in 802.11h
913 * Measurement, Channel Switch, Quieting, TPC
915 * @IEEE80211_HW_AMPDU_AGGREGATION:
916 * Hardware supports 11n A-MPDU aggregation.
918 * @IEEE80211_HW_SUPPORTS_PS:
919 * Hardware has power save support (i.e. can go to sleep).
921 * @IEEE80211_HW_PS_NULLFUNC_STACK:
922 * Hardware requires nullfunc frame handling in stack, implies
923 * stack support for dynamic PS.
925 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
926 * Hardware has support for dynamic PS.
928 * @IEEE80211_HW_MFP_CAPABLE:
929 * Hardware supports management frame protection (MFP, IEEE 802.11w).
931 * @IEEE80211_HW_BEACON_FILTER:
932 * Hardware supports dropping of irrelevant beacon frames to
933 * avoid waking up cpu.
935 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
936 * Hardware supports static spatial multiplexing powersave,
937 * ie. can turn off all but one chain even on HT connections
938 * that should be using more chains.
940 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
941 * Hardware supports dynamic spatial multiplexing powersave,
942 * ie. can turn off all but one chain and then wake the rest
943 * up as required after, for example, rts/cts handshake.
945 * @IEEE80211_HW_SUPPORTS_UAPSD:
946 * Hardware supports Unscheduled Automatic Power Save Delivery
947 * (U-APSD) in managed mode. The mode is configured with
948 * conf_tx() operation.
950 enum ieee80211_hw_flags {
951 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
952 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
953 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
954 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
955 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
956 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
957 IEEE80211_HW_SIGNAL_DBM = 1<<6,
958 IEEE80211_HW_NOISE_DBM = 1<<7,
959 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
960 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
961 IEEE80211_HW_SUPPORTS_PS = 1<<10,
962 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
963 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
964 IEEE80211_HW_MFP_CAPABLE = 1<<13,
965 IEEE80211_HW_BEACON_FILTER = 1<<14,
966 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
967 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
968 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
972 * struct ieee80211_hw - hardware information and state
974 * This structure contains the configuration and hardware
975 * information for an 802.11 PHY.
977 * @wiphy: This points to the &struct wiphy allocated for this
978 * 802.11 PHY. You must fill in the @perm_addr and @dev
979 * members of this structure using SET_IEEE80211_DEV()
980 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
981 * bands (with channels, bitrates) are registered here.
983 * @conf: &struct ieee80211_conf, device configuration, don't use.
985 * @priv: pointer to private area that was allocated for driver use
986 * along with this structure.
988 * @flags: hardware flags, see &enum ieee80211_hw_flags.
990 * @extra_tx_headroom: headroom to reserve in each transmit skb
991 * for use by the driver (e.g. for transmit headers.)
993 * @channel_change_time: time (in microseconds) it takes to change channels.
995 * @max_signal: Maximum value for signal (rssi) in RX information, used
996 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
998 * @max_listen_interval: max listen interval in units of beacon interval
1001 * @queues: number of available hardware transmit queues for
1002 * data packets. WMM/QoS requires at least four, these
1003 * queues need to have configurable access parameters.
1005 * @rate_control_algorithm: rate control algorithm for this hardware.
1006 * If unset (NULL), the default algorithm will be used. Must be
1007 * set before calling ieee80211_register_hw().
1009 * @vif_data_size: size (in bytes) of the drv_priv data area
1010 * within &struct ieee80211_vif.
1011 * @sta_data_size: size (in bytes) of the drv_priv data area
1012 * within &struct ieee80211_sta.
1014 * @max_rates: maximum number of alternate rate retry stages
1015 * @max_rate_tries: maximum number of tries for each stage
1017 struct ieee80211_hw {
1018 struct ieee80211_conf conf;
1019 struct wiphy *wiphy;
1020 const char *rate_control_algorithm;
1023 unsigned int extra_tx_headroom;
1024 int channel_change_time;
1028 u16 max_listen_interval;
1035 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1037 * @wiphy: the &struct wiphy which we want to query
1039 * mac80211 drivers can use this to get to their respective
1040 * &struct ieee80211_hw. Drivers wishing to get to their own private
1041 * structure can then access it via hw->priv. Note that mac802111 drivers should
1042 * not use wiphy_priv() to try to get their private driver structure as this
1043 * is already used internally by mac80211.
1045 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1048 * SET_IEEE80211_DEV - set device for 802.11 hardware
1050 * @hw: the &struct ieee80211_hw to set the device for
1051 * @dev: the &struct device of this 802.11 device
1053 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1055 set_wiphy_dev(hw->wiphy, dev);
1059 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1061 * @hw: the &struct ieee80211_hw to set the MAC address for
1062 * @addr: the address to set
1064 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1066 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1069 static inline struct ieee80211_rate *
1070 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1071 const struct ieee80211_tx_info *c)
1073 if (WARN_ON(c->control.rates[0].idx < 0))
1075 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1078 static inline struct ieee80211_rate *
1079 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1080 const struct ieee80211_tx_info *c)
1082 if (c->control.rts_cts_rate_idx < 0)
1084 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1087 static inline struct ieee80211_rate *
1088 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1089 const struct ieee80211_tx_info *c, int idx)
1091 if (c->control.rates[idx + 1].idx < 0)
1093 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1097 * DOC: Hardware crypto acceleration
1099 * mac80211 is capable of taking advantage of many hardware
1100 * acceleration designs for encryption and decryption operations.
1102 * The set_key() callback in the &struct ieee80211_ops for a given
1103 * device is called to enable hardware acceleration of encryption and
1104 * decryption. The callback takes a @sta parameter that will be NULL
1105 * for default keys or keys used for transmission only, or point to
1106 * the station information for the peer for individual keys.
1107 * Multiple transmission keys with the same key index may be used when
1108 * VLANs are configured for an access point.
1110 * When transmitting, the TX control data will use the @hw_key_idx
1111 * selected by the driver by modifying the &struct ieee80211_key_conf
1112 * pointed to by the @key parameter to the set_key() function.
1114 * The set_key() call for the %SET_KEY command should return 0 if
1115 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1116 * added; if you return 0 then hw_key_idx must be assigned to the
1117 * hardware key index, you are free to use the full u8 range.
1119 * When the cmd is %DISABLE_KEY then it must succeed.
1121 * Note that it is permissible to not decrypt a frame even if a key
1122 * for it has been uploaded to hardware, the stack will not make any
1123 * decision based on whether a key has been uploaded or not but rather
1124 * based on the receive flags.
1126 * The &struct ieee80211_key_conf structure pointed to by the @key
1127 * parameter is guaranteed to be valid until another call to set_key()
1128 * removes it, but it can only be used as a cookie to differentiate
1131 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1132 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1134 * The update_tkip_key() call updates the driver with the new phase 1 key.
1135 * This happens everytime the iv16 wraps around (every 65536 packets). The
1136 * set_key() call will happen only once for each key (unless the AP did
1137 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1138 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1139 * handler is software decryption with wrap around of iv16.
1143 * DOC: Powersave support
1145 * mac80211 has support for various powersave implementations.
1147 * First, it can support hardware that handles all powersaving by itself,
1148 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1149 * flag. In that case, it will be told about the desired powersave mode
1150 * with the %IEEE80211_CONF_PS flag depending on the association status.
1151 * The hardware must take care of sending nullfunc frames when necessary,
1152 * i.e. when entering and leaving powersave mode. The hardware is required
1153 * to look at the AID in beacons and signal to the AP that it woke up when
1154 * it finds traffic directed to it.
1156 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1157 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1158 * with hardware wakeup and sleep states. Driver is responsible for waking
1159 * up the hardware before issueing commands to the hardware and putting it
1160 * back to sleep at approriate times.
1162 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1163 * buffered multicast/broadcast frames after the beacon. Also it must be
1164 * possible to send frames and receive the acknowledment frame.
1166 * Other hardware designs cannot send nullfunc frames by themselves and also
1167 * need software support for parsing the TIM bitmap. This is also supported
1168 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1169 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1170 * required to pass up beacons. The hardware is still required to handle
1171 * waking up for multicast traffic; if it cannot the driver must handle that
1172 * as best as it can, mac80211 is too slow to do that.
1174 * Dynamic powersave is an extension to normal powersave in which the
1175 * hardware stays awake for a user-specified period of time after sending a
1176 * frame so that reply frames need not be buffered and therefore delayed to
1177 * the next wakeup. It's compromise of getting good enough latency when
1178 * there's data traffic and still saving significantly power in idle
1181 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1182 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1183 * flag and mac80211 will handle everything automatically. Additionally,
1184 * hardware having support for the dynamic PS feature may set the
1185 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1186 * dynamic PS mode itself. The driver needs to look at the
1187 * @dynamic_ps_timeout hardware configuration value and use it that value
1188 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1189 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1190 * enabled whenever user has enabled powersave.
1192 * Driver informs U-APSD client support by enabling
1193 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1194 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1195 * Nullfunc frames and stay awake until the service period has ended. To
1196 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1197 * from that AC are transmitted with powersave enabled.
1199 * Note: U-APSD client mode is not yet supported with
1200 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1204 * DOC: Beacon filter support
1206 * Some hardware have beacon filter support to reduce host cpu wakeups
1207 * which will reduce system power consumption. It usuallly works so that
1208 * the firmware creates a checksum of the beacon but omits all constantly
1209 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1210 * beacon is forwarded to the host, otherwise it will be just dropped. That
1211 * way the host will only receive beacons where some relevant information
1212 * (for example ERP protection or WMM settings) have changed.
1214 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1215 * hardware capability. The driver needs to enable beacon filter support
1216 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1217 * power save is enabled, the stack will not check for beacon loss and the
1218 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1220 * The time (or number of beacons missed) until the firmware notifies the
1221 * driver of a beacon loss event (which in turn causes the driver to call
1222 * ieee80211_beacon_loss()) should be configurable and will be controlled
1223 * by mac80211 and the roaming algorithm in the future.
1225 * Since there may be constantly changing information elements that nothing
1226 * in the software stack cares about, we will, in the future, have mac80211
1227 * tell the driver which information elements are interesting in the sense
1228 * that we want to see changes in them. This will include
1229 * - a list of information element IDs
1230 * - a list of OUIs for the vendor information element
1232 * Ideally, the hardware would filter out any beacons without changes in the
1233 * requested elements, but if it cannot support that it may, at the expense
1234 * of some efficiency, filter out only a subset. For example, if the device
1235 * doesn't support checking for OUIs it should pass up all changes in all
1236 * vendor information elements.
1238 * Note that change, for the sake of simplification, also includes information
1239 * elements appearing or disappearing from the beacon.
1241 * Some hardware supports an "ignore list" instead, just make sure nothing
1242 * that was requested is on the ignore list, and include commonly changing
1243 * information element IDs in the ignore list, for example 11 (BSS load) and
1244 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1245 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1246 * it could also include some currently unused IDs.
1249 * In addition to these capabilities, hardware should support notifying the
1250 * host of changes in the beacon RSSI. This is relevant to implement roaming
1251 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1252 * the received data packets). This can consist in notifying the host when
1253 * the RSSI changes significantly or when it drops below or rises above
1254 * configurable thresholds. In the future these thresholds will also be
1255 * configured by mac80211 (which gets them from userspace) to implement
1256 * them as the roaming algorithm requires.
1258 * If the hardware cannot implement this, the driver should ask it to
1259 * periodically pass beacon frames to the host so that software can do the
1260 * signal strength threshold checking.
1264 * DOC: Spatial multiplexing power save
1266 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1267 * power in an 802.11n implementation. For details on the mechanism
1268 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1269 * "11.2.3 SM power save".
1271 * The mac80211 implementation is capable of sending action frames
1272 * to update the AP about the station's SMPS mode, and will instruct
1273 * the driver to enter the specific mode. It will also announce the
1274 * requested SMPS mode during the association handshake. Hardware
1275 * support for this feature is required, and can be indicated by
1278 * The default mode will be "automatic", which nl80211/cfg80211
1279 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1280 * turned off otherwise.
1282 * To support this feature, the driver must set the appropriate
1283 * hardware support flags, and handle the SMPS flag to the config()
1284 * operation. It will then with this mechanism be instructed to
1285 * enter the requested SMPS mode while associated to an HT AP.
1289 * DOC: Frame filtering
1291 * mac80211 requires to see many management frames for proper
1292 * operation, and users may want to see many more frames when
1293 * in monitor mode. However, for best CPU usage and power consumption,
1294 * having as few frames as possible percolate through the stack is
1295 * desirable. Hence, the hardware should filter as much as possible.
1297 * To achieve this, mac80211 uses filter flags (see below) to tell
1298 * the driver's configure_filter() function which frames should be
1299 * passed to mac80211 and which should be filtered out.
1301 * Before configure_filter() is invoked, the prepare_multicast()
1302 * callback is invoked with the parameters @mc_count and @mc_list
1303 * for the combined multicast address list of all virtual interfaces.
1304 * It's use is optional, and it returns a u64 that is passed to
1305 * configure_filter(). Additionally, configure_filter() has the
1306 * arguments @changed_flags telling which flags were changed and
1307 * @total_flags with the new flag states.
1309 * If your device has no multicast address filters your driver will
1310 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1311 * parameter to see whether multicast frames should be accepted
1314 * All unsupported flags in @total_flags must be cleared.
1315 * Hardware does not support a flag if it is incapable of _passing_
1316 * the frame to the stack. Otherwise the driver must ignore
1317 * the flag, but not clear it.
1318 * You must _only_ clear the flag (announce no support for the
1319 * flag to mac80211) if you are not able to pass the packet type
1320 * to the stack (so the hardware always filters it).
1321 * So for example, you should clear @FIF_CONTROL, if your hardware
1322 * always filters control frames. If your hardware always passes
1323 * control frames to the kernel and is incapable of filtering them,
1324 * you do _not_ clear the @FIF_CONTROL flag.
1325 * This rule applies to all other FIF flags as well.
1329 * enum ieee80211_filter_flags - hardware filter flags
1331 * These flags determine what the filter in hardware should be
1332 * programmed to let through and what should not be passed to the
1333 * stack. It is always safe to pass more frames than requested,
1334 * but this has negative impact on power consumption.
1336 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1337 * think of the BSS as your network segment and then this corresponds
1338 * to the regular ethernet device promiscuous mode.
1340 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1341 * by the user or if the hardware is not capable of filtering by
1342 * multicast address.
1344 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1345 * %RX_FLAG_FAILED_FCS_CRC for them)
1347 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1348 * the %RX_FLAG_FAILED_PLCP_CRC for them
1350 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1351 * to the hardware that it should not filter beacons or probe responses
1352 * by BSSID. Filtering them can greatly reduce the amount of processing
1353 * mac80211 needs to do and the amount of CPU wakeups, so you should
1354 * honour this flag if possible.
1356 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1357 * is not set then only those addressed to this station.
1359 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1361 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1362 * those addressed to this station.
1364 enum ieee80211_filter_flags {
1365 FIF_PROMISC_IN_BSS = 1<<0,
1366 FIF_ALLMULTI = 1<<1,
1368 FIF_PLCPFAIL = 1<<3,
1369 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1371 FIF_OTHER_BSS = 1<<6,
1376 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1378 * These flags are used with the ampdu_action() callback in
1379 * &struct ieee80211_ops to indicate which action is needed.
1381 * Note that drivers MUST be able to deal with a TX aggregation
1382 * session being stopped even before they OK'ed starting it by
1383 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1384 * might receive the addBA frame and send a delBA right away!
1386 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1387 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1388 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1389 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1390 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1392 enum ieee80211_ampdu_mlme_action {
1393 IEEE80211_AMPDU_RX_START,
1394 IEEE80211_AMPDU_RX_STOP,
1395 IEEE80211_AMPDU_TX_START,
1396 IEEE80211_AMPDU_TX_STOP,
1397 IEEE80211_AMPDU_TX_OPERATIONAL,
1401 * struct ieee80211_ops - callbacks from mac80211 to the driver
1403 * This structure contains various callbacks that the driver may
1404 * handle or, in some cases, must handle, for example to configure
1405 * the hardware to a new channel or to transmit a frame.
1407 * @tx: Handler that 802.11 module calls for each transmitted frame.
1408 * skb contains the buffer starting from the IEEE 802.11 header.
1409 * The low-level driver should send the frame out based on
1410 * configuration in the TX control data. This handler should,
1411 * preferably, never fail and stop queues appropriately, more
1412 * importantly, however, it must never fail for A-MPDU-queues.
1413 * This function should return NETDEV_TX_OK except in very
1415 * Must be implemented and atomic.
1417 * @start: Called before the first netdevice attached to the hardware
1418 * is enabled. This should turn on the hardware and must turn on
1419 * frame reception (for possibly enabled monitor interfaces.)
1420 * Returns negative error codes, these may be seen in userspace,
1422 * When the device is started it should not have a MAC address
1423 * to avoid acknowledging frames before a non-monitor device
1425 * Must be implemented and can sleep.
1427 * @stop: Called after last netdevice attached to the hardware
1428 * is disabled. This should turn off the hardware (at least
1429 * it must turn off frame reception.)
1430 * May be called right after add_interface if that rejects
1431 * an interface. If you added any work onto the mac80211 workqueue
1432 * you should ensure to cancel it on this callback.
1433 * Must be implemented and can sleep.
1435 * @add_interface: Called when a netdevice attached to the hardware is
1436 * enabled. Because it is not called for monitor mode devices, @start
1437 * and @stop must be implemented.
1438 * The driver should perform any initialization it needs before
1439 * the device can be enabled. The initial configuration for the
1440 * interface is given in the conf parameter.
1441 * The callback may refuse to add an interface by returning a
1442 * negative error code (which will be seen in userspace.)
1443 * Must be implemented and can sleep.
1445 * @remove_interface: Notifies a driver that an interface is going down.
1446 * The @stop callback is called after this if it is the last interface
1447 * and no monitor interfaces are present.
1448 * When all interfaces are removed, the MAC address in the hardware
1449 * must be cleared so the device no longer acknowledges packets,
1450 * the mac_addr member of the conf structure is, however, set to the
1451 * MAC address of the device going away.
1452 * Hence, this callback must be implemented. It can sleep.
1454 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1455 * function to change hardware configuration, e.g., channel.
1456 * This function should never fail but returns a negative error code
1457 * if it does. The callback can sleep.
1459 * @bss_info_changed: Handler for configuration requests related to BSS
1460 * parameters that may vary during BSS's lifespan, and may affect low
1461 * level driver (e.g. assoc/disassoc status, erp parameters).
1462 * This function should not be used if no BSS has been set, unless
1463 * for association indication. The @changed parameter indicates which
1464 * of the bss parameters has changed when a call is made. The callback
1467 * @prepare_multicast: Prepare for multicast filter configuration.
1468 * This callback is optional, and its return value is passed
1469 * to configure_filter(). This callback must be atomic.
1471 * @configure_filter: Configure the device's RX filter.
1472 * See the section "Frame filtering" for more information.
1473 * This callback must be implemented and can sleep.
1475 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1476 * must be set or cleared for a given STA. Must be atomic.
1478 * @set_key: See the section "Hardware crypto acceleration"
1479 * This callback is only called between add_interface and
1480 * remove_interface calls, i.e. while the given virtual interface
1482 * Returns a negative error code if the key can't be added.
1483 * The callback can sleep.
1485 * @update_tkip_key: See the section "Hardware crypto acceleration"
1486 * This callback will be called in the context of Rx. Called for drivers
1487 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1488 * The callback can sleep.
1490 * @hw_scan: Ask the hardware to service the scan request, no need to start
1491 * the scan state machine in stack. The scan must honour the channel
1492 * configuration done by the regulatory agent in the wiphy's
1493 * registered bands. The hardware (or the driver) needs to make sure
1494 * that power save is disabled.
1495 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1496 * entire IEs after the SSID, so that drivers need not look at these
1497 * at all but just send them after the SSID -- mac80211 includes the
1498 * (extended) supported rates and HT information (where applicable).
1499 * When the scan finishes, ieee80211_scan_completed() must be called;
1500 * note that it also must be called when the scan cannot finish due to
1501 * any error unless this callback returned a negative error code.
1502 * The callback can sleep.
1504 * @sw_scan_start: Notifier function that is called just before a software scan
1505 * is started. Can be NULL, if the driver doesn't need this notification.
1506 * The callback can sleep.
1508 * @sw_scan_complete: Notifier function that is called just after a
1509 * software scan finished. Can be NULL, if the driver doesn't need
1510 * this notification.
1511 * The callback can sleep.
1513 * @get_stats: Return low-level statistics.
1514 * Returns zero if statistics are available.
1515 * The callback can sleep.
1517 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1518 * callback should be provided to read the TKIP transmit IVs (both IV32
1519 * and IV16) for the given key from hardware.
1520 * The callback must be atomic.
1522 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1523 * The callback can sleep.
1525 * @sta_notify: Notifies low level driver about addition, removal or power
1526 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1529 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1530 * bursting) for a hardware TX queue.
1531 * Returns a negative error code on failure.
1532 * The callback can sleep.
1534 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1535 * to get number of currently queued packets (queue length), maximum queue
1536 * size (limit), and total number of packets sent using each TX queue
1537 * (count). The 'stats' pointer points to an array that has hw->queues
1539 * The callback must be atomic.
1541 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1542 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1543 * required function.
1544 * The callback can sleep.
1546 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1547 * Currently, this is only used for IBSS mode debugging. Is not a
1548 * required function.
1549 * The callback can sleep.
1551 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1552 * with other STAs in the IBSS. This is only used in IBSS mode. This
1553 * function is optional if the firmware/hardware takes full care of
1554 * TSF synchronization.
1555 * The callback can sleep.
1557 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1558 * This is needed only for IBSS mode and the result of this function is
1559 * used to determine whether to reply to Probe Requests.
1560 * Returns non-zero if this device sent the last beacon.
1561 * The callback can sleep.
1563 * @ampdu_action: Perform a certain A-MPDU action
1564 * The RA/TID combination determines the destination and TID we want
1565 * the ampdu action to be performed for. The action is defined through
1566 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1567 * is the first frame we expect to perform the action on. Notice
1568 * that TX/RX_STOP can pass NULL for this parameter.
1569 * Returns a negative error code on failure.
1570 * The callback must be atomic.
1572 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1573 * need to set wiphy->rfkill_poll to %true before registration,
1574 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1575 * The callback can sleep.
1577 * @set_coverage_class: Set slot time for given coverage class as specified
1578 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1579 * accordingly. This callback is not required and may sleep.
1581 * @testmode_cmd: Implement a cfg80211 test mode command.
1582 * The callback can sleep.
1584 * @flush: Flush all pending frames from the hardware queue, making sure
1585 * that the hardware queues are empty. If the parameter @drop is set
1586 * to %true, pending frames may be dropped. The callback can sleep.
1588 struct ieee80211_ops {
1589 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1590 int (*start)(struct ieee80211_hw *hw);
1591 void (*stop)(struct ieee80211_hw *hw);
1592 int (*add_interface)(struct ieee80211_hw *hw,
1593 struct ieee80211_vif *vif);
1594 void (*remove_interface)(struct ieee80211_hw *hw,
1595 struct ieee80211_vif *vif);
1596 int (*config)(struct ieee80211_hw *hw, u32 changed);
1597 void (*bss_info_changed)(struct ieee80211_hw *hw,
1598 struct ieee80211_vif *vif,
1599 struct ieee80211_bss_conf *info,
1601 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1602 int mc_count, struct dev_addr_list *mc_list);
1603 void (*configure_filter)(struct ieee80211_hw *hw,
1604 unsigned int changed_flags,
1605 unsigned int *total_flags,
1607 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1609 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1610 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1611 struct ieee80211_key_conf *key);
1612 void (*update_tkip_key)(struct ieee80211_hw *hw,
1613 struct ieee80211_key_conf *conf, const u8 *address,
1614 u32 iv32, u16 *phase1key);
1615 int (*hw_scan)(struct ieee80211_hw *hw,
1616 struct cfg80211_scan_request *req);
1617 void (*sw_scan_start)(struct ieee80211_hw *hw);
1618 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1619 int (*get_stats)(struct ieee80211_hw *hw,
1620 struct ieee80211_low_level_stats *stats);
1621 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1622 u32 *iv32, u16 *iv16);
1623 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1624 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1625 enum sta_notify_cmd, struct ieee80211_sta *sta);
1626 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1627 const struct ieee80211_tx_queue_params *params);
1628 int (*get_tx_stats)(struct ieee80211_hw *hw,
1629 struct ieee80211_tx_queue_stats *stats);
1630 u64 (*get_tsf)(struct ieee80211_hw *hw);
1631 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1632 void (*reset_tsf)(struct ieee80211_hw *hw);
1633 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1634 int (*ampdu_action)(struct ieee80211_hw *hw,
1635 struct ieee80211_vif *vif,
1636 enum ieee80211_ampdu_mlme_action action,
1637 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1639 void (*rfkill_poll)(struct ieee80211_hw *hw);
1640 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1641 #ifdef CONFIG_NL80211_TESTMODE
1642 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1644 void (*flush)(struct ieee80211_hw *hw, bool drop);
1648 * ieee80211_alloc_hw - Allocate a new hardware device
1650 * This must be called once for each hardware device. The returned pointer
1651 * must be used to refer to this device when calling other functions.
1652 * mac80211 allocates a private data area for the driver pointed to by
1653 * @priv in &struct ieee80211_hw, the size of this area is given as
1656 * @priv_data_len: length of private data
1657 * @ops: callbacks for this device
1659 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1660 const struct ieee80211_ops *ops);
1663 * ieee80211_register_hw - Register hardware device
1665 * You must call this function before any other functions in
1666 * mac80211. Note that before a hardware can be registered, you
1667 * need to fill the contained wiphy's information.
1669 * @hw: the device to register as returned by ieee80211_alloc_hw()
1671 int ieee80211_register_hw(struct ieee80211_hw *hw);
1673 #ifdef CONFIG_MAC80211_LEDS
1674 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1675 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1676 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1677 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1680 * ieee80211_get_tx_led_name - get name of TX LED
1682 * mac80211 creates a transmit LED trigger for each wireless hardware
1683 * that can be used to drive LEDs if your driver registers a LED device.
1684 * This function returns the name (or %NULL if not configured for LEDs)
1685 * of the trigger so you can automatically link the LED device.
1687 * @hw: the hardware to get the LED trigger name for
1689 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1691 #ifdef CONFIG_MAC80211_LEDS
1692 return __ieee80211_get_tx_led_name(hw);
1699 * ieee80211_get_rx_led_name - get name of RX LED
1701 * mac80211 creates a receive LED trigger for each wireless hardware
1702 * that can be used to drive LEDs if your driver registers a LED device.
1703 * This function returns the name (or %NULL if not configured for LEDs)
1704 * of the trigger so you can automatically link the LED device.
1706 * @hw: the hardware to get the LED trigger name for
1708 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1710 #ifdef CONFIG_MAC80211_LEDS
1711 return __ieee80211_get_rx_led_name(hw);
1718 * ieee80211_get_assoc_led_name - get name of association LED
1720 * mac80211 creates a association LED trigger for each wireless hardware
1721 * that can be used to drive LEDs if your driver registers a LED device.
1722 * This function returns the name (or %NULL if not configured for LEDs)
1723 * of the trigger so you can automatically link the LED device.
1725 * @hw: the hardware to get the LED trigger name for
1727 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1729 #ifdef CONFIG_MAC80211_LEDS
1730 return __ieee80211_get_assoc_led_name(hw);
1737 * ieee80211_get_radio_led_name - get name of radio LED
1739 * mac80211 creates a radio change LED trigger for each wireless hardware
1740 * that can be used to drive LEDs if your driver registers a LED device.
1741 * This function returns the name (or %NULL if not configured for LEDs)
1742 * of the trigger so you can automatically link the LED device.
1744 * @hw: the hardware to get the LED trigger name for
1746 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1748 #ifdef CONFIG_MAC80211_LEDS
1749 return __ieee80211_get_radio_led_name(hw);
1756 * ieee80211_unregister_hw - Unregister a hardware device
1758 * This function instructs mac80211 to free allocated resources
1759 * and unregister netdevices from the networking subsystem.
1761 * @hw: the hardware to unregister
1763 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1766 * ieee80211_free_hw - free hardware descriptor
1768 * This function frees everything that was allocated, including the
1769 * private data for the driver. You must call ieee80211_unregister_hw()
1770 * before calling this function.
1772 * @hw: the hardware to free
1774 void ieee80211_free_hw(struct ieee80211_hw *hw);
1777 * ieee80211_restart_hw - restart hardware completely
1779 * Call this function when the hardware was restarted for some reason
1780 * (hardware error, ...) and the driver is unable to restore its state
1781 * by itself. mac80211 assumes that at this point the driver/hardware
1782 * is completely uninitialised and stopped, it starts the process by
1783 * calling the ->start() operation. The driver will need to reset all
1784 * internal state that it has prior to calling this function.
1786 * @hw: the hardware to restart
1788 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1791 * ieee80211_rx - receive frame
1793 * Use this function to hand received frames to mac80211. The receive
1794 * buffer in @skb must start with an IEEE 802.11 header.
1796 * This function may not be called in IRQ context. Calls to this function
1797 * for a single hardware must be synchronized against each other. Calls to
1798 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1799 * mixed for a single hardware.
1801 * In process context use instead ieee80211_rx_ni().
1803 * @hw: the hardware this frame came in on
1804 * @skb: the buffer to receive, owned by mac80211 after this call
1806 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1809 * ieee80211_rx_irqsafe - receive frame
1811 * Like ieee80211_rx() but can be called in IRQ context
1812 * (internally defers to a tasklet.)
1814 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1815 * be mixed for a single hardware.
1817 * @hw: the hardware this frame came in on
1818 * @skb: the buffer to receive, owned by mac80211 after this call
1820 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1823 * ieee80211_rx_ni - receive frame (in process context)
1825 * Like ieee80211_rx() but can be called in process context
1826 * (internally disables bottom halves).
1828 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1829 * not be mixed for a single hardware.
1831 * @hw: the hardware this frame came in on
1832 * @skb: the buffer to receive, owned by mac80211 after this call
1834 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1835 struct sk_buff *skb)
1838 ieee80211_rx(hw, skb);
1843 * The TX headroom reserved by mac80211 for its own tx_status functions.
1844 * This is enough for the radiotap header.
1846 #define IEEE80211_TX_STATUS_HEADROOM 13
1849 * ieee80211_tx_status - transmit status callback
1851 * Call this function for all transmitted frames after they have been
1852 * transmitted. It is permissible to not call this function for
1853 * multicast frames but this can affect statistics.
1855 * This function may not be called in IRQ context. Calls to this function
1856 * for a single hardware must be synchronized against each other. Calls
1857 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1858 * for a single hardware.
1860 * @hw: the hardware the frame was transmitted by
1861 * @skb: the frame that was transmitted, owned by mac80211 after this call
1863 void ieee80211_tx_status(struct ieee80211_hw *hw,
1864 struct sk_buff *skb);
1867 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1869 * Like ieee80211_tx_status() but can be called in IRQ context
1870 * (internally defers to a tasklet.)
1872 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1875 * @hw: the hardware the frame was transmitted by
1876 * @skb: the frame that was transmitted, owned by mac80211 after this call
1878 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1879 struct sk_buff *skb);
1882 * ieee80211_beacon_get_tim - beacon generation function
1883 * @hw: pointer obtained from ieee80211_alloc_hw().
1884 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1885 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1886 * Set to 0 if invalid (in non-AP modes).
1887 * @tim_length: pointer to variable that will receive the TIM IE length,
1888 * (including the ID and length bytes!).
1889 * Set to 0 if invalid (in non-AP modes).
1891 * If the driver implements beaconing modes, it must use this function to
1892 * obtain the beacon frame/template.
1894 * If the beacon frames are generated by the host system (i.e., not in
1895 * hardware/firmware), the driver uses this function to get each beacon
1896 * frame from mac80211 -- it is responsible for calling this function
1897 * before the beacon is needed (e.g. based on hardware interrupt).
1899 * If the beacon frames are generated by the device, then the driver
1900 * must use the returned beacon as the template and change the TIM IE
1901 * according to the current DTIM parameters/TIM bitmap.
1903 * The driver is responsible for freeing the returned skb.
1905 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1906 struct ieee80211_vif *vif,
1907 u16 *tim_offset, u16 *tim_length);
1910 * ieee80211_beacon_get - beacon generation function
1911 * @hw: pointer obtained from ieee80211_alloc_hw().
1912 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1914 * See ieee80211_beacon_get_tim().
1916 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1917 struct ieee80211_vif *vif)
1919 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1923 * ieee80211_pspoll_get - retrieve a PS Poll template
1924 * @hw: pointer obtained from ieee80211_alloc_hw().
1925 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1927 * Creates a PS Poll a template which can, for example, uploaded to
1928 * hardware. The template must be updated after association so that correct
1929 * AID, BSSID and MAC address is used.
1931 * Note: Caller (or hardware) is responsible for setting the
1932 * &IEEE80211_FCTL_PM bit.
1934 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1935 struct ieee80211_vif *vif);
1938 * ieee80211_nullfunc_get - retrieve a nullfunc template
1939 * @hw: pointer obtained from ieee80211_alloc_hw().
1940 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1942 * Creates a Nullfunc template which can, for example, uploaded to
1943 * hardware. The template must be updated after association so that correct
1944 * BSSID and address is used.
1946 * Note: Caller (or hardware) is responsible for setting the
1947 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
1949 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
1950 struct ieee80211_vif *vif);
1953 * ieee80211_probereq_get - retrieve a Probe Request template
1954 * @hw: pointer obtained from ieee80211_alloc_hw().
1955 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1956 * @ssid: SSID buffer
1957 * @ssid_len: length of SSID
1958 * @ie: buffer containing all IEs except SSID for the template
1959 * @ie_len: length of the IE buffer
1961 * Creates a Probe Request template which can, for example, be uploaded to
1964 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
1965 struct ieee80211_vif *vif,
1966 const u8 *ssid, size_t ssid_len,
1967 const u8 *ie, size_t ie_len);
1970 * ieee80211_rts_get - RTS frame generation function
1971 * @hw: pointer obtained from ieee80211_alloc_hw().
1972 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1973 * @frame: pointer to the frame that is going to be protected by the RTS.
1974 * @frame_len: the frame length (in octets).
1975 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1976 * @rts: The buffer where to store the RTS frame.
1978 * If the RTS frames are generated by the host system (i.e., not in
1979 * hardware/firmware), the low-level driver uses this function to receive
1980 * the next RTS frame from the 802.11 code. The low-level is responsible
1981 * for calling this function before and RTS frame is needed.
1983 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1984 const void *frame, size_t frame_len,
1985 const struct ieee80211_tx_info *frame_txctl,
1986 struct ieee80211_rts *rts);
1989 * ieee80211_rts_duration - Get the duration field for an RTS frame
1990 * @hw: pointer obtained from ieee80211_alloc_hw().
1991 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1992 * @frame_len: the length of the frame that is going to be protected by the RTS.
1993 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1995 * If the RTS is generated in firmware, but the host system must provide
1996 * the duration field, the low-level driver uses this function to receive
1997 * the duration field value in little-endian byteorder.
1999 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2000 struct ieee80211_vif *vif, size_t frame_len,
2001 const struct ieee80211_tx_info *frame_txctl);
2004 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2005 * @hw: pointer obtained from ieee80211_alloc_hw().
2006 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2007 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2008 * @frame_len: the frame length (in octets).
2009 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2010 * @cts: The buffer where to store the CTS-to-self frame.
2012 * If the CTS-to-self frames are generated by the host system (i.e., not in
2013 * hardware/firmware), the low-level driver uses this function to receive
2014 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2015 * for calling this function before and CTS-to-self frame is needed.
2017 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2018 struct ieee80211_vif *vif,
2019 const void *frame, size_t frame_len,
2020 const struct ieee80211_tx_info *frame_txctl,
2021 struct ieee80211_cts *cts);
2024 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2025 * @hw: pointer obtained from ieee80211_alloc_hw().
2026 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2027 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2028 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2030 * If the CTS-to-self is generated in firmware, but the host system must provide
2031 * the duration field, the low-level driver uses this function to receive
2032 * the duration field value in little-endian byteorder.
2034 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2035 struct ieee80211_vif *vif,
2037 const struct ieee80211_tx_info *frame_txctl);
2040 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2041 * @hw: pointer obtained from ieee80211_alloc_hw().
2042 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2043 * @frame_len: the length of the frame.
2044 * @rate: the rate at which the frame is going to be transmitted.
2046 * Calculate the duration field of some generic frame, given its
2047 * length and transmission rate (in 100kbps).
2049 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2050 struct ieee80211_vif *vif,
2052 struct ieee80211_rate *rate);
2055 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2056 * @hw: pointer as obtained from ieee80211_alloc_hw().
2057 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2059 * Function for accessing buffered broadcast and multicast frames. If
2060 * hardware/firmware does not implement buffering of broadcast/multicast
2061 * frames when power saving is used, 802.11 code buffers them in the host
2062 * memory. The low-level driver uses this function to fetch next buffered
2063 * frame. In most cases, this is used when generating beacon frame. This
2064 * function returns a pointer to the next buffered skb or NULL if no more
2065 * buffered frames are available.
2067 * Note: buffered frames are returned only after DTIM beacon frame was
2068 * generated with ieee80211_beacon_get() and the low-level driver must thus
2069 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2070 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2071 * does not need to check for DTIM beacons separately and should be able to
2072 * use common code for all beacons.
2075 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2078 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2080 * This function computes a TKIP rc4 key for an skb. It computes
2081 * a phase 1 key if needed (iv16 wraps around). This function is to
2082 * be used by drivers which can do HW encryption but need to compute
2083 * to phase 1/2 key in SW.
2085 * @keyconf: the parameter passed with the set key
2086 * @skb: the skb for which the key is needed
2088 * @key: a buffer to which the key will be written
2090 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2091 struct sk_buff *skb,
2092 enum ieee80211_tkip_key_type type, u8 *key);
2094 * ieee80211_wake_queue - wake specific queue
2095 * @hw: pointer as obtained from ieee80211_alloc_hw().
2096 * @queue: queue number (counted from zero).
2098 * Drivers should use this function instead of netif_wake_queue.
2100 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2103 * ieee80211_stop_queue - stop specific queue
2104 * @hw: pointer as obtained from ieee80211_alloc_hw().
2105 * @queue: queue number (counted from zero).
2107 * Drivers should use this function instead of netif_stop_queue.
2109 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2112 * ieee80211_queue_stopped - test status of the queue
2113 * @hw: pointer as obtained from ieee80211_alloc_hw().
2114 * @queue: queue number (counted from zero).
2116 * Drivers should use this function instead of netif_stop_queue.
2119 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2122 * ieee80211_stop_queues - stop all queues
2123 * @hw: pointer as obtained from ieee80211_alloc_hw().
2125 * Drivers should use this function instead of netif_stop_queue.
2127 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2130 * ieee80211_wake_queues - wake all queues
2131 * @hw: pointer as obtained from ieee80211_alloc_hw().
2133 * Drivers should use this function instead of netif_wake_queue.
2135 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2138 * ieee80211_scan_completed - completed hardware scan
2140 * When hardware scan offload is used (i.e. the hw_scan() callback is
2141 * assigned) this function needs to be called by the driver to notify
2142 * mac80211 that the scan finished.
2144 * @hw: the hardware that finished the scan
2145 * @aborted: set to true if scan was aborted
2147 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2150 * ieee80211_iterate_active_interfaces - iterate active interfaces
2152 * This function iterates over the interfaces associated with a given
2153 * hardware that are currently active and calls the callback for them.
2154 * This function allows the iterator function to sleep, when the iterator
2155 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2158 * @hw: the hardware struct of which the interfaces should be iterated over
2159 * @iterator: the iterator function to call
2160 * @data: first argument of the iterator function
2162 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2163 void (*iterator)(void *data, u8 *mac,
2164 struct ieee80211_vif *vif),
2168 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2170 * This function iterates over the interfaces associated with a given
2171 * hardware that are currently active and calls the callback for them.
2172 * This function requires the iterator callback function to be atomic,
2173 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2175 * @hw: the hardware struct of which the interfaces should be iterated over
2176 * @iterator: the iterator function to call, cannot sleep
2177 * @data: first argument of the iterator function
2179 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2180 void (*iterator)(void *data,
2182 struct ieee80211_vif *vif),
2186 * ieee80211_queue_work - add work onto the mac80211 workqueue
2188 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2189 * This helper ensures drivers are not queueing work when they should not be.
2191 * @hw: the hardware struct for the interface we are adding work for
2192 * @work: the work we want to add onto the mac80211 workqueue
2194 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2197 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2199 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2202 * @hw: the hardware struct for the interface we are adding work for
2203 * @dwork: delayable work to queue onto the mac80211 workqueue
2204 * @delay: number of jiffies to wait before queueing
2206 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2207 struct delayed_work *dwork,
2208 unsigned long delay);
2211 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2212 * @sta: the station for which to start a BA session
2213 * @tid: the TID to BA on.
2215 * Return: success if addBA request was sent, failure otherwise
2217 * Although mac80211/low level driver/user space application can estimate
2218 * the need to start aggregation on a certain RA/TID, the session level
2219 * will be managed by the mac80211.
2221 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2224 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2225 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2226 * @ra: receiver address of the BA session recipient.
2227 * @tid: the TID to BA on.
2229 * This function must be called by low level driver once it has
2230 * finished with preparations for the BA session.
2232 void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
2235 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2236 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2237 * @ra: receiver address of the BA session recipient.
2238 * @tid: the TID to BA on.
2240 * This function must be called by low level driver once it has
2241 * finished with preparations for the BA session.
2242 * This version of the function is IRQ-safe.
2244 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2248 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2249 * @sta: the station whose BA session to stop
2250 * @tid: the TID to stop BA.
2251 * @initiator: if indicates initiator DELBA frame will be sent.
2253 * Return: error if no sta with matching da found, success otherwise
2255 * Although mac80211/low level driver/user space application can estimate
2256 * the need to stop aggregation on a certain RA/TID, the session level
2257 * will be managed by the mac80211.
2259 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2260 enum ieee80211_back_parties initiator);
2263 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2264 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2265 * @ra: receiver address of the BA session recipient.
2266 * @tid: the desired TID to BA on.
2268 * This function must be called by low level driver once it has
2269 * finished with preparations for the BA session tear down.
2271 void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
2274 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2275 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2276 * @ra: receiver address of the BA session recipient.
2277 * @tid: the desired TID to BA on.
2279 * This function must be called by low level driver once it has
2280 * finished with preparations for the BA session tear down.
2281 * This version of the function is IRQ-safe.
2283 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2287 * ieee80211_find_sta - find a station
2289 * @vif: virtual interface to look for station on
2290 * @addr: station's address
2292 * This function must be called under RCU lock and the
2293 * resulting pointer is only valid under RCU lock as well.
2295 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2299 * ieee80211_find_sta_by_hw - find a station on hardware
2301 * @hw: pointer as obtained from ieee80211_alloc_hw()
2302 * @addr: station's address
2304 * This function must be called under RCU lock and the
2305 * resulting pointer is only valid under RCU lock as well.
2307 * NOTE: This function should not be used! When mac80211 is converted
2308 * internally to properly keep track of stations on multiple
2309 * virtual interfaces, it will not always know which station to
2310 * return here since a single address might be used by multiple
2311 * logical stations (e.g. consider a station connecting to another
2312 * BSSID on the same AP hardware without disconnecting first).
2314 * DO NOT USE THIS FUNCTION.
2316 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2320 * ieee80211_sta_block_awake - block station from waking up
2322 * @pubsta: the station
2323 * @block: whether to block or unblock
2325 * Some devices require that all frames that are on the queues
2326 * for a specific station that went to sleep are flushed before
2327 * a poll response or frames after the station woke up can be
2328 * delivered to that it. Note that such frames must be rejected
2329 * by the driver as filtered, with the appropriate status flag.
2331 * This function allows implementing this mode in a race-free
2334 * To do this, a driver must keep track of the number of frames
2335 * still enqueued for a specific station. If this number is not
2336 * zero when the station goes to sleep, the driver must call
2337 * this function to force mac80211 to consider the station to
2338 * be asleep regardless of the station's actual state. Once the
2339 * number of outstanding frames reaches zero, the driver must
2340 * call this function again to unblock the station. That will
2341 * cause mac80211 to be able to send ps-poll responses, and if
2342 * the station queried in the meantime then frames will also
2343 * be sent out as a result of this. Additionally, the driver
2344 * will be notified that the station woke up some time after
2345 * it is unblocked, regardless of whether the station actually
2346 * woke up while blocked or not.
2348 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2349 struct ieee80211_sta *pubsta, bool block);
2352 * ieee80211_beacon_loss - inform hardware does not receive beacons
2354 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2356 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2357 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2358 * hardware is not receiving beacons with this function.
2360 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2362 /* Rate control API */
2365 * enum rate_control_changed - flags to indicate which parameter changed
2367 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2368 * changed, rate control algorithm can update its internal state if needed.
2370 enum rate_control_changed {
2371 IEEE80211_RC_HT_CHANGED = BIT(0)
2375 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2377 * @hw: The hardware the algorithm is invoked for.
2378 * @sband: The band this frame is being transmitted on.
2379 * @bss_conf: the current BSS configuration
2380 * @reported_rate: The rate control algorithm can fill this in to indicate
2381 * which rate should be reported to userspace as the current rate and
2382 * used for rate calculations in the mesh network.
2383 * @rts: whether RTS will be used for this frame because it is longer than the
2385 * @short_preamble: whether mac80211 will request short-preamble transmission
2386 * if the selected rate supports it
2387 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2388 * (deprecated; this will be removed once drivers get updated to use
2390 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2391 * @skb: the skb that will be transmitted, the control information in it needs
2393 * @ap: whether this frame is sent out in AP mode
2395 struct ieee80211_tx_rate_control {
2396 struct ieee80211_hw *hw;
2397 struct ieee80211_supported_band *sband;
2398 struct ieee80211_bss_conf *bss_conf;
2399 struct sk_buff *skb;
2400 struct ieee80211_tx_rate reported_rate;
2401 bool rts, short_preamble;
2407 struct rate_control_ops {
2408 struct module *module;
2410 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2411 void (*free)(void *priv);
2413 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2414 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2415 struct ieee80211_sta *sta, void *priv_sta);
2416 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2417 struct ieee80211_sta *sta,
2418 void *priv_sta, u32 changed);
2419 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2422 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2423 struct ieee80211_sta *sta, void *priv_sta,
2424 struct sk_buff *skb);
2425 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2426 struct ieee80211_tx_rate_control *txrc);
2428 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2429 struct dentry *dir);
2430 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2433 static inline int rate_supported(struct ieee80211_sta *sta,
2434 enum ieee80211_band band,
2437 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2441 * rate_control_send_low - helper for drivers for management/no-ack frames
2443 * Rate control algorithms that agree to use the lowest rate to
2444 * send management frames and NO_ACK data with the respective hw
2445 * retries should use this in the beginning of their mac80211 get_rate
2446 * callback. If true is returned the rate control can simply return.
2447 * If false is returned we guarantee that sta and sta and priv_sta is
2450 * Rate control algorithms wishing to do more intelligent selection of
2451 * rate for multicast/broadcast frames may choose to not use this.
2453 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2454 * that this may be null.
2455 * @priv_sta: private rate control structure. This may be null.
2456 * @txrc: rate control information we sholud populate for mac80211.
2458 bool rate_control_send_low(struct ieee80211_sta *sta,
2460 struct ieee80211_tx_rate_control *txrc);
2464 rate_lowest_index(struct ieee80211_supported_band *sband,
2465 struct ieee80211_sta *sta)
2469 for (i = 0; i < sband->n_bitrates; i++)
2470 if (rate_supported(sta, sband->band, i))
2473 /* warn when we cannot find a rate. */
2480 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2481 struct ieee80211_sta *sta)
2485 for (i = 0; i < sband->n_bitrates; i++)
2486 if (rate_supported(sta, sband->band, i))
2491 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2492 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2495 conf_is_ht20(struct ieee80211_conf *conf)
2497 return conf->channel_type == NL80211_CHAN_HT20;
2501 conf_is_ht40_minus(struct ieee80211_conf *conf)
2503 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2507 conf_is_ht40_plus(struct ieee80211_conf *conf)
2509 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2513 conf_is_ht40(struct ieee80211_conf *conf)
2515 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2519 conf_is_ht(struct ieee80211_conf *conf)
2521 return conf->channel_type != NL80211_CHAN_NO_HT;
2524 #endif /* MAC80211_H */