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
149 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
150 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
151 * that it is only ever disabled for station mode.
152 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
154 enum ieee80211_bss_change {
155 BSS_CHANGED_ASSOC = 1<<0,
156 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
157 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
158 BSS_CHANGED_ERP_SLOT = 1<<3,
159 BSS_CHANGED_HT = 1<<4,
160 BSS_CHANGED_BASIC_RATES = 1<<5,
161 BSS_CHANGED_BEACON_INT = 1<<6,
162 BSS_CHANGED_BSSID = 1<<7,
163 BSS_CHANGED_BEACON = 1<<8,
164 BSS_CHANGED_BEACON_ENABLED = 1<<9,
165 BSS_CHANGED_CQM = 1<<10,
166 BSS_CHANGED_IBSS = 1<<11,
167 BSS_CHANGED_ARP_FILTER = 1<<12,
168 BSS_CHANGED_QOS = 1<<13,
169 BSS_CHANGED_IDLE = 1<<14,
171 /* when adding here, make sure to change ieee80211_reconfig */
175 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
176 * of addresses for an interface increase beyond this value, hardware ARP
177 * filtering will be disabled.
179 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
182 * struct ieee80211_bss_conf - holds the BSS's changing parameters
184 * This structure keeps information about a BSS (and an association
185 * to that BSS) that can change during the lifetime of the BSS.
187 * @assoc: association status
188 * @ibss_joined: indicates whether this station is part of an IBSS
190 * @aid: association ID number, valid only when @assoc is true
191 * @use_cts_prot: use CTS protection
192 * @use_short_preamble: use 802.11b short preamble;
193 * if the hardware cannot handle this it must set the
194 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
195 * @use_short_slot: use short slot time (only relevant for ERP);
196 * if the hardware cannot handle this it must set the
197 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
198 * @dtim_period: num of beacons before the next DTIM, for beaconing,
199 * valid in station mode only while @assoc is true and if also
200 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
202 * @timestamp: beacon timestamp
203 * @beacon_int: beacon interval
204 * @assoc_capability: capabilities taken from assoc resp
205 * @basic_rates: bitmap of basic rates, each bit stands for an
206 * index into the rate table configured by the driver in
208 * @bssid: The BSSID for this BSS
209 * @enable_beacon: whether beaconing should be enabled or not
210 * @channel_type: Channel type for this BSS -- the hardware might be
211 * configured for HT40+ while this BSS only uses no-HT, for
213 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
214 * This field is only valid when the channel type is one of the HT types.
215 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
217 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
218 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
219 * may filter ARP queries targeted for other addresses than listed here.
220 * The driver must allow ARP queries targeted for all address listed here
221 * to pass through. An empty list implies no ARP queries need to pass.
222 * @arp_addr_cnt: Number of addresses currently on the list.
223 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
224 * filter ARP queries based on the @arp_addr_list, if disabled, the
225 * hardware must not perform any ARP filtering. Note, that the filter will
226 * be enabled also in promiscuous mode.
227 * @qos: This is a QoS-enabled BSS.
228 * @idle: This interface is idle. There's also a global idle flag in the
229 * hardware config which may be more appropriate depending on what
230 * your driver/device needs to do.
232 struct ieee80211_bss_conf {
234 /* association related data */
235 bool assoc, ibss_joined;
237 /* erp related data */
239 bool use_short_preamble;
244 u16 assoc_capability;
247 u16 ht_operation_mode;
250 enum nl80211_channel_type channel_type;
251 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
253 bool arp_filter_enabled;
259 * enum mac80211_tx_control_flags - flags to describe transmission information/status
261 * These flags are used with the @flags member of &ieee80211_tx_info.
263 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
264 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
265 * number to this frame, taking care of not overwriting the fragment
266 * number and increasing the sequence number only when the
267 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
268 * assign sequence numbers to QoS-data frames but cannot do so correctly
269 * for non-QoS-data and management frames because beacons need them from
270 * that counter as well and mac80211 cannot guarantee proper sequencing.
271 * If this flag is set, the driver should instruct the hardware to
272 * assign a sequence number to the frame or assign one itself. Cf. IEEE
273 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
274 * beacons and always be clear for frames without a sequence number field.
275 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
276 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
278 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
279 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
280 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
281 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
282 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
283 * because the destination STA was in powersave mode. Note that to
284 * avoid race conditions, the filter must be set by the hardware or
285 * firmware upon receiving a frame that indicates that the station
286 * went to sleep (must be done on device to filter frames already on
287 * the queue) and may only be unset after mac80211 gives the OK for
288 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
289 * since only then is it guaranteed that no more frames are in the
291 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
292 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
293 * is for the whole aggregation.
294 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
295 * so consider using block ack request (BAR).
296 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
297 * set by rate control algorithms to indicate probe rate, will
298 * be cleared for fragmented frames (except on the last fragment)
299 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
300 * used to indicate that a pending frame requires TX processing before
301 * it can be sent out.
302 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
303 * used to indicate that a frame was already retried due to PS
304 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
305 * used to indicate frame should not be encrypted
306 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
307 * This frame is a response to a PS-poll frame and should be sent
308 * although the station is in powersave mode.
309 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
310 * transmit function after the current frame, this can be used
311 * by drivers to kick the DMA queue only if unset or when the
313 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
314 * after TX status because the destination was asleep, it must not
315 * be modified again (no seqno assignment, crypto, etc.)
316 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
317 * has a radiotap header at skb->data.
318 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
319 * MLME command (internal to mac80211 to figure out whether to send TX
320 * status to user space)
321 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
322 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
323 * frame and selects the maximum number of streams that it can use.
325 enum mac80211_tx_control_flags {
326 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
327 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
328 IEEE80211_TX_CTL_NO_ACK = BIT(2),
329 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
330 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
331 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
332 IEEE80211_TX_CTL_AMPDU = BIT(6),
333 IEEE80211_TX_CTL_INJECTED = BIT(7),
334 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
335 IEEE80211_TX_STAT_ACK = BIT(9),
336 IEEE80211_TX_STAT_AMPDU = BIT(10),
337 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
338 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
339 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
340 IEEE80211_TX_INTFL_RETRIED = BIT(15),
341 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
342 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
343 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
344 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
345 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
346 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
347 IEEE80211_TX_CTL_LDPC = BIT(22),
348 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
351 #define IEEE80211_TX_CTL_STBC_SHIFT 23
354 * enum mac80211_rate_control_flags - per-rate flags set by the
355 * Rate Control algorithm.
357 * These flags are set by the Rate control algorithm for each rate during tx,
358 * in the @flags member of struct ieee80211_tx_rate.
360 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
361 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
362 * This is set if the current BSS requires ERP protection.
363 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
364 * @IEEE80211_TX_RC_MCS: HT rate.
365 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
367 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
368 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
369 * adjacent 20 MHz channels, if the current channel type is
370 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
371 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
373 enum mac80211_rate_control_flags {
374 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
375 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
376 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
378 /* rate index is an MCS rate number instead of an index */
379 IEEE80211_TX_RC_MCS = BIT(3),
380 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
381 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
382 IEEE80211_TX_RC_DUP_DATA = BIT(6),
383 IEEE80211_TX_RC_SHORT_GI = BIT(7),
387 /* there are 40 bytes if you don't need the rateset to be kept */
388 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
390 /* if you do need the rateset, then you have less space */
391 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
393 /* maximum number of rate stages */
394 #define IEEE80211_TX_MAX_RATES 5
397 * struct ieee80211_tx_rate - rate selection/status
399 * @idx: rate index to attempt to send with
400 * @flags: rate control flags (&enum mac80211_rate_control_flags)
401 * @count: number of tries in this rate before going to the next rate
403 * A value of -1 for @idx indicates an invalid rate and, if used
404 * in an array of retry rates, that no more rates should be tried.
406 * When used for transmit status reporting, the driver should
407 * always report the rate along with the flags it used.
409 * &struct ieee80211_tx_info contains an array of these structs
410 * in the control information, and it will be filled by the rate
411 * control algorithm according to what should be sent. For example,
412 * if this array contains, in the format { <idx>, <count> } the
414 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
415 * then this means that the frame should be transmitted
416 * up to twice at rate 3, up to twice at rate 2, and up to four
417 * times at rate 1 if it doesn't get acknowledged. Say it gets
418 * acknowledged by the peer after the fifth attempt, the status
419 * information should then contain
420 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
421 * since it was transmitted twice at rate 3, twice at rate 2
422 * and once at rate 1 after which we received an acknowledgement.
424 struct ieee80211_tx_rate {
431 * struct ieee80211_tx_info - skb transmit information
433 * This structure is placed in skb->cb for three uses:
434 * (1) mac80211 TX control - mac80211 tells the driver what to do
435 * (2) driver internal use (if applicable)
436 * (3) TX status information - driver tells mac80211 what happened
438 * The TX control's sta pointer is only valid during the ->tx call,
441 * @flags: transmit info flags, defined above
442 * @band: the band to transmit on (use for checking for races)
443 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
444 * @pad: padding, ignore
445 * @control: union for control data
446 * @status: union for status data
447 * @driver_data: array of driver_data pointers
448 * @ampdu_ack_len: number of acked aggregated frames.
449 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
450 * @ampdu_len: number of aggregated frames.
451 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
452 * @ack_signal: signal strength of the ACK frame
454 struct ieee80211_tx_info {
455 /* common information */
469 struct ieee80211_tx_rate rates[
470 IEEE80211_TX_MAX_RATES];
473 /* only needed before rate control */
474 unsigned long jiffies;
476 /* NB: vif can be NULL for injected frames */
477 struct ieee80211_vif *vif;
478 struct ieee80211_key_conf *hw_key;
479 struct ieee80211_sta *sta;
482 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
489 struct ieee80211_tx_rate driver_rates[
490 IEEE80211_TX_MAX_RATES];
491 void *rate_driver_data[
492 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
495 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
499 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
501 return (struct ieee80211_tx_info *)skb->cb;
504 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
506 return (struct ieee80211_rx_status *)skb->cb;
510 * ieee80211_tx_info_clear_status - clear TX status
512 * @info: The &struct ieee80211_tx_info to be cleared.
514 * When the driver passes an skb back to mac80211, it must report
515 * a number of things in TX status. This function clears everything
516 * in the TX status but the rate control information (it does clear
517 * the count since you need to fill that in anyway).
519 * NOTE: You can only use this function if you do NOT use
520 * info->driver_data! Use info->rate_driver_data
521 * instead if you need only the less space that allows.
524 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
528 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
529 offsetof(struct ieee80211_tx_info, control.rates));
530 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
531 offsetof(struct ieee80211_tx_info, driver_rates));
532 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
533 /* clear the rate counts */
534 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
535 info->status.rates[i].count = 0;
538 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
539 memset(&info->status.ampdu_ack_len, 0,
540 sizeof(struct ieee80211_tx_info) -
541 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
546 * enum mac80211_rx_flags - receive flags
548 * These flags are used with the @flag member of &struct ieee80211_rx_status.
549 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
550 * Use together with %RX_FLAG_MMIC_STRIPPED.
551 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
552 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
553 * verification has been done by the hardware.
554 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
555 * If this flag is set, the stack cannot do any replay detection
556 * hence the driver or hardware will have to do that.
557 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
559 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
561 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
562 * is valid. This is useful in monitor mode and necessary for beacon frames
563 * to enable IBSS merging.
564 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
565 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
566 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
567 * @RX_FLAG_SHORT_GI: Short guard interval was used
568 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
569 * on cooked monitor to avoid double-reporting it for multiple
572 enum mac80211_rx_flags {
573 RX_FLAG_MMIC_ERROR = 1<<0,
574 RX_FLAG_DECRYPTED = 1<<1,
575 RX_FLAG_MMIC_STRIPPED = 1<<3,
576 RX_FLAG_IV_STRIPPED = 1<<4,
577 RX_FLAG_FAILED_FCS_CRC = 1<<5,
578 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
580 RX_FLAG_SHORTPRE = 1<<8,
582 RX_FLAG_40MHZ = 1<<10,
583 RX_FLAG_SHORT_GI = 1<<11,
584 RX_FLAG_INTERNAL_CMTR = 1<<12,
588 * struct ieee80211_rx_status - receive status
590 * The low-level driver should provide this information (the subset
591 * supported by hardware) to the 802.11 code with each received
592 * frame, in the skb's control buffer (cb).
594 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
595 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
596 * @band: the active band when this frame was received
597 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
598 * @signal: signal strength when receiving this frame, either in dBm, in dB or
599 * unspecified depending on the hardware capabilities flags
600 * @IEEE80211_HW_SIGNAL_*
601 * @antenna: antenna used
602 * @rate_idx: index of data rate into band's supported rates or MCS index if
603 * HT rates are use (RX_FLAG_HT)
606 struct ieee80211_rx_status {
608 enum ieee80211_band band;
617 * enum ieee80211_conf_flags - configuration flags
619 * Flags to define PHY configuration options
621 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
622 * to determine for example whether to calculate timestamps for packets
623 * or not, do not use instead of filter flags!
624 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
625 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
626 * meaning that the hardware still wakes up for beacons, is able to
627 * transmit frames and receive the possible acknowledgment frames.
628 * Not to be confused with hardware specific wakeup/sleep states,
629 * driver is responsible for that. See the section "Powersave support"
631 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
632 * the driver should be prepared to handle configuration requests but
633 * may turn the device off as much as possible. Typically, this flag will
634 * be set when an interface is set UP but not associated or scanning, but
635 * it can also be unset in that case when monitor interfaces are active.
636 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
639 enum ieee80211_conf_flags {
640 IEEE80211_CONF_MONITOR = (1<<0),
641 IEEE80211_CONF_PS = (1<<1),
642 IEEE80211_CONF_IDLE = (1<<2),
643 IEEE80211_CONF_OFFCHANNEL = (1<<3),
648 * enum ieee80211_conf_changed - denotes which configuration changed
650 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
651 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
652 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
653 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
654 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
655 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
656 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
657 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
659 enum ieee80211_conf_changed {
660 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
661 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
662 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
663 IEEE80211_CONF_CHANGE_PS = BIT(4),
664 IEEE80211_CONF_CHANGE_POWER = BIT(5),
665 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
666 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
667 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
671 * enum ieee80211_smps_mode - spatial multiplexing power save mode
673 * @IEEE80211_SMPS_AUTOMATIC: automatic
674 * @IEEE80211_SMPS_OFF: off
675 * @IEEE80211_SMPS_STATIC: static
676 * @IEEE80211_SMPS_DYNAMIC: dynamic
677 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
679 enum ieee80211_smps_mode {
680 IEEE80211_SMPS_AUTOMATIC,
682 IEEE80211_SMPS_STATIC,
683 IEEE80211_SMPS_DYNAMIC,
686 IEEE80211_SMPS_NUM_MODES,
690 * struct ieee80211_conf - configuration of the device
692 * This struct indicates how the driver shall configure the hardware.
694 * @flags: configuration flags defined above
696 * @listen_interval: listen interval in units of beacon interval
697 * @max_sleep_period: the maximum number of beacon intervals to sleep for
698 * before checking the beacon for a TIM bit (managed mode only); this
699 * value will be only achievable between DTIM frames, the hardware
700 * needs to check for the multicast traffic bit in DTIM beacons.
701 * This variable is valid only when the CONF_PS flag is set.
702 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
703 * in power saving. Power saving will not be enabled until a beacon
704 * has been received and the DTIM period is known.
705 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
706 * powersave documentation below. This variable is valid only when
707 * the CONF_PS flag is set.
709 * @power_level: requested transmit power (in dBm)
711 * @channel: the channel to tune to
712 * @channel_type: the channel (HT) type
714 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
715 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
716 * but actually means the number of transmissions not the number of retries
717 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
718 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
719 * number of transmissions not the number of retries
721 * @smps_mode: spatial multiplexing powersave mode; note that
722 * %IEEE80211_SMPS_STATIC is used when the device is not
723 * configured for an HT channel
725 struct ieee80211_conf {
727 int power_level, dynamic_ps_timeout;
728 int max_sleep_period;
733 u8 long_frame_max_tx_count, short_frame_max_tx_count;
735 struct ieee80211_channel *channel;
736 enum nl80211_channel_type channel_type;
737 enum ieee80211_smps_mode smps_mode;
741 * struct ieee80211_channel_switch - holds the channel switch data
743 * The information provided in this structure is required for channel switch
746 * @timestamp: value in microseconds of the 64-bit Time Synchronization
747 * Function (TSF) timer when the frame containing the channel switch
748 * announcement was received. This is simply the rx.mactime parameter
749 * the driver passed into mac80211.
750 * @block_tx: Indicates whether transmission must be blocked before the
751 * scheduled channel switch, as indicated by the AP.
752 * @channel: the new channel to switch to
753 * @count: the number of TBTT's until the channel switch event
755 struct ieee80211_channel_switch {
758 struct ieee80211_channel *channel;
763 * struct ieee80211_vif - per-interface data
765 * Data in this structure is continually present for driver
766 * use during the life of a virtual interface.
768 * @type: type of this virtual interface
769 * @bss_conf: BSS configuration for this interface, either our own
770 * or the BSS we're associated to
771 * @addr: address of this interface
772 * @drv_priv: data area for driver use, will always be aligned to
775 struct ieee80211_vif {
776 enum nl80211_iftype type;
777 struct ieee80211_bss_conf bss_conf;
780 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
783 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
785 #ifdef CONFIG_MAC80211_MESH
786 return vif->type == NL80211_IFTYPE_MESH_POINT;
792 * enum ieee80211_key_flags - key flags
794 * These flags are used for communication about keys between the driver
795 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
797 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
798 * that the STA this key will be used with could be using QoS.
799 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
800 * driver to indicate that it requires IV generation for this
802 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
803 * the driver for a TKIP key if it requires Michael MIC
804 * generation in software.
805 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
806 * that the key is pairwise rather then a shared key.
807 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
808 * CCMP key if it requires CCMP encryption of management frames (MFP) to
809 * be done in software.
811 enum ieee80211_key_flags {
812 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
813 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
814 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
815 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
816 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
820 * struct ieee80211_key_conf - key information
822 * This key information is given by mac80211 to the driver by
823 * the set_key() callback in &struct ieee80211_ops.
825 * @hw_key_idx: To be set by the driver, this is the key index the driver
826 * wants to be given when a frame is transmitted and needs to be
827 * encrypted in hardware.
828 * @cipher: The key's cipher suite selector.
829 * @flags: key flags, see &enum ieee80211_key_flags.
830 * @keyidx: the key index (0-3)
831 * @keylen: key material length
832 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
834 * - Temporal Encryption Key (128 bits)
835 * - Temporal Authenticator Tx MIC Key (64 bits)
836 * - Temporal Authenticator Rx MIC Key (64 bits)
837 * @icv_len: The ICV length for this key type
838 * @iv_len: The IV length for this key type
840 struct ieee80211_key_conf {
852 * enum set_key_cmd - key command
854 * Used with the set_key() callback in &struct ieee80211_ops, this
855 * indicates whether a key is being removed or added.
857 * @SET_KEY: a key is set
858 * @DISABLE_KEY: a key must be disabled
861 SET_KEY, DISABLE_KEY,
865 * struct ieee80211_sta - station table entry
867 * A station table entry represents a station we are possibly
868 * communicating with. Since stations are RCU-managed in
869 * mac80211, any ieee80211_sta pointer you get access to must
870 * either be protected by rcu_read_lock() explicitly or implicitly,
871 * or you must take good care to not use such a pointer after a
872 * call to your sta_remove callback that removed it.
875 * @aid: AID we assigned to the station if we're an AP
876 * @supp_rates: Bitmap of supported rates (per band)
877 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
878 * @drv_priv: data area for driver use, will always be aligned to
879 * sizeof(void *), size is determined in hw information.
881 struct ieee80211_sta {
882 u32 supp_rates[IEEE80211_NUM_BANDS];
885 struct ieee80211_sta_ht_cap ht_cap;
888 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
892 * enum sta_notify_cmd - sta notify command
894 * Used with the sta_notify() callback in &struct ieee80211_ops, this
895 * indicates if an associated station made a power state transition.
897 * @STA_NOTIFY_SLEEP: a station is now sleeping
898 * @STA_NOTIFY_AWAKE: a sleeping station woke up
900 enum sta_notify_cmd {
901 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
905 * enum ieee80211_tkip_key_type - get tkip key
907 * Used by drivers which need to get a tkip key for skb. Some drivers need a
908 * phase 1 key, others need a phase 2 key. A single function allows the driver
909 * to get the key, this enum indicates what type of key is required.
911 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
912 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
914 enum ieee80211_tkip_key_type {
915 IEEE80211_TKIP_P1_KEY,
916 IEEE80211_TKIP_P2_KEY,
920 * enum ieee80211_hw_flags - hardware flags
922 * These flags are used to indicate hardware capabilities to
923 * the stack. Generally, flags here should have their meaning
924 * done in a way that the simplest hardware doesn't need setting
925 * any particular flags. There are some exceptions to this rule,
926 * however, so you are advised to review these flags carefully.
928 * @IEEE80211_HW_HAS_RATE_CONTROL:
929 * The hardware or firmware includes rate control, and cannot be
930 * controlled by the stack. As such, no rate control algorithm
931 * should be instantiated, and the TX rate reported to userspace
932 * will be taken from the TX status instead of the rate control
934 * Note that this requires that the driver implement a number of
935 * callbacks so it has the correct information, it needs to have
936 * the @set_rts_threshold callback and must look at the BSS config
937 * @use_cts_prot for G/N protection, @use_short_slot for slot
938 * timing in 2.4 GHz and @use_short_preamble for preambles for
941 * @IEEE80211_HW_RX_INCLUDES_FCS:
942 * Indicates that received frames passed to the stack include
943 * the FCS at the end.
945 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
946 * Some wireless LAN chipsets buffer broadcast/multicast frames
947 * for power saving stations in the hardware/firmware and others
948 * rely on the host system for such buffering. This option is used
949 * to configure the IEEE 802.11 upper layer to buffer broadcast and
950 * multicast frames when there are power saving stations so that
951 * the driver can fetch them with ieee80211_get_buffered_bc().
953 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
954 * Hardware is not capable of short slot operation on the 2.4 GHz band.
956 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
957 * Hardware is not capable of receiving frames with short preamble on
960 * @IEEE80211_HW_SIGNAL_UNSPEC:
961 * Hardware can provide signal values but we don't know its units. We
962 * expect values between 0 and @max_signal.
963 * If possible please provide dB or dBm instead.
965 * @IEEE80211_HW_SIGNAL_DBM:
966 * Hardware gives signal values in dBm, decibel difference from
967 * one milliwatt. This is the preferred method since it is standardized
968 * between different devices. @max_signal does not need to be set.
970 * @IEEE80211_HW_SPECTRUM_MGMT:
971 * Hardware supports spectrum management defined in 802.11h
972 * Measurement, Channel Switch, Quieting, TPC
974 * @IEEE80211_HW_AMPDU_AGGREGATION:
975 * Hardware supports 11n A-MPDU aggregation.
977 * @IEEE80211_HW_SUPPORTS_PS:
978 * Hardware has power save support (i.e. can go to sleep).
980 * @IEEE80211_HW_PS_NULLFUNC_STACK:
981 * Hardware requires nullfunc frame handling in stack, implies
982 * stack support for dynamic PS.
984 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
985 * Hardware has support for dynamic PS.
987 * @IEEE80211_HW_MFP_CAPABLE:
988 * Hardware supports management frame protection (MFP, IEEE 802.11w).
990 * @IEEE80211_HW_BEACON_FILTER:
991 * Hardware supports dropping of irrelevant beacon frames to
992 * avoid waking up cpu.
994 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
995 * Hardware supports static spatial multiplexing powersave,
996 * ie. can turn off all but one chain even on HT connections
997 * that should be using more chains.
999 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1000 * Hardware supports dynamic spatial multiplexing powersave,
1001 * ie. can turn off all but one chain and then wake the rest
1002 * up as required after, for example, rts/cts handshake.
1004 * @IEEE80211_HW_SUPPORTS_UAPSD:
1005 * Hardware supports Unscheduled Automatic Power Save Delivery
1006 * (U-APSD) in managed mode. The mode is configured with
1007 * conf_tx() operation.
1009 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1010 * Hardware can provide ack status reports of Tx frames to
1013 * @IEEE80211_HW_CONNECTION_MONITOR:
1014 * The hardware performs its own connection monitoring, including
1015 * periodic keep-alives to the AP and probing the AP on beacon loss.
1016 * When this flag is set, signaling beacon-loss will cause an immediate
1017 * change to disassociated state.
1019 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1020 * Hardware can do connection quality monitoring - i.e. it can monitor
1021 * connection quality related parameters, such as the RSSI level and
1022 * provide notifications if configured trigger levels are reached.
1024 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1025 * This device needs to know the DTIM period for the BSS before
1028 enum ieee80211_hw_flags {
1029 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1030 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1031 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1032 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1033 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1034 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1035 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1036 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1037 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1038 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1039 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1040 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1041 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1042 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1043 IEEE80211_HW_BEACON_FILTER = 1<<14,
1044 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1045 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1046 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1047 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1048 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1049 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1053 * struct ieee80211_hw - hardware information and state
1055 * This structure contains the configuration and hardware
1056 * information for an 802.11 PHY.
1058 * @wiphy: This points to the &struct wiphy allocated for this
1059 * 802.11 PHY. You must fill in the @perm_addr and @dev
1060 * members of this structure using SET_IEEE80211_DEV()
1061 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1062 * bands (with channels, bitrates) are registered here.
1064 * @conf: &struct ieee80211_conf, device configuration, don't use.
1066 * @priv: pointer to private area that was allocated for driver use
1067 * along with this structure.
1069 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1071 * @extra_tx_headroom: headroom to reserve in each transmit skb
1072 * for use by the driver (e.g. for transmit headers.)
1074 * @channel_change_time: time (in microseconds) it takes to change channels.
1076 * @max_signal: Maximum value for signal (rssi) in RX information, used
1077 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1079 * @max_listen_interval: max listen interval in units of beacon interval
1082 * @queues: number of available hardware transmit queues for
1083 * data packets. WMM/QoS requires at least four, these
1084 * queues need to have configurable access parameters.
1086 * @rate_control_algorithm: rate control algorithm for this hardware.
1087 * If unset (NULL), the default algorithm will be used. Must be
1088 * set before calling ieee80211_register_hw().
1090 * @vif_data_size: size (in bytes) of the drv_priv data area
1091 * within &struct ieee80211_vif.
1092 * @sta_data_size: size (in bytes) of the drv_priv data area
1093 * within &struct ieee80211_sta.
1095 * @max_rates: maximum number of alternate rate retry stages
1096 * @max_rate_tries: maximum number of tries for each stage
1098 * @napi_weight: weight used for NAPI polling. You must specify an
1099 * appropriate value here if a napi_poll operation is provided
1102 struct ieee80211_hw {
1103 struct ieee80211_conf conf;
1104 struct wiphy *wiphy;
1105 const char *rate_control_algorithm;
1108 unsigned int extra_tx_headroom;
1109 int channel_change_time;
1114 u16 max_listen_interval;
1121 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1123 * @wiphy: the &struct wiphy which we want to query
1125 * mac80211 drivers can use this to get to their respective
1126 * &struct ieee80211_hw. Drivers wishing to get to their own private
1127 * structure can then access it via hw->priv. Note that mac802111 drivers should
1128 * not use wiphy_priv() to try to get their private driver structure as this
1129 * is already used internally by mac80211.
1131 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1134 * SET_IEEE80211_DEV - set device for 802.11 hardware
1136 * @hw: the &struct ieee80211_hw to set the device for
1137 * @dev: the &struct device of this 802.11 device
1139 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1141 set_wiphy_dev(hw->wiphy, dev);
1145 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1147 * @hw: the &struct ieee80211_hw to set the MAC address for
1148 * @addr: the address to set
1150 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1152 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1155 static inline struct ieee80211_rate *
1156 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1157 const struct ieee80211_tx_info *c)
1159 if (WARN_ON(c->control.rates[0].idx < 0))
1161 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1164 static inline struct ieee80211_rate *
1165 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1166 const struct ieee80211_tx_info *c)
1168 if (c->control.rts_cts_rate_idx < 0)
1170 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1173 static inline struct ieee80211_rate *
1174 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1175 const struct ieee80211_tx_info *c, int idx)
1177 if (c->control.rates[idx + 1].idx < 0)
1179 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1183 * DOC: Hardware crypto acceleration
1185 * mac80211 is capable of taking advantage of many hardware
1186 * acceleration designs for encryption and decryption operations.
1188 * The set_key() callback in the &struct ieee80211_ops for a given
1189 * device is called to enable hardware acceleration of encryption and
1190 * decryption. The callback takes a @sta parameter that will be NULL
1191 * for default keys or keys used for transmission only, or point to
1192 * the station information for the peer for individual keys.
1193 * Multiple transmission keys with the same key index may be used when
1194 * VLANs are configured for an access point.
1196 * When transmitting, the TX control data will use the @hw_key_idx
1197 * selected by the driver by modifying the &struct ieee80211_key_conf
1198 * pointed to by the @key parameter to the set_key() function.
1200 * The set_key() call for the %SET_KEY command should return 0 if
1201 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1202 * added; if you return 0 then hw_key_idx must be assigned to the
1203 * hardware key index, you are free to use the full u8 range.
1205 * When the cmd is %DISABLE_KEY then it must succeed.
1207 * Note that it is permissible to not decrypt a frame even if a key
1208 * for it has been uploaded to hardware, the stack will not make any
1209 * decision based on whether a key has been uploaded or not but rather
1210 * based on the receive flags.
1212 * The &struct ieee80211_key_conf structure pointed to by the @key
1213 * parameter is guaranteed to be valid until another call to set_key()
1214 * removes it, but it can only be used as a cookie to differentiate
1217 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1218 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1220 * The update_tkip_key() call updates the driver with the new phase 1 key.
1221 * This happens everytime the iv16 wraps around (every 65536 packets). The
1222 * set_key() call will happen only once for each key (unless the AP did
1223 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1224 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1225 * handler is software decryption with wrap around of iv16.
1229 * DOC: Powersave support
1231 * mac80211 has support for various powersave implementations.
1233 * First, it can support hardware that handles all powersaving by itself,
1234 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1235 * flag. In that case, it will be told about the desired powersave mode
1236 * with the %IEEE80211_CONF_PS flag depending on the association status.
1237 * The hardware must take care of sending nullfunc frames when necessary,
1238 * i.e. when entering and leaving powersave mode. The hardware is required
1239 * to look at the AID in beacons and signal to the AP that it woke up when
1240 * it finds traffic directed to it.
1242 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1243 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1244 * with hardware wakeup and sleep states. Driver is responsible for waking
1245 * up the hardware before issuing commands to the hardware and putting it
1246 * back to sleep at appropriate times.
1248 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1249 * buffered multicast/broadcast frames after the beacon. Also it must be
1250 * possible to send frames and receive the acknowledment frame.
1252 * Other hardware designs cannot send nullfunc frames by themselves and also
1253 * need software support for parsing the TIM bitmap. This is also supported
1254 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1255 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1256 * required to pass up beacons. The hardware is still required to handle
1257 * waking up for multicast traffic; if it cannot the driver must handle that
1258 * as best as it can, mac80211 is too slow to do that.
1260 * Dynamic powersave is an extension to normal powersave in which the
1261 * hardware stays awake for a user-specified period of time after sending a
1262 * frame so that reply frames need not be buffered and therefore delayed to
1263 * the next wakeup. It's compromise of getting good enough latency when
1264 * there's data traffic and still saving significantly power in idle
1267 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1268 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1269 * flag and mac80211 will handle everything automatically. Additionally,
1270 * hardware having support for the dynamic PS feature may set the
1271 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1272 * dynamic PS mode itself. The driver needs to look at the
1273 * @dynamic_ps_timeout hardware configuration value and use it that value
1274 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1275 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1276 * enabled whenever user has enabled powersave.
1278 * Some hardware need to toggle a single shared antenna between WLAN and
1279 * Bluetooth to facilitate co-existence. These types of hardware set
1280 * limitations on the use of host controlled dynamic powersave whenever there
1281 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1282 * driver may request temporarily going into full power save, in order to
1283 * enable toggling the antenna between BT and WLAN. If the driver requests
1284 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1285 * temporarily set to zero until the driver re-enables dynamic powersave.
1287 * Driver informs U-APSD client support by enabling
1288 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1289 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1290 * Nullfunc frames and stay awake until the service period has ended. To
1291 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1292 * from that AC are transmitted with powersave enabled.
1294 * Note: U-APSD client mode is not yet supported with
1295 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1299 * DOC: Beacon filter support
1301 * Some hardware have beacon filter support to reduce host cpu wakeups
1302 * which will reduce system power consumption. It usuallly works so that
1303 * the firmware creates a checksum of the beacon but omits all constantly
1304 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1305 * beacon is forwarded to the host, otherwise it will be just dropped. That
1306 * way the host will only receive beacons where some relevant information
1307 * (for example ERP protection or WMM settings) have changed.
1309 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1310 * hardware capability. The driver needs to enable beacon filter support
1311 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1312 * power save is enabled, the stack will not check for beacon loss and the
1313 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1315 * The time (or number of beacons missed) until the firmware notifies the
1316 * driver of a beacon loss event (which in turn causes the driver to call
1317 * ieee80211_beacon_loss()) should be configurable and will be controlled
1318 * by mac80211 and the roaming algorithm in the future.
1320 * Since there may be constantly changing information elements that nothing
1321 * in the software stack cares about, we will, in the future, have mac80211
1322 * tell the driver which information elements are interesting in the sense
1323 * that we want to see changes in them. This will include
1324 * - a list of information element IDs
1325 * - a list of OUIs for the vendor information element
1327 * Ideally, the hardware would filter out any beacons without changes in the
1328 * requested elements, but if it cannot support that it may, at the expense
1329 * of some efficiency, filter out only a subset. For example, if the device
1330 * doesn't support checking for OUIs it should pass up all changes in all
1331 * vendor information elements.
1333 * Note that change, for the sake of simplification, also includes information
1334 * elements appearing or disappearing from the beacon.
1336 * Some hardware supports an "ignore list" instead, just make sure nothing
1337 * that was requested is on the ignore list, and include commonly changing
1338 * information element IDs in the ignore list, for example 11 (BSS load) and
1339 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1340 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1341 * it could also include some currently unused IDs.
1344 * In addition to these capabilities, hardware should support notifying the
1345 * host of changes in the beacon RSSI. This is relevant to implement roaming
1346 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1347 * the received data packets). This can consist in notifying the host when
1348 * the RSSI changes significantly or when it drops below or rises above
1349 * configurable thresholds. In the future these thresholds will also be
1350 * configured by mac80211 (which gets them from userspace) to implement
1351 * them as the roaming algorithm requires.
1353 * If the hardware cannot implement this, the driver should ask it to
1354 * periodically pass beacon frames to the host so that software can do the
1355 * signal strength threshold checking.
1359 * DOC: Spatial multiplexing power save
1361 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1362 * power in an 802.11n implementation. For details on the mechanism
1363 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1364 * "11.2.3 SM power save".
1366 * The mac80211 implementation is capable of sending action frames
1367 * to update the AP about the station's SMPS mode, and will instruct
1368 * the driver to enter the specific mode. It will also announce the
1369 * requested SMPS mode during the association handshake. Hardware
1370 * support for this feature is required, and can be indicated by
1373 * The default mode will be "automatic", which nl80211/cfg80211
1374 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1375 * turned off otherwise.
1377 * To support this feature, the driver must set the appropriate
1378 * hardware support flags, and handle the SMPS flag to the config()
1379 * operation. It will then with this mechanism be instructed to
1380 * enter the requested SMPS mode while associated to an HT AP.
1384 * DOC: Frame filtering
1386 * mac80211 requires to see many management frames for proper
1387 * operation, and users may want to see many more frames when
1388 * in monitor mode. However, for best CPU usage and power consumption,
1389 * having as few frames as possible percolate through the stack is
1390 * desirable. Hence, the hardware should filter as much as possible.
1392 * To achieve this, mac80211 uses filter flags (see below) to tell
1393 * the driver's configure_filter() function which frames should be
1394 * passed to mac80211 and which should be filtered out.
1396 * Before configure_filter() is invoked, the prepare_multicast()
1397 * callback is invoked with the parameters @mc_count and @mc_list
1398 * for the combined multicast address list of all virtual interfaces.
1399 * It's use is optional, and it returns a u64 that is passed to
1400 * configure_filter(). Additionally, configure_filter() has the
1401 * arguments @changed_flags telling which flags were changed and
1402 * @total_flags with the new flag states.
1404 * If your device has no multicast address filters your driver will
1405 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1406 * parameter to see whether multicast frames should be accepted
1409 * All unsupported flags in @total_flags must be cleared.
1410 * Hardware does not support a flag if it is incapable of _passing_
1411 * the frame to the stack. Otherwise the driver must ignore
1412 * the flag, but not clear it.
1413 * You must _only_ clear the flag (announce no support for the
1414 * flag to mac80211) if you are not able to pass the packet type
1415 * to the stack (so the hardware always filters it).
1416 * So for example, you should clear @FIF_CONTROL, if your hardware
1417 * always filters control frames. If your hardware always passes
1418 * control frames to the kernel and is incapable of filtering them,
1419 * you do _not_ clear the @FIF_CONTROL flag.
1420 * This rule applies to all other FIF flags as well.
1424 * enum ieee80211_filter_flags - hardware filter flags
1426 * These flags determine what the filter in hardware should be
1427 * programmed to let through and what should not be passed to the
1428 * stack. It is always safe to pass more frames than requested,
1429 * but this has negative impact on power consumption.
1431 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1432 * think of the BSS as your network segment and then this corresponds
1433 * to the regular ethernet device promiscuous mode.
1435 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1436 * by the user or if the hardware is not capable of filtering by
1437 * multicast address.
1439 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1440 * %RX_FLAG_FAILED_FCS_CRC for them)
1442 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1443 * the %RX_FLAG_FAILED_PLCP_CRC for them
1445 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1446 * to the hardware that it should not filter beacons or probe responses
1447 * by BSSID. Filtering them can greatly reduce the amount of processing
1448 * mac80211 needs to do and the amount of CPU wakeups, so you should
1449 * honour this flag if possible.
1451 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1452 * is not set then only those addressed to this station.
1454 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1456 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1457 * those addressed to this station.
1459 enum ieee80211_filter_flags {
1460 FIF_PROMISC_IN_BSS = 1<<0,
1461 FIF_ALLMULTI = 1<<1,
1463 FIF_PLCPFAIL = 1<<3,
1464 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1466 FIF_OTHER_BSS = 1<<6,
1471 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1473 * These flags are used with the ampdu_action() callback in
1474 * &struct ieee80211_ops to indicate which action is needed.
1476 * Note that drivers MUST be able to deal with a TX aggregation
1477 * session being stopped even before they OK'ed starting it by
1478 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1479 * might receive the addBA frame and send a delBA right away!
1481 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1482 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1483 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1484 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1485 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1487 enum ieee80211_ampdu_mlme_action {
1488 IEEE80211_AMPDU_RX_START,
1489 IEEE80211_AMPDU_RX_STOP,
1490 IEEE80211_AMPDU_TX_START,
1491 IEEE80211_AMPDU_TX_STOP,
1492 IEEE80211_AMPDU_TX_OPERATIONAL,
1496 * struct ieee80211_ops - callbacks from mac80211 to the driver
1498 * This structure contains various callbacks that the driver may
1499 * handle or, in some cases, must handle, for example to configure
1500 * the hardware to a new channel or to transmit a frame.
1502 * @tx: Handler that 802.11 module calls for each transmitted frame.
1503 * skb contains the buffer starting from the IEEE 802.11 header.
1504 * The low-level driver should send the frame out based on
1505 * configuration in the TX control data. This handler should,
1506 * preferably, never fail and stop queues appropriately, more
1507 * importantly, however, it must never fail for A-MPDU-queues.
1508 * This function should return NETDEV_TX_OK except in very
1510 * Must be implemented and atomic.
1512 * @start: Called before the first netdevice attached to the hardware
1513 * is enabled. This should turn on the hardware and must turn on
1514 * frame reception (for possibly enabled monitor interfaces.)
1515 * Returns negative error codes, these may be seen in userspace,
1517 * When the device is started it should not have a MAC address
1518 * to avoid acknowledging frames before a non-monitor device
1520 * Must be implemented and can sleep.
1522 * @stop: Called after last netdevice attached to the hardware
1523 * is disabled. This should turn off the hardware (at least
1524 * it must turn off frame reception.)
1525 * May be called right after add_interface if that rejects
1526 * an interface. If you added any work onto the mac80211 workqueue
1527 * you should ensure to cancel it on this callback.
1528 * Must be implemented and can sleep.
1530 * @add_interface: Called when a netdevice attached to the hardware is
1531 * enabled. Because it is not called for monitor mode devices, @start
1532 * and @stop must be implemented.
1533 * The driver should perform any initialization it needs before
1534 * the device can be enabled. The initial configuration for the
1535 * interface is given in the conf parameter.
1536 * The callback may refuse to add an interface by returning a
1537 * negative error code (which will be seen in userspace.)
1538 * Must be implemented and can sleep.
1540 * @change_interface: Called when a netdevice changes type. This callback
1541 * is optional, but only if it is supported can interface types be
1542 * switched while the interface is UP. The callback may sleep.
1543 * Note that while an interface is being switched, it will not be
1544 * found by the interface iteration callbacks.
1546 * @remove_interface: Notifies a driver that an interface is going down.
1547 * The @stop callback is called after this if it is the last interface
1548 * and no monitor interfaces are present.
1549 * When all interfaces are removed, the MAC address in the hardware
1550 * must be cleared so the device no longer acknowledges packets,
1551 * the mac_addr member of the conf structure is, however, set to the
1552 * MAC address of the device going away.
1553 * Hence, this callback must be implemented. It can sleep.
1555 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1556 * function to change hardware configuration, e.g., channel.
1557 * This function should never fail but returns a negative error code
1558 * if it does. The callback can sleep.
1560 * @bss_info_changed: Handler for configuration requests related to BSS
1561 * parameters that may vary during BSS's lifespan, and may affect low
1562 * level driver (e.g. assoc/disassoc status, erp parameters).
1563 * This function should not be used if no BSS has been set, unless
1564 * for association indication. The @changed parameter indicates which
1565 * of the bss parameters has changed when a call is made. The callback
1568 * @prepare_multicast: Prepare for multicast filter configuration.
1569 * This callback is optional, and its return value is passed
1570 * to configure_filter(). This callback must be atomic.
1572 * @configure_filter: Configure the device's RX filter.
1573 * See the section "Frame filtering" for more information.
1574 * This callback must be implemented and can sleep.
1576 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1577 * must be set or cleared for a given STA. Must be atomic.
1579 * @set_key: See the section "Hardware crypto acceleration"
1580 * This callback is only called between add_interface and
1581 * remove_interface calls, i.e. while the given virtual interface
1583 * Returns a negative error code if the key can't be added.
1584 * The callback can sleep.
1586 * @update_tkip_key: See the section "Hardware crypto acceleration"
1587 * This callback will be called in the context of Rx. Called for drivers
1588 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1589 * The callback must be atomic.
1591 * @hw_scan: Ask the hardware to service the scan request, no need to start
1592 * the scan state machine in stack. The scan must honour the channel
1593 * configuration done by the regulatory agent in the wiphy's
1594 * registered bands. The hardware (or the driver) needs to make sure
1595 * that power save is disabled.
1596 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1597 * entire IEs after the SSID, so that drivers need not look at these
1598 * at all but just send them after the SSID -- mac80211 includes the
1599 * (extended) supported rates and HT information (where applicable).
1600 * When the scan finishes, ieee80211_scan_completed() must be called;
1601 * note that it also must be called when the scan cannot finish due to
1602 * any error unless this callback returned a negative error code.
1603 * The callback can sleep.
1605 * @sw_scan_start: Notifier function that is called just before a software scan
1606 * is started. Can be NULL, if the driver doesn't need this notification.
1607 * The callback can sleep.
1609 * @sw_scan_complete: Notifier function that is called just after a
1610 * software scan finished. Can be NULL, if the driver doesn't need
1611 * this notification.
1612 * The callback can sleep.
1614 * @get_stats: Return low-level statistics.
1615 * Returns zero if statistics are available.
1616 * The callback can sleep.
1618 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1619 * callback should be provided to read the TKIP transmit IVs (both IV32
1620 * and IV16) for the given key from hardware.
1621 * The callback must be atomic.
1623 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1624 * The callback can sleep.
1626 * @sta_add: Notifies low level driver about addition of an associated station,
1627 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1629 * @sta_remove: Notifies low level driver about removal of an associated
1630 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1632 * @sta_notify: Notifies low level driver about power state transition of an
1633 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
1635 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1636 * bursting) for a hardware TX queue.
1637 * Returns a negative error code on failure.
1638 * The callback can sleep.
1640 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1641 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1642 * required function.
1643 * The callback can sleep.
1645 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1646 * Currently, this is only used for IBSS mode debugging. Is not a
1647 * required function.
1648 * The callback can sleep.
1650 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1651 * with other STAs in the IBSS. This is only used in IBSS mode. This
1652 * function is optional if the firmware/hardware takes full care of
1653 * TSF synchronization.
1654 * The callback can sleep.
1656 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1657 * This is needed only for IBSS mode and the result of this function is
1658 * used to determine whether to reply to Probe Requests.
1659 * Returns non-zero if this device sent the last beacon.
1660 * The callback can sleep.
1662 * @ampdu_action: Perform a certain A-MPDU action
1663 * The RA/TID combination determines the destination and TID we want
1664 * the ampdu action to be performed for. The action is defined through
1665 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1666 * is the first frame we expect to perform the action on. Notice
1667 * that TX/RX_STOP can pass NULL for this parameter.
1668 * Returns a negative error code on failure.
1669 * The callback can sleep.
1671 * @get_survey: Return per-channel survey information
1673 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1674 * need to set wiphy->rfkill_poll to %true before registration,
1675 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1676 * The callback can sleep.
1678 * @set_coverage_class: Set slot time for given coverage class as specified
1679 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1680 * accordingly. This callback is not required and may sleep.
1682 * @testmode_cmd: Implement a cfg80211 test mode command.
1683 * The callback can sleep.
1685 * @flush: Flush all pending frames from the hardware queue, making sure
1686 * that the hardware queues are empty. If the parameter @drop is set
1687 * to %true, pending frames may be dropped. The callback can sleep.
1689 * @channel_switch: Drivers that need (or want) to offload the channel
1690 * switch operation for CSAs received from the AP may implement this
1691 * callback. They must then call ieee80211_chswitch_done() to indicate
1692 * completion of the channel switch.
1694 * @napi_poll: Poll Rx queue for incoming data frames.
1696 struct ieee80211_ops {
1697 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1698 int (*start)(struct ieee80211_hw *hw);
1699 void (*stop)(struct ieee80211_hw *hw);
1700 int (*add_interface)(struct ieee80211_hw *hw,
1701 struct ieee80211_vif *vif);
1702 int (*change_interface)(struct ieee80211_hw *hw,
1703 struct ieee80211_vif *vif,
1704 enum nl80211_iftype new_type);
1705 void (*remove_interface)(struct ieee80211_hw *hw,
1706 struct ieee80211_vif *vif);
1707 int (*config)(struct ieee80211_hw *hw, u32 changed);
1708 void (*bss_info_changed)(struct ieee80211_hw *hw,
1709 struct ieee80211_vif *vif,
1710 struct ieee80211_bss_conf *info,
1712 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1713 struct netdev_hw_addr_list *mc_list);
1714 void (*configure_filter)(struct ieee80211_hw *hw,
1715 unsigned int changed_flags,
1716 unsigned int *total_flags,
1718 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1720 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1721 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1722 struct ieee80211_key_conf *key);
1723 void (*update_tkip_key)(struct ieee80211_hw *hw,
1724 struct ieee80211_vif *vif,
1725 struct ieee80211_key_conf *conf,
1726 struct ieee80211_sta *sta,
1727 u32 iv32, u16 *phase1key);
1728 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1729 struct cfg80211_scan_request *req);
1730 void (*sw_scan_start)(struct ieee80211_hw *hw);
1731 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1732 int (*get_stats)(struct ieee80211_hw *hw,
1733 struct ieee80211_low_level_stats *stats);
1734 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1735 u32 *iv32, u16 *iv16);
1736 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1737 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1738 struct ieee80211_sta *sta);
1739 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1740 struct ieee80211_sta *sta);
1741 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1742 enum sta_notify_cmd, struct ieee80211_sta *sta);
1743 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1744 const struct ieee80211_tx_queue_params *params);
1745 u64 (*get_tsf)(struct ieee80211_hw *hw);
1746 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1747 void (*reset_tsf)(struct ieee80211_hw *hw);
1748 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1749 int (*ampdu_action)(struct ieee80211_hw *hw,
1750 struct ieee80211_vif *vif,
1751 enum ieee80211_ampdu_mlme_action action,
1752 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1753 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1754 struct survey_info *survey);
1755 void (*rfkill_poll)(struct ieee80211_hw *hw);
1756 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1757 #ifdef CONFIG_NL80211_TESTMODE
1758 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1760 void (*flush)(struct ieee80211_hw *hw, bool drop);
1761 void (*channel_switch)(struct ieee80211_hw *hw,
1762 struct ieee80211_channel_switch *ch_switch);
1763 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
1767 * ieee80211_alloc_hw - Allocate a new hardware device
1769 * This must be called once for each hardware device. The returned pointer
1770 * must be used to refer to this device when calling other functions.
1771 * mac80211 allocates a private data area for the driver pointed to by
1772 * @priv in &struct ieee80211_hw, the size of this area is given as
1775 * @priv_data_len: length of private data
1776 * @ops: callbacks for this device
1778 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1779 const struct ieee80211_ops *ops);
1782 * ieee80211_register_hw - Register hardware device
1784 * You must call this function before any other functions in
1785 * mac80211. Note that before a hardware can be registered, you
1786 * need to fill the contained wiphy's information.
1788 * @hw: the device to register as returned by ieee80211_alloc_hw()
1790 int ieee80211_register_hw(struct ieee80211_hw *hw);
1792 #ifdef CONFIG_MAC80211_LEDS
1793 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1794 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1795 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1796 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1799 * ieee80211_get_tx_led_name - get name of TX LED
1801 * mac80211 creates a transmit LED trigger for each wireless hardware
1802 * that can be used to drive LEDs if your driver registers a LED device.
1803 * This function returns the name (or %NULL if not configured for LEDs)
1804 * of the trigger so you can automatically link the LED device.
1806 * @hw: the hardware to get the LED trigger name for
1808 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1810 #ifdef CONFIG_MAC80211_LEDS
1811 return __ieee80211_get_tx_led_name(hw);
1818 * ieee80211_get_rx_led_name - get name of RX LED
1820 * mac80211 creates a receive LED trigger for each wireless hardware
1821 * that can be used to drive LEDs if your driver registers a LED device.
1822 * This function returns the name (or %NULL if not configured for LEDs)
1823 * of the trigger so you can automatically link the LED device.
1825 * @hw: the hardware to get the LED trigger name for
1827 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1829 #ifdef CONFIG_MAC80211_LEDS
1830 return __ieee80211_get_rx_led_name(hw);
1837 * ieee80211_get_assoc_led_name - get name of association LED
1839 * mac80211 creates a association LED trigger for each wireless hardware
1840 * that can be used to drive LEDs if your driver registers a LED device.
1841 * This function returns the name (or %NULL if not configured for LEDs)
1842 * of the trigger so you can automatically link the LED device.
1844 * @hw: the hardware to get the LED trigger name for
1846 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1848 #ifdef CONFIG_MAC80211_LEDS
1849 return __ieee80211_get_assoc_led_name(hw);
1856 * ieee80211_get_radio_led_name - get name of radio LED
1858 * mac80211 creates a radio change LED trigger for each wireless hardware
1859 * that can be used to drive LEDs if your driver registers a LED device.
1860 * This function returns the name (or %NULL if not configured for LEDs)
1861 * of the trigger so you can automatically link the LED device.
1863 * @hw: the hardware to get the LED trigger name for
1865 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1867 #ifdef CONFIG_MAC80211_LEDS
1868 return __ieee80211_get_radio_led_name(hw);
1875 * ieee80211_unregister_hw - Unregister a hardware device
1877 * This function instructs mac80211 to free allocated resources
1878 * and unregister netdevices from the networking subsystem.
1880 * @hw: the hardware to unregister
1882 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1885 * ieee80211_free_hw - free hardware descriptor
1887 * This function frees everything that was allocated, including the
1888 * private data for the driver. You must call ieee80211_unregister_hw()
1889 * before calling this function.
1891 * @hw: the hardware to free
1893 void ieee80211_free_hw(struct ieee80211_hw *hw);
1896 * ieee80211_restart_hw - restart hardware completely
1898 * Call this function when the hardware was restarted for some reason
1899 * (hardware error, ...) and the driver is unable to restore its state
1900 * by itself. mac80211 assumes that at this point the driver/hardware
1901 * is completely uninitialised and stopped, it starts the process by
1902 * calling the ->start() operation. The driver will need to reset all
1903 * internal state that it has prior to calling this function.
1905 * @hw: the hardware to restart
1907 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1909 /** ieee80211_napi_schedule - schedule NAPI poll
1911 * Use this function to schedule NAPI polling on a device.
1913 * @hw: the hardware to start polling
1915 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
1917 /** ieee80211_napi_complete - complete NAPI polling
1919 * Use this function to finish NAPI polling on a device.
1921 * @hw: the hardware to stop polling
1923 void ieee80211_napi_complete(struct ieee80211_hw *hw);
1926 * ieee80211_rx - receive frame
1928 * Use this function to hand received frames to mac80211. The receive
1929 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1930 * paged @skb is used, the driver is recommended to put the ieee80211
1931 * header of the frame on the linear part of the @skb to avoid memory
1932 * allocation and/or memcpy by the stack.
1934 * This function may not be called in IRQ context. Calls to this function
1935 * for a single hardware must be synchronized against each other. Calls to
1936 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1937 * mixed for a single hardware.
1939 * In process context use instead ieee80211_rx_ni().
1941 * @hw: the hardware this frame came in on
1942 * @skb: the buffer to receive, owned by mac80211 after this call
1944 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1947 * ieee80211_rx_irqsafe - receive frame
1949 * Like ieee80211_rx() but can be called in IRQ context
1950 * (internally defers to a tasklet.)
1952 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1953 * be mixed for a single hardware.
1955 * @hw: the hardware this frame came in on
1956 * @skb: the buffer to receive, owned by mac80211 after this call
1958 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1961 * ieee80211_rx_ni - receive frame (in process context)
1963 * Like ieee80211_rx() but can be called in process context
1964 * (internally disables bottom halves).
1966 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1967 * not be mixed for a single hardware.
1969 * @hw: the hardware this frame came in on
1970 * @skb: the buffer to receive, owned by mac80211 after this call
1972 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1973 struct sk_buff *skb)
1976 ieee80211_rx(hw, skb);
1981 * The TX headroom reserved by mac80211 for its own tx_status functions.
1982 * This is enough for the radiotap header.
1984 #define IEEE80211_TX_STATUS_HEADROOM 13
1987 * ieee80211_tx_status - transmit status callback
1989 * Call this function for all transmitted frames after they have been
1990 * transmitted. It is permissible to not call this function for
1991 * multicast frames but this can affect statistics.
1993 * This function may not be called in IRQ context. Calls to this function
1994 * for a single hardware must be synchronized against each other. Calls
1995 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1996 * for a single hardware.
1998 * @hw: the hardware the frame was transmitted by
1999 * @skb: the frame that was transmitted, owned by mac80211 after this call
2001 void ieee80211_tx_status(struct ieee80211_hw *hw,
2002 struct sk_buff *skb);
2005 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2007 * Like ieee80211_tx_status() but can be called in IRQ context
2008 * (internally defers to a tasklet.)
2010 * Calls to this function and ieee80211_tx_status() may not be mixed for a
2013 * @hw: the hardware the frame was transmitted by
2014 * @skb: the frame that was transmitted, owned by mac80211 after this call
2016 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2017 struct sk_buff *skb);
2020 * ieee80211_beacon_get_tim - beacon generation function
2021 * @hw: pointer obtained from ieee80211_alloc_hw().
2022 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2023 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2024 * Set to 0 if invalid (in non-AP modes).
2025 * @tim_length: pointer to variable that will receive the TIM IE length,
2026 * (including the ID and length bytes!).
2027 * Set to 0 if invalid (in non-AP modes).
2029 * If the driver implements beaconing modes, it must use this function to
2030 * obtain the beacon frame/template.
2032 * If the beacon frames are generated by the host system (i.e., not in
2033 * hardware/firmware), the driver uses this function to get each beacon
2034 * frame from mac80211 -- it is responsible for calling this function
2035 * before the beacon is needed (e.g. based on hardware interrupt).
2037 * If the beacon frames are generated by the device, then the driver
2038 * must use the returned beacon as the template and change the TIM IE
2039 * according to the current DTIM parameters/TIM bitmap.
2041 * The driver is responsible for freeing the returned skb.
2043 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2044 struct ieee80211_vif *vif,
2045 u16 *tim_offset, u16 *tim_length);
2048 * ieee80211_beacon_get - beacon generation function
2049 * @hw: pointer obtained from ieee80211_alloc_hw().
2050 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2052 * See ieee80211_beacon_get_tim().
2054 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2055 struct ieee80211_vif *vif)
2057 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2061 * ieee80211_pspoll_get - retrieve a PS Poll template
2062 * @hw: pointer obtained from ieee80211_alloc_hw().
2063 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2065 * Creates a PS Poll a template which can, for example, uploaded to
2066 * hardware. The template must be updated after association so that correct
2067 * AID, BSSID and MAC address is used.
2069 * Note: Caller (or hardware) is responsible for setting the
2070 * &IEEE80211_FCTL_PM bit.
2072 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2073 struct ieee80211_vif *vif);
2076 * ieee80211_nullfunc_get - retrieve a nullfunc template
2077 * @hw: pointer obtained from ieee80211_alloc_hw().
2078 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2080 * Creates a Nullfunc template which can, for example, uploaded to
2081 * hardware. The template must be updated after association so that correct
2082 * BSSID and address is used.
2084 * Note: Caller (or hardware) is responsible for setting the
2085 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2087 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2088 struct ieee80211_vif *vif);
2091 * ieee80211_probereq_get - retrieve a Probe Request template
2092 * @hw: pointer obtained from ieee80211_alloc_hw().
2093 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2094 * @ssid: SSID buffer
2095 * @ssid_len: length of SSID
2096 * @ie: buffer containing all IEs except SSID for the template
2097 * @ie_len: length of the IE buffer
2099 * Creates a Probe Request template which can, for example, be uploaded to
2102 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2103 struct ieee80211_vif *vif,
2104 const u8 *ssid, size_t ssid_len,
2105 const u8 *ie, size_t ie_len);
2108 * ieee80211_rts_get - RTS frame generation function
2109 * @hw: pointer obtained from ieee80211_alloc_hw().
2110 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2111 * @frame: pointer to the frame that is going to be protected by the RTS.
2112 * @frame_len: the frame length (in octets).
2113 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2114 * @rts: The buffer where to store the RTS frame.
2116 * If the RTS frames are generated by the host system (i.e., not in
2117 * hardware/firmware), the low-level driver uses this function to receive
2118 * the next RTS frame from the 802.11 code. The low-level is responsible
2119 * for calling this function before and RTS frame is needed.
2121 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2122 const void *frame, size_t frame_len,
2123 const struct ieee80211_tx_info *frame_txctl,
2124 struct ieee80211_rts *rts);
2127 * ieee80211_rts_duration - Get the duration field for an RTS frame
2128 * @hw: pointer obtained from ieee80211_alloc_hw().
2129 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2130 * @frame_len: the length of the frame that is going to be protected by the RTS.
2131 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2133 * If the RTS is generated in firmware, but the host system must provide
2134 * the duration field, the low-level driver uses this function to receive
2135 * the duration field value in little-endian byteorder.
2137 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2138 struct ieee80211_vif *vif, size_t frame_len,
2139 const struct ieee80211_tx_info *frame_txctl);
2142 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2143 * @hw: pointer obtained from ieee80211_alloc_hw().
2144 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2145 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2146 * @frame_len: the frame length (in octets).
2147 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2148 * @cts: The buffer where to store the CTS-to-self frame.
2150 * If the CTS-to-self frames are generated by the host system (i.e., not in
2151 * hardware/firmware), the low-level driver uses this function to receive
2152 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2153 * for calling this function before and CTS-to-self frame is needed.
2155 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2156 struct ieee80211_vif *vif,
2157 const void *frame, size_t frame_len,
2158 const struct ieee80211_tx_info *frame_txctl,
2159 struct ieee80211_cts *cts);
2162 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2163 * @hw: pointer obtained from ieee80211_alloc_hw().
2164 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2165 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2166 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2168 * If the CTS-to-self is generated in firmware, but the host system must provide
2169 * the duration field, the low-level driver uses this function to receive
2170 * the duration field value in little-endian byteorder.
2172 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2173 struct ieee80211_vif *vif,
2175 const struct ieee80211_tx_info *frame_txctl);
2178 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2179 * @hw: pointer obtained from ieee80211_alloc_hw().
2180 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2181 * @frame_len: the length of the frame.
2182 * @rate: the rate at which the frame is going to be transmitted.
2184 * Calculate the duration field of some generic frame, given its
2185 * length and transmission rate (in 100kbps).
2187 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2188 struct ieee80211_vif *vif,
2190 struct ieee80211_rate *rate);
2193 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2194 * @hw: pointer as obtained from ieee80211_alloc_hw().
2195 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2197 * Function for accessing buffered broadcast and multicast frames. If
2198 * hardware/firmware does not implement buffering of broadcast/multicast
2199 * frames when power saving is used, 802.11 code buffers them in the host
2200 * memory. The low-level driver uses this function to fetch next buffered
2201 * frame. In most cases, this is used when generating beacon frame. This
2202 * function returns a pointer to the next buffered skb or NULL if no more
2203 * buffered frames are available.
2205 * Note: buffered frames are returned only after DTIM beacon frame was
2206 * generated with ieee80211_beacon_get() and the low-level driver must thus
2207 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2208 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2209 * does not need to check for DTIM beacons separately and should be able to
2210 * use common code for all beacons.
2213 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2216 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2218 * This function computes a TKIP rc4 key for an skb. It computes
2219 * a phase 1 key if needed (iv16 wraps around). This function is to
2220 * be used by drivers which can do HW encryption but need to compute
2221 * to phase 1/2 key in SW.
2223 * @keyconf: the parameter passed with the set key
2224 * @skb: the skb for which the key is needed
2226 * @key: a buffer to which the key will be written
2228 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2229 struct sk_buff *skb,
2230 enum ieee80211_tkip_key_type type, u8 *key);
2232 * ieee80211_wake_queue - wake specific queue
2233 * @hw: pointer as obtained from ieee80211_alloc_hw().
2234 * @queue: queue number (counted from zero).
2236 * Drivers should use this function instead of netif_wake_queue.
2238 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2241 * ieee80211_stop_queue - stop specific queue
2242 * @hw: pointer as obtained from ieee80211_alloc_hw().
2243 * @queue: queue number (counted from zero).
2245 * Drivers should use this function instead of netif_stop_queue.
2247 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2250 * ieee80211_queue_stopped - test status of the queue
2251 * @hw: pointer as obtained from ieee80211_alloc_hw().
2252 * @queue: queue number (counted from zero).
2254 * Drivers should use this function instead of netif_stop_queue.
2257 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2260 * ieee80211_stop_queues - stop all queues
2261 * @hw: pointer as obtained from ieee80211_alloc_hw().
2263 * Drivers should use this function instead of netif_stop_queue.
2265 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2268 * ieee80211_wake_queues - wake all queues
2269 * @hw: pointer as obtained from ieee80211_alloc_hw().
2271 * Drivers should use this function instead of netif_wake_queue.
2273 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2276 * ieee80211_scan_completed - completed hardware scan
2278 * When hardware scan offload is used (i.e. the hw_scan() callback is
2279 * assigned) this function needs to be called by the driver to notify
2280 * mac80211 that the scan finished. This function can be called from
2281 * any context, including hardirq context.
2283 * @hw: the hardware that finished the scan
2284 * @aborted: set to true if scan was aborted
2286 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2289 * ieee80211_iterate_active_interfaces - iterate active interfaces
2291 * This function iterates over the interfaces associated with a given
2292 * hardware that are currently active and calls the callback for them.
2293 * This function allows the iterator function to sleep, when the iterator
2294 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2297 * @hw: the hardware struct of which the interfaces should be iterated over
2298 * @iterator: the iterator function to call
2299 * @data: first argument of the iterator function
2301 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2302 void (*iterator)(void *data, u8 *mac,
2303 struct ieee80211_vif *vif),
2307 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2309 * This function iterates over the interfaces associated with a given
2310 * hardware that are currently active and calls the callback for them.
2311 * This function requires the iterator callback function to be atomic,
2312 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2314 * @hw: the hardware struct of which the interfaces should be iterated over
2315 * @iterator: the iterator function to call, cannot sleep
2316 * @data: first argument of the iterator function
2318 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2319 void (*iterator)(void *data,
2321 struct ieee80211_vif *vif),
2325 * ieee80211_queue_work - add work onto the mac80211 workqueue
2327 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2328 * This helper ensures drivers are not queueing work when they should not be.
2330 * @hw: the hardware struct for the interface we are adding work for
2331 * @work: the work we want to add onto the mac80211 workqueue
2333 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2336 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2338 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2341 * @hw: the hardware struct for the interface we are adding work for
2342 * @dwork: delayable work to queue onto the mac80211 workqueue
2343 * @delay: number of jiffies to wait before queueing
2345 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2346 struct delayed_work *dwork,
2347 unsigned long delay);
2350 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2351 * @sta: the station for which to start a BA session
2352 * @tid: the TID to BA on.
2354 * Return: success if addBA request was sent, failure otherwise
2356 * Although mac80211/low level driver/user space application can estimate
2357 * the need to start aggregation on a certain RA/TID, the session level
2358 * will be managed by the mac80211.
2360 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2363 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2364 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2365 * @ra: receiver address of the BA session recipient.
2366 * @tid: the TID to BA on.
2368 * This function must be called by low level driver once it has
2369 * finished with preparations for the BA session. It can be called
2372 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2376 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2377 * @sta: the station whose BA session to stop
2378 * @tid: the TID to stop BA.
2380 * Return: negative error if the TID is invalid, or no aggregation active
2382 * Although mac80211/low level driver/user space application can estimate
2383 * the need to stop aggregation on a certain RA/TID, the session level
2384 * will be managed by the mac80211.
2386 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2389 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2390 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2391 * @ra: receiver address of the BA session recipient.
2392 * @tid: the desired TID to BA on.
2394 * This function must be called by low level driver once it has
2395 * finished with preparations for the BA session tear down. It
2396 * can be called from any context.
2398 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2402 * ieee80211_find_sta - find a station
2404 * @vif: virtual interface to look for station on
2405 * @addr: station's address
2407 * This function must be called under RCU lock and the
2408 * resulting pointer is only valid under RCU lock as well.
2410 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2414 * ieee80211_find_sta_by_hw - find a station on hardware
2416 * @hw: pointer as obtained from ieee80211_alloc_hw()
2417 * @addr: station's address
2419 * This function must be called under RCU lock and the
2420 * resulting pointer is only valid under RCU lock as well.
2422 * NOTE: This function should not be used! When mac80211 is converted
2423 * internally to properly keep track of stations on multiple
2424 * virtual interfaces, it will not always know which station to
2425 * return here since a single address might be used by multiple
2426 * logical stations (e.g. consider a station connecting to another
2427 * BSSID on the same AP hardware without disconnecting first).
2429 * DO NOT USE THIS FUNCTION.
2431 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2435 * ieee80211_sta_block_awake - block station from waking up
2437 * @pubsta: the station
2438 * @block: whether to block or unblock
2440 * Some devices require that all frames that are on the queues
2441 * for a specific station that went to sleep are flushed before
2442 * a poll response or frames after the station woke up can be
2443 * delivered to that it. Note that such frames must be rejected
2444 * by the driver as filtered, with the appropriate status flag.
2446 * This function allows implementing this mode in a race-free
2449 * To do this, a driver must keep track of the number of frames
2450 * still enqueued for a specific station. If this number is not
2451 * zero when the station goes to sleep, the driver must call
2452 * this function to force mac80211 to consider the station to
2453 * be asleep regardless of the station's actual state. Once the
2454 * number of outstanding frames reaches zero, the driver must
2455 * call this function again to unblock the station. That will
2456 * cause mac80211 to be able to send ps-poll responses, and if
2457 * the station queried in the meantime then frames will also
2458 * be sent out as a result of this. Additionally, the driver
2459 * will be notified that the station woke up some time after
2460 * it is unblocked, regardless of whether the station actually
2461 * woke up while blocked or not.
2463 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2464 struct ieee80211_sta *pubsta, bool block);
2467 * ieee80211_beacon_loss - inform hardware does not receive beacons
2469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2471 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
2472 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2473 * hardware is not receiving beacons with this function.
2475 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2478 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2480 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2482 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
2483 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2484 * needs to inform if the connection to the AP has been lost.
2486 * This function will cause immediate change to disassociated state,
2487 * without connection recovery attempts.
2489 void ieee80211_connection_loss(struct ieee80211_vif *vif);
2492 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2494 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2496 * Some hardware require full power save to manage simultaneous BT traffic
2497 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2498 * burst of BT traffic. The hardware gets information of BT traffic via
2499 * hardware co-existence lines, and consequentially requests mac80211 to
2500 * (temporarily) enter full psm.
2501 * This function will only temporarily disable dynamic PS, not enable PSM if
2502 * it was not already enabled.
2503 * The driver must make sure to re-enable dynamic PS using
2504 * ieee80211_enable_dyn_ps() if the driver has disabled it.
2507 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2510 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2512 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2514 * This function restores dynamic PS after being temporarily disabled via
2515 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2516 * be coupled with an eventual call to this function.
2519 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2522 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2523 * rssi threshold triggered
2525 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2526 * @rssi_event: the RSSI trigger event type
2527 * @gfp: context flags
2529 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2530 * monitoring is configured with an rssi threshold, the driver will inform
2531 * whenever the rssi level reaches the threshold.
2533 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2534 enum nl80211_cqm_rssi_threshold_event rssi_event,
2538 * ieee80211_chswitch_done - Complete channel switch process
2539 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2540 * @success: make the channel switch successful or not
2542 * Complete the channel switch post-process: set the new operational channel
2543 * and wake up the suspended queues.
2545 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2548 * ieee80211_request_smps - request SM PS transition
2549 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2550 * @smps_mode: new SM PS mode
2552 * This allows the driver to request an SM PS transition in managed
2553 * mode. This is useful when the driver has more information than
2554 * the stack about possible interference, for example by bluetooth.
2556 void ieee80211_request_smps(struct ieee80211_vif *vif,
2557 enum ieee80211_smps_mode smps_mode);
2559 /* Rate control API */
2562 * enum rate_control_changed - flags to indicate which parameter changed
2564 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2565 * changed, rate control algorithm can update its internal state if needed.
2567 enum rate_control_changed {
2568 IEEE80211_RC_HT_CHANGED = BIT(0)
2572 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2574 * @hw: The hardware the algorithm is invoked for.
2575 * @sband: The band this frame is being transmitted on.
2576 * @bss_conf: the current BSS configuration
2577 * @reported_rate: The rate control algorithm can fill this in to indicate
2578 * which rate should be reported to userspace as the current rate and
2579 * used for rate calculations in the mesh network.
2580 * @rts: whether RTS will be used for this frame because it is longer than the
2582 * @short_preamble: whether mac80211 will request short-preamble transmission
2583 * if the selected rate supports it
2584 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2585 * (deprecated; this will be removed once drivers get updated to use
2587 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2588 * @skb: the skb that will be transmitted, the control information in it needs
2590 * @ap: whether this frame is sent out in AP mode
2592 struct ieee80211_tx_rate_control {
2593 struct ieee80211_hw *hw;
2594 struct ieee80211_supported_band *sband;
2595 struct ieee80211_bss_conf *bss_conf;
2596 struct sk_buff *skb;
2597 struct ieee80211_tx_rate reported_rate;
2598 bool rts, short_preamble;
2604 struct rate_control_ops {
2605 struct module *module;
2607 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2608 void (*free)(void *priv);
2610 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2611 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2612 struct ieee80211_sta *sta, void *priv_sta);
2613 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2614 struct ieee80211_sta *sta,
2615 void *priv_sta, u32 changed,
2616 enum nl80211_channel_type oper_chan_type);
2617 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2620 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2621 struct ieee80211_sta *sta, void *priv_sta,
2622 struct sk_buff *skb);
2623 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2624 struct ieee80211_tx_rate_control *txrc);
2626 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2627 struct dentry *dir);
2628 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2631 static inline int rate_supported(struct ieee80211_sta *sta,
2632 enum ieee80211_band band,
2635 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2639 * rate_control_send_low - helper for drivers for management/no-ack frames
2641 * Rate control algorithms that agree to use the lowest rate to
2642 * send management frames and NO_ACK data with the respective hw
2643 * retries should use this in the beginning of their mac80211 get_rate
2644 * callback. If true is returned the rate control can simply return.
2645 * If false is returned we guarantee that sta and sta and priv_sta is
2648 * Rate control algorithms wishing to do more intelligent selection of
2649 * rate for multicast/broadcast frames may choose to not use this.
2651 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2652 * that this may be null.
2653 * @priv_sta: private rate control structure. This may be null.
2654 * @txrc: rate control information we sholud populate for mac80211.
2656 bool rate_control_send_low(struct ieee80211_sta *sta,
2658 struct ieee80211_tx_rate_control *txrc);
2662 rate_lowest_index(struct ieee80211_supported_band *sband,
2663 struct ieee80211_sta *sta)
2667 for (i = 0; i < sband->n_bitrates; i++)
2668 if (rate_supported(sta, sband->band, i))
2671 /* warn when we cannot find a rate. */
2678 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2679 struct ieee80211_sta *sta)
2683 for (i = 0; i < sband->n_bitrates; i++)
2684 if (rate_supported(sta, sband->band, i))
2689 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2690 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2693 conf_is_ht20(struct ieee80211_conf *conf)
2695 return conf->channel_type == NL80211_CHAN_HT20;
2699 conf_is_ht40_minus(struct ieee80211_conf *conf)
2701 return conf->channel_type == NL80211_CHAN_HT40MINUS;
2705 conf_is_ht40_plus(struct ieee80211_conf *conf)
2707 return conf->channel_type == NL80211_CHAN_HT40PLUS;
2711 conf_is_ht40(struct ieee80211_conf *conf)
2713 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2717 conf_is_ht(struct ieee80211_conf *conf)
2719 return conf->channel_type != NL80211_CHAN_NO_HT;
2722 #endif /* MAC80211_H */