2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 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 {
120 struct ieee80211_low_level_stats {
121 unsigned int dot11ACKFailureCount;
122 unsigned int dot11RTSFailureCount;
123 unsigned int dot11FCSErrorCount;
124 unsigned int dot11RTSSuccessCount;
128 * enum ieee80211_bss_change - BSS change notification flags
130 * These flags are used with the bss_info_changed() callback
131 * to indicate which BSS parameter changed.
133 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134 * also implies a change in the AID.
135 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
137 * @BSS_CHANGED_ERP_SLOT: slot timing changed
138 * @BSS_CHANGED_HT: 802.11n parameters changed
139 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
140 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
141 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
142 * reason (IBSS and managed mode)
143 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144 * new beacon (beaconing modes)
145 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146 * enabled/disabled (beaconing modes)
147 * @BSS_CHANGED_CQM: Connection quality monitor config changed
149 enum ieee80211_bss_change {
150 BSS_CHANGED_ASSOC = 1<<0,
151 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
152 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
153 BSS_CHANGED_ERP_SLOT = 1<<3,
154 BSS_CHANGED_HT = 1<<4,
155 BSS_CHANGED_BASIC_RATES = 1<<5,
156 BSS_CHANGED_BEACON_INT = 1<<6,
157 BSS_CHANGED_BSSID = 1<<7,
158 BSS_CHANGED_BEACON = 1<<8,
159 BSS_CHANGED_BEACON_ENABLED = 1<<9,
160 BSS_CHANGED_CQM = 1<<10,
164 * struct ieee80211_bss_conf - holds the BSS's changing parameters
166 * This structure keeps information about a BSS (and an association
167 * to that BSS) that can change during the lifetime of the BSS.
169 * @assoc: association status
170 * @aid: association ID number, valid only when @assoc is true
171 * @use_cts_prot: use CTS protection
172 * @use_short_preamble: use 802.11b short preamble;
173 * if the hardware cannot handle this it must set the
174 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
175 * @use_short_slot: use short slot time (only relevant for ERP);
176 * if the hardware cannot handle this it must set the
177 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
178 * @dtim_period: num of beacons before the next DTIM, for beaconing,
179 * not valid in station mode (cf. hw conf ps_dtim_period)
180 * @timestamp: beacon timestamp
181 * @beacon_int: beacon interval
182 * @assoc_capability: capabilities taken from assoc resp
183 * @basic_rates: bitmap of basic rates, each bit stands for an
184 * index into the rate table configured by the driver in
186 * @bssid: The BSSID for this BSS
187 * @enable_beacon: whether beaconing should be enabled or not
188 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
189 * This field is only valid when the channel type is one of the HT types.
190 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
192 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
194 struct ieee80211_bss_conf {
196 /* association related data */
199 /* erp related data */
201 bool use_short_preamble;
206 u16 assoc_capability;
209 u16 ht_operation_mode;
215 * enum mac80211_tx_control_flags - flags to describe transmission information/status
217 * These flags are used with the @flags member of &ieee80211_tx_info.
219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221 * number to this frame, taking care of not overwriting the fragment
222 * number and increasing the sequence number only when the
223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224 * assign sequence numbers to QoS-data frames but cannot do so correctly
225 * for non-QoS-data and management frames because beacons need them from
226 * that counter as well and mac80211 cannot guarantee proper sequencing.
227 * If this flag is set, the driver should instruct the hardware to
228 * assign a sequence number to the frame or assign one itself. Cf. IEEE
229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230 * beacons and always be clear for frames without a sequence number field.
231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode. Note that to
240 * avoid race conditions, the filter must be set by the hardware or
241 * firmware upon receiving a frame that indicates that the station
242 * went to sleep (must be done on device to filter frames already on
243 * the queue) and may only be unset after mac80211 gives the OK for
244 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
245 * since only then is it guaranteed that no more frames are in the
247 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
248 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
249 * is for the whole aggregation.
250 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
251 * so consider using block ack request (BAR).
252 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
253 * set by rate control algorithms to indicate probe rate, will
254 * be cleared for fragmented frames (except on the last fragment)
255 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
256 * used to indicate that a pending frame requires TX processing before
257 * it can be sent out.
258 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
259 * used to indicate that a frame was already retried due to PS
260 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
261 * used to indicate frame should not be encrypted
262 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
263 * This frame is a response to a PS-poll frame and should be sent
264 * although the station is in powersave mode.
265 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
266 * transmit function after the current frame, this can be used
267 * by drivers to kick the DMA queue only if unset or when the
269 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
270 * after TX status because the destination was asleep, it must not
271 * be modified again (no seqno assignment, crypto, etc.)
272 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
273 * has a radiotap header at skb->data.
274 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
275 * MLME command (internal to mac80211 to figure out whether to send TX
276 * status to user space)
277 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
278 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
279 * frame and selects the maximum number of streams that it can use.
281 enum mac80211_tx_control_flags {
282 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
283 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
284 IEEE80211_TX_CTL_NO_ACK = BIT(2),
285 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
286 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
287 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
288 IEEE80211_TX_CTL_AMPDU = BIT(6),
289 IEEE80211_TX_CTL_INJECTED = BIT(7),
290 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
291 IEEE80211_TX_STAT_ACK = BIT(9),
292 IEEE80211_TX_STAT_AMPDU = BIT(10),
293 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
294 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
295 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
296 IEEE80211_TX_INTFL_RETRIED = BIT(15),
297 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
298 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
299 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
300 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
301 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
302 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
303 IEEE80211_TX_CTL_LDPC = BIT(22),
304 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
305 #define IEEE80211_TX_CTL_STBC_SHIFT 23
309 * enum mac80211_rate_control_flags - per-rate flags set by the
310 * Rate Control algorithm.
312 * These flags are set by the Rate control algorithm for each rate during tx,
313 * in the @flags member of struct ieee80211_tx_rate.
315 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
316 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
317 * This is set if the current BSS requires ERP protection.
318 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
319 * @IEEE80211_TX_RC_MCS: HT rate.
320 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
322 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
323 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
324 * adjacent 20 MHz channels, if the current channel type is
325 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
326 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
328 enum mac80211_rate_control_flags {
329 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
330 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
331 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
333 /* rate index is an MCS rate number instead of an index */
334 IEEE80211_TX_RC_MCS = BIT(3),
335 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
336 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
337 IEEE80211_TX_RC_DUP_DATA = BIT(6),
338 IEEE80211_TX_RC_SHORT_GI = BIT(7),
342 /* there are 40 bytes if you don't need the rateset to be kept */
343 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
345 /* if you do need the rateset, then you have less space */
346 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
348 /* maximum number of rate stages */
349 #define IEEE80211_TX_MAX_RATES 5
352 * struct ieee80211_tx_rate - rate selection/status
354 * @idx: rate index to attempt to send with
355 * @flags: rate control flags (&enum mac80211_rate_control_flags)
356 * @count: number of tries in this rate before going to the next rate
358 * A value of -1 for @idx indicates an invalid rate and, if used
359 * in an array of retry rates, that no more rates should be tried.
361 * When used for transmit status reporting, the driver should
362 * always report the rate along with the flags it used.
364 * &struct ieee80211_tx_info contains an array of these structs
365 * in the control information, and it will be filled by the rate
366 * control algorithm according to what should be sent. For example,
367 * if this array contains, in the format { <idx>, <count> } the
369 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
370 * then this means that the frame should be transmitted
371 * up to twice at rate 3, up to twice at rate 2, and up to four
372 * times at rate 1 if it doesn't get acknowledged. Say it gets
373 * acknowledged by the peer after the fifth attempt, the status
374 * information should then contain
375 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
376 * since it was transmitted twice at rate 3, twice at rate 2
377 * and once at rate 1 after which we received an acknowledgement.
379 struct ieee80211_tx_rate {
383 } __attribute__((packed));
386 * struct ieee80211_tx_info - skb transmit information
388 * This structure is placed in skb->cb for three uses:
389 * (1) mac80211 TX control - mac80211 tells the driver what to do
390 * (2) driver internal use (if applicable)
391 * (3) TX status information - driver tells mac80211 what happened
393 * The TX control's sta pointer is only valid during the ->tx call,
396 * @flags: transmit info flags, defined above
397 * @band: the band to transmit on (use for checking for races)
398 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
399 * @pad: padding, ignore
400 * @control: union for control data
401 * @status: union for status data
402 * @driver_data: array of driver_data pointers
403 * @ampdu_ack_len: number of acked aggregated frames.
404 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
405 * @ampdu_ack_map: block ack bit map for the aggregation.
406 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
407 * @ampdu_len: number of aggregated frames.
408 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
409 * @ack_signal: signal strength of the ACK frame
411 struct ieee80211_tx_info {
412 /* common information */
426 struct ieee80211_tx_rate rates[
427 IEEE80211_TX_MAX_RATES];
430 /* only needed before rate control */
431 unsigned long jiffies;
433 /* NB: vif can be NULL for injected frames */
434 struct ieee80211_vif *vif;
435 struct ieee80211_key_conf *hw_key;
436 struct ieee80211_sta *sta;
439 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
447 struct ieee80211_tx_rate driver_rates[
448 IEEE80211_TX_MAX_RATES];
449 void *rate_driver_data[
450 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
453 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
457 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
459 return (struct ieee80211_tx_info *)skb->cb;
462 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
464 return (struct ieee80211_rx_status *)skb->cb;
468 * ieee80211_tx_info_clear_status - clear TX status
470 * @info: The &struct ieee80211_tx_info to be cleared.
472 * When the driver passes an skb back to mac80211, it must report
473 * a number of things in TX status. This function clears everything
474 * in the TX status but the rate control information (it does clear
475 * the count since you need to fill that in anyway).
477 * NOTE: You can only use this function if you do NOT use
478 * info->driver_data! Use info->rate_driver_data
479 * instead if you need only the less space that allows.
482 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
486 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
487 offsetof(struct ieee80211_tx_info, control.rates));
488 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
489 offsetof(struct ieee80211_tx_info, driver_rates));
490 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
491 /* clear the rate counts */
492 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
493 info->status.rates[i].count = 0;
496 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
497 memset(&info->status.ampdu_ack_len, 0,
498 sizeof(struct ieee80211_tx_info) -
499 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
504 * enum mac80211_rx_flags - receive flags
506 * These flags are used with the @flag member of &struct ieee80211_rx_status.
507 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
508 * Use together with %RX_FLAG_MMIC_STRIPPED.
509 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
510 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
511 * verification has been done by the hardware.
512 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
513 * If this flag is set, the stack cannot do any replay detection
514 * hence the driver or hardware will have to do that.
515 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
517 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
519 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
520 * is valid. This is useful in monitor mode and necessary for beacon frames
521 * to enable IBSS merging.
522 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
523 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
524 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
525 * @RX_FLAG_SHORT_GI: Short guard interval was used
526 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
527 * on cooked monitor to avoid double-reporting it for multiple
530 enum mac80211_rx_flags {
531 RX_FLAG_MMIC_ERROR = 1<<0,
532 RX_FLAG_DECRYPTED = 1<<1,
533 RX_FLAG_MMIC_STRIPPED = 1<<3,
534 RX_FLAG_IV_STRIPPED = 1<<4,
535 RX_FLAG_FAILED_FCS_CRC = 1<<5,
536 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
538 RX_FLAG_SHORTPRE = 1<<8,
540 RX_FLAG_40MHZ = 1<<10,
541 RX_FLAG_SHORT_GI = 1<<11,
542 RX_FLAG_INTERNAL_CMTR = 1<<12,
546 * struct ieee80211_rx_status - receive status
548 * The low-level driver should provide this information (the subset
549 * supported by hardware) to the 802.11 code with each received
550 * frame, in the skb's control buffer (cb).
552 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
553 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
554 * @band: the active band when this frame was received
555 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
556 * @signal: signal strength when receiving this frame, either in dBm, in dB or
557 * unspecified depending on the hardware capabilities flags
558 * @IEEE80211_HW_SIGNAL_*
559 * @noise: noise when receiving this frame, in dBm (DEPRECATED).
560 * @antenna: antenna used
561 * @rate_idx: index of data rate into band's supported rates or MCS index if
562 * HT rates are use (RX_FLAG_HT)
565 struct ieee80211_rx_status {
567 enum ieee80211_band band;
570 int noise __deprecated;
577 * enum ieee80211_conf_flags - configuration flags
579 * Flags to define PHY configuration options
581 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
582 * to determine for example whether to calculate timestamps for packets
583 * or not, do not use instead of filter flags!
584 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
585 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
586 * meaning that the hardware still wakes up for beacons, is able to
587 * transmit frames and receive the possible acknowledgment frames.
588 * Not to be confused with hardware specific wakeup/sleep states,
589 * driver is responsible for that. See the section "Powersave support"
591 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
592 * the driver should be prepared to handle configuration requests but
593 * may turn the device off as much as possible. Typically, this flag will
594 * be set when an interface is set UP but not associated or scanning, but
595 * it can also be unset in that case when monitor interfaces are active.
596 * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless
597 * Multimedia). On some drivers (iwlwifi is one of know) we have
598 * to enable/disable QoS explicitly.
600 enum ieee80211_conf_flags {
601 IEEE80211_CONF_MONITOR = (1<<0),
602 IEEE80211_CONF_PS = (1<<1),
603 IEEE80211_CONF_IDLE = (1<<2),
604 IEEE80211_CONF_QOS = (1<<3),
609 * enum ieee80211_conf_changed - denotes which configuration changed
611 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
612 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
613 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
614 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
615 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
616 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
617 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
618 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
619 * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled
621 enum ieee80211_conf_changed {
622 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
623 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
624 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
625 IEEE80211_CONF_CHANGE_PS = BIT(4),
626 IEEE80211_CONF_CHANGE_POWER = BIT(5),
627 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
628 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
629 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
630 IEEE80211_CONF_CHANGE_QOS = BIT(9),
634 * enum ieee80211_smps_mode - spatial multiplexing power save mode
636 * @IEEE80211_SMPS_AUTOMATIC: automatic
637 * @IEEE80211_SMPS_OFF: off
638 * @IEEE80211_SMPS_STATIC: static
639 * @IEEE80211_SMPS_DYNAMIC: dynamic
640 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
642 enum ieee80211_smps_mode {
643 IEEE80211_SMPS_AUTOMATIC,
645 IEEE80211_SMPS_STATIC,
646 IEEE80211_SMPS_DYNAMIC,
649 IEEE80211_SMPS_NUM_MODES,
653 * struct ieee80211_conf - configuration of the device
655 * This struct indicates how the driver shall configure the hardware.
657 * @flags: configuration flags defined above
659 * @listen_interval: listen interval in units of beacon interval
660 * @max_sleep_period: the maximum number of beacon intervals to sleep for
661 * before checking the beacon for a TIM bit (managed mode only); this
662 * value will be only achievable between DTIM frames, the hardware
663 * needs to check for the multicast traffic bit in DTIM beacons.
664 * This variable is valid only when the CONF_PS flag is set.
665 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
666 * in power saving. Power saving will not be enabled until a beacon
667 * has been received and the DTIM period is known.
668 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
669 * powersave documentation below. This variable is valid only when
670 * the CONF_PS flag is set.
672 * @power_level: requested transmit power (in dBm)
674 * @channel: the channel to tune to
675 * @channel_type: the channel (HT) type
677 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
678 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
679 * but actually means the number of transmissions not the number of retries
680 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
681 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
682 * number of transmissions not the number of retries
684 * @smps_mode: spatial multiplexing powersave mode; note that
685 * %IEEE80211_SMPS_STATIC is used when the device is not
686 * configured for an HT channel
688 struct ieee80211_conf {
690 int power_level, dynamic_ps_timeout;
691 int max_sleep_period;
696 u8 long_frame_max_tx_count, short_frame_max_tx_count;
698 struct ieee80211_channel *channel;
699 enum nl80211_channel_type channel_type;
700 enum ieee80211_smps_mode smps_mode;
704 * struct ieee80211_vif - per-interface data
706 * Data in this structure is continually present for driver
707 * use during the life of a virtual interface.
709 * @type: type of this virtual interface
710 * @bss_conf: BSS configuration for this interface, either our own
711 * or the BSS we're associated to
712 * @addr: address of this interface
713 * @drv_priv: data area for driver use, will always be aligned to
716 struct ieee80211_vif {
717 enum nl80211_iftype type;
718 struct ieee80211_bss_conf bss_conf;
721 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
724 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
726 #ifdef CONFIG_MAC80211_MESH
727 return vif->type == NL80211_IFTYPE_MESH_POINT;
733 * enum ieee80211_key_alg - key algorithm
734 * @ALG_WEP: WEP40 or WEP104
736 * @ALG_CCMP: CCMP (AES)
737 * @ALG_AES_CMAC: AES-128-CMAC
739 enum ieee80211_key_alg {
747 * enum ieee80211_key_flags - key flags
749 * These flags are used for communication about keys between the driver
750 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
752 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
753 * that the STA this key will be used with could be using QoS.
754 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
755 * driver to indicate that it requires IV generation for this
757 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
758 * the driver for a TKIP key if it requires Michael MIC
759 * generation in software.
760 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
761 * that the key is pairwise rather then a shared key.
762 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
763 * CCMP key if it requires CCMP encryption of management frames (MFP) to
764 * be done in software.
766 enum ieee80211_key_flags {
767 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
768 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
769 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
770 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
771 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
775 * struct ieee80211_key_conf - key information
777 * This key information is given by mac80211 to the driver by
778 * the set_key() callback in &struct ieee80211_ops.
780 * @hw_key_idx: To be set by the driver, this is the key index the driver
781 * wants to be given when a frame is transmitted and needs to be
782 * encrypted in hardware.
783 * @alg: The key algorithm.
784 * @flags: key flags, see &enum ieee80211_key_flags.
785 * @keyidx: the key index (0-3)
786 * @keylen: key material length
787 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
789 * - Temporal Encryption Key (128 bits)
790 * - Temporal Authenticator Tx MIC Key (64 bits)
791 * - Temporal Authenticator Rx MIC Key (64 bits)
792 * @icv_len: The ICV length for this key type
793 * @iv_len: The IV length for this key type
795 struct ieee80211_key_conf {
796 enum ieee80211_key_alg alg;
808 * enum set_key_cmd - key command
810 * Used with the set_key() callback in &struct ieee80211_ops, this
811 * indicates whether a key is being removed or added.
813 * @SET_KEY: a key is set
814 * @DISABLE_KEY: a key must be disabled
817 SET_KEY, DISABLE_KEY,
821 * struct ieee80211_sta - station table entry
823 * A station table entry represents a station we are possibly
824 * communicating with. Since stations are RCU-managed in
825 * mac80211, any ieee80211_sta pointer you get access to must
826 * either be protected by rcu_read_lock() explicitly or implicitly,
827 * or you must take good care to not use such a pointer after a
828 * call to your sta_remove callback that removed it.
831 * @aid: AID we assigned to the station if we're an AP
832 * @supp_rates: Bitmap of supported rates (per band)
833 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
834 * @drv_priv: data area for driver use, will always be aligned to
835 * sizeof(void *), size is determined in hw information.
837 struct ieee80211_sta {
838 u32 supp_rates[IEEE80211_NUM_BANDS];
841 struct ieee80211_sta_ht_cap ht_cap;
844 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
848 * enum sta_notify_cmd - sta notify command
850 * Used with the sta_notify() callback in &struct ieee80211_ops, this
851 * indicates addition and removal of a station to station table,
852 * or if a associated station made a power state transition.
854 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
855 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
856 * @STA_NOTIFY_SLEEP: a station is now sleeping
857 * @STA_NOTIFY_AWAKE: a sleeping station woke up
859 enum sta_notify_cmd {
860 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
861 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
865 * enum ieee80211_tkip_key_type - get tkip key
867 * Used by drivers which need to get a tkip key for skb. Some drivers need a
868 * phase 1 key, others need a phase 2 key. A single function allows the driver
869 * to get the key, this enum indicates what type of key is required.
871 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
872 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
874 enum ieee80211_tkip_key_type {
875 IEEE80211_TKIP_P1_KEY,
876 IEEE80211_TKIP_P2_KEY,
880 * enum ieee80211_hw_flags - hardware flags
882 * These flags are used to indicate hardware capabilities to
883 * the stack. Generally, flags here should have their meaning
884 * done in a way that the simplest hardware doesn't need setting
885 * any particular flags. There are some exceptions to this rule,
886 * however, so you are advised to review these flags carefully.
888 * @IEEE80211_HW_HAS_RATE_CONTROL:
889 * The hardware or firmware includes rate control, and cannot be
890 * controlled by the stack. As such, no rate control algorithm
891 * should be instantiated, and the TX rate reported to userspace
892 * will be taken from the TX status instead of the rate control
894 * Note that this requires that the driver implement a number of
895 * callbacks so it has the correct information, it needs to have
896 * the @set_rts_threshold callback and must look at the BSS config
897 * @use_cts_prot for G/N protection, @use_short_slot for slot
898 * timing in 2.4 GHz and @use_short_preamble for preambles for
901 * @IEEE80211_HW_RX_INCLUDES_FCS:
902 * Indicates that received frames passed to the stack include
903 * the FCS at the end.
905 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
906 * Some wireless LAN chipsets buffer broadcast/multicast frames
907 * for power saving stations in the hardware/firmware and others
908 * rely on the host system for such buffering. This option is used
909 * to configure the IEEE 802.11 upper layer to buffer broadcast and
910 * multicast frames when there are power saving stations so that
911 * the driver can fetch them with ieee80211_get_buffered_bc().
913 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
914 * Hardware is not capable of short slot operation on the 2.4 GHz band.
916 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
917 * Hardware is not capable of receiving frames with short preamble on
920 * @IEEE80211_HW_SIGNAL_UNSPEC:
921 * Hardware can provide signal values but we don't know its units. We
922 * expect values between 0 and @max_signal.
923 * If possible please provide dB or dBm instead.
925 * @IEEE80211_HW_SIGNAL_DBM:
926 * Hardware gives signal values in dBm, decibel difference from
927 * one milliwatt. This is the preferred method since it is standardized
928 * between different devices. @max_signal does not need to be set.
930 * @IEEE80211_HW_NOISE_DBM:
931 * Hardware can provide noise (radio interference) values in units dBm,
932 * decibel difference from one milliwatt.
934 * @IEEE80211_HW_SPECTRUM_MGMT:
935 * Hardware supports spectrum management defined in 802.11h
936 * Measurement, Channel Switch, Quieting, TPC
938 * @IEEE80211_HW_AMPDU_AGGREGATION:
939 * Hardware supports 11n A-MPDU aggregation.
941 * @IEEE80211_HW_SUPPORTS_PS:
942 * Hardware has power save support (i.e. can go to sleep).
944 * @IEEE80211_HW_PS_NULLFUNC_STACK:
945 * Hardware requires nullfunc frame handling in stack, implies
946 * stack support for dynamic PS.
948 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
949 * Hardware has support for dynamic PS.
951 * @IEEE80211_HW_MFP_CAPABLE:
952 * Hardware supports management frame protection (MFP, IEEE 802.11w).
954 * @IEEE80211_HW_BEACON_FILTER:
955 * Hardware supports dropping of irrelevant beacon frames to
956 * avoid waking up cpu.
958 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
959 * Hardware supports static spatial multiplexing powersave,
960 * ie. can turn off all but one chain even on HT connections
961 * that should be using more chains.
963 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
964 * Hardware supports dynamic spatial multiplexing powersave,
965 * ie. can turn off all but one chain and then wake the rest
966 * up as required after, for example, rts/cts handshake.
968 * @IEEE80211_HW_SUPPORTS_UAPSD:
969 * Hardware supports Unscheduled Automatic Power Save Delivery
970 * (U-APSD) in managed mode. The mode is configured with
971 * conf_tx() operation.
973 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
974 * Hardware can provide ack status reports of Tx frames to
977 * @IEEE80211_HW_CONNECTION_MONITOR:
978 * The hardware performs its own connection monitoring, including
979 * periodic keep-alives to the AP and probing the AP on beacon loss.
980 * When this flag is set, signaling beacon-loss will cause an immediate
981 * change to disassociated state.
983 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
984 * Hardware can do connection quality monitoring - i.e. it can monitor
985 * connection quality related parameters, such as the RSSI level and
986 * provide notifications if configured trigger levels are reached.
989 enum ieee80211_hw_flags {
990 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
991 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
992 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
993 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
994 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
995 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
996 IEEE80211_HW_SIGNAL_DBM = 1<<6,
997 IEEE80211_HW_NOISE_DBM = 1<<7,
998 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
999 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1000 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1001 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1002 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1003 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1004 IEEE80211_HW_BEACON_FILTER = 1<<14,
1005 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1006 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1007 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1008 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1009 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1010 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1014 * struct ieee80211_hw - hardware information and state
1016 * This structure contains the configuration and hardware
1017 * information for an 802.11 PHY.
1019 * @wiphy: This points to the &struct wiphy allocated for this
1020 * 802.11 PHY. You must fill in the @perm_addr and @dev
1021 * members of this structure using SET_IEEE80211_DEV()
1022 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1023 * bands (with channels, bitrates) are registered here.
1025 * @conf: &struct ieee80211_conf, device configuration, don't use.
1027 * @priv: pointer to private area that was allocated for driver use
1028 * along with this structure.
1030 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1032 * @extra_tx_headroom: headroom to reserve in each transmit skb
1033 * for use by the driver (e.g. for transmit headers.)
1035 * @channel_change_time: time (in microseconds) it takes to change channels.
1037 * @max_signal: Maximum value for signal (rssi) in RX information, used
1038 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1040 * @max_listen_interval: max listen interval in units of beacon interval
1043 * @queues: number of available hardware transmit queues for
1044 * data packets. WMM/QoS requires at least four, these
1045 * queues need to have configurable access parameters.
1047 * @rate_control_algorithm: rate control algorithm for this hardware.
1048 * If unset (NULL), the default algorithm will be used. Must be
1049 * set before calling ieee80211_register_hw().
1051 * @vif_data_size: size (in bytes) of the drv_priv data area
1052 * within &struct ieee80211_vif.
1053 * @sta_data_size: size (in bytes) of the drv_priv data area
1054 * within &struct ieee80211_sta.
1056 * @max_rates: maximum number of alternate rate retry stages
1057 * @max_rate_tries: maximum number of tries for each stage
1059 struct ieee80211_hw {
1060 struct ieee80211_conf conf;
1061 struct wiphy *wiphy;
1062 const char *rate_control_algorithm;
1065 unsigned int extra_tx_headroom;
1066 int channel_change_time;
1070 u16 max_listen_interval;
1077 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1079 * @wiphy: the &struct wiphy which we want to query
1081 * mac80211 drivers can use this to get to their respective
1082 * &struct ieee80211_hw. Drivers wishing to get to their own private
1083 * structure can then access it via hw->priv. Note that mac802111 drivers should
1084 * not use wiphy_priv() to try to get their private driver structure as this
1085 * is already used internally by mac80211.
1087 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1090 * SET_IEEE80211_DEV - set device for 802.11 hardware
1092 * @hw: the &struct ieee80211_hw to set the device for
1093 * @dev: the &struct device of this 802.11 device
1095 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1097 set_wiphy_dev(hw->wiphy, dev);
1101 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1103 * @hw: the &struct ieee80211_hw to set the MAC address for
1104 * @addr: the address to set
1106 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1108 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1111 static inline struct ieee80211_rate *
1112 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1113 const struct ieee80211_tx_info *c)
1115 if (WARN_ON(c->control.rates[0].idx < 0))
1117 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1120 static inline struct ieee80211_rate *
1121 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1122 const struct ieee80211_tx_info *c)
1124 if (c->control.rts_cts_rate_idx < 0)
1126 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1129 static inline struct ieee80211_rate *
1130 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1131 const struct ieee80211_tx_info *c, int idx)
1133 if (c->control.rates[idx + 1].idx < 0)
1135 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1139 * DOC: Hardware crypto acceleration
1141 * mac80211 is capable of taking advantage of many hardware
1142 * acceleration designs for encryption and decryption operations.
1144 * The set_key() callback in the &struct ieee80211_ops for a given
1145 * device is called to enable hardware acceleration of encryption and
1146 * decryption. The callback takes a @sta parameter that will be NULL
1147 * for default keys or keys used for transmission only, or point to
1148 * the station information for the peer for individual keys.
1149 * Multiple transmission keys with the same key index may be used when
1150 * VLANs are configured for an access point.
1152 * When transmitting, the TX control data will use the @hw_key_idx
1153 * selected by the driver by modifying the &struct ieee80211_key_conf
1154 * pointed to by the @key parameter to the set_key() function.
1156 * The set_key() call for the %SET_KEY command should return 0 if
1157 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1158 * added; if you return 0 then hw_key_idx must be assigned to the
1159 * hardware key index, you are free to use the full u8 range.
1161 * When the cmd is %DISABLE_KEY then it must succeed.
1163 * Note that it is permissible to not decrypt a frame even if a key
1164 * for it has been uploaded to hardware, the stack will not make any
1165 * decision based on whether a key has been uploaded or not but rather
1166 * based on the receive flags.
1168 * The &struct ieee80211_key_conf structure pointed to by the @key
1169 * parameter is guaranteed to be valid until another call to set_key()
1170 * removes it, but it can only be used as a cookie to differentiate
1173 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1174 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1176 * The update_tkip_key() call updates the driver with the new phase 1 key.
1177 * This happens everytime the iv16 wraps around (every 65536 packets). The
1178 * set_key() call will happen only once for each key (unless the AP did
1179 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1180 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1181 * handler is software decryption with wrap around of iv16.
1185 * DOC: Powersave support
1187 * mac80211 has support for various powersave implementations.
1189 * First, it can support hardware that handles all powersaving by itself,
1190 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1191 * flag. In that case, it will be told about the desired powersave mode
1192 * with the %IEEE80211_CONF_PS flag depending on the association status.
1193 * The hardware must take care of sending nullfunc frames when necessary,
1194 * i.e. when entering and leaving powersave mode. The hardware is required
1195 * to look at the AID in beacons and signal to the AP that it woke up when
1196 * it finds traffic directed to it.
1198 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1199 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1200 * with hardware wakeup and sleep states. Driver is responsible for waking
1201 * up the hardware before issueing commands to the hardware and putting it
1202 * back to sleep at approriate times.
1204 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1205 * buffered multicast/broadcast frames after the beacon. Also it must be
1206 * possible to send frames and receive the acknowledment frame.
1208 * Other hardware designs cannot send nullfunc frames by themselves and also
1209 * need software support for parsing the TIM bitmap. This is also supported
1210 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1211 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1212 * required to pass up beacons. The hardware is still required to handle
1213 * waking up for multicast traffic; if it cannot the driver must handle that
1214 * as best as it can, mac80211 is too slow to do that.
1216 * Dynamic powersave is an extension to normal powersave in which the
1217 * hardware stays awake for a user-specified period of time after sending a
1218 * frame so that reply frames need not be buffered and therefore delayed to
1219 * the next wakeup. It's compromise of getting good enough latency when
1220 * there's data traffic and still saving significantly power in idle
1223 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1224 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1225 * flag and mac80211 will handle everything automatically. Additionally,
1226 * hardware having support for the dynamic PS feature may set the
1227 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1228 * dynamic PS mode itself. The driver needs to look at the
1229 * @dynamic_ps_timeout hardware configuration value and use it that value
1230 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1231 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1232 * enabled whenever user has enabled powersave.
1234 * Driver informs U-APSD client support by enabling
1235 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1236 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1237 * Nullfunc frames and stay awake until the service period has ended. To
1238 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1239 * from that AC are transmitted with powersave enabled.
1241 * Note: U-APSD client mode is not yet supported with
1242 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1246 * DOC: Beacon filter support
1248 * Some hardware have beacon filter support to reduce host cpu wakeups
1249 * which will reduce system power consumption. It usuallly works so that
1250 * the firmware creates a checksum of the beacon but omits all constantly
1251 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1252 * beacon is forwarded to the host, otherwise it will be just dropped. That
1253 * way the host will only receive beacons where some relevant information
1254 * (for example ERP protection or WMM settings) have changed.
1256 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1257 * hardware capability. The driver needs to enable beacon filter support
1258 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1259 * power save is enabled, the stack will not check for beacon loss and the
1260 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1262 * The time (or number of beacons missed) until the firmware notifies the
1263 * driver of a beacon loss event (which in turn causes the driver to call
1264 * ieee80211_beacon_loss()) should be configurable and will be controlled
1265 * by mac80211 and the roaming algorithm in the future.
1267 * Since there may be constantly changing information elements that nothing
1268 * in the software stack cares about, we will, in the future, have mac80211
1269 * tell the driver which information elements are interesting in the sense
1270 * that we want to see changes in them. This will include
1271 * - a list of information element IDs
1272 * - a list of OUIs for the vendor information element
1274 * Ideally, the hardware would filter out any beacons without changes in the
1275 * requested elements, but if it cannot support that it may, at the expense
1276 * of some efficiency, filter out only a subset. For example, if the device
1277 * doesn't support checking for OUIs it should pass up all changes in all
1278 * vendor information elements.
1280 * Note that change, for the sake of simplification, also includes information
1281 * elements appearing or disappearing from the beacon.
1283 * Some hardware supports an "ignore list" instead, just make sure nothing
1284 * that was requested is on the ignore list, and include commonly changing
1285 * information element IDs in the ignore list, for example 11 (BSS load) and
1286 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1287 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1288 * it could also include some currently unused IDs.
1291 * In addition to these capabilities, hardware should support notifying the
1292 * host of changes in the beacon RSSI. This is relevant to implement roaming
1293 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1294 * the received data packets). This can consist in notifying the host when
1295 * the RSSI changes significantly or when it drops below or rises above
1296 * configurable thresholds. In the future these thresholds will also be
1297 * configured by mac80211 (which gets them from userspace) to implement
1298 * them as the roaming algorithm requires.
1300 * If the hardware cannot implement this, the driver should ask it to
1301 * periodically pass beacon frames to the host so that software can do the
1302 * signal strength threshold checking.
1306 * DOC: Spatial multiplexing power save
1308 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1309 * power in an 802.11n implementation. For details on the mechanism
1310 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1311 * "11.2.3 SM power save".
1313 * The mac80211 implementation is capable of sending action frames
1314 * to update the AP about the station's SMPS mode, and will instruct
1315 * the driver to enter the specific mode. It will also announce the
1316 * requested SMPS mode during the association handshake. Hardware
1317 * support for this feature is required, and can be indicated by
1320 * The default mode will be "automatic", which nl80211/cfg80211
1321 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1322 * turned off otherwise.
1324 * To support this feature, the driver must set the appropriate
1325 * hardware support flags, and handle the SMPS flag to the config()
1326 * operation. It will then with this mechanism be instructed to
1327 * enter the requested SMPS mode while associated to an HT AP.
1331 * DOC: Frame filtering
1333 * mac80211 requires to see many management frames for proper
1334 * operation, and users may want to see many more frames when
1335 * in monitor mode. However, for best CPU usage and power consumption,
1336 * having as few frames as possible percolate through the stack is
1337 * desirable. Hence, the hardware should filter as much as possible.
1339 * To achieve this, mac80211 uses filter flags (see below) to tell
1340 * the driver's configure_filter() function which frames should be
1341 * passed to mac80211 and which should be filtered out.
1343 * Before configure_filter() is invoked, the prepare_multicast()
1344 * callback is invoked with the parameters @mc_count and @mc_list
1345 * for the combined multicast address list of all virtual interfaces.
1346 * It's use is optional, and it returns a u64 that is passed to
1347 * configure_filter(). Additionally, configure_filter() has the
1348 * arguments @changed_flags telling which flags were changed and
1349 * @total_flags with the new flag states.
1351 * If your device has no multicast address filters your driver will
1352 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1353 * parameter to see whether multicast frames should be accepted
1356 * All unsupported flags in @total_flags must be cleared.
1357 * Hardware does not support a flag if it is incapable of _passing_
1358 * the frame to the stack. Otherwise the driver must ignore
1359 * the flag, but not clear it.
1360 * You must _only_ clear the flag (announce no support for the
1361 * flag to mac80211) if you are not able to pass the packet type
1362 * to the stack (so the hardware always filters it).
1363 * So for example, you should clear @FIF_CONTROL, if your hardware
1364 * always filters control frames. If your hardware always passes
1365 * control frames to the kernel and is incapable of filtering them,
1366 * you do _not_ clear the @FIF_CONTROL flag.
1367 * This rule applies to all other FIF flags as well.
1371 * enum ieee80211_filter_flags - hardware filter flags
1373 * These flags determine what the filter in hardware should be
1374 * programmed to let through and what should not be passed to the
1375 * stack. It is always safe to pass more frames than requested,
1376 * but this has negative impact on power consumption.
1378 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1379 * think of the BSS as your network segment and then this corresponds
1380 * to the regular ethernet device promiscuous mode.
1382 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1383 * by the user or if the hardware is not capable of filtering by
1384 * multicast address.
1386 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1387 * %RX_FLAG_FAILED_FCS_CRC for them)
1389 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1390 * the %RX_FLAG_FAILED_PLCP_CRC for them
1392 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1393 * to the hardware that it should not filter beacons or probe responses
1394 * by BSSID. Filtering them can greatly reduce the amount of processing
1395 * mac80211 needs to do and the amount of CPU wakeups, so you should
1396 * honour this flag if possible.
1398 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1399 * is not set then only those addressed to this station.
1401 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1403 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1404 * those addressed to this station.
1406 enum ieee80211_filter_flags {
1407 FIF_PROMISC_IN_BSS = 1<<0,
1408 FIF_ALLMULTI = 1<<1,
1410 FIF_PLCPFAIL = 1<<3,
1411 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1413 FIF_OTHER_BSS = 1<<6,
1418 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1420 * These flags are used with the ampdu_action() callback in
1421 * &struct ieee80211_ops to indicate which action is needed.
1423 * Note that drivers MUST be able to deal with a TX aggregation
1424 * session being stopped even before they OK'ed starting it by
1425 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1426 * might receive the addBA frame and send a delBA right away!
1428 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1429 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1430 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1431 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1432 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1434 enum ieee80211_ampdu_mlme_action {
1435 IEEE80211_AMPDU_RX_START,
1436 IEEE80211_AMPDU_RX_STOP,
1437 IEEE80211_AMPDU_TX_START,
1438 IEEE80211_AMPDU_TX_STOP,
1439 IEEE80211_AMPDU_TX_OPERATIONAL,
1443 * struct ieee80211_ops - callbacks from mac80211 to the driver
1445 * This structure contains various callbacks that the driver may
1446 * handle or, in some cases, must handle, for example to configure
1447 * the hardware to a new channel or to transmit a frame.
1449 * @tx: Handler that 802.11 module calls for each transmitted frame.
1450 * skb contains the buffer starting from the IEEE 802.11 header.
1451 * The low-level driver should send the frame out based on
1452 * configuration in the TX control data. This handler should,
1453 * preferably, never fail and stop queues appropriately, more
1454 * importantly, however, it must never fail for A-MPDU-queues.
1455 * This function should return NETDEV_TX_OK except in very
1457 * Must be implemented and atomic.
1459 * @start: Called before the first netdevice attached to the hardware
1460 * is enabled. This should turn on the hardware and must turn on
1461 * frame reception (for possibly enabled monitor interfaces.)
1462 * Returns negative error codes, these may be seen in userspace,
1464 * When the device is started it should not have a MAC address
1465 * to avoid acknowledging frames before a non-monitor device
1467 * Must be implemented and can sleep.
1469 * @stop: Called after last netdevice attached to the hardware
1470 * is disabled. This should turn off the hardware (at least
1471 * it must turn off frame reception.)
1472 * May be called right after add_interface if that rejects
1473 * an interface. If you added any work onto the mac80211 workqueue
1474 * you should ensure to cancel it on this callback.
1475 * Must be implemented and can sleep.
1477 * @add_interface: Called when a netdevice attached to the hardware is
1478 * enabled. Because it is not called for monitor mode devices, @start
1479 * and @stop must be implemented.
1480 * The driver should perform any initialization it needs before
1481 * the device can be enabled. The initial configuration for the
1482 * interface is given in the conf parameter.
1483 * The callback may refuse to add an interface by returning a
1484 * negative error code (which will be seen in userspace.)
1485 * Must be implemented and can sleep.
1487 * @remove_interface: Notifies a driver that an interface is going down.
1488 * The @stop callback is called after this if it is the last interface
1489 * and no monitor interfaces are present.
1490 * When all interfaces are removed, the MAC address in the hardware
1491 * must be cleared so the device no longer acknowledges packets,
1492 * the mac_addr member of the conf structure is, however, set to the
1493 * MAC address of the device going away.
1494 * Hence, this callback must be implemented. It can sleep.
1496 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1497 * function to change hardware configuration, e.g., channel.
1498 * This function should never fail but returns a negative error code
1499 * if it does. The callback can sleep.
1501 * @bss_info_changed: Handler for configuration requests related to BSS
1502 * parameters that may vary during BSS's lifespan, and may affect low
1503 * level driver (e.g. assoc/disassoc status, erp parameters).
1504 * This function should not be used if no BSS has been set, unless
1505 * for association indication. The @changed parameter indicates which
1506 * of the bss parameters has changed when a call is made. The callback
1509 * @prepare_multicast: Prepare for multicast filter configuration.
1510 * This callback is optional, and its return value is passed
1511 * to configure_filter(). This callback must be atomic.
1513 * @configure_filter: Configure the device's RX filter.
1514 * See the section "Frame filtering" for more information.
1515 * This callback must be implemented and can sleep.
1517 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1518 * must be set or cleared for a given STA. Must be atomic.
1520 * @set_key: See the section "Hardware crypto acceleration"
1521 * This callback is only called between add_interface and
1522 * remove_interface calls, i.e. while the given virtual interface
1524 * Returns a negative error code if the key can't be added.
1525 * The callback can sleep.
1527 * @update_tkip_key: See the section "Hardware crypto acceleration"
1528 * This callback will be called in the context of Rx. Called for drivers
1529 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1530 * The callback must be atomic.
1532 * @hw_scan: Ask the hardware to service the scan request, no need to start
1533 * the scan state machine in stack. The scan must honour the channel
1534 * configuration done by the regulatory agent in the wiphy's
1535 * registered bands. The hardware (or the driver) needs to make sure
1536 * that power save is disabled.
1537 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1538 * entire IEs after the SSID, so that drivers need not look at these
1539 * at all but just send them after the SSID -- mac80211 includes the
1540 * (extended) supported rates and HT information (where applicable).
1541 * When the scan finishes, ieee80211_scan_completed() must be called;
1542 * note that it also must be called when the scan cannot finish due to
1543 * any error unless this callback returned a negative error code.
1544 * The callback can sleep.
1546 * @sw_scan_start: Notifier function that is called just before a software scan
1547 * is started. Can be NULL, if the driver doesn't need this notification.
1548 * The callback can sleep.
1550 * @sw_scan_complete: Notifier function that is called just after a
1551 * software scan finished. Can be NULL, if the driver doesn't need
1552 * this notification.
1553 * The callback can sleep.
1555 * @get_stats: Return low-level statistics.
1556 * Returns zero if statistics are available.
1557 * The callback can sleep.
1559 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1560 * callback should be provided to read the TKIP transmit IVs (both IV32
1561 * and IV16) for the given key from hardware.
1562 * The callback must be atomic.
1564 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1565 * The callback can sleep.
1567 * @sta_add: Notifies low level driver about addition of an associated station,
1568 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1570 * @sta_remove: Notifies low level driver about removal of an associated
1571 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1573 * @sta_notify: Notifies low level driver about power state transition of an
1574 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
1576 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1577 * bursting) for a hardware TX queue.
1578 * Returns a negative error code on failure.
1579 * The callback can sleep.
1581 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1582 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1583 * required function.
1584 * The callback can sleep.
1586 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1587 * Currently, this is only used for IBSS mode debugging. Is not a
1588 * required function.
1589 * The callback can sleep.
1591 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1592 * with other STAs in the IBSS. This is only used in IBSS mode. This
1593 * function is optional if the firmware/hardware takes full care of
1594 * TSF synchronization.
1595 * The callback can sleep.
1597 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1598 * This is needed only for IBSS mode and the result of this function is
1599 * used to determine whether to reply to Probe Requests.
1600 * Returns non-zero if this device sent the last beacon.
1601 * The callback can sleep.
1603 * @ampdu_action: Perform a certain A-MPDU action
1604 * The RA/TID combination determines the destination and TID we want
1605 * the ampdu action to be performed for. The action is defined through
1606 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1607 * is the first frame we expect to perform the action on. Notice
1608 * that TX/RX_STOP can pass NULL for this parameter.
1609 * Returns a negative error code on failure.
1610 * The callback must be atomic.
1612 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1613 * need to set wiphy->rfkill_poll to %true before registration,
1614 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1615 * The callback can sleep.
1617 * @set_coverage_class: Set slot time for given coverage class as specified
1618 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1619 * accordingly. This callback is not required and may sleep.
1621 * @testmode_cmd: Implement a cfg80211 test mode command.
1622 * The callback can sleep.
1624 * @flush: Flush all pending frames from the hardware queue, making sure
1625 * that the hardware queues are empty. If the parameter @drop is set
1626 * to %true, pending frames may be dropped. The callback can sleep.
1628 struct ieee80211_ops {
1629 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1630 int (*start)(struct ieee80211_hw *hw);
1631 void (*stop)(struct ieee80211_hw *hw);
1632 int (*add_interface)(struct ieee80211_hw *hw,
1633 struct ieee80211_vif *vif);
1634 void (*remove_interface)(struct ieee80211_hw *hw,
1635 struct ieee80211_vif *vif);
1636 int (*config)(struct ieee80211_hw *hw, u32 changed);
1637 void (*bss_info_changed)(struct ieee80211_hw *hw,
1638 struct ieee80211_vif *vif,
1639 struct ieee80211_bss_conf *info,
1641 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1642 struct netdev_hw_addr_list *mc_list);
1643 void (*configure_filter)(struct ieee80211_hw *hw,
1644 unsigned int changed_flags,
1645 unsigned int *total_flags,
1647 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1649 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1650 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1651 struct ieee80211_key_conf *key);
1652 void (*update_tkip_key)(struct ieee80211_hw *hw,
1653 struct ieee80211_vif *vif,
1654 struct ieee80211_key_conf *conf,
1655 struct ieee80211_sta *sta,
1656 u32 iv32, u16 *phase1key);
1657 int (*hw_scan)(struct ieee80211_hw *hw,
1658 struct cfg80211_scan_request *req);
1659 void (*sw_scan_start)(struct ieee80211_hw *hw);
1660 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1661 int (*get_stats)(struct ieee80211_hw *hw,
1662 struct ieee80211_low_level_stats *stats);
1663 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1664 u32 *iv32, u16 *iv16);
1665 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1666 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1667 struct ieee80211_sta *sta);
1668 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1669 struct ieee80211_sta *sta);
1670 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1671 enum sta_notify_cmd, struct ieee80211_sta *sta);
1672 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1673 const struct ieee80211_tx_queue_params *params);
1674 u64 (*get_tsf)(struct ieee80211_hw *hw);
1675 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1676 void (*reset_tsf)(struct ieee80211_hw *hw);
1677 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1678 int (*ampdu_action)(struct ieee80211_hw *hw,
1679 struct ieee80211_vif *vif,
1680 enum ieee80211_ampdu_mlme_action action,
1681 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1682 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1683 struct survey_info *survey);
1684 void (*rfkill_poll)(struct ieee80211_hw *hw);
1685 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1686 #ifdef CONFIG_NL80211_TESTMODE
1687 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1689 void (*flush)(struct ieee80211_hw *hw, bool drop);
1693 * ieee80211_alloc_hw - Allocate a new hardware device
1695 * This must be called once for each hardware device. The returned pointer
1696 * must be used to refer to this device when calling other functions.
1697 * mac80211 allocates a private data area for the driver pointed to by
1698 * @priv in &struct ieee80211_hw, the size of this area is given as
1701 * @priv_data_len: length of private data
1702 * @ops: callbacks for this device
1704 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1705 const struct ieee80211_ops *ops);
1708 * ieee80211_register_hw - Register hardware device
1710 * You must call this function before any other functions in
1711 * mac80211. Note that before a hardware can be registered, you
1712 * need to fill the contained wiphy's information.
1714 * @hw: the device to register as returned by ieee80211_alloc_hw()
1716 int ieee80211_register_hw(struct ieee80211_hw *hw);
1718 #ifdef CONFIG_MAC80211_LEDS
1719 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1720 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1721 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1722 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1725 * ieee80211_get_tx_led_name - get name of TX LED
1727 * mac80211 creates a transmit LED trigger for each wireless hardware
1728 * that can be used to drive LEDs if your driver registers a LED device.
1729 * This function returns the name (or %NULL if not configured for LEDs)
1730 * of the trigger so you can automatically link the LED device.
1732 * @hw: the hardware to get the LED trigger name for
1734 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1736 #ifdef CONFIG_MAC80211_LEDS
1737 return __ieee80211_get_tx_led_name(hw);
1744 * ieee80211_get_rx_led_name - get name of RX LED
1746 * mac80211 creates a receive LED trigger for each wireless hardware
1747 * that can be used to drive LEDs if your driver registers a LED device.
1748 * This function returns the name (or %NULL if not configured for LEDs)
1749 * of the trigger so you can automatically link the LED device.
1751 * @hw: the hardware to get the LED trigger name for
1753 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1755 #ifdef CONFIG_MAC80211_LEDS
1756 return __ieee80211_get_rx_led_name(hw);
1763 * ieee80211_get_assoc_led_name - get name of association LED
1765 * mac80211 creates a association LED trigger for each wireless hardware
1766 * that can be used to drive LEDs if your driver registers a LED device.
1767 * This function returns the name (or %NULL if not configured for LEDs)
1768 * of the trigger so you can automatically link the LED device.
1770 * @hw: the hardware to get the LED trigger name for
1772 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1774 #ifdef CONFIG_MAC80211_LEDS
1775 return __ieee80211_get_assoc_led_name(hw);
1782 * ieee80211_get_radio_led_name - get name of radio LED
1784 * mac80211 creates a radio change LED trigger for each wireless hardware
1785 * that can be used to drive LEDs if your driver registers a LED device.
1786 * This function returns the name (or %NULL if not configured for LEDs)
1787 * of the trigger so you can automatically link the LED device.
1789 * @hw: the hardware to get the LED trigger name for
1791 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1793 #ifdef CONFIG_MAC80211_LEDS
1794 return __ieee80211_get_radio_led_name(hw);
1801 * ieee80211_unregister_hw - Unregister a hardware device
1803 * This function instructs mac80211 to free allocated resources
1804 * and unregister netdevices from the networking subsystem.
1806 * @hw: the hardware to unregister
1808 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1811 * ieee80211_free_hw - free hardware descriptor
1813 * This function frees everything that was allocated, including the
1814 * private data for the driver. You must call ieee80211_unregister_hw()
1815 * before calling this function.
1817 * @hw: the hardware to free
1819 void ieee80211_free_hw(struct ieee80211_hw *hw);
1822 * ieee80211_restart_hw - restart hardware completely
1824 * Call this function when the hardware was restarted for some reason
1825 * (hardware error, ...) and the driver is unable to restore its state
1826 * by itself. mac80211 assumes that at this point the driver/hardware
1827 * is completely uninitialised and stopped, it starts the process by
1828 * calling the ->start() operation. The driver will need to reset all
1829 * internal state that it has prior to calling this function.
1831 * @hw: the hardware to restart
1833 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1836 * ieee80211_rx - receive frame
1838 * Use this function to hand received frames to mac80211. The receive
1839 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1840 * paged @skb is used, the driver is recommended to put the ieee80211
1841 * header of the frame on the linear part of the @skb to avoid memory
1842 * allocation and/or memcpy by the stack.
1844 * This function may not be called in IRQ context. Calls to this function
1845 * for a single hardware must be synchronized against each other. Calls to
1846 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1847 * mixed for a single hardware.
1849 * In process context use instead ieee80211_rx_ni().
1851 * @hw: the hardware this frame came in on
1852 * @skb: the buffer to receive, owned by mac80211 after this call
1854 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1857 * ieee80211_rx_irqsafe - receive frame
1859 * Like ieee80211_rx() but can be called in IRQ context
1860 * (internally defers to a tasklet.)
1862 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1863 * be mixed for a single hardware.
1865 * @hw: the hardware this frame came in on
1866 * @skb: the buffer to receive, owned by mac80211 after this call
1868 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1871 * ieee80211_rx_ni - receive frame (in process context)
1873 * Like ieee80211_rx() but can be called in process context
1874 * (internally disables bottom halves).
1876 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1877 * not be mixed for a single hardware.
1879 * @hw: the hardware this frame came in on
1880 * @skb: the buffer to receive, owned by mac80211 after this call
1882 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1883 struct sk_buff *skb)
1886 ieee80211_rx(hw, skb);
1891 * The TX headroom reserved by mac80211 for its own tx_status functions.
1892 * This is enough for the radiotap header.
1894 #define IEEE80211_TX_STATUS_HEADROOM 13
1897 * ieee80211_tx_status - transmit status callback
1899 * Call this function for all transmitted frames after they have been
1900 * transmitted. It is permissible to not call this function for
1901 * multicast frames but this can affect statistics.
1903 * This function may not be called in IRQ context. Calls to this function
1904 * for a single hardware must be synchronized against each other. Calls
1905 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1906 * for a single hardware.
1908 * @hw: the hardware the frame was transmitted by
1909 * @skb: the frame that was transmitted, owned by mac80211 after this call
1911 void ieee80211_tx_status(struct ieee80211_hw *hw,
1912 struct sk_buff *skb);
1915 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1917 * Like ieee80211_tx_status() but can be called in IRQ context
1918 * (internally defers to a tasklet.)
1920 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1923 * @hw: the hardware the frame was transmitted by
1924 * @skb: the frame that was transmitted, owned by mac80211 after this call
1926 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1927 struct sk_buff *skb);
1930 * ieee80211_beacon_get_tim - beacon generation function
1931 * @hw: pointer obtained from ieee80211_alloc_hw().
1932 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1933 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1934 * Set to 0 if invalid (in non-AP modes).
1935 * @tim_length: pointer to variable that will receive the TIM IE length,
1936 * (including the ID and length bytes!).
1937 * Set to 0 if invalid (in non-AP modes).
1939 * If the driver implements beaconing modes, it must use this function to
1940 * obtain the beacon frame/template.
1942 * If the beacon frames are generated by the host system (i.e., not in
1943 * hardware/firmware), the driver uses this function to get each beacon
1944 * frame from mac80211 -- it is responsible for calling this function
1945 * before the beacon is needed (e.g. based on hardware interrupt).
1947 * If the beacon frames are generated by the device, then the driver
1948 * must use the returned beacon as the template and change the TIM IE
1949 * according to the current DTIM parameters/TIM bitmap.
1951 * The driver is responsible for freeing the returned skb.
1953 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1954 struct ieee80211_vif *vif,
1955 u16 *tim_offset, u16 *tim_length);
1958 * ieee80211_beacon_get - beacon generation function
1959 * @hw: pointer obtained from ieee80211_alloc_hw().
1960 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1962 * See ieee80211_beacon_get_tim().
1964 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1965 struct ieee80211_vif *vif)
1967 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1971 * ieee80211_pspoll_get - retrieve a PS Poll template
1972 * @hw: pointer obtained from ieee80211_alloc_hw().
1973 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1975 * Creates a PS Poll a template which can, for example, uploaded to
1976 * hardware. The template must be updated after association so that correct
1977 * AID, BSSID and MAC address is used.
1979 * Note: Caller (or hardware) is responsible for setting the
1980 * &IEEE80211_FCTL_PM bit.
1982 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1983 struct ieee80211_vif *vif);
1986 * ieee80211_nullfunc_get - retrieve a nullfunc template
1987 * @hw: pointer obtained from ieee80211_alloc_hw().
1988 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1990 * Creates a Nullfunc template which can, for example, uploaded to
1991 * hardware. The template must be updated after association so that correct
1992 * BSSID and address is used.
1994 * Note: Caller (or hardware) is responsible for setting the
1995 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
1997 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
1998 struct ieee80211_vif *vif);
2001 * ieee80211_probereq_get - retrieve a Probe Request template
2002 * @hw: pointer obtained from ieee80211_alloc_hw().
2003 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2004 * @ssid: SSID buffer
2005 * @ssid_len: length of SSID
2006 * @ie: buffer containing all IEs except SSID for the template
2007 * @ie_len: length of the IE buffer
2009 * Creates a Probe Request template which can, for example, be uploaded to
2012 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2013 struct ieee80211_vif *vif,
2014 const u8 *ssid, size_t ssid_len,
2015 const u8 *ie, size_t ie_len);
2018 * ieee80211_rts_get - RTS frame generation function
2019 * @hw: pointer obtained from ieee80211_alloc_hw().
2020 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2021 * @frame: pointer to the frame that is going to be protected by the RTS.
2022 * @frame_len: the frame length (in octets).
2023 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2024 * @rts: The buffer where to store the RTS frame.
2026 * If the RTS frames are generated by the host system (i.e., not in
2027 * hardware/firmware), the low-level driver uses this function to receive
2028 * the next RTS frame from the 802.11 code. The low-level is responsible
2029 * for calling this function before and RTS frame is needed.
2031 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2032 const void *frame, size_t frame_len,
2033 const struct ieee80211_tx_info *frame_txctl,
2034 struct ieee80211_rts *rts);
2037 * ieee80211_rts_duration - Get the duration field for an RTS frame
2038 * @hw: pointer obtained from ieee80211_alloc_hw().
2039 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2040 * @frame_len: the length of the frame that is going to be protected by the RTS.
2041 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2043 * If the RTS is generated in firmware, but the host system must provide
2044 * the duration field, the low-level driver uses this function to receive
2045 * the duration field value in little-endian byteorder.
2047 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2048 struct ieee80211_vif *vif, size_t frame_len,
2049 const struct ieee80211_tx_info *frame_txctl);
2052 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2053 * @hw: pointer obtained from ieee80211_alloc_hw().
2054 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2055 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2056 * @frame_len: the frame length (in octets).
2057 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2058 * @cts: The buffer where to store the CTS-to-self frame.
2060 * If the CTS-to-self frames are generated by the host system (i.e., not in
2061 * hardware/firmware), the low-level driver uses this function to receive
2062 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2063 * for calling this function before and CTS-to-self frame is needed.
2065 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2066 struct ieee80211_vif *vif,
2067 const void *frame, size_t frame_len,
2068 const struct ieee80211_tx_info *frame_txctl,
2069 struct ieee80211_cts *cts);
2072 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2073 * @hw: pointer obtained from ieee80211_alloc_hw().
2074 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2075 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2076 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2078 * If the CTS-to-self is generated in firmware, but the host system must provide
2079 * the duration field, the low-level driver uses this function to receive
2080 * the duration field value in little-endian byteorder.
2082 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2083 struct ieee80211_vif *vif,
2085 const struct ieee80211_tx_info *frame_txctl);
2088 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2089 * @hw: pointer obtained from ieee80211_alloc_hw().
2090 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2091 * @frame_len: the length of the frame.
2092 * @rate: the rate at which the frame is going to be transmitted.
2094 * Calculate the duration field of some generic frame, given its
2095 * length and transmission rate (in 100kbps).
2097 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2098 struct ieee80211_vif *vif,
2100 struct ieee80211_rate *rate);
2103 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2104 * @hw: pointer as obtained from ieee80211_alloc_hw().
2105 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2107 * Function for accessing buffered broadcast and multicast frames. If
2108 * hardware/firmware does not implement buffering of broadcast/multicast
2109 * frames when power saving is used, 802.11 code buffers them in the host
2110 * memory. The low-level driver uses this function to fetch next buffered
2111 * frame. In most cases, this is used when generating beacon frame. This
2112 * function returns a pointer to the next buffered skb or NULL if no more
2113 * buffered frames are available.
2115 * Note: buffered frames are returned only after DTIM beacon frame was
2116 * generated with ieee80211_beacon_get() and the low-level driver must thus
2117 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2118 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2119 * does not need to check for DTIM beacons separately and should be able to
2120 * use common code for all beacons.
2123 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2126 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2128 * This function computes a TKIP rc4 key for an skb. It computes
2129 * a phase 1 key if needed (iv16 wraps around). This function is to
2130 * be used by drivers which can do HW encryption but need to compute
2131 * to phase 1/2 key in SW.
2133 * @keyconf: the parameter passed with the set key
2134 * @skb: the skb for which the key is needed
2136 * @key: a buffer to which the key will be written
2138 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2139 struct sk_buff *skb,
2140 enum ieee80211_tkip_key_type type, u8 *key);
2142 * ieee80211_wake_queue - wake specific queue
2143 * @hw: pointer as obtained from ieee80211_alloc_hw().
2144 * @queue: queue number (counted from zero).
2146 * Drivers should use this function instead of netif_wake_queue.
2148 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2151 * ieee80211_stop_queue - stop specific queue
2152 * @hw: pointer as obtained from ieee80211_alloc_hw().
2153 * @queue: queue number (counted from zero).
2155 * Drivers should use this function instead of netif_stop_queue.
2157 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2160 * ieee80211_queue_stopped - test status of the queue
2161 * @hw: pointer as obtained from ieee80211_alloc_hw().
2162 * @queue: queue number (counted from zero).
2164 * Drivers should use this function instead of netif_stop_queue.
2167 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2170 * ieee80211_stop_queues - stop all queues
2171 * @hw: pointer as obtained from ieee80211_alloc_hw().
2173 * Drivers should use this function instead of netif_stop_queue.
2175 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2178 * ieee80211_wake_queues - wake all queues
2179 * @hw: pointer as obtained from ieee80211_alloc_hw().
2181 * Drivers should use this function instead of netif_wake_queue.
2183 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2186 * ieee80211_scan_completed - completed hardware scan
2188 * When hardware scan offload is used (i.e. the hw_scan() callback is
2189 * assigned) this function needs to be called by the driver to notify
2190 * mac80211 that the scan finished.
2192 * @hw: the hardware that finished the scan
2193 * @aborted: set to true if scan was aborted
2195 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2198 * ieee80211_iterate_active_interfaces - iterate active interfaces
2200 * This function iterates over the interfaces associated with a given
2201 * hardware that are currently active and calls the callback for them.
2202 * This function allows the iterator function to sleep, when the iterator
2203 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2206 * @hw: the hardware struct of which the interfaces should be iterated over
2207 * @iterator: the iterator function to call
2208 * @data: first argument of the iterator function
2210 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2211 void (*iterator)(void *data, u8 *mac,
2212 struct ieee80211_vif *vif),
2216 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2218 * This function iterates over the interfaces associated with a given
2219 * hardware that are currently active and calls the callback for them.
2220 * This function requires the iterator callback function to be atomic,
2221 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2223 * @hw: the hardware struct of which the interfaces should be iterated over
2224 * @iterator: the iterator function to call, cannot sleep
2225 * @data: first argument of the iterator function
2227 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2228 void (*iterator)(void *data,
2230 struct ieee80211_vif *vif),
2234 * ieee80211_queue_work - add work onto the mac80211 workqueue
2236 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2237 * This helper ensures drivers are not queueing work when they should not be.
2239 * @hw: the hardware struct for the interface we are adding work for
2240 * @work: the work we want to add onto the mac80211 workqueue
2242 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2245 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2247 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2250 * @hw: the hardware struct for the interface we are adding work for
2251 * @dwork: delayable work to queue onto the mac80211 workqueue
2252 * @delay: number of jiffies to wait before queueing
2254 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2255 struct delayed_work *dwork,
2256 unsigned long delay);
2259 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2260 * @sta: the station for which to start a BA session
2261 * @tid: the TID to BA on.
2263 * Return: success if addBA request was sent, failure otherwise
2265 * Although mac80211/low level driver/user space application can estimate
2266 * the need to start aggregation on a certain RA/TID, the session level
2267 * will be managed by the mac80211.
2269 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2272 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2273 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2274 * @ra: receiver address of the BA session recipient.
2275 * @tid: the TID to BA on.
2277 * This function must be called by low level driver once it has
2278 * finished with preparations for the BA session.
2280 void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
2283 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2284 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2285 * @ra: receiver address of the BA session recipient.
2286 * @tid: the TID to BA on.
2288 * This function must be called by low level driver once it has
2289 * finished with preparations for the BA session.
2290 * This version of the function is IRQ-safe.
2292 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2296 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2297 * @sta: the station whose BA session to stop
2298 * @tid: the TID to stop BA.
2299 * @initiator: if indicates initiator DELBA frame will be sent.
2301 * Return: error if no sta with matching da found, success otherwise
2303 * Although mac80211/low level driver/user space application can estimate
2304 * the need to stop aggregation on a certain RA/TID, the session level
2305 * will be managed by the mac80211.
2307 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2308 enum ieee80211_back_parties initiator);
2311 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2312 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2313 * @ra: receiver address of the BA session recipient.
2314 * @tid: the desired TID to BA on.
2316 * This function must be called by low level driver once it has
2317 * finished with preparations for the BA session tear down.
2319 void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
2322 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2323 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2324 * @ra: receiver address of the BA session recipient.
2325 * @tid: the desired TID to BA on.
2327 * This function must be called by low level driver once it has
2328 * finished with preparations for the BA session tear down.
2329 * This version of the function is IRQ-safe.
2331 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2335 * ieee80211_find_sta - find a station
2337 * @vif: virtual interface to look for station on
2338 * @addr: station's address
2340 * This function must be called under RCU lock and the
2341 * resulting pointer is only valid under RCU lock as well.
2343 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2347 * ieee80211_find_sta_by_hw - find a station on hardware
2349 * @hw: pointer as obtained from ieee80211_alloc_hw()
2350 * @addr: station's address
2352 * This function must be called under RCU lock and the
2353 * resulting pointer is only valid under RCU lock as well.
2355 * NOTE: This function should not be used! When mac80211 is converted
2356 * internally to properly keep track of stations on multiple
2357 * virtual interfaces, it will not always know which station to
2358 * return here since a single address might be used by multiple
2359 * logical stations (e.g. consider a station connecting to another
2360 * BSSID on the same AP hardware without disconnecting first).
2362 * DO NOT USE THIS FUNCTION.
2364 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2368 * ieee80211_sta_block_awake - block station from waking up
2370 * @pubsta: the station
2371 * @block: whether to block or unblock
2373 * Some devices require that all frames that are on the queues
2374 * for a specific station that went to sleep are flushed before
2375 * a poll response or frames after the station woke up can be
2376 * delivered to that it. Note that such frames must be rejected
2377 * by the driver as filtered, with the appropriate status flag.
2379 * This function allows implementing this mode in a race-free
2382 * To do this, a driver must keep track of the number of frames
2383 * still enqueued for a specific station. If this number is not
2384 * zero when the station goes to sleep, the driver must call
2385 * this function to force mac80211 to consider the station to
2386 * be asleep regardless of the station's actual state. Once the
2387 * number of outstanding frames reaches zero, the driver must
2388 * call this function again to unblock the station. That will
2389 * cause mac80211 to be able to send ps-poll responses, and if
2390 * the station queried in the meantime then frames will also
2391 * be sent out as a result of this. Additionally, the driver
2392 * will be notified that the station woke up some time after
2393 * it is unblocked, regardless of whether the station actually
2394 * woke up while blocked or not.
2396 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2397 struct ieee80211_sta *pubsta, bool block);
2400 * ieee80211_beacon_loss - inform hardware does not receive beacons
2402 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2404 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and
2405 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2406 * hardware is not receiving beacons with this function.
2408 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2411 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2413 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2415 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and
2416 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2417 * needs to inform if the connection to the AP has been lost.
2419 * This function will cause immediate change to disassociated state,
2420 * without connection recovery attempts.
2422 void ieee80211_connection_loss(struct ieee80211_vif *vif);
2425 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2426 * rssi threshold triggered
2428 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2429 * @rssi_event: the RSSI trigger event type
2430 * @gfp: context flags
2432 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2433 * monitoring is configured with an rssi threshold, the driver will inform
2434 * whenever the rssi level reaches the threshold.
2436 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2437 enum nl80211_cqm_rssi_threshold_event rssi_event,
2440 /* Rate control API */
2443 * enum rate_control_changed - flags to indicate which parameter changed
2445 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2446 * changed, rate control algorithm can update its internal state if needed.
2448 enum rate_control_changed {
2449 IEEE80211_RC_HT_CHANGED = BIT(0)
2453 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2455 * @hw: The hardware the algorithm is invoked for.
2456 * @sband: The band this frame is being transmitted on.
2457 * @bss_conf: the current BSS configuration
2458 * @reported_rate: The rate control algorithm can fill this in to indicate
2459 * which rate should be reported to userspace as the current rate and
2460 * used for rate calculations in the mesh network.
2461 * @rts: whether RTS will be used for this frame because it is longer than the
2463 * @short_preamble: whether mac80211 will request short-preamble transmission
2464 * if the selected rate supports it
2465 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2466 * (deprecated; this will be removed once drivers get updated to use
2468 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2469 * @skb: the skb that will be transmitted, the control information in it needs
2471 * @ap: whether this frame is sent out in AP mode
2473 struct ieee80211_tx_rate_control {
2474 struct ieee80211_hw *hw;
2475 struct ieee80211_supported_band *sband;
2476 struct ieee80211_bss_conf *bss_conf;
2477 struct sk_buff *skb;
2478 struct ieee80211_tx_rate reported_rate;
2479 bool rts, short_preamble;
2485 struct rate_control_ops {
2486 struct module *module;
2488 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2489 void (*free)(void *priv);
2491 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2492 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2493 struct ieee80211_sta *sta, void *priv_sta);
2494 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2495 struct ieee80211_sta *sta,
2496 void *priv_sta, u32 changed,
2497 enum nl80211_channel_type oper_chan_type);
2498 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2501 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2502 struct ieee80211_sta *sta, void *priv_sta,
2503 struct sk_buff *skb);
2504 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2505 struct ieee80211_tx_rate_control *txrc);
2507 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2508 struct dentry *dir);
2509 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2512 static inline int rate_supported(struct ieee80211_sta *sta,
2513 enum ieee80211_band band,
2516 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2520 * rate_control_send_low - helper for drivers for management/no-ack frames
2522 * Rate control algorithms that agree to use the lowest rate to
2523 * send management frames and NO_ACK data with the respective hw
2524 * retries should use this in the beginning of their mac80211 get_rate
2525 * callback. If true is returned the rate control can simply return.
2526 * If false is returned we guarantee that sta and sta and priv_sta is
2529 * Rate control algorithms wishing to do more intelligent selection of
2530 * rate for multicast/broadcast frames may choose to not use this.
2532 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2533 * that this may be null.
2534 * @priv_sta: private rate control structure. This may be null.
2535 * @txrc: rate control information we sholud populate for mac80211.
2537 bool rate_control_send_low(struct ieee80211_sta *sta,
2539 struct ieee80211_tx_rate_control *txrc);
2543 rate_lowest_index(struct ieee80211_supported_band *sband,
2544 struct ieee80211_sta *sta)
2548 for (i = 0; i < sband->n_bitrates; i++)
2549 if (rate_supported(sta, sband->band, i))
2552 /* warn when we cannot find a rate. */
2559 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2560 struct ieee80211_sta *sta)
2564 for (i = 0; i < sband->n_bitrates; i++)
2565 if (rate_supported(sta, sband->band, i))
2570 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2571 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2574 conf_is_ht20(struct ieee80211_conf *conf)
2576 return conf->channel_type == NL80211_CHAN_HT20;
2580 conf_is_ht40_minus(struct ieee80211_conf *conf)
2582 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2586 conf_is_ht40_plus(struct ieee80211_conf *conf)
2588 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2592 conf_is_ht40(struct ieee80211_conf *conf)
2594 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2598 conf_is_ht(struct ieee80211_conf *conf)
2600 return conf->channel_type != NL80211_CHAN_NO_HT;
2603 #endif /* MAC80211_H */