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
148 * @BSS_CHANGED_IBSS: IBSS join status changed
150 enum ieee80211_bss_change {
151 BSS_CHANGED_ASSOC = 1<<0,
152 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
153 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
154 BSS_CHANGED_ERP_SLOT = 1<<3,
155 BSS_CHANGED_HT = 1<<4,
156 BSS_CHANGED_BASIC_RATES = 1<<5,
157 BSS_CHANGED_BEACON_INT = 1<<6,
158 BSS_CHANGED_BSSID = 1<<7,
159 BSS_CHANGED_BEACON = 1<<8,
160 BSS_CHANGED_BEACON_ENABLED = 1<<9,
161 BSS_CHANGED_CQM = 1<<10,
162 BSS_CHANGED_IBSS = 1<<11,
164 /* when adding here, make sure to change ieee80211_reconfig */
168 * struct ieee80211_bss_conf - holds the BSS's changing parameters
170 * This structure keeps information about a BSS (and an association
171 * to that BSS) that can change during the lifetime of the BSS.
173 * @assoc: association status
174 * @ibss_joined: indicates whether this station is part of an IBSS
176 * @aid: association ID number, valid only when @assoc is true
177 * @use_cts_prot: use CTS protection
178 * @use_short_preamble: use 802.11b short preamble;
179 * if the hardware cannot handle this it must set the
180 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
181 * @use_short_slot: use short slot time (only relevant for ERP);
182 * if the hardware cannot handle this it must set the
183 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
184 * @dtim_period: num of beacons before the next DTIM, for beaconing,
185 * not valid in station mode (cf. hw conf ps_dtim_period)
186 * @timestamp: beacon timestamp
187 * @beacon_int: beacon interval
188 * @assoc_capability: capabilities taken from assoc resp
189 * @basic_rates: bitmap of basic rates, each bit stands for an
190 * index into the rate table configured by the driver in
192 * @bssid: The BSSID for this BSS
193 * @enable_beacon: whether beaconing should be enabled or not
194 * @channel_type: Channel type for this BSS -- the hardware might be
195 * configured for HT40+ while this BSS only uses no-HT, for
197 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
198 * This field is only valid when the channel type is one of the HT types.
199 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
201 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
203 struct ieee80211_bss_conf {
205 /* association related data */
206 bool assoc, ibss_joined;
208 /* erp related data */
210 bool use_short_preamble;
215 u16 assoc_capability;
218 u16 ht_operation_mode;
221 enum nl80211_channel_type channel_type;
225 * enum mac80211_tx_control_flags - flags to describe transmission information/status
227 * These flags are used with the @flags member of &ieee80211_tx_info.
229 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
230 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
231 * number to this frame, taking care of not overwriting the fragment
232 * number and increasing the sequence number only when the
233 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
234 * assign sequence numbers to QoS-data frames but cannot do so correctly
235 * for non-QoS-data and management frames because beacons need them from
236 * that counter as well and mac80211 cannot guarantee proper sequencing.
237 * If this flag is set, the driver should instruct the hardware to
238 * assign a sequence number to the frame or assign one itself. Cf. IEEE
239 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
240 * beacons and always be clear for frames without a sequence number field.
241 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
242 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
244 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
245 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
246 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
247 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
248 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
249 * because the destination STA was in powersave mode. Note that to
250 * avoid race conditions, the filter must be set by the hardware or
251 * firmware upon receiving a frame that indicates that the station
252 * went to sleep (must be done on device to filter frames already on
253 * the queue) and may only be unset after mac80211 gives the OK for
254 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
255 * since only then is it guaranteed that no more frames are in the
257 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
258 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
259 * is for the whole aggregation.
260 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
261 * so consider using block ack request (BAR).
262 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
263 * set by rate control algorithms to indicate probe rate, will
264 * be cleared for fragmented frames (except on the last fragment)
265 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
266 * used to indicate that a pending frame requires TX processing before
267 * it can be sent out.
268 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
269 * used to indicate that a frame was already retried due to PS
270 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
271 * used to indicate frame should not be encrypted
272 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
273 * This frame is a response to a PS-poll frame and should be sent
274 * although the station is in powersave mode.
275 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
276 * transmit function after the current frame, this can be used
277 * by drivers to kick the DMA queue only if unset or when the
279 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
280 * after TX status because the destination was asleep, it must not
281 * be modified again (no seqno assignment, crypto, etc.)
282 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
283 * has a radiotap header at skb->data.
284 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
285 * MLME command (internal to mac80211 to figure out whether to send TX
286 * status to user space)
287 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
288 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
289 * frame and selects the maximum number of streams that it can use.
291 enum mac80211_tx_control_flags {
292 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
293 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
294 IEEE80211_TX_CTL_NO_ACK = BIT(2),
295 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
296 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
297 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
298 IEEE80211_TX_CTL_AMPDU = BIT(6),
299 IEEE80211_TX_CTL_INJECTED = BIT(7),
300 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
301 IEEE80211_TX_STAT_ACK = BIT(9),
302 IEEE80211_TX_STAT_AMPDU = BIT(10),
303 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
304 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
305 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
306 IEEE80211_TX_INTFL_RETRIED = BIT(15),
307 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
308 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
309 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
310 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
311 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
312 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
313 IEEE80211_TX_CTL_LDPC = BIT(22),
314 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
315 #define IEEE80211_TX_CTL_STBC_SHIFT 23
319 * enum mac80211_rate_control_flags - per-rate flags set by the
320 * Rate Control algorithm.
322 * These flags are set by the Rate control algorithm for each rate during tx,
323 * in the @flags member of struct ieee80211_tx_rate.
325 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
326 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
327 * This is set if the current BSS requires ERP protection.
328 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
329 * @IEEE80211_TX_RC_MCS: HT rate.
330 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
332 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
333 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
334 * adjacent 20 MHz channels, if the current channel type is
335 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
336 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
338 enum mac80211_rate_control_flags {
339 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
340 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
341 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
343 /* rate index is an MCS rate number instead of an index */
344 IEEE80211_TX_RC_MCS = BIT(3),
345 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
346 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
347 IEEE80211_TX_RC_DUP_DATA = BIT(6),
348 IEEE80211_TX_RC_SHORT_GI = BIT(7),
352 /* there are 40 bytes if you don't need the rateset to be kept */
353 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
355 /* if you do need the rateset, then you have less space */
356 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
358 /* maximum number of rate stages */
359 #define IEEE80211_TX_MAX_RATES 5
362 * struct ieee80211_tx_rate - rate selection/status
364 * @idx: rate index to attempt to send with
365 * @flags: rate control flags (&enum mac80211_rate_control_flags)
366 * @count: number of tries in this rate before going to the next rate
368 * A value of -1 for @idx indicates an invalid rate and, if used
369 * in an array of retry rates, that no more rates should be tried.
371 * When used for transmit status reporting, the driver should
372 * always report the rate along with the flags it used.
374 * &struct ieee80211_tx_info contains an array of these structs
375 * in the control information, and it will be filled by the rate
376 * control algorithm according to what should be sent. For example,
377 * if this array contains, in the format { <idx>, <count> } the
379 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
380 * then this means that the frame should be transmitted
381 * up to twice at rate 3, up to twice at rate 2, and up to four
382 * times at rate 1 if it doesn't get acknowledged. Say it gets
383 * acknowledged by the peer after the fifth attempt, the status
384 * information should then contain
385 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
386 * since it was transmitted twice at rate 3, twice at rate 2
387 * and once at rate 1 after which we received an acknowledgement.
389 struct ieee80211_tx_rate {
393 } __attribute__((packed));
396 * struct ieee80211_tx_info - skb transmit information
398 * This structure is placed in skb->cb for three uses:
399 * (1) mac80211 TX control - mac80211 tells the driver what to do
400 * (2) driver internal use (if applicable)
401 * (3) TX status information - driver tells mac80211 what happened
403 * The TX control's sta pointer is only valid during the ->tx call,
406 * @flags: transmit info flags, defined above
407 * @band: the band to transmit on (use for checking for races)
408 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
409 * @pad: padding, ignore
410 * @control: union for control data
411 * @status: union for status data
412 * @driver_data: array of driver_data pointers
413 * @ampdu_ack_len: number of acked aggregated frames.
414 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
415 * @ampdu_ack_map: block ack bit map for the aggregation.
416 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
417 * @ampdu_len: number of aggregated frames.
418 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
419 * @ack_signal: signal strength of the ACK frame
421 struct ieee80211_tx_info {
422 /* common information */
436 struct ieee80211_tx_rate rates[
437 IEEE80211_TX_MAX_RATES];
440 /* only needed before rate control */
441 unsigned long jiffies;
443 /* NB: vif can be NULL for injected frames */
444 struct ieee80211_vif *vif;
445 struct ieee80211_key_conf *hw_key;
446 struct ieee80211_sta *sta;
449 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
457 struct ieee80211_tx_rate driver_rates[
458 IEEE80211_TX_MAX_RATES];
459 void *rate_driver_data[
460 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
463 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
467 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
469 return (struct ieee80211_tx_info *)skb->cb;
472 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
474 return (struct ieee80211_rx_status *)skb->cb;
478 * ieee80211_tx_info_clear_status - clear TX status
480 * @info: The &struct ieee80211_tx_info to be cleared.
482 * When the driver passes an skb back to mac80211, it must report
483 * a number of things in TX status. This function clears everything
484 * in the TX status but the rate control information (it does clear
485 * the count since you need to fill that in anyway).
487 * NOTE: You can only use this function if you do NOT use
488 * info->driver_data! Use info->rate_driver_data
489 * instead if you need only the less space that allows.
492 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
496 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
497 offsetof(struct ieee80211_tx_info, control.rates));
498 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
499 offsetof(struct ieee80211_tx_info, driver_rates));
500 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
501 /* clear the rate counts */
502 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
503 info->status.rates[i].count = 0;
506 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
507 memset(&info->status.ampdu_ack_len, 0,
508 sizeof(struct ieee80211_tx_info) -
509 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
514 * enum mac80211_rx_flags - receive flags
516 * These flags are used with the @flag member of &struct ieee80211_rx_status.
517 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
518 * Use together with %RX_FLAG_MMIC_STRIPPED.
519 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
520 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
521 * verification has been done by the hardware.
522 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
523 * If this flag is set, the stack cannot do any replay detection
524 * hence the driver or hardware will have to do that.
525 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
527 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
529 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
530 * is valid. This is useful in monitor mode and necessary for beacon frames
531 * to enable IBSS merging.
532 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
533 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
534 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
535 * @RX_FLAG_SHORT_GI: Short guard interval was used
536 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
537 * on cooked monitor to avoid double-reporting it for multiple
540 enum mac80211_rx_flags {
541 RX_FLAG_MMIC_ERROR = 1<<0,
542 RX_FLAG_DECRYPTED = 1<<1,
543 RX_FLAG_MMIC_STRIPPED = 1<<3,
544 RX_FLAG_IV_STRIPPED = 1<<4,
545 RX_FLAG_FAILED_FCS_CRC = 1<<5,
546 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
548 RX_FLAG_SHORTPRE = 1<<8,
550 RX_FLAG_40MHZ = 1<<10,
551 RX_FLAG_SHORT_GI = 1<<11,
552 RX_FLAG_INTERNAL_CMTR = 1<<12,
556 * struct ieee80211_rx_status - receive status
558 * The low-level driver should provide this information (the subset
559 * supported by hardware) to the 802.11 code with each received
560 * frame, in the skb's control buffer (cb).
562 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
563 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
564 * @band: the active band when this frame was received
565 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
566 * @signal: signal strength when receiving this frame, either in dBm, in dB or
567 * unspecified depending on the hardware capabilities flags
568 * @IEEE80211_HW_SIGNAL_*
569 * @antenna: antenna used
570 * @rate_idx: index of data rate into band's supported rates or MCS index if
571 * HT rates are use (RX_FLAG_HT)
574 struct ieee80211_rx_status {
576 enum ieee80211_band band;
585 * enum ieee80211_conf_flags - configuration flags
587 * Flags to define PHY configuration options
589 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
590 * to determine for example whether to calculate timestamps for packets
591 * or not, do not use instead of filter flags!
592 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
593 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
594 * meaning that the hardware still wakes up for beacons, is able to
595 * transmit frames and receive the possible acknowledgment frames.
596 * Not to be confused with hardware specific wakeup/sleep states,
597 * driver is responsible for that. See the section "Powersave support"
599 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
600 * the driver should be prepared to handle configuration requests but
601 * may turn the device off as much as possible. Typically, this flag will
602 * be set when an interface is set UP but not associated or scanning, but
603 * it can also be unset in that case when monitor interfaces are active.
604 * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless
605 * Multimedia). On some drivers (iwlwifi is one of know) we have
606 * to enable/disable QoS explicitly.
608 enum ieee80211_conf_flags {
609 IEEE80211_CONF_MONITOR = (1<<0),
610 IEEE80211_CONF_PS = (1<<1),
611 IEEE80211_CONF_IDLE = (1<<2),
612 IEEE80211_CONF_QOS = (1<<3),
617 * enum ieee80211_conf_changed - denotes which configuration changed
619 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
620 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
621 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
622 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
623 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
624 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
625 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
626 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
627 * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled
629 enum ieee80211_conf_changed {
630 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
631 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
632 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
633 IEEE80211_CONF_CHANGE_PS = BIT(4),
634 IEEE80211_CONF_CHANGE_POWER = BIT(5),
635 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
636 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
637 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
638 IEEE80211_CONF_CHANGE_QOS = BIT(9),
642 * enum ieee80211_smps_mode - spatial multiplexing power save mode
644 * @IEEE80211_SMPS_AUTOMATIC: automatic
645 * @IEEE80211_SMPS_OFF: off
646 * @IEEE80211_SMPS_STATIC: static
647 * @IEEE80211_SMPS_DYNAMIC: dynamic
648 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
650 enum ieee80211_smps_mode {
651 IEEE80211_SMPS_AUTOMATIC,
653 IEEE80211_SMPS_STATIC,
654 IEEE80211_SMPS_DYNAMIC,
657 IEEE80211_SMPS_NUM_MODES,
661 * struct ieee80211_conf - configuration of the device
663 * This struct indicates how the driver shall configure the hardware.
665 * @flags: configuration flags defined above
667 * @listen_interval: listen interval in units of beacon interval
668 * @max_sleep_period: the maximum number of beacon intervals to sleep for
669 * before checking the beacon for a TIM bit (managed mode only); this
670 * value will be only achievable between DTIM frames, the hardware
671 * needs to check for the multicast traffic bit in DTIM beacons.
672 * This variable is valid only when the CONF_PS flag is set.
673 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
674 * in power saving. Power saving will not be enabled until a beacon
675 * has been received and the DTIM period is known.
676 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
677 * powersave documentation below. This variable is valid only when
678 * the CONF_PS flag is set.
679 * @dynamic_ps_forced_timeout: The dynamic powersave timeout (in ms) configured
680 * by cfg80211 (essentially, wext) If set, this value overrules the value
681 * chosen by mac80211 based on ps qos network latency.
683 * @power_level: requested transmit power (in dBm)
685 * @channel: the channel to tune to
686 * @channel_type: the channel (HT) type
688 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
689 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
690 * but actually means the number of transmissions not the number of retries
691 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
692 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
693 * number of transmissions not the number of retries
695 * @smps_mode: spatial multiplexing powersave mode; note that
696 * %IEEE80211_SMPS_STATIC is used when the device is not
697 * configured for an HT channel
699 struct ieee80211_conf {
701 int power_level, dynamic_ps_timeout, dynamic_ps_forced_timeout;
702 int max_sleep_period;
707 u8 long_frame_max_tx_count, short_frame_max_tx_count;
709 struct ieee80211_channel *channel;
710 enum nl80211_channel_type channel_type;
711 enum ieee80211_smps_mode smps_mode;
715 * struct ieee80211_vif - per-interface data
717 * Data in this structure is continually present for driver
718 * use during the life of a virtual interface.
720 * @type: type of this virtual interface
721 * @bss_conf: BSS configuration for this interface, either our own
722 * or the BSS we're associated to
723 * @addr: address of this interface
724 * @drv_priv: data area for driver use, will always be aligned to
727 struct ieee80211_vif {
728 enum nl80211_iftype type;
729 struct ieee80211_bss_conf bss_conf;
732 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
735 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
737 #ifdef CONFIG_MAC80211_MESH
738 return vif->type == NL80211_IFTYPE_MESH_POINT;
744 * enum ieee80211_key_alg - key algorithm
745 * @ALG_WEP: WEP40 or WEP104
747 * @ALG_CCMP: CCMP (AES)
748 * @ALG_AES_CMAC: AES-128-CMAC
750 enum ieee80211_key_alg {
758 * enum ieee80211_key_flags - key flags
760 * These flags are used for communication about keys between the driver
761 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
763 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
764 * that the STA this key will be used with could be using QoS.
765 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
766 * driver to indicate that it requires IV generation for this
768 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
769 * the driver for a TKIP key if it requires Michael MIC
770 * generation in software.
771 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
772 * that the key is pairwise rather then a shared key.
773 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
774 * CCMP key if it requires CCMP encryption of management frames (MFP) to
775 * be done in software.
777 enum ieee80211_key_flags {
778 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
779 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
780 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
781 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
782 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
786 * struct ieee80211_key_conf - key information
788 * This key information is given by mac80211 to the driver by
789 * the set_key() callback in &struct ieee80211_ops.
791 * @hw_key_idx: To be set by the driver, this is the key index the driver
792 * wants to be given when a frame is transmitted and needs to be
793 * encrypted in hardware.
794 * @alg: The key algorithm.
795 * @flags: key flags, see &enum ieee80211_key_flags.
796 * @keyidx: the key index (0-3)
797 * @keylen: key material length
798 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
800 * - Temporal Encryption Key (128 bits)
801 * - Temporal Authenticator Tx MIC Key (64 bits)
802 * - Temporal Authenticator Rx MIC Key (64 bits)
803 * @icv_len: The ICV length for this key type
804 * @iv_len: The IV length for this key type
806 struct ieee80211_key_conf {
807 enum ieee80211_key_alg alg;
819 * enum set_key_cmd - key command
821 * Used with the set_key() callback in &struct ieee80211_ops, this
822 * indicates whether a key is being removed or added.
824 * @SET_KEY: a key is set
825 * @DISABLE_KEY: a key must be disabled
828 SET_KEY, DISABLE_KEY,
832 * struct ieee80211_sta - station table entry
834 * A station table entry represents a station we are possibly
835 * communicating with. Since stations are RCU-managed in
836 * mac80211, any ieee80211_sta pointer you get access to must
837 * either be protected by rcu_read_lock() explicitly or implicitly,
838 * or you must take good care to not use such a pointer after a
839 * call to your sta_remove callback that removed it.
842 * @aid: AID we assigned to the station if we're an AP
843 * @supp_rates: Bitmap of supported rates (per band)
844 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
845 * @drv_priv: data area for driver use, will always be aligned to
846 * sizeof(void *), size is determined in hw information.
848 struct ieee80211_sta {
849 u32 supp_rates[IEEE80211_NUM_BANDS];
852 struct ieee80211_sta_ht_cap ht_cap;
855 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
859 * enum sta_notify_cmd - sta notify command
861 * Used with the sta_notify() callback in &struct ieee80211_ops, this
862 * indicates addition and removal of a station to station table,
863 * or if a associated station made a power state transition.
865 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
866 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
867 * @STA_NOTIFY_SLEEP: a station is now sleeping
868 * @STA_NOTIFY_AWAKE: a sleeping station woke up
870 enum sta_notify_cmd {
871 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
872 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
876 * enum ieee80211_tkip_key_type - get tkip key
878 * Used by drivers which need to get a tkip key for skb. Some drivers need a
879 * phase 1 key, others need a phase 2 key. A single function allows the driver
880 * to get the key, this enum indicates what type of key is required.
882 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
883 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
885 enum ieee80211_tkip_key_type {
886 IEEE80211_TKIP_P1_KEY,
887 IEEE80211_TKIP_P2_KEY,
891 * enum ieee80211_hw_flags - hardware flags
893 * These flags are used to indicate hardware capabilities to
894 * the stack. Generally, flags here should have their meaning
895 * done in a way that the simplest hardware doesn't need setting
896 * any particular flags. There are some exceptions to this rule,
897 * however, so you are advised to review these flags carefully.
899 * @IEEE80211_HW_HAS_RATE_CONTROL:
900 * The hardware or firmware includes rate control, and cannot be
901 * controlled by the stack. As such, no rate control algorithm
902 * should be instantiated, and the TX rate reported to userspace
903 * will be taken from the TX status instead of the rate control
905 * Note that this requires that the driver implement a number of
906 * callbacks so it has the correct information, it needs to have
907 * the @set_rts_threshold callback and must look at the BSS config
908 * @use_cts_prot for G/N protection, @use_short_slot for slot
909 * timing in 2.4 GHz and @use_short_preamble for preambles for
912 * @IEEE80211_HW_RX_INCLUDES_FCS:
913 * Indicates that received frames passed to the stack include
914 * the FCS at the end.
916 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
917 * Some wireless LAN chipsets buffer broadcast/multicast frames
918 * for power saving stations in the hardware/firmware and others
919 * rely on the host system for such buffering. This option is used
920 * to configure the IEEE 802.11 upper layer to buffer broadcast and
921 * multicast frames when there are power saving stations so that
922 * the driver can fetch them with ieee80211_get_buffered_bc().
924 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
925 * Hardware is not capable of short slot operation on the 2.4 GHz band.
927 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
928 * Hardware is not capable of receiving frames with short preamble on
931 * @IEEE80211_HW_SIGNAL_UNSPEC:
932 * Hardware can provide signal values but we don't know its units. We
933 * expect values between 0 and @max_signal.
934 * If possible please provide dB or dBm instead.
936 * @IEEE80211_HW_SIGNAL_DBM:
937 * Hardware gives signal values in dBm, decibel difference from
938 * one milliwatt. This is the preferred method since it is standardized
939 * between different devices. @max_signal does not need to be set.
941 * @IEEE80211_HW_SPECTRUM_MGMT:
942 * Hardware supports spectrum management defined in 802.11h
943 * Measurement, Channel Switch, Quieting, TPC
945 * @IEEE80211_HW_AMPDU_AGGREGATION:
946 * Hardware supports 11n A-MPDU aggregation.
948 * @IEEE80211_HW_SUPPORTS_PS:
949 * Hardware has power save support (i.e. can go to sleep).
951 * @IEEE80211_HW_PS_NULLFUNC_STACK:
952 * Hardware requires nullfunc frame handling in stack, implies
953 * stack support for dynamic PS.
955 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
956 * Hardware has support for dynamic PS.
958 * @IEEE80211_HW_MFP_CAPABLE:
959 * Hardware supports management frame protection (MFP, IEEE 802.11w).
961 * @IEEE80211_HW_BEACON_FILTER:
962 * Hardware supports dropping of irrelevant beacon frames to
963 * avoid waking up cpu.
965 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
966 * Hardware supports static spatial multiplexing powersave,
967 * ie. can turn off all but one chain even on HT connections
968 * that should be using more chains.
970 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
971 * Hardware supports dynamic spatial multiplexing powersave,
972 * ie. can turn off all but one chain and then wake the rest
973 * up as required after, for example, rts/cts handshake.
975 * @IEEE80211_HW_SUPPORTS_UAPSD:
976 * Hardware supports Unscheduled Automatic Power Save Delivery
977 * (U-APSD) in managed mode. The mode is configured with
978 * conf_tx() operation.
980 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
981 * Hardware can provide ack status reports of Tx frames to
984 * @IEEE80211_HW_CONNECTION_MONITOR:
985 * The hardware performs its own connection monitoring, including
986 * periodic keep-alives to the AP and probing the AP on beacon loss.
987 * When this flag is set, signaling beacon-loss will cause an immediate
988 * change to disassociated state.
990 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
991 * Hardware can do connection quality monitoring - i.e. it can monitor
992 * connection quality related parameters, such as the RSSI level and
993 * provide notifications if configured trigger levels are reached.
996 enum ieee80211_hw_flags {
997 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
998 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
999 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1000 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1001 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1002 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1003 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1005 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1006 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1007 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1008 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1009 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1010 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1011 IEEE80211_HW_BEACON_FILTER = 1<<14,
1012 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1013 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1014 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1015 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1016 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1017 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1021 * struct ieee80211_hw - hardware information and state
1023 * This structure contains the configuration and hardware
1024 * information for an 802.11 PHY.
1026 * @wiphy: This points to the &struct wiphy allocated for this
1027 * 802.11 PHY. You must fill in the @perm_addr and @dev
1028 * members of this structure using SET_IEEE80211_DEV()
1029 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1030 * bands (with channels, bitrates) are registered here.
1032 * @conf: &struct ieee80211_conf, device configuration, don't use.
1034 * @priv: pointer to private area that was allocated for driver use
1035 * along with this structure.
1037 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1039 * @extra_tx_headroom: headroom to reserve in each transmit skb
1040 * for use by the driver (e.g. for transmit headers.)
1042 * @channel_change_time: time (in microseconds) it takes to change channels.
1044 * @max_signal: Maximum value for signal (rssi) in RX information, used
1045 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1047 * @max_listen_interval: max listen interval in units of beacon interval
1050 * @queues: number of available hardware transmit queues for
1051 * data packets. WMM/QoS requires at least four, these
1052 * queues need to have configurable access parameters.
1054 * @rate_control_algorithm: rate control algorithm for this hardware.
1055 * If unset (NULL), the default algorithm will be used. Must be
1056 * set before calling ieee80211_register_hw().
1058 * @vif_data_size: size (in bytes) of the drv_priv data area
1059 * within &struct ieee80211_vif.
1060 * @sta_data_size: size (in bytes) of the drv_priv data area
1061 * within &struct ieee80211_sta.
1063 * @max_rates: maximum number of alternate rate retry stages
1064 * @max_rate_tries: maximum number of tries for each stage
1066 struct ieee80211_hw {
1067 struct ieee80211_conf conf;
1068 struct wiphy *wiphy;
1069 const char *rate_control_algorithm;
1072 unsigned int extra_tx_headroom;
1073 int channel_change_time;
1077 u16 max_listen_interval;
1084 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1086 * @wiphy: the &struct wiphy which we want to query
1088 * mac80211 drivers can use this to get to their respective
1089 * &struct ieee80211_hw. Drivers wishing to get to their own private
1090 * structure can then access it via hw->priv. Note that mac802111 drivers should
1091 * not use wiphy_priv() to try to get their private driver structure as this
1092 * is already used internally by mac80211.
1094 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1097 * SET_IEEE80211_DEV - set device for 802.11 hardware
1099 * @hw: the &struct ieee80211_hw to set the device for
1100 * @dev: the &struct device of this 802.11 device
1102 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1104 set_wiphy_dev(hw->wiphy, dev);
1108 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1110 * @hw: the &struct ieee80211_hw to set the MAC address for
1111 * @addr: the address to set
1113 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1115 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1118 static inline struct ieee80211_rate *
1119 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1120 const struct ieee80211_tx_info *c)
1122 if (WARN_ON(c->control.rates[0].idx < 0))
1124 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1127 static inline struct ieee80211_rate *
1128 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1129 const struct ieee80211_tx_info *c)
1131 if (c->control.rts_cts_rate_idx < 0)
1133 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1136 static inline struct ieee80211_rate *
1137 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1138 const struct ieee80211_tx_info *c, int idx)
1140 if (c->control.rates[idx + 1].idx < 0)
1142 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1146 * DOC: Hardware crypto acceleration
1148 * mac80211 is capable of taking advantage of many hardware
1149 * acceleration designs for encryption and decryption operations.
1151 * The set_key() callback in the &struct ieee80211_ops for a given
1152 * device is called to enable hardware acceleration of encryption and
1153 * decryption. The callback takes a @sta parameter that will be NULL
1154 * for default keys or keys used for transmission only, or point to
1155 * the station information for the peer for individual keys.
1156 * Multiple transmission keys with the same key index may be used when
1157 * VLANs are configured for an access point.
1159 * When transmitting, the TX control data will use the @hw_key_idx
1160 * selected by the driver by modifying the &struct ieee80211_key_conf
1161 * pointed to by the @key parameter to the set_key() function.
1163 * The set_key() call for the %SET_KEY command should return 0 if
1164 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1165 * added; if you return 0 then hw_key_idx must be assigned to the
1166 * hardware key index, you are free to use the full u8 range.
1168 * When the cmd is %DISABLE_KEY then it must succeed.
1170 * Note that it is permissible to not decrypt a frame even if a key
1171 * for it has been uploaded to hardware, the stack will not make any
1172 * decision based on whether a key has been uploaded or not but rather
1173 * based on the receive flags.
1175 * The &struct ieee80211_key_conf structure pointed to by the @key
1176 * parameter is guaranteed to be valid until another call to set_key()
1177 * removes it, but it can only be used as a cookie to differentiate
1180 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1181 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1183 * The update_tkip_key() call updates the driver with the new phase 1 key.
1184 * This happens everytime the iv16 wraps around (every 65536 packets). The
1185 * set_key() call will happen only once for each key (unless the AP did
1186 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1187 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1188 * handler is software decryption with wrap around of iv16.
1192 * DOC: Powersave support
1194 * mac80211 has support for various powersave implementations.
1196 * First, it can support hardware that handles all powersaving by itself,
1197 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1198 * flag. In that case, it will be told about the desired powersave mode
1199 * with the %IEEE80211_CONF_PS flag depending on the association status.
1200 * The hardware must take care of sending nullfunc frames when necessary,
1201 * i.e. when entering and leaving powersave mode. The hardware is required
1202 * to look at the AID in beacons and signal to the AP that it woke up when
1203 * it finds traffic directed to it.
1205 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1206 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1207 * with hardware wakeup and sleep states. Driver is responsible for waking
1208 * up the hardware before issueing commands to the hardware and putting it
1209 * back to sleep at approriate times.
1211 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1212 * buffered multicast/broadcast frames after the beacon. Also it must be
1213 * possible to send frames and receive the acknowledment frame.
1215 * Other hardware designs cannot send nullfunc frames by themselves and also
1216 * need software support for parsing the TIM bitmap. This is also supported
1217 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1218 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1219 * required to pass up beacons. The hardware is still required to handle
1220 * waking up for multicast traffic; if it cannot the driver must handle that
1221 * as best as it can, mac80211 is too slow to do that.
1223 * Dynamic powersave is an extension to normal powersave in which the
1224 * hardware stays awake for a user-specified period of time after sending a
1225 * frame so that reply frames need not be buffered and therefore delayed to
1226 * the next wakeup. It's compromise of getting good enough latency when
1227 * there's data traffic and still saving significantly power in idle
1230 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1231 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1232 * flag and mac80211 will handle everything automatically. Additionally,
1233 * hardware having support for the dynamic PS feature may set the
1234 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1235 * dynamic PS mode itself. The driver needs to look at the
1236 * @dynamic_ps_timeout hardware configuration value and use it that value
1237 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1238 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1239 * enabled whenever user has enabled powersave.
1241 * Driver informs U-APSD client support by enabling
1242 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1243 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1244 * Nullfunc frames and stay awake until the service period has ended. To
1245 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1246 * from that AC are transmitted with powersave enabled.
1248 * Note: U-APSD client mode is not yet supported with
1249 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1253 * DOC: Beacon filter support
1255 * Some hardware have beacon filter support to reduce host cpu wakeups
1256 * which will reduce system power consumption. It usuallly works so that
1257 * the firmware creates a checksum of the beacon but omits all constantly
1258 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1259 * beacon is forwarded to the host, otherwise it will be just dropped. That
1260 * way the host will only receive beacons where some relevant information
1261 * (for example ERP protection or WMM settings) have changed.
1263 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1264 * hardware capability. The driver needs to enable beacon filter support
1265 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1266 * power save is enabled, the stack will not check for beacon loss and the
1267 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1269 * The time (or number of beacons missed) until the firmware notifies the
1270 * driver of a beacon loss event (which in turn causes the driver to call
1271 * ieee80211_beacon_loss()) should be configurable and will be controlled
1272 * by mac80211 and the roaming algorithm in the future.
1274 * Since there may be constantly changing information elements that nothing
1275 * in the software stack cares about, we will, in the future, have mac80211
1276 * tell the driver which information elements are interesting in the sense
1277 * that we want to see changes in them. This will include
1278 * - a list of information element IDs
1279 * - a list of OUIs for the vendor information element
1281 * Ideally, the hardware would filter out any beacons without changes in the
1282 * requested elements, but if it cannot support that it may, at the expense
1283 * of some efficiency, filter out only a subset. For example, if the device
1284 * doesn't support checking for OUIs it should pass up all changes in all
1285 * vendor information elements.
1287 * Note that change, for the sake of simplification, also includes information
1288 * elements appearing or disappearing from the beacon.
1290 * Some hardware supports an "ignore list" instead, just make sure nothing
1291 * that was requested is on the ignore list, and include commonly changing
1292 * information element IDs in the ignore list, for example 11 (BSS load) and
1293 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1294 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1295 * it could also include some currently unused IDs.
1298 * In addition to these capabilities, hardware should support notifying the
1299 * host of changes in the beacon RSSI. This is relevant to implement roaming
1300 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1301 * the received data packets). This can consist in notifying the host when
1302 * the RSSI changes significantly or when it drops below or rises above
1303 * configurable thresholds. In the future these thresholds will also be
1304 * configured by mac80211 (which gets them from userspace) to implement
1305 * them as the roaming algorithm requires.
1307 * If the hardware cannot implement this, the driver should ask it to
1308 * periodically pass beacon frames to the host so that software can do the
1309 * signal strength threshold checking.
1313 * DOC: Spatial multiplexing power save
1315 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1316 * power in an 802.11n implementation. For details on the mechanism
1317 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1318 * "11.2.3 SM power save".
1320 * The mac80211 implementation is capable of sending action frames
1321 * to update the AP about the station's SMPS mode, and will instruct
1322 * the driver to enter the specific mode. It will also announce the
1323 * requested SMPS mode during the association handshake. Hardware
1324 * support for this feature is required, and can be indicated by
1327 * The default mode will be "automatic", which nl80211/cfg80211
1328 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1329 * turned off otherwise.
1331 * To support this feature, the driver must set the appropriate
1332 * hardware support flags, and handle the SMPS flag to the config()
1333 * operation. It will then with this mechanism be instructed to
1334 * enter the requested SMPS mode while associated to an HT AP.
1338 * DOC: Frame filtering
1340 * mac80211 requires to see many management frames for proper
1341 * operation, and users may want to see many more frames when
1342 * in monitor mode. However, for best CPU usage and power consumption,
1343 * having as few frames as possible percolate through the stack is
1344 * desirable. Hence, the hardware should filter as much as possible.
1346 * To achieve this, mac80211 uses filter flags (see below) to tell
1347 * the driver's configure_filter() function which frames should be
1348 * passed to mac80211 and which should be filtered out.
1350 * Before configure_filter() is invoked, the prepare_multicast()
1351 * callback is invoked with the parameters @mc_count and @mc_list
1352 * for the combined multicast address list of all virtual interfaces.
1353 * It's use is optional, and it returns a u64 that is passed to
1354 * configure_filter(). Additionally, configure_filter() has the
1355 * arguments @changed_flags telling which flags were changed and
1356 * @total_flags with the new flag states.
1358 * If your device has no multicast address filters your driver will
1359 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1360 * parameter to see whether multicast frames should be accepted
1363 * All unsupported flags in @total_flags must be cleared.
1364 * Hardware does not support a flag if it is incapable of _passing_
1365 * the frame to the stack. Otherwise the driver must ignore
1366 * the flag, but not clear it.
1367 * You must _only_ clear the flag (announce no support for the
1368 * flag to mac80211) if you are not able to pass the packet type
1369 * to the stack (so the hardware always filters it).
1370 * So for example, you should clear @FIF_CONTROL, if your hardware
1371 * always filters control frames. If your hardware always passes
1372 * control frames to the kernel and is incapable of filtering them,
1373 * you do _not_ clear the @FIF_CONTROL flag.
1374 * This rule applies to all other FIF flags as well.
1378 * enum ieee80211_filter_flags - hardware filter flags
1380 * These flags determine what the filter in hardware should be
1381 * programmed to let through and what should not be passed to the
1382 * stack. It is always safe to pass more frames than requested,
1383 * but this has negative impact on power consumption.
1385 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1386 * think of the BSS as your network segment and then this corresponds
1387 * to the regular ethernet device promiscuous mode.
1389 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1390 * by the user or if the hardware is not capable of filtering by
1391 * multicast address.
1393 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1394 * %RX_FLAG_FAILED_FCS_CRC for them)
1396 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1397 * the %RX_FLAG_FAILED_PLCP_CRC for them
1399 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1400 * to the hardware that it should not filter beacons or probe responses
1401 * by BSSID. Filtering them can greatly reduce the amount of processing
1402 * mac80211 needs to do and the amount of CPU wakeups, so you should
1403 * honour this flag if possible.
1405 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1406 * is not set then only those addressed to this station.
1408 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1410 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1411 * those addressed to this station.
1413 enum ieee80211_filter_flags {
1414 FIF_PROMISC_IN_BSS = 1<<0,
1415 FIF_ALLMULTI = 1<<1,
1417 FIF_PLCPFAIL = 1<<3,
1418 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1420 FIF_OTHER_BSS = 1<<6,
1425 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1427 * These flags are used with the ampdu_action() callback in
1428 * &struct ieee80211_ops to indicate which action is needed.
1430 * Note that drivers MUST be able to deal with a TX aggregation
1431 * session being stopped even before they OK'ed starting it by
1432 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1433 * might receive the addBA frame and send a delBA right away!
1435 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1436 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1437 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1438 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1439 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1441 enum ieee80211_ampdu_mlme_action {
1442 IEEE80211_AMPDU_RX_START,
1443 IEEE80211_AMPDU_RX_STOP,
1444 IEEE80211_AMPDU_TX_START,
1445 IEEE80211_AMPDU_TX_STOP,
1446 IEEE80211_AMPDU_TX_OPERATIONAL,
1450 * struct ieee80211_ops - callbacks from mac80211 to the driver
1452 * This structure contains various callbacks that the driver may
1453 * handle or, in some cases, must handle, for example to configure
1454 * the hardware to a new channel or to transmit a frame.
1456 * @tx: Handler that 802.11 module calls for each transmitted frame.
1457 * skb contains the buffer starting from the IEEE 802.11 header.
1458 * The low-level driver should send the frame out based on
1459 * configuration in the TX control data. This handler should,
1460 * preferably, never fail and stop queues appropriately, more
1461 * importantly, however, it must never fail for A-MPDU-queues.
1462 * This function should return NETDEV_TX_OK except in very
1464 * Must be implemented and atomic.
1466 * @start: Called before the first netdevice attached to the hardware
1467 * is enabled. This should turn on the hardware and must turn on
1468 * frame reception (for possibly enabled monitor interfaces.)
1469 * Returns negative error codes, these may be seen in userspace,
1471 * When the device is started it should not have a MAC address
1472 * to avoid acknowledging frames before a non-monitor device
1474 * Must be implemented and can sleep.
1476 * @stop: Called after last netdevice attached to the hardware
1477 * is disabled. This should turn off the hardware (at least
1478 * it must turn off frame reception.)
1479 * May be called right after add_interface if that rejects
1480 * an interface. If you added any work onto the mac80211 workqueue
1481 * you should ensure to cancel it on this callback.
1482 * Must be implemented and can sleep.
1484 * @add_interface: Called when a netdevice attached to the hardware is
1485 * enabled. Because it is not called for monitor mode devices, @start
1486 * and @stop must be implemented.
1487 * The driver should perform any initialization it needs before
1488 * the device can be enabled. The initial configuration for the
1489 * interface is given in the conf parameter.
1490 * The callback may refuse to add an interface by returning a
1491 * negative error code (which will be seen in userspace.)
1492 * Must be implemented and can sleep.
1494 * @remove_interface: Notifies a driver that an interface is going down.
1495 * The @stop callback is called after this if it is the last interface
1496 * and no monitor interfaces are present.
1497 * When all interfaces are removed, the MAC address in the hardware
1498 * must be cleared so the device no longer acknowledges packets,
1499 * the mac_addr member of the conf structure is, however, set to the
1500 * MAC address of the device going away.
1501 * Hence, this callback must be implemented. It can sleep.
1503 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1504 * function to change hardware configuration, e.g., channel.
1505 * This function should never fail but returns a negative error code
1506 * if it does. The callback can sleep.
1508 * @bss_info_changed: Handler for configuration requests related to BSS
1509 * parameters that may vary during BSS's lifespan, and may affect low
1510 * level driver (e.g. assoc/disassoc status, erp parameters).
1511 * This function should not be used if no BSS has been set, unless
1512 * for association indication. The @changed parameter indicates which
1513 * of the bss parameters has changed when a call is made. The callback
1516 * @prepare_multicast: Prepare for multicast filter configuration.
1517 * This callback is optional, and its return value is passed
1518 * to configure_filter(). This callback must be atomic.
1520 * @configure_filter: Configure the device's RX filter.
1521 * See the section "Frame filtering" for more information.
1522 * This callback must be implemented and can sleep.
1524 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1525 * must be set or cleared for a given STA. Must be atomic.
1527 * @set_key: See the section "Hardware crypto acceleration"
1528 * This callback is only called between add_interface and
1529 * remove_interface calls, i.e. while the given virtual interface
1531 * Returns a negative error code if the key can't be added.
1532 * The callback can sleep.
1534 * @update_tkip_key: See the section "Hardware crypto acceleration"
1535 * This callback will be called in the context of Rx. Called for drivers
1536 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1537 * The callback must be atomic.
1539 * @hw_scan: Ask the hardware to service the scan request, no need to start
1540 * the scan state machine in stack. The scan must honour the channel
1541 * configuration done by the regulatory agent in the wiphy's
1542 * registered bands. The hardware (or the driver) needs to make sure
1543 * that power save is disabled.
1544 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1545 * entire IEs after the SSID, so that drivers need not look at these
1546 * at all but just send them after the SSID -- mac80211 includes the
1547 * (extended) supported rates and HT information (where applicable).
1548 * When the scan finishes, ieee80211_scan_completed() must be called;
1549 * note that it also must be called when the scan cannot finish due to
1550 * any error unless this callback returned a negative error code.
1551 * The callback can sleep.
1553 * @sw_scan_start: Notifier function that is called just before a software scan
1554 * is started. Can be NULL, if the driver doesn't need this notification.
1555 * The callback can sleep.
1557 * @sw_scan_complete: Notifier function that is called just after a
1558 * software scan finished. Can be NULL, if the driver doesn't need
1559 * this notification.
1560 * The callback can sleep.
1562 * @get_stats: Return low-level statistics.
1563 * Returns zero if statistics are available.
1564 * The callback can sleep.
1566 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1567 * callback should be provided to read the TKIP transmit IVs (both IV32
1568 * and IV16) for the given key from hardware.
1569 * The callback must be atomic.
1571 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1572 * The callback can sleep.
1574 * @sta_add: Notifies low level driver about addition of an associated station,
1575 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1577 * @sta_remove: Notifies low level driver about removal of an associated
1578 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1580 * @sta_notify: Notifies low level driver about power state transition of an
1581 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
1583 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1584 * bursting) for a hardware TX queue.
1585 * Returns a negative error code on failure.
1586 * The callback can sleep.
1588 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1589 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1590 * required function.
1591 * The callback can sleep.
1593 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1594 * Currently, this is only used for IBSS mode debugging. Is not a
1595 * required function.
1596 * The callback can sleep.
1598 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1599 * with other STAs in the IBSS. This is only used in IBSS mode. This
1600 * function is optional if the firmware/hardware takes full care of
1601 * TSF synchronization.
1602 * The callback can sleep.
1604 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1605 * This is needed only for IBSS mode and the result of this function is
1606 * used to determine whether to reply to Probe Requests.
1607 * Returns non-zero if this device sent the last beacon.
1608 * The callback can sleep.
1610 * @ampdu_action: Perform a certain A-MPDU action
1611 * The RA/TID combination determines the destination and TID we want
1612 * the ampdu action to be performed for. The action is defined through
1613 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1614 * is the first frame we expect to perform the action on. Notice
1615 * that TX/RX_STOP can pass NULL for this parameter.
1616 * Returns a negative error code on failure.
1617 * The callback must be atomic.
1619 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1620 * need to set wiphy->rfkill_poll to %true before registration,
1621 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1622 * The callback can sleep.
1624 * @set_coverage_class: Set slot time for given coverage class as specified
1625 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1626 * accordingly. This callback is not required and may sleep.
1628 * @testmode_cmd: Implement a cfg80211 test mode command.
1629 * The callback can sleep.
1631 * @flush: Flush all pending frames from the hardware queue, making sure
1632 * that the hardware queues are empty. If the parameter @drop is set
1633 * to %true, pending frames may be dropped. The callback can sleep.
1635 struct ieee80211_ops {
1636 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1637 int (*start)(struct ieee80211_hw *hw);
1638 void (*stop)(struct ieee80211_hw *hw);
1639 int (*add_interface)(struct ieee80211_hw *hw,
1640 struct ieee80211_vif *vif);
1641 void (*remove_interface)(struct ieee80211_hw *hw,
1642 struct ieee80211_vif *vif);
1643 int (*config)(struct ieee80211_hw *hw, u32 changed);
1644 void (*bss_info_changed)(struct ieee80211_hw *hw,
1645 struct ieee80211_vif *vif,
1646 struct ieee80211_bss_conf *info,
1648 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1649 struct netdev_hw_addr_list *mc_list);
1650 void (*configure_filter)(struct ieee80211_hw *hw,
1651 unsigned int changed_flags,
1652 unsigned int *total_flags,
1654 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1656 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1657 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1658 struct ieee80211_key_conf *key);
1659 void (*update_tkip_key)(struct ieee80211_hw *hw,
1660 struct ieee80211_vif *vif,
1661 struct ieee80211_key_conf *conf,
1662 struct ieee80211_sta *sta,
1663 u32 iv32, u16 *phase1key);
1664 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1665 struct cfg80211_scan_request *req);
1666 void (*sw_scan_start)(struct ieee80211_hw *hw);
1667 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1668 int (*get_stats)(struct ieee80211_hw *hw,
1669 struct ieee80211_low_level_stats *stats);
1670 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1671 u32 *iv32, u16 *iv16);
1672 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1673 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1674 struct ieee80211_sta *sta);
1675 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1676 struct ieee80211_sta *sta);
1677 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1678 enum sta_notify_cmd, struct ieee80211_sta *sta);
1679 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1680 const struct ieee80211_tx_queue_params *params);
1681 u64 (*get_tsf)(struct ieee80211_hw *hw);
1682 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1683 void (*reset_tsf)(struct ieee80211_hw *hw);
1684 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1685 int (*ampdu_action)(struct ieee80211_hw *hw,
1686 struct ieee80211_vif *vif,
1687 enum ieee80211_ampdu_mlme_action action,
1688 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1689 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1690 struct survey_info *survey);
1691 void (*rfkill_poll)(struct ieee80211_hw *hw);
1692 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1693 #ifdef CONFIG_NL80211_TESTMODE
1694 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1696 void (*flush)(struct ieee80211_hw *hw, bool drop);
1700 * ieee80211_alloc_hw - Allocate a new hardware device
1702 * This must be called once for each hardware device. The returned pointer
1703 * must be used to refer to this device when calling other functions.
1704 * mac80211 allocates a private data area for the driver pointed to by
1705 * @priv in &struct ieee80211_hw, the size of this area is given as
1708 * @priv_data_len: length of private data
1709 * @ops: callbacks for this device
1711 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1712 const struct ieee80211_ops *ops);
1715 * ieee80211_register_hw - Register hardware device
1717 * You must call this function before any other functions in
1718 * mac80211. Note that before a hardware can be registered, you
1719 * need to fill the contained wiphy's information.
1721 * @hw: the device to register as returned by ieee80211_alloc_hw()
1723 int ieee80211_register_hw(struct ieee80211_hw *hw);
1725 #ifdef CONFIG_MAC80211_LEDS
1726 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1727 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1728 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1729 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1732 * ieee80211_get_tx_led_name - get name of TX LED
1734 * mac80211 creates a transmit LED trigger for each wireless hardware
1735 * that can be used to drive LEDs if your driver registers a LED device.
1736 * This function returns the name (or %NULL if not configured for LEDs)
1737 * of the trigger so you can automatically link the LED device.
1739 * @hw: the hardware to get the LED trigger name for
1741 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1743 #ifdef CONFIG_MAC80211_LEDS
1744 return __ieee80211_get_tx_led_name(hw);
1751 * ieee80211_get_rx_led_name - get name of RX LED
1753 * mac80211 creates a receive LED trigger for each wireless hardware
1754 * that can be used to drive LEDs if your driver registers a LED device.
1755 * This function returns the name (or %NULL if not configured for LEDs)
1756 * of the trigger so you can automatically link the LED device.
1758 * @hw: the hardware to get the LED trigger name for
1760 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1762 #ifdef CONFIG_MAC80211_LEDS
1763 return __ieee80211_get_rx_led_name(hw);
1770 * ieee80211_get_assoc_led_name - get name of association LED
1772 * mac80211 creates a association LED trigger for each wireless hardware
1773 * that can be used to drive LEDs if your driver registers a LED device.
1774 * This function returns the name (or %NULL if not configured for LEDs)
1775 * of the trigger so you can automatically link the LED device.
1777 * @hw: the hardware to get the LED trigger name for
1779 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1781 #ifdef CONFIG_MAC80211_LEDS
1782 return __ieee80211_get_assoc_led_name(hw);
1789 * ieee80211_get_radio_led_name - get name of radio LED
1791 * mac80211 creates a radio change LED trigger for each wireless hardware
1792 * that can be used to drive LEDs if your driver registers a LED device.
1793 * This function returns the name (or %NULL if not configured for LEDs)
1794 * of the trigger so you can automatically link the LED device.
1796 * @hw: the hardware to get the LED trigger name for
1798 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1800 #ifdef CONFIG_MAC80211_LEDS
1801 return __ieee80211_get_radio_led_name(hw);
1808 * ieee80211_unregister_hw - Unregister a hardware device
1810 * This function instructs mac80211 to free allocated resources
1811 * and unregister netdevices from the networking subsystem.
1813 * @hw: the hardware to unregister
1815 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1818 * ieee80211_free_hw - free hardware descriptor
1820 * This function frees everything that was allocated, including the
1821 * private data for the driver. You must call ieee80211_unregister_hw()
1822 * before calling this function.
1824 * @hw: the hardware to free
1826 void ieee80211_free_hw(struct ieee80211_hw *hw);
1829 * ieee80211_restart_hw - restart hardware completely
1831 * Call this function when the hardware was restarted for some reason
1832 * (hardware error, ...) and the driver is unable to restore its state
1833 * by itself. mac80211 assumes that at this point the driver/hardware
1834 * is completely uninitialised and stopped, it starts the process by
1835 * calling the ->start() operation. The driver will need to reset all
1836 * internal state that it has prior to calling this function.
1838 * @hw: the hardware to restart
1840 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1843 * ieee80211_rx - receive frame
1845 * Use this function to hand received frames to mac80211. The receive
1846 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1847 * paged @skb is used, the driver is recommended to put the ieee80211
1848 * header of the frame on the linear part of the @skb to avoid memory
1849 * allocation and/or memcpy by the stack.
1851 * This function may not be called in IRQ context. Calls to this function
1852 * for a single hardware must be synchronized against each other. Calls to
1853 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1854 * mixed for a single hardware.
1856 * In process context use instead ieee80211_rx_ni().
1858 * @hw: the hardware this frame came in on
1859 * @skb: the buffer to receive, owned by mac80211 after this call
1861 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1864 * ieee80211_rx_irqsafe - receive frame
1866 * Like ieee80211_rx() but can be called in IRQ context
1867 * (internally defers to a tasklet.)
1869 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1870 * be mixed for a single hardware.
1872 * @hw: the hardware this frame came in on
1873 * @skb: the buffer to receive, owned by mac80211 after this call
1875 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1878 * ieee80211_rx_ni - receive frame (in process context)
1880 * Like ieee80211_rx() but can be called in process context
1881 * (internally disables bottom halves).
1883 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1884 * not be mixed for a single hardware.
1886 * @hw: the hardware this frame came in on
1887 * @skb: the buffer to receive, owned by mac80211 after this call
1889 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1890 struct sk_buff *skb)
1893 ieee80211_rx(hw, skb);
1898 * The TX headroom reserved by mac80211 for its own tx_status functions.
1899 * This is enough for the radiotap header.
1901 #define IEEE80211_TX_STATUS_HEADROOM 13
1904 * ieee80211_tx_status - transmit status callback
1906 * Call this function for all transmitted frames after they have been
1907 * transmitted. It is permissible to not call this function for
1908 * multicast frames but this can affect statistics.
1910 * This function may not be called in IRQ context. Calls to this function
1911 * for a single hardware must be synchronized against each other. Calls
1912 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1913 * for a single hardware.
1915 * @hw: the hardware the frame was transmitted by
1916 * @skb: the frame that was transmitted, owned by mac80211 after this call
1918 void ieee80211_tx_status(struct ieee80211_hw *hw,
1919 struct sk_buff *skb);
1922 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1924 * Like ieee80211_tx_status() but can be called in IRQ context
1925 * (internally defers to a tasklet.)
1927 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1930 * @hw: the hardware the frame was transmitted by
1931 * @skb: the frame that was transmitted, owned by mac80211 after this call
1933 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1934 struct sk_buff *skb);
1937 * ieee80211_beacon_get_tim - beacon generation function
1938 * @hw: pointer obtained from ieee80211_alloc_hw().
1939 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1940 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1941 * Set to 0 if invalid (in non-AP modes).
1942 * @tim_length: pointer to variable that will receive the TIM IE length,
1943 * (including the ID and length bytes!).
1944 * Set to 0 if invalid (in non-AP modes).
1946 * If the driver implements beaconing modes, it must use this function to
1947 * obtain the beacon frame/template.
1949 * If the beacon frames are generated by the host system (i.e., not in
1950 * hardware/firmware), the driver uses this function to get each beacon
1951 * frame from mac80211 -- it is responsible for calling this function
1952 * before the beacon is needed (e.g. based on hardware interrupt).
1954 * If the beacon frames are generated by the device, then the driver
1955 * must use the returned beacon as the template and change the TIM IE
1956 * according to the current DTIM parameters/TIM bitmap.
1958 * The driver is responsible for freeing the returned skb.
1960 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1961 struct ieee80211_vif *vif,
1962 u16 *tim_offset, u16 *tim_length);
1965 * ieee80211_beacon_get - beacon generation function
1966 * @hw: pointer obtained from ieee80211_alloc_hw().
1967 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1969 * See ieee80211_beacon_get_tim().
1971 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1972 struct ieee80211_vif *vif)
1974 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1978 * ieee80211_pspoll_get - retrieve a PS Poll template
1979 * @hw: pointer obtained from ieee80211_alloc_hw().
1980 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1982 * Creates a PS Poll a template which can, for example, uploaded to
1983 * hardware. The template must be updated after association so that correct
1984 * AID, BSSID and MAC address is used.
1986 * Note: Caller (or hardware) is responsible for setting the
1987 * &IEEE80211_FCTL_PM bit.
1989 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1990 struct ieee80211_vif *vif);
1993 * ieee80211_nullfunc_get - retrieve a nullfunc template
1994 * @hw: pointer obtained from ieee80211_alloc_hw().
1995 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1997 * Creates a Nullfunc template which can, for example, uploaded to
1998 * hardware. The template must be updated after association so that correct
1999 * BSSID and address is used.
2001 * Note: Caller (or hardware) is responsible for setting the
2002 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2004 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2005 struct ieee80211_vif *vif);
2008 * ieee80211_probereq_get - retrieve a Probe Request template
2009 * @hw: pointer obtained from ieee80211_alloc_hw().
2010 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2011 * @ssid: SSID buffer
2012 * @ssid_len: length of SSID
2013 * @ie: buffer containing all IEs except SSID for the template
2014 * @ie_len: length of the IE buffer
2016 * Creates a Probe Request template which can, for example, be uploaded to
2019 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2020 struct ieee80211_vif *vif,
2021 const u8 *ssid, size_t ssid_len,
2022 const u8 *ie, size_t ie_len);
2025 * ieee80211_rts_get - RTS frame generation function
2026 * @hw: pointer obtained from ieee80211_alloc_hw().
2027 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2028 * @frame: pointer to the frame that is going to be protected by the RTS.
2029 * @frame_len: the frame length (in octets).
2030 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2031 * @rts: The buffer where to store the RTS frame.
2033 * If the RTS frames are generated by the host system (i.e., not in
2034 * hardware/firmware), the low-level driver uses this function to receive
2035 * the next RTS frame from the 802.11 code. The low-level is responsible
2036 * for calling this function before and RTS frame is needed.
2038 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2039 const void *frame, size_t frame_len,
2040 const struct ieee80211_tx_info *frame_txctl,
2041 struct ieee80211_rts *rts);
2044 * ieee80211_rts_duration - Get the duration field for an RTS frame
2045 * @hw: pointer obtained from ieee80211_alloc_hw().
2046 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2047 * @frame_len: the length of the frame that is going to be protected by the RTS.
2048 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2050 * If the RTS is generated in firmware, but the host system must provide
2051 * the duration field, the low-level driver uses this function to receive
2052 * the duration field value in little-endian byteorder.
2054 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2055 struct ieee80211_vif *vif, size_t frame_len,
2056 const struct ieee80211_tx_info *frame_txctl);
2059 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2060 * @hw: pointer obtained from ieee80211_alloc_hw().
2061 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2062 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2063 * @frame_len: the frame length (in octets).
2064 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2065 * @cts: The buffer where to store the CTS-to-self frame.
2067 * If the CTS-to-self frames are generated by the host system (i.e., not in
2068 * hardware/firmware), the low-level driver uses this function to receive
2069 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2070 * for calling this function before and CTS-to-self frame is needed.
2072 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2073 struct ieee80211_vif *vif,
2074 const void *frame, size_t frame_len,
2075 const struct ieee80211_tx_info *frame_txctl,
2076 struct ieee80211_cts *cts);
2079 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2080 * @hw: pointer obtained from ieee80211_alloc_hw().
2081 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2082 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2083 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2085 * If the CTS-to-self is generated in firmware, but the host system must provide
2086 * the duration field, the low-level driver uses this function to receive
2087 * the duration field value in little-endian byteorder.
2089 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2090 struct ieee80211_vif *vif,
2092 const struct ieee80211_tx_info *frame_txctl);
2095 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2096 * @hw: pointer obtained from ieee80211_alloc_hw().
2097 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2098 * @frame_len: the length of the frame.
2099 * @rate: the rate at which the frame is going to be transmitted.
2101 * Calculate the duration field of some generic frame, given its
2102 * length and transmission rate (in 100kbps).
2104 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2105 struct ieee80211_vif *vif,
2107 struct ieee80211_rate *rate);
2110 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2111 * @hw: pointer as obtained from ieee80211_alloc_hw().
2112 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2114 * Function for accessing buffered broadcast and multicast frames. If
2115 * hardware/firmware does not implement buffering of broadcast/multicast
2116 * frames when power saving is used, 802.11 code buffers them in the host
2117 * memory. The low-level driver uses this function to fetch next buffered
2118 * frame. In most cases, this is used when generating beacon frame. This
2119 * function returns a pointer to the next buffered skb or NULL if no more
2120 * buffered frames are available.
2122 * Note: buffered frames are returned only after DTIM beacon frame was
2123 * generated with ieee80211_beacon_get() and the low-level driver must thus
2124 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2125 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2126 * does not need to check for DTIM beacons separately and should be able to
2127 * use common code for all beacons.
2130 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2133 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2135 * This function computes a TKIP rc4 key for an skb. It computes
2136 * a phase 1 key if needed (iv16 wraps around). This function is to
2137 * be used by drivers which can do HW encryption but need to compute
2138 * to phase 1/2 key in SW.
2140 * @keyconf: the parameter passed with the set key
2141 * @skb: the skb for which the key is needed
2143 * @key: a buffer to which the key will be written
2145 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2146 struct sk_buff *skb,
2147 enum ieee80211_tkip_key_type type, u8 *key);
2149 * ieee80211_wake_queue - wake specific queue
2150 * @hw: pointer as obtained from ieee80211_alloc_hw().
2151 * @queue: queue number (counted from zero).
2153 * Drivers should use this function instead of netif_wake_queue.
2155 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2158 * ieee80211_stop_queue - stop specific queue
2159 * @hw: pointer as obtained from ieee80211_alloc_hw().
2160 * @queue: queue number (counted from zero).
2162 * Drivers should use this function instead of netif_stop_queue.
2164 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2167 * ieee80211_queue_stopped - test status of the queue
2168 * @hw: pointer as obtained from ieee80211_alloc_hw().
2169 * @queue: queue number (counted from zero).
2171 * Drivers should use this function instead of netif_stop_queue.
2174 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2177 * ieee80211_stop_queues - stop all queues
2178 * @hw: pointer as obtained from ieee80211_alloc_hw().
2180 * Drivers should use this function instead of netif_stop_queue.
2182 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2185 * ieee80211_wake_queues - wake all queues
2186 * @hw: pointer as obtained from ieee80211_alloc_hw().
2188 * Drivers should use this function instead of netif_wake_queue.
2190 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2193 * ieee80211_scan_completed - completed hardware scan
2195 * When hardware scan offload is used (i.e. the hw_scan() callback is
2196 * assigned) this function needs to be called by the driver to notify
2197 * mac80211 that the scan finished.
2199 * @hw: the hardware that finished the scan
2200 * @aborted: set to true if scan was aborted
2202 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2205 * ieee80211_iterate_active_interfaces - iterate active interfaces
2207 * This function iterates over the interfaces associated with a given
2208 * hardware that are currently active and calls the callback for them.
2209 * This function allows the iterator function to sleep, when the iterator
2210 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2213 * @hw: the hardware struct of which the interfaces should be iterated over
2214 * @iterator: the iterator function to call
2215 * @data: first argument of the iterator function
2217 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2218 void (*iterator)(void *data, u8 *mac,
2219 struct ieee80211_vif *vif),
2223 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2225 * This function iterates over the interfaces associated with a given
2226 * hardware that are currently active and calls the callback for them.
2227 * This function requires the iterator callback function to be atomic,
2228 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2230 * @hw: the hardware struct of which the interfaces should be iterated over
2231 * @iterator: the iterator function to call, cannot sleep
2232 * @data: first argument of the iterator function
2234 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2235 void (*iterator)(void *data,
2237 struct ieee80211_vif *vif),
2241 * ieee80211_queue_work - add work onto the mac80211 workqueue
2243 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2244 * This helper ensures drivers are not queueing work when they should not be.
2246 * @hw: the hardware struct for the interface we are adding work for
2247 * @work: the work we want to add onto the mac80211 workqueue
2249 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2252 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2254 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2257 * @hw: the hardware struct for the interface we are adding work for
2258 * @dwork: delayable work to queue onto the mac80211 workqueue
2259 * @delay: number of jiffies to wait before queueing
2261 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2262 struct delayed_work *dwork,
2263 unsigned long delay);
2266 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2267 * @sta: the station for which to start a BA session
2268 * @tid: the TID to BA on.
2270 * Return: success if addBA request was sent, failure otherwise
2272 * Although mac80211/low level driver/user space application can estimate
2273 * the need to start aggregation on a certain RA/TID, the session level
2274 * will be managed by the mac80211.
2276 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2279 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2280 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2281 * @ra: receiver address of the BA session recipient.
2282 * @tid: the TID to BA on.
2284 * This function must be called by low level driver once it has
2285 * finished with preparations for the BA session.
2287 void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
2290 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2291 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2292 * @ra: receiver address of the BA session recipient.
2293 * @tid: the TID to BA on.
2295 * This function must be called by low level driver once it has
2296 * finished with preparations for the BA session.
2297 * This version of the function is IRQ-safe.
2299 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2303 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2304 * @sta: the station whose BA session to stop
2305 * @tid: the TID to stop BA.
2306 * @initiator: if indicates initiator DELBA frame will be sent.
2308 * Return: error if no sta with matching da found, success otherwise
2310 * Although mac80211/low level driver/user space application can estimate
2311 * the need to stop aggregation on a certain RA/TID, the session level
2312 * will be managed by the mac80211.
2314 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2315 enum ieee80211_back_parties initiator);
2318 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2319 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2320 * @ra: receiver address of the BA session recipient.
2321 * @tid: the desired TID to BA on.
2323 * This function must be called by low level driver once it has
2324 * finished with preparations for the BA session tear down.
2326 void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
2329 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2330 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2331 * @ra: receiver address of the BA session recipient.
2332 * @tid: the desired TID to BA on.
2334 * This function must be called by low level driver once it has
2335 * finished with preparations for the BA session tear down.
2336 * This version of the function is IRQ-safe.
2338 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2342 * ieee80211_find_sta - find a station
2344 * @vif: virtual interface to look for station on
2345 * @addr: station's address
2347 * This function must be called under RCU lock and the
2348 * resulting pointer is only valid under RCU lock as well.
2350 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2354 * ieee80211_find_sta_by_hw - find a station on hardware
2356 * @hw: pointer as obtained from ieee80211_alloc_hw()
2357 * @addr: station's address
2359 * This function must be called under RCU lock and the
2360 * resulting pointer is only valid under RCU lock as well.
2362 * NOTE: This function should not be used! When mac80211 is converted
2363 * internally to properly keep track of stations on multiple
2364 * virtual interfaces, it will not always know which station to
2365 * return here since a single address might be used by multiple
2366 * logical stations (e.g. consider a station connecting to another
2367 * BSSID on the same AP hardware without disconnecting first).
2369 * DO NOT USE THIS FUNCTION.
2371 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2375 * ieee80211_sta_block_awake - block station from waking up
2377 * @pubsta: the station
2378 * @block: whether to block or unblock
2380 * Some devices require that all frames that are on the queues
2381 * for a specific station that went to sleep are flushed before
2382 * a poll response or frames after the station woke up can be
2383 * delivered to that it. Note that such frames must be rejected
2384 * by the driver as filtered, with the appropriate status flag.
2386 * This function allows implementing this mode in a race-free
2389 * To do this, a driver must keep track of the number of frames
2390 * still enqueued for a specific station. If this number is not
2391 * zero when the station goes to sleep, the driver must call
2392 * this function to force mac80211 to consider the station to
2393 * be asleep regardless of the station's actual state. Once the
2394 * number of outstanding frames reaches zero, the driver must
2395 * call this function again to unblock the station. That will
2396 * cause mac80211 to be able to send ps-poll responses, and if
2397 * the station queried in the meantime then frames will also
2398 * be sent out as a result of this. Additionally, the driver
2399 * will be notified that the station woke up some time after
2400 * it is unblocked, regardless of whether the station actually
2401 * woke up while blocked or not.
2403 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2404 struct ieee80211_sta *pubsta, bool block);
2407 * ieee80211_beacon_loss - inform hardware does not receive beacons
2409 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2411 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and
2412 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2413 * hardware is not receiving beacons with this function.
2415 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2418 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2420 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2422 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and
2423 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2424 * needs to inform if the connection to the AP has been lost.
2426 * This function will cause immediate change to disassociated state,
2427 * without connection recovery attempts.
2429 void ieee80211_connection_loss(struct ieee80211_vif *vif);
2432 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2433 * rssi threshold triggered
2435 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2436 * @rssi_event: the RSSI trigger event type
2437 * @gfp: context flags
2439 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2440 * monitoring is configured with an rssi threshold, the driver will inform
2441 * whenever the rssi level reaches the threshold.
2443 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2444 enum nl80211_cqm_rssi_threshold_event rssi_event,
2447 /* Rate control API */
2450 * enum rate_control_changed - flags to indicate which parameter changed
2452 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2453 * changed, rate control algorithm can update its internal state if needed.
2455 enum rate_control_changed {
2456 IEEE80211_RC_HT_CHANGED = BIT(0)
2460 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2462 * @hw: The hardware the algorithm is invoked for.
2463 * @sband: The band this frame is being transmitted on.
2464 * @bss_conf: the current BSS configuration
2465 * @reported_rate: The rate control algorithm can fill this in to indicate
2466 * which rate should be reported to userspace as the current rate and
2467 * used for rate calculations in the mesh network.
2468 * @rts: whether RTS will be used for this frame because it is longer than the
2470 * @short_preamble: whether mac80211 will request short-preamble transmission
2471 * if the selected rate supports it
2472 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2473 * (deprecated; this will be removed once drivers get updated to use
2475 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2476 * @skb: the skb that will be transmitted, the control information in it needs
2478 * @ap: whether this frame is sent out in AP mode
2480 struct ieee80211_tx_rate_control {
2481 struct ieee80211_hw *hw;
2482 struct ieee80211_supported_band *sband;
2483 struct ieee80211_bss_conf *bss_conf;
2484 struct sk_buff *skb;
2485 struct ieee80211_tx_rate reported_rate;
2486 bool rts, short_preamble;
2492 struct rate_control_ops {
2493 struct module *module;
2495 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2496 void (*free)(void *priv);
2498 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2499 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2500 struct ieee80211_sta *sta, void *priv_sta);
2501 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2502 struct ieee80211_sta *sta,
2503 void *priv_sta, u32 changed,
2504 enum nl80211_channel_type oper_chan_type);
2505 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2508 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2509 struct ieee80211_sta *sta, void *priv_sta,
2510 struct sk_buff *skb);
2511 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2512 struct ieee80211_tx_rate_control *txrc);
2514 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2515 struct dentry *dir);
2516 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2519 static inline int rate_supported(struct ieee80211_sta *sta,
2520 enum ieee80211_band band,
2523 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2527 * rate_control_send_low - helper for drivers for management/no-ack frames
2529 * Rate control algorithms that agree to use the lowest rate to
2530 * send management frames and NO_ACK data with the respective hw
2531 * retries should use this in the beginning of their mac80211 get_rate
2532 * callback. If true is returned the rate control can simply return.
2533 * If false is returned we guarantee that sta and sta and priv_sta is
2536 * Rate control algorithms wishing to do more intelligent selection of
2537 * rate for multicast/broadcast frames may choose to not use this.
2539 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2540 * that this may be null.
2541 * @priv_sta: private rate control structure. This may be null.
2542 * @txrc: rate control information we sholud populate for mac80211.
2544 bool rate_control_send_low(struct ieee80211_sta *sta,
2546 struct ieee80211_tx_rate_control *txrc);
2550 rate_lowest_index(struct ieee80211_supported_band *sband,
2551 struct ieee80211_sta *sta)
2555 for (i = 0; i < sband->n_bitrates; i++)
2556 if (rate_supported(sta, sband->band, i))
2559 /* warn when we cannot find a rate. */
2566 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2567 struct ieee80211_sta *sta)
2571 for (i = 0; i < sband->n_bitrates; i++)
2572 if (rate_supported(sta, sband->band, i))
2577 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2578 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2581 conf_is_ht20(struct ieee80211_conf *conf)
2583 return conf->channel_type == NL80211_CHAN_HT20;
2587 conf_is_ht40_minus(struct ieee80211_conf *conf)
2589 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2593 conf_is_ht40_plus(struct ieee80211_conf *conf)
2595 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2599 conf_is_ht40(struct ieee80211_conf *conf)
2601 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2605 conf_is_ht(struct ieee80211_conf *conf)
2607 return conf->channel_type != NL80211_CHAN_NO_HT;
2610 #endif /* MAC80211_H */