2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/cfg80211.h>
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
34 * DOC: Calling mac80211 from interrupts
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 * use the non-IRQ-safe functions!
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
62 * There are, however, various exceptions to this rule for advanced features:
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
76 * DOC: mac80211 workqueue
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 * mac80211 will flushed the workqueue upon interface removal and during
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
91 * enum ieee80211_max_queues - maximum number of queues
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 enum ieee80211_max_queues
{
96 IEEE80211_MAX_QUEUES
= 4,
100 * struct ieee80211_tx_queue_params - transmit queue configuration
102 * The information provided in this structure is required for QoS
103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
105 * @aifs: arbitration interframe space [0..255]
106 * @cw_min: minimum contention window [a value of the form
107 * 2^n-1 in the range 1..32767]
108 * @cw_max: maximum contention window [like @cw_min]
109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
110 * @uapsd: is U-APSD mode enabled for the queue
112 struct ieee80211_tx_queue_params
{
120 struct ieee80211_low_level_stats
{
121 unsigned int dot11ACKFailureCount
;
122 unsigned int dot11RTSFailureCount
;
123 unsigned int dot11FCSErrorCount
;
124 unsigned int dot11RTSSuccessCount
;
128 * enum ieee80211_bss_change - BSS change notification flags
130 * These flags are used with the bss_info_changed() callback
131 * to indicate which BSS parameter changed.
133 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134 * also implies a change in the AID.
135 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
137 * @BSS_CHANGED_ERP_SLOT: slot timing changed
138 * @BSS_CHANGED_HT: 802.11n parameters changed
139 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
140 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
141 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
142 * reason (IBSS and managed mode)
143 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144 * new beacon (beaconing modes)
145 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146 * enabled/disabled (beaconing modes)
147 * @BSS_CHANGED_CQM: Connection quality monitor config changed
148 * @BSS_CHANGED_IBSS: IBSS join status changed
150 enum ieee80211_bss_change
{
151 BSS_CHANGED_ASSOC
= 1<<0,
152 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
153 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
154 BSS_CHANGED_ERP_SLOT
= 1<<3,
155 BSS_CHANGED_HT
= 1<<4,
156 BSS_CHANGED_BASIC_RATES
= 1<<5,
157 BSS_CHANGED_BEACON_INT
= 1<<6,
158 BSS_CHANGED_BSSID
= 1<<7,
159 BSS_CHANGED_BEACON
= 1<<8,
160 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
161 BSS_CHANGED_CQM
= 1<<10,
162 BSS_CHANGED_IBSS
= 1<<11,
164 /* when adding here, make sure to change ieee80211_reconfig */
168 * struct ieee80211_bss_conf - holds the BSS's changing parameters
170 * This structure keeps information about a BSS (and an association
171 * to that BSS) that can change during the lifetime of the BSS.
173 * @assoc: association status
174 * @ibss_joined: indicates whether this station is part of an IBSS
176 * @aid: association ID number, valid only when @assoc is true
177 * @use_cts_prot: use CTS protection
178 * @use_short_preamble: use 802.11b short preamble;
179 * if the hardware cannot handle this it must set the
180 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
181 * @use_short_slot: use short slot time (only relevant for ERP);
182 * if the hardware cannot handle this it must set the
183 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
184 * @dtim_period: num of beacons before the next DTIM, for beaconing,
185 * not valid in station mode (cf. hw conf ps_dtim_period)
186 * @timestamp: beacon timestamp
187 * @beacon_int: beacon interval
188 * @assoc_capability: capabilities taken from assoc resp
189 * @basic_rates: bitmap of basic rates, each bit stands for an
190 * index into the rate table configured by the driver in
192 * @bssid: The BSSID for this BSS
193 * @enable_beacon: whether beaconing should be enabled or not
194 * @channel_type: Channel type for this BSS -- the hardware might be
195 * configured for HT40+ while this BSS only uses no-HT, for
197 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
198 * This field is only valid when the channel type is one of the HT types.
199 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
201 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
203 struct ieee80211_bss_conf
{
205 /* association related data */
206 bool assoc
, ibss_joined
;
208 /* erp related data */
210 bool use_short_preamble
;
215 u16 assoc_capability
;
218 u16 ht_operation_mode
;
221 enum nl80211_channel_type channel_type
;
225 * enum mac80211_tx_control_flags - flags to describe transmission information/status
227 * These flags are used with the @flags member of &ieee80211_tx_info.
229 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
230 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
231 * number to this frame, taking care of not overwriting the fragment
232 * number and increasing the sequence number only when the
233 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
234 * assign sequence numbers to QoS-data frames but cannot do so correctly
235 * for non-QoS-data and management frames because beacons need them from
236 * that counter as well and mac80211 cannot guarantee proper sequencing.
237 * If this flag is set, the driver should instruct the hardware to
238 * assign a sequence number to the frame or assign one itself. Cf. IEEE
239 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
240 * beacons and always be clear for frames without a sequence number field.
241 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
242 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
244 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
245 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
246 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
247 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
248 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
249 * because the destination STA was in powersave mode. Note that to
250 * avoid race conditions, the filter must be set by the hardware or
251 * firmware upon receiving a frame that indicates that the station
252 * went to sleep (must be done on device to filter frames already on
253 * the queue) and may only be unset after mac80211 gives the OK for
254 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
255 * since only then is it guaranteed that no more frames are in the
257 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
258 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
259 * is for the whole aggregation.
260 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
261 * so consider using block ack request (BAR).
262 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
263 * set by rate control algorithms to indicate probe rate, will
264 * be cleared for fragmented frames (except on the last fragment)
265 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
266 * used to indicate that a pending frame requires TX processing before
267 * it can be sent out.
268 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
269 * used to indicate that a frame was already retried due to PS
270 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
271 * used to indicate frame should not be encrypted
272 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
273 * This frame is a response to a PS-poll frame and should be sent
274 * although the station is in powersave mode.
275 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
276 * transmit function after the current frame, this can be used
277 * by drivers to kick the DMA queue only if unset or when the
279 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
280 * after TX status because the destination was asleep, it must not
281 * be modified again (no seqno assignment, crypto, etc.)
282 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
283 * has a radiotap header at skb->data.
284 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
285 * MLME command (internal to mac80211 to figure out whether to send TX
286 * status to user space)
287 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
288 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
289 * frame and selects the maximum number of streams that it can use.
291 * Note: If you have to add new flags to the enumeration, then don't
292 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
294 enum mac80211_tx_control_flags
{
295 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
296 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
297 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
298 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
299 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
300 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
301 IEEE80211_TX_CTL_AMPDU
= BIT(6),
302 IEEE80211_TX_CTL_INJECTED
= BIT(7),
303 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
304 IEEE80211_TX_STAT_ACK
= BIT(9),
305 IEEE80211_TX_STAT_AMPDU
= BIT(10),
306 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
307 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
308 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
309 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
310 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
311 IEEE80211_TX_CTL_PSPOLL_RESPONSE
= BIT(17),
312 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
313 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
314 IEEE80211_TX_INTFL_HAS_RADIOTAP
= BIT(20),
315 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
316 IEEE80211_TX_CTL_LDPC
= BIT(22),
317 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
318 #define IEEE80211_TX_CTL_STBC_SHIFT 23
322 * This definition is used as a mask to clear all temporary flags, which are
323 * set by the tx handlers for each transmission attempt by the mac80211 stack.
325 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
326 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
327 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
328 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
329 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
330 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
331 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
332 IEEE80211_TX_CTL_STBC)
335 * enum mac80211_rate_control_flags - per-rate flags set by the
336 * Rate Control algorithm.
338 * These flags are set by the Rate control algorithm for each rate during tx,
339 * in the @flags member of struct ieee80211_tx_rate.
341 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
342 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
343 * This is set if the current BSS requires ERP protection.
344 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
345 * @IEEE80211_TX_RC_MCS: HT rate.
346 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
348 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
349 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
350 * adjacent 20 MHz channels, if the current channel type is
351 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
352 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
354 enum mac80211_rate_control_flags
{
355 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
356 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
357 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
359 /* rate index is an MCS rate number instead of an index */
360 IEEE80211_TX_RC_MCS
= BIT(3),
361 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
362 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
363 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
364 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
368 /* there are 40 bytes if you don't need the rateset to be kept */
369 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
371 /* if you do need the rateset, then you have less space */
372 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
374 /* maximum number of rate stages */
375 #define IEEE80211_TX_MAX_RATES 5
378 * struct ieee80211_tx_rate - rate selection/status
380 * @idx: rate index to attempt to send with
381 * @flags: rate control flags (&enum mac80211_rate_control_flags)
382 * @count: number of tries in this rate before going to the next rate
384 * A value of -1 for @idx indicates an invalid rate and, if used
385 * in an array of retry rates, that no more rates should be tried.
387 * When used for transmit status reporting, the driver should
388 * always report the rate along with the flags it used.
390 * &struct ieee80211_tx_info contains an array of these structs
391 * in the control information, and it will be filled by the rate
392 * control algorithm according to what should be sent. For example,
393 * if this array contains, in the format { <idx>, <count> } the
395 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
396 * then this means that the frame should be transmitted
397 * up to twice at rate 3, up to twice at rate 2, and up to four
398 * times at rate 1 if it doesn't get acknowledged. Say it gets
399 * acknowledged by the peer after the fifth attempt, the status
400 * information should then contain
401 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
402 * since it was transmitted twice at rate 3, twice at rate 2
403 * and once at rate 1 after which we received an acknowledgement.
405 struct ieee80211_tx_rate
{
409 } __attribute__((packed
));
412 * struct ieee80211_tx_info - skb transmit information
414 * This structure is placed in skb->cb for three uses:
415 * (1) mac80211 TX control - mac80211 tells the driver what to do
416 * (2) driver internal use (if applicable)
417 * (3) TX status information - driver tells mac80211 what happened
419 * The TX control's sta pointer is only valid during the ->tx call,
422 * @flags: transmit info flags, defined above
423 * @band: the band to transmit on (use for checking for races)
424 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
425 * @pad: padding, ignore
426 * @control: union for control data
427 * @status: union for status data
428 * @driver_data: array of driver_data pointers
429 * @ampdu_ack_len: number of acked aggregated frames.
430 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
431 * @ampdu_ack_map: block ack bit map for the aggregation.
432 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
433 * @ampdu_len: number of aggregated frames.
434 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
435 * @ack_signal: signal strength of the ACK frame
437 struct ieee80211_tx_info
{
438 /* common information */
452 struct ieee80211_tx_rate rates
[
453 IEEE80211_TX_MAX_RATES
];
456 /* only needed before rate control */
457 unsigned long jiffies
;
459 /* NB: vif can be NULL for injected frames */
460 struct ieee80211_vif
*vif
;
461 struct ieee80211_key_conf
*hw_key
;
462 struct ieee80211_sta
*sta
;
465 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
473 struct ieee80211_tx_rate driver_rates
[
474 IEEE80211_TX_MAX_RATES
];
475 void *rate_driver_data
[
476 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
479 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
483 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
485 return (struct ieee80211_tx_info
*)skb
->cb
;
488 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
490 return (struct ieee80211_rx_status
*)skb
->cb
;
494 * ieee80211_tx_info_clear_status - clear TX status
496 * @info: The &struct ieee80211_tx_info to be cleared.
498 * When the driver passes an skb back to mac80211, it must report
499 * a number of things in TX status. This function clears everything
500 * in the TX status but the rate control information (it does clear
501 * the count since you need to fill that in anyway).
503 * NOTE: You can only use this function if you do NOT use
504 * info->driver_data! Use info->rate_driver_data
505 * instead if you need only the less space that allows.
508 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
512 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
513 offsetof(struct ieee80211_tx_info
, control
.rates
));
514 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
515 offsetof(struct ieee80211_tx_info
, driver_rates
));
516 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
517 /* clear the rate counts */
518 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
519 info
->status
.rates
[i
].count
= 0;
522 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
523 memset(&info
->status
.ampdu_ack_len
, 0,
524 sizeof(struct ieee80211_tx_info
) -
525 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
530 * enum mac80211_rx_flags - receive flags
532 * These flags are used with the @flag member of &struct ieee80211_rx_status.
533 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
534 * Use together with %RX_FLAG_MMIC_STRIPPED.
535 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
536 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
537 * verification has been done by the hardware.
538 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
539 * If this flag is set, the stack cannot do any replay detection
540 * hence the driver or hardware will have to do that.
541 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
543 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
545 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
546 * is valid. This is useful in monitor mode and necessary for beacon frames
547 * to enable IBSS merging.
548 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
549 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
550 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
551 * @RX_FLAG_SHORT_GI: Short guard interval was used
552 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
553 * on cooked monitor to avoid double-reporting it for multiple
556 enum mac80211_rx_flags
{
557 RX_FLAG_MMIC_ERROR
= 1<<0,
558 RX_FLAG_DECRYPTED
= 1<<1,
559 RX_FLAG_MMIC_STRIPPED
= 1<<3,
560 RX_FLAG_IV_STRIPPED
= 1<<4,
561 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
562 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
564 RX_FLAG_SHORTPRE
= 1<<8,
566 RX_FLAG_40MHZ
= 1<<10,
567 RX_FLAG_SHORT_GI
= 1<<11,
568 RX_FLAG_INTERNAL_CMTR
= 1<<12,
572 * struct ieee80211_rx_status - receive status
574 * The low-level driver should provide this information (the subset
575 * supported by hardware) to the 802.11 code with each received
576 * frame, in the skb's control buffer (cb).
578 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
579 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
580 * @band: the active band when this frame was received
581 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
582 * @signal: signal strength when receiving this frame, either in dBm, in dB or
583 * unspecified depending on the hardware capabilities flags
584 * @IEEE80211_HW_SIGNAL_*
585 * @antenna: antenna used
586 * @rate_idx: index of data rate into band's supported rates or MCS index if
587 * HT rates are use (RX_FLAG_HT)
590 struct ieee80211_rx_status
{
592 enum ieee80211_band band
;
601 * enum ieee80211_conf_flags - configuration flags
603 * Flags to define PHY configuration options
605 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
606 * to determine for example whether to calculate timestamps for packets
607 * or not, do not use instead of filter flags!
608 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
609 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
610 * meaning that the hardware still wakes up for beacons, is able to
611 * transmit frames and receive the possible acknowledgment frames.
612 * Not to be confused with hardware specific wakeup/sleep states,
613 * driver is responsible for that. See the section "Powersave support"
615 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
616 * the driver should be prepared to handle configuration requests but
617 * may turn the device off as much as possible. Typically, this flag will
618 * be set when an interface is set UP but not associated or scanning, but
619 * it can also be unset in that case when monitor interfaces are active.
620 * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless
621 * Multimedia). On some drivers (iwlwifi is one of know) we have
622 * to enable/disable QoS explicitly.
624 enum ieee80211_conf_flags
{
625 IEEE80211_CONF_MONITOR
= (1<<0),
626 IEEE80211_CONF_PS
= (1<<1),
627 IEEE80211_CONF_IDLE
= (1<<2),
628 IEEE80211_CONF_QOS
= (1<<3),
633 * enum ieee80211_conf_changed - denotes which configuration changed
635 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
636 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
637 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
638 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
639 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
640 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
641 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
642 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
643 * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled
645 enum ieee80211_conf_changed
{
646 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
647 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
648 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
649 IEEE80211_CONF_CHANGE_PS
= BIT(4),
650 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
651 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
652 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
653 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
654 IEEE80211_CONF_CHANGE_QOS
= BIT(9),
658 * enum ieee80211_smps_mode - spatial multiplexing power save mode
660 * @IEEE80211_SMPS_AUTOMATIC: automatic
661 * @IEEE80211_SMPS_OFF: off
662 * @IEEE80211_SMPS_STATIC: static
663 * @IEEE80211_SMPS_DYNAMIC: dynamic
664 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
666 enum ieee80211_smps_mode
{
667 IEEE80211_SMPS_AUTOMATIC
,
669 IEEE80211_SMPS_STATIC
,
670 IEEE80211_SMPS_DYNAMIC
,
673 IEEE80211_SMPS_NUM_MODES
,
677 * struct ieee80211_conf - configuration of the device
679 * This struct indicates how the driver shall configure the hardware.
681 * @flags: configuration flags defined above
683 * @listen_interval: listen interval in units of beacon interval
684 * @max_sleep_period: the maximum number of beacon intervals to sleep for
685 * before checking the beacon for a TIM bit (managed mode only); this
686 * value will be only achievable between DTIM frames, the hardware
687 * needs to check for the multicast traffic bit in DTIM beacons.
688 * This variable is valid only when the CONF_PS flag is set.
689 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
690 * in power saving. Power saving will not be enabled until a beacon
691 * has been received and the DTIM period is known.
692 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
693 * powersave documentation below. This variable is valid only when
694 * the CONF_PS flag is set.
695 * @dynamic_ps_forced_timeout: The dynamic powersave timeout (in ms) configured
696 * by cfg80211 (essentially, wext) If set, this value overrules the value
697 * chosen by mac80211 based on ps qos network latency.
699 * @power_level: requested transmit power (in dBm)
701 * @channel: the channel to tune to
702 * @channel_type: the channel (HT) type
704 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
705 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
706 * but actually means the number of transmissions not the number of retries
707 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
708 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
709 * number of transmissions not the number of retries
711 * @smps_mode: spatial multiplexing powersave mode; note that
712 * %IEEE80211_SMPS_STATIC is used when the device is not
713 * configured for an HT channel
715 struct ieee80211_conf
{
717 int power_level
, dynamic_ps_timeout
, dynamic_ps_forced_timeout
;
718 int max_sleep_period
;
723 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
725 struct ieee80211_channel
*channel
;
726 enum nl80211_channel_type channel_type
;
727 enum ieee80211_smps_mode smps_mode
;
731 * struct ieee80211_channel_switch - holds the channel switch data
733 * The information provided in this structure is required for channel switch
736 * @timestamp: value in microseconds of the 64-bit Time Synchronization
737 * Function (TSF) timer when the frame containing the channel switch
738 * announcement was received. This is simply the rx.mactime parameter
739 * the driver passed into mac80211.
740 * @block_tx: Indicates whether transmission must be blocked before the
741 * scheduled channel switch, as indicated by the AP.
742 * @channel: the new channel to switch to
743 * @count: the number of TBTT's until the channel switch event
745 struct ieee80211_channel_switch
{
748 struct ieee80211_channel
*channel
;
753 * struct ieee80211_vif - per-interface data
755 * Data in this structure is continually present for driver
756 * use during the life of a virtual interface.
758 * @type: type of this virtual interface
759 * @bss_conf: BSS configuration for this interface, either our own
760 * or the BSS we're associated to
761 * @addr: address of this interface
762 * @drv_priv: data area for driver use, will always be aligned to
765 struct ieee80211_vif
{
766 enum nl80211_iftype type
;
767 struct ieee80211_bss_conf bss_conf
;
770 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
773 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
775 #ifdef CONFIG_MAC80211_MESH
776 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
782 * enum ieee80211_key_alg - key algorithm
783 * @ALG_WEP: WEP40 or WEP104
785 * @ALG_CCMP: CCMP (AES)
786 * @ALG_AES_CMAC: AES-128-CMAC
788 enum ieee80211_key_alg
{
796 * enum ieee80211_key_flags - key flags
798 * These flags are used for communication about keys between the driver
799 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
801 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
802 * that the STA this key will be used with could be using QoS.
803 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
804 * driver to indicate that it requires IV generation for this
806 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
807 * the driver for a TKIP key if it requires Michael MIC
808 * generation in software.
809 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
810 * that the key is pairwise rather then a shared key.
811 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
812 * CCMP key if it requires CCMP encryption of management frames (MFP) to
813 * be done in software.
815 enum ieee80211_key_flags
{
816 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
817 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
818 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
819 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
820 IEEE80211_KEY_FLAG_SW_MGMT
= 1<<4,
824 * struct ieee80211_key_conf - key information
826 * This key information is given by mac80211 to the driver by
827 * the set_key() callback in &struct ieee80211_ops.
829 * @hw_key_idx: To be set by the driver, this is the key index the driver
830 * wants to be given when a frame is transmitted and needs to be
831 * encrypted in hardware.
832 * @alg: The key algorithm.
833 * @flags: key flags, see &enum ieee80211_key_flags.
834 * @ap_addr: AP's MAC address
835 * @keyidx: the key index (0-3)
836 * @keylen: key material length
837 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
839 * - Temporal Encryption Key (128 bits)
840 * - Temporal Authenticator Tx MIC Key (64 bits)
841 * - Temporal Authenticator Rx MIC Key (64 bits)
842 * @icv_len: The ICV length for this key type
843 * @iv_len: The IV length for this key type
845 struct ieee80211_key_conf
{
846 enum ieee80211_key_alg alg
;
857 * enum set_key_cmd - key command
859 * Used with the set_key() callback in &struct ieee80211_ops, this
860 * indicates whether a key is being removed or added.
862 * @SET_KEY: a key is set
863 * @DISABLE_KEY: a key must be disabled
866 SET_KEY
, DISABLE_KEY
,
870 * struct ieee80211_sta - station table entry
872 * A station table entry represents a station we are possibly
873 * communicating with. Since stations are RCU-managed in
874 * mac80211, any ieee80211_sta pointer you get access to must
875 * either be protected by rcu_read_lock() explicitly or implicitly,
876 * or you must take good care to not use such a pointer after a
877 * call to your sta_remove callback that removed it.
880 * @aid: AID we assigned to the station if we're an AP
881 * @supp_rates: Bitmap of supported rates (per band)
882 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
883 * @drv_priv: data area for driver use, will always be aligned to
884 * sizeof(void *), size is determined in hw information.
886 struct ieee80211_sta
{
887 u32 supp_rates
[IEEE80211_NUM_BANDS
];
890 struct ieee80211_sta_ht_cap ht_cap
;
893 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
897 * enum sta_notify_cmd - sta notify command
899 * Used with the sta_notify() callback in &struct ieee80211_ops, this
900 * indicates addition and removal of a station to station table,
901 * or if a associated station made a power state transition.
903 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
904 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
905 * @STA_NOTIFY_SLEEP: a station is now sleeping
906 * @STA_NOTIFY_AWAKE: a sleeping station woke up
908 enum sta_notify_cmd
{
909 STA_NOTIFY_ADD
, STA_NOTIFY_REMOVE
,
910 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
914 * enum ieee80211_tkip_key_type - get tkip key
916 * Used by drivers which need to get a tkip key for skb. Some drivers need a
917 * phase 1 key, others need a phase 2 key. A single function allows the driver
918 * to get the key, this enum indicates what type of key is required.
920 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
921 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
923 enum ieee80211_tkip_key_type
{
924 IEEE80211_TKIP_P1_KEY
,
925 IEEE80211_TKIP_P2_KEY
,
929 * enum ieee80211_hw_flags - hardware flags
931 * These flags are used to indicate hardware capabilities to
932 * the stack. Generally, flags here should have their meaning
933 * done in a way that the simplest hardware doesn't need setting
934 * any particular flags. There are some exceptions to this rule,
935 * however, so you are advised to review these flags carefully.
937 * @IEEE80211_HW_HAS_RATE_CONTROL:
938 * The hardware or firmware includes rate control, and cannot be
939 * controlled by the stack. As such, no rate control algorithm
940 * should be instantiated, and the TX rate reported to userspace
941 * will be taken from the TX status instead of the rate control
943 * Note that this requires that the driver implement a number of
944 * callbacks so it has the correct information, it needs to have
945 * the @set_rts_threshold callback and must look at the BSS config
946 * @use_cts_prot for G/N protection, @use_short_slot for slot
947 * timing in 2.4 GHz and @use_short_preamble for preambles for
950 * @IEEE80211_HW_RX_INCLUDES_FCS:
951 * Indicates that received frames passed to the stack include
952 * the FCS at the end.
954 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
955 * Some wireless LAN chipsets buffer broadcast/multicast frames
956 * for power saving stations in the hardware/firmware and others
957 * rely on the host system for such buffering. This option is used
958 * to configure the IEEE 802.11 upper layer to buffer broadcast and
959 * multicast frames when there are power saving stations so that
960 * the driver can fetch them with ieee80211_get_buffered_bc().
962 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
963 * Hardware is not capable of short slot operation on the 2.4 GHz band.
965 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
966 * Hardware is not capable of receiving frames with short preamble on
969 * @IEEE80211_HW_SIGNAL_UNSPEC:
970 * Hardware can provide signal values but we don't know its units. We
971 * expect values between 0 and @max_signal.
972 * If possible please provide dB or dBm instead.
974 * @IEEE80211_HW_SIGNAL_DBM:
975 * Hardware gives signal values in dBm, decibel difference from
976 * one milliwatt. This is the preferred method since it is standardized
977 * between different devices. @max_signal does not need to be set.
979 * @IEEE80211_HW_SPECTRUM_MGMT:
980 * Hardware supports spectrum management defined in 802.11h
981 * Measurement, Channel Switch, Quieting, TPC
983 * @IEEE80211_HW_AMPDU_AGGREGATION:
984 * Hardware supports 11n A-MPDU aggregation.
986 * @IEEE80211_HW_SUPPORTS_PS:
987 * Hardware has power save support (i.e. can go to sleep).
989 * @IEEE80211_HW_PS_NULLFUNC_STACK:
990 * Hardware requires nullfunc frame handling in stack, implies
991 * stack support for dynamic PS.
993 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
994 * Hardware has support for dynamic PS.
996 * @IEEE80211_HW_MFP_CAPABLE:
997 * Hardware supports management frame protection (MFP, IEEE 802.11w).
999 * @IEEE80211_HW_BEACON_FILTER:
1000 * Hardware supports dropping of irrelevant beacon frames to
1001 * avoid waking up cpu.
1003 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1004 * Hardware supports static spatial multiplexing powersave,
1005 * ie. can turn off all but one chain even on HT connections
1006 * that should be using more chains.
1008 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1009 * Hardware supports dynamic spatial multiplexing powersave,
1010 * ie. can turn off all but one chain and then wake the rest
1011 * up as required after, for example, rts/cts handshake.
1013 * @IEEE80211_HW_SUPPORTS_UAPSD:
1014 * Hardware supports Unscheduled Automatic Power Save Delivery
1015 * (U-APSD) in managed mode. The mode is configured with
1016 * conf_tx() operation.
1018 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1019 * Hardware can provide ack status reports of Tx frames to
1022 * @IEEE80211_HW_CONNECTION_MONITOR:
1023 * The hardware performs its own connection monitoring, including
1024 * periodic keep-alives to the AP and probing the AP on beacon loss.
1025 * When this flag is set, signaling beacon-loss will cause an immediate
1026 * change to disassociated state.
1028 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1029 * Hardware can do connection quality monitoring - i.e. it can monitor
1030 * connection quality related parameters, such as the RSSI level and
1031 * provide notifications if configured trigger levels are reached.
1034 enum ieee80211_hw_flags
{
1035 IEEE80211_HW_HAS_RATE_CONTROL
= 1<<0,
1036 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
1037 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
1038 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
1039 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
1040 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
1041 IEEE80211_HW_SIGNAL_DBM
= 1<<6,
1043 IEEE80211_HW_SPECTRUM_MGMT
= 1<<8,
1044 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<9,
1045 IEEE80211_HW_SUPPORTS_PS
= 1<<10,
1046 IEEE80211_HW_PS_NULLFUNC_STACK
= 1<<11,
1047 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
= 1<<12,
1048 IEEE80211_HW_MFP_CAPABLE
= 1<<13,
1049 IEEE80211_HW_BEACON_FILTER
= 1<<14,
1050 IEEE80211_HW_SUPPORTS_STATIC_SMPS
= 1<<15,
1051 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS
= 1<<16,
1052 IEEE80211_HW_SUPPORTS_UAPSD
= 1<<17,
1053 IEEE80211_HW_REPORTS_TX_ACK_STATUS
= 1<<18,
1054 IEEE80211_HW_CONNECTION_MONITOR
= 1<<19,
1055 IEEE80211_HW_SUPPORTS_CQM_RSSI
= 1<<20,
1059 * struct ieee80211_hw - hardware information and state
1061 * This structure contains the configuration and hardware
1062 * information for an 802.11 PHY.
1064 * @wiphy: This points to the &struct wiphy allocated for this
1065 * 802.11 PHY. You must fill in the @perm_addr and @dev
1066 * members of this structure using SET_IEEE80211_DEV()
1067 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1068 * bands (with channels, bitrates) are registered here.
1070 * @conf: &struct ieee80211_conf, device configuration, don't use.
1072 * @priv: pointer to private area that was allocated for driver use
1073 * along with this structure.
1075 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1077 * @extra_tx_headroom: headroom to reserve in each transmit skb
1078 * for use by the driver (e.g. for transmit headers.)
1080 * @channel_change_time: time (in microseconds) it takes to change channels.
1082 * @max_signal: Maximum value for signal (rssi) in RX information, used
1083 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1085 * @max_listen_interval: max listen interval in units of beacon interval
1088 * @queues: number of available hardware transmit queues for
1089 * data packets. WMM/QoS requires at least four, these
1090 * queues need to have configurable access parameters.
1092 * @rate_control_algorithm: rate control algorithm for this hardware.
1093 * If unset (NULL), the default algorithm will be used. Must be
1094 * set before calling ieee80211_register_hw().
1096 * @vif_data_size: size (in bytes) of the drv_priv data area
1097 * within &struct ieee80211_vif.
1098 * @sta_data_size: size (in bytes) of the drv_priv data area
1099 * within &struct ieee80211_sta.
1101 * @max_rates: maximum number of alternate rate retry stages
1102 * @max_rate_tries: maximum number of tries for each stage
1104 struct ieee80211_hw
{
1105 struct ieee80211_conf conf
;
1106 struct wiphy
*wiphy
;
1107 const char *rate_control_algorithm
;
1110 unsigned int extra_tx_headroom
;
1111 int channel_change_time
;
1115 u16 max_listen_interval
;
1122 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1124 * @wiphy: the &struct wiphy which we want to query
1126 * mac80211 drivers can use this to get to their respective
1127 * &struct ieee80211_hw. Drivers wishing to get to their own private
1128 * structure can then access it via hw->priv. Note that mac802111 drivers should
1129 * not use wiphy_priv() to try to get their private driver structure as this
1130 * is already used internally by mac80211.
1132 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
1135 * SET_IEEE80211_DEV - set device for 802.11 hardware
1137 * @hw: the &struct ieee80211_hw to set the device for
1138 * @dev: the &struct device of this 802.11 device
1140 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
1142 set_wiphy_dev(hw
->wiphy
, dev
);
1146 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1148 * @hw: the &struct ieee80211_hw to set the MAC address for
1149 * @addr: the address to set
1151 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
1153 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
1156 static inline struct ieee80211_rate
*
1157 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
1158 const struct ieee80211_tx_info
*c
)
1160 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
1162 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
1165 static inline struct ieee80211_rate
*
1166 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
1167 const struct ieee80211_tx_info
*c
)
1169 if (c
->control
.rts_cts_rate_idx
< 0)
1171 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
1174 static inline struct ieee80211_rate
*
1175 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
1176 const struct ieee80211_tx_info
*c
, int idx
)
1178 if (c
->control
.rates
[idx
+ 1].idx
< 0)
1180 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
1184 * DOC: Hardware crypto acceleration
1186 * mac80211 is capable of taking advantage of many hardware
1187 * acceleration designs for encryption and decryption operations.
1189 * The set_key() callback in the &struct ieee80211_ops for a given
1190 * device is called to enable hardware acceleration of encryption and
1191 * decryption. The callback takes a @sta parameter that will be NULL
1192 * for default keys or keys used for transmission only, or point to
1193 * the station information for the peer for individual keys.
1194 * Multiple transmission keys with the same key index may be used when
1195 * VLANs are configured for an access point.
1197 * When transmitting, the TX control data will use the @hw_key_idx
1198 * selected by the driver by modifying the &struct ieee80211_key_conf
1199 * pointed to by the @key parameter to the set_key() function.
1201 * The set_key() call for the %SET_KEY command should return 0 if
1202 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1203 * added; if you return 0 then hw_key_idx must be assigned to the
1204 * hardware key index, you are free to use the full u8 range.
1206 * When the cmd is %DISABLE_KEY then it must succeed.
1208 * Note that it is permissible to not decrypt a frame even if a key
1209 * for it has been uploaded to hardware, the stack will not make any
1210 * decision based on whether a key has been uploaded or not but rather
1211 * based on the receive flags.
1213 * The &struct ieee80211_key_conf structure pointed to by the @key
1214 * parameter is guaranteed to be valid until another call to set_key()
1215 * removes it, but it can only be used as a cookie to differentiate
1218 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1219 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1221 * The update_tkip_key() call updates the driver with the new phase 1 key.
1222 * This happens everytime the iv16 wraps around (every 65536 packets). The
1223 * set_key() call will happen only once for each key (unless the AP did
1224 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1225 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1226 * handler is software decryption with wrap around of iv16.
1230 * DOC: Powersave support
1232 * mac80211 has support for various powersave implementations.
1234 * First, it can support hardware that handles all powersaving by itself,
1235 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1236 * flag. In that case, it will be told about the desired powersave mode
1237 * with the %IEEE80211_CONF_PS flag depending on the association status.
1238 * The hardware must take care of sending nullfunc frames when necessary,
1239 * i.e. when entering and leaving powersave mode. The hardware is required
1240 * to look at the AID in beacons and signal to the AP that it woke up when
1241 * it finds traffic directed to it.
1243 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1244 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1245 * with hardware wakeup and sleep states. Driver is responsible for waking
1246 * up the hardware before issueing commands to the hardware and putting it
1247 * back to sleep at approriate times.
1249 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1250 * buffered multicast/broadcast frames after the beacon. Also it must be
1251 * possible to send frames and receive the acknowledment frame.
1253 * Other hardware designs cannot send nullfunc frames by themselves and also
1254 * need software support for parsing the TIM bitmap. This is also supported
1255 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1256 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1257 * required to pass up beacons. The hardware is still required to handle
1258 * waking up for multicast traffic; if it cannot the driver must handle that
1259 * as best as it can, mac80211 is too slow to do that.
1261 * Dynamic powersave is an extension to normal powersave in which the
1262 * hardware stays awake for a user-specified period of time after sending a
1263 * frame so that reply frames need not be buffered and therefore delayed to
1264 * the next wakeup. It's compromise of getting good enough latency when
1265 * there's data traffic and still saving significantly power in idle
1268 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1269 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1270 * flag and mac80211 will handle everything automatically. Additionally,
1271 * hardware having support for the dynamic PS feature may set the
1272 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1273 * dynamic PS mode itself. The driver needs to look at the
1274 * @dynamic_ps_timeout hardware configuration value and use it that value
1275 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1276 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1277 * enabled whenever user has enabled powersave.
1279 * Driver informs U-APSD client support by enabling
1280 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1281 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1282 * Nullfunc frames and stay awake until the service period has ended. To
1283 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1284 * from that AC are transmitted with powersave enabled.
1286 * Note: U-APSD client mode is not yet supported with
1287 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1291 * DOC: Beacon filter support
1293 * Some hardware have beacon filter support to reduce host cpu wakeups
1294 * which will reduce system power consumption. It usuallly works so that
1295 * the firmware creates a checksum of the beacon but omits all constantly
1296 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1297 * beacon is forwarded to the host, otherwise it will be just dropped. That
1298 * way the host will only receive beacons where some relevant information
1299 * (for example ERP protection or WMM settings) have changed.
1301 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1302 * hardware capability. The driver needs to enable beacon filter support
1303 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1304 * power save is enabled, the stack will not check for beacon loss and the
1305 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1307 * The time (or number of beacons missed) until the firmware notifies the
1308 * driver of a beacon loss event (which in turn causes the driver to call
1309 * ieee80211_beacon_loss()) should be configurable and will be controlled
1310 * by mac80211 and the roaming algorithm in the future.
1312 * Since there may be constantly changing information elements that nothing
1313 * in the software stack cares about, we will, in the future, have mac80211
1314 * tell the driver which information elements are interesting in the sense
1315 * that we want to see changes in them. This will include
1316 * - a list of information element IDs
1317 * - a list of OUIs for the vendor information element
1319 * Ideally, the hardware would filter out any beacons without changes in the
1320 * requested elements, but if it cannot support that it may, at the expense
1321 * of some efficiency, filter out only a subset. For example, if the device
1322 * doesn't support checking for OUIs it should pass up all changes in all
1323 * vendor information elements.
1325 * Note that change, for the sake of simplification, also includes information
1326 * elements appearing or disappearing from the beacon.
1328 * Some hardware supports an "ignore list" instead, just make sure nothing
1329 * that was requested is on the ignore list, and include commonly changing
1330 * information element IDs in the ignore list, for example 11 (BSS load) and
1331 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1332 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1333 * it could also include some currently unused IDs.
1336 * In addition to these capabilities, hardware should support notifying the
1337 * host of changes in the beacon RSSI. This is relevant to implement roaming
1338 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1339 * the received data packets). This can consist in notifying the host when
1340 * the RSSI changes significantly or when it drops below or rises above
1341 * configurable thresholds. In the future these thresholds will also be
1342 * configured by mac80211 (which gets them from userspace) to implement
1343 * them as the roaming algorithm requires.
1345 * If the hardware cannot implement this, the driver should ask it to
1346 * periodically pass beacon frames to the host so that software can do the
1347 * signal strength threshold checking.
1351 * DOC: Spatial multiplexing power save
1353 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1354 * power in an 802.11n implementation. For details on the mechanism
1355 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1356 * "11.2.3 SM power save".
1358 * The mac80211 implementation is capable of sending action frames
1359 * to update the AP about the station's SMPS mode, and will instruct
1360 * the driver to enter the specific mode. It will also announce the
1361 * requested SMPS mode during the association handshake. Hardware
1362 * support for this feature is required, and can be indicated by
1365 * The default mode will be "automatic", which nl80211/cfg80211
1366 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1367 * turned off otherwise.
1369 * To support this feature, the driver must set the appropriate
1370 * hardware support flags, and handle the SMPS flag to the config()
1371 * operation. It will then with this mechanism be instructed to
1372 * enter the requested SMPS mode while associated to an HT AP.
1376 * DOC: Frame filtering
1378 * mac80211 requires to see many management frames for proper
1379 * operation, and users may want to see many more frames when
1380 * in monitor mode. However, for best CPU usage and power consumption,
1381 * having as few frames as possible percolate through the stack is
1382 * desirable. Hence, the hardware should filter as much as possible.
1384 * To achieve this, mac80211 uses filter flags (see below) to tell
1385 * the driver's configure_filter() function which frames should be
1386 * passed to mac80211 and which should be filtered out.
1388 * Before configure_filter() is invoked, the prepare_multicast()
1389 * callback is invoked with the parameters @mc_count and @mc_list
1390 * for the combined multicast address list of all virtual interfaces.
1391 * It's use is optional, and it returns a u64 that is passed to
1392 * configure_filter(). Additionally, configure_filter() has the
1393 * arguments @changed_flags telling which flags were changed and
1394 * @total_flags with the new flag states.
1396 * If your device has no multicast address filters your driver will
1397 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1398 * parameter to see whether multicast frames should be accepted
1401 * All unsupported flags in @total_flags must be cleared.
1402 * Hardware does not support a flag if it is incapable of _passing_
1403 * the frame to the stack. Otherwise the driver must ignore
1404 * the flag, but not clear it.
1405 * You must _only_ clear the flag (announce no support for the
1406 * flag to mac80211) if you are not able to pass the packet type
1407 * to the stack (so the hardware always filters it).
1408 * So for example, you should clear @FIF_CONTROL, if your hardware
1409 * always filters control frames. If your hardware always passes
1410 * control frames to the kernel and is incapable of filtering them,
1411 * you do _not_ clear the @FIF_CONTROL flag.
1412 * This rule applies to all other FIF flags as well.
1416 * enum ieee80211_filter_flags - hardware filter flags
1418 * These flags determine what the filter in hardware should be
1419 * programmed to let through and what should not be passed to the
1420 * stack. It is always safe to pass more frames than requested,
1421 * but this has negative impact on power consumption.
1423 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1424 * think of the BSS as your network segment and then this corresponds
1425 * to the regular ethernet device promiscuous mode.
1427 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1428 * by the user or if the hardware is not capable of filtering by
1429 * multicast address.
1431 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1432 * %RX_FLAG_FAILED_FCS_CRC for them)
1434 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1435 * the %RX_FLAG_FAILED_PLCP_CRC for them
1437 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1438 * to the hardware that it should not filter beacons or probe responses
1439 * by BSSID. Filtering them can greatly reduce the amount of processing
1440 * mac80211 needs to do and the amount of CPU wakeups, so you should
1441 * honour this flag if possible.
1443 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1444 * is not set then only those addressed to this station.
1446 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1448 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1449 * those addressed to this station.
1451 enum ieee80211_filter_flags
{
1452 FIF_PROMISC_IN_BSS
= 1<<0,
1453 FIF_ALLMULTI
= 1<<1,
1455 FIF_PLCPFAIL
= 1<<3,
1456 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1458 FIF_OTHER_BSS
= 1<<6,
1463 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1465 * These flags are used with the ampdu_action() callback in
1466 * &struct ieee80211_ops to indicate which action is needed.
1468 * Note that drivers MUST be able to deal with a TX aggregation
1469 * session being stopped even before they OK'ed starting it by
1470 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1471 * might receive the addBA frame and send a delBA right away!
1473 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1474 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1475 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1476 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1477 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1479 enum ieee80211_ampdu_mlme_action
{
1480 IEEE80211_AMPDU_RX_START
,
1481 IEEE80211_AMPDU_RX_STOP
,
1482 IEEE80211_AMPDU_TX_START
,
1483 IEEE80211_AMPDU_TX_STOP
,
1484 IEEE80211_AMPDU_TX_OPERATIONAL
,
1488 * struct ieee80211_ops - callbacks from mac80211 to the driver
1490 * This structure contains various callbacks that the driver may
1491 * handle or, in some cases, must handle, for example to configure
1492 * the hardware to a new channel or to transmit a frame.
1494 * @tx: Handler that 802.11 module calls for each transmitted frame.
1495 * skb contains the buffer starting from the IEEE 802.11 header.
1496 * The low-level driver should send the frame out based on
1497 * configuration in the TX control data. This handler should,
1498 * preferably, never fail and stop queues appropriately, more
1499 * importantly, however, it must never fail for A-MPDU-queues.
1500 * This function should return NETDEV_TX_OK except in very
1502 * Must be implemented and atomic.
1504 * @start: Called before the first netdevice attached to the hardware
1505 * is enabled. This should turn on the hardware and must turn on
1506 * frame reception (for possibly enabled monitor interfaces.)
1507 * Returns negative error codes, these may be seen in userspace,
1509 * When the device is started it should not have a MAC address
1510 * to avoid acknowledging frames before a non-monitor device
1512 * Must be implemented and can sleep.
1514 * @stop: Called after last netdevice attached to the hardware
1515 * is disabled. This should turn off the hardware (at least
1516 * it must turn off frame reception.)
1517 * May be called right after add_interface if that rejects
1518 * an interface. If you added any work onto the mac80211 workqueue
1519 * you should ensure to cancel it on this callback.
1520 * Must be implemented and can sleep.
1522 * @add_interface: Called when a netdevice attached to the hardware is
1523 * enabled. Because it is not called for monitor mode devices, @start
1524 * and @stop must be implemented.
1525 * The driver should perform any initialization it needs before
1526 * the device can be enabled. The initial configuration for the
1527 * interface is given in the conf parameter.
1528 * The callback may refuse to add an interface by returning a
1529 * negative error code (which will be seen in userspace.)
1530 * Must be implemented and can sleep.
1532 * @remove_interface: Notifies a driver that an interface is going down.
1533 * The @stop callback is called after this if it is the last interface
1534 * and no monitor interfaces are present.
1535 * When all interfaces are removed, the MAC address in the hardware
1536 * must be cleared so the device no longer acknowledges packets,
1537 * the mac_addr member of the conf structure is, however, set to the
1538 * MAC address of the device going away.
1539 * Hence, this callback must be implemented. It can sleep.
1541 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1542 * function to change hardware configuration, e.g., channel.
1543 * This function should never fail but returns a negative error code
1544 * if it does. The callback can sleep.
1546 * @bss_info_changed: Handler for configuration requests related to BSS
1547 * parameters that may vary during BSS's lifespan, and may affect low
1548 * level driver (e.g. assoc/disassoc status, erp parameters).
1549 * This function should not be used if no BSS has been set, unless
1550 * for association indication. The @changed parameter indicates which
1551 * of the bss parameters has changed when a call is made. The callback
1554 * @prepare_multicast: Prepare for multicast filter configuration.
1555 * This callback is optional, and its return value is passed
1556 * to configure_filter(). This callback must be atomic.
1558 * @configure_filter: Configure the device's RX filter.
1559 * See the section "Frame filtering" for more information.
1560 * This callback must be implemented and can sleep.
1562 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1563 * must be set or cleared for a given STA. Must be atomic.
1565 * @set_key: See the section "Hardware crypto acceleration"
1566 * This callback is only called between add_interface and
1567 * remove_interface calls, i.e. while the given virtual interface
1569 * Returns a negative error code if the key can't be added.
1570 * The callback can sleep.
1572 * @update_tkip_key: See the section "Hardware crypto acceleration"
1573 * This callback will be called in the context of Rx. Called for drivers
1574 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1575 * The callback must be atomic.
1577 * @hw_scan: Ask the hardware to service the scan request, no need to start
1578 * the scan state machine in stack. The scan must honour the channel
1579 * configuration done by the regulatory agent in the wiphy's
1580 * registered bands. The hardware (or the driver) needs to make sure
1581 * that power save is disabled.
1582 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1583 * entire IEs after the SSID, so that drivers need not look at these
1584 * at all but just send them after the SSID -- mac80211 includes the
1585 * (extended) supported rates and HT information (where applicable).
1586 * When the scan finishes, ieee80211_scan_completed() must be called;
1587 * note that it also must be called when the scan cannot finish due to
1588 * any error unless this callback returned a negative error code.
1589 * The callback can sleep.
1591 * @sw_scan_start: Notifier function that is called just before a software scan
1592 * is started. Can be NULL, if the driver doesn't need this notification.
1593 * The callback can sleep.
1595 * @sw_scan_complete: Notifier function that is called just after a
1596 * software scan finished. Can be NULL, if the driver doesn't need
1597 * this notification.
1598 * The callback can sleep.
1600 * @get_stats: Return low-level statistics.
1601 * Returns zero if statistics are available.
1602 * The callback can sleep.
1604 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1605 * callback should be provided to read the TKIP transmit IVs (both IV32
1606 * and IV16) for the given key from hardware.
1607 * The callback must be atomic.
1609 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1610 * The callback can sleep.
1612 * @sta_add: Notifies low level driver about addition of an associated station,
1613 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1615 * @sta_remove: Notifies low level driver about removal of an associated
1616 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1618 * @sta_notify: Notifies low level driver about power state transition of an
1619 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
1621 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1622 * bursting) for a hardware TX queue.
1623 * Returns a negative error code on failure.
1624 * The callback can sleep.
1626 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1627 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1628 * required function.
1629 * The callback can sleep.
1631 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1632 * Currently, this is only used for IBSS mode debugging. Is not a
1633 * required function.
1634 * The callback can sleep.
1636 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1637 * with other STAs in the IBSS. This is only used in IBSS mode. This
1638 * function is optional if the firmware/hardware takes full care of
1639 * TSF synchronization.
1640 * The callback can sleep.
1642 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1643 * This is needed only for IBSS mode and the result of this function is
1644 * used to determine whether to reply to Probe Requests.
1645 * Returns non-zero if this device sent the last beacon.
1646 * The callback can sleep.
1648 * @ampdu_action: Perform a certain A-MPDU action
1649 * The RA/TID combination determines the destination and TID we want
1650 * the ampdu action to be performed for. The action is defined through
1651 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1652 * is the first frame we expect to perform the action on. Notice
1653 * that TX/RX_STOP can pass NULL for this parameter.
1654 * Returns a negative error code on failure.
1655 * The callback must be atomic.
1657 * @get_survey: Return per-channel survey information
1659 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1660 * need to set wiphy->rfkill_poll to %true before registration,
1661 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1662 * The callback can sleep.
1664 * @set_coverage_class: Set slot time for given coverage class as specified
1665 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1666 * accordingly. This callback is not required and may sleep.
1668 * @testmode_cmd: Implement a cfg80211 test mode command.
1669 * The callback can sleep.
1671 * @flush: Flush all pending frames from the hardware queue, making sure
1672 * that the hardware queues are empty. If the parameter @drop is set
1673 * to %true, pending frames may be dropped. The callback can sleep.
1675 * @channel_switch: Drivers that need (or want) to offload the channel
1676 * switch operation for CSAs received from the AP may implement this
1677 * callback. They must then call ieee80211_chswitch_done() to indicate
1678 * completion of the channel switch.
1680 struct ieee80211_ops
{
1681 int (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1682 int (*start
)(struct ieee80211_hw
*hw
);
1683 void (*stop
)(struct ieee80211_hw
*hw
);
1684 int (*add_interface
)(struct ieee80211_hw
*hw
,
1685 struct ieee80211_vif
*vif
);
1686 void (*remove_interface
)(struct ieee80211_hw
*hw
,
1687 struct ieee80211_vif
*vif
);
1688 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
1689 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
1690 struct ieee80211_vif
*vif
,
1691 struct ieee80211_bss_conf
*info
,
1693 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
1694 struct netdev_hw_addr_list
*mc_list
);
1695 void (*configure_filter
)(struct ieee80211_hw
*hw
,
1696 unsigned int changed_flags
,
1697 unsigned int *total_flags
,
1699 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
1701 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
1702 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
1703 struct ieee80211_key_conf
*key
);
1704 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
1705 struct ieee80211_vif
*vif
,
1706 struct ieee80211_key_conf
*conf
,
1707 struct ieee80211_sta
*sta
,
1708 u32 iv32
, u16
*phase1key
);
1709 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1710 struct cfg80211_scan_request
*req
);
1711 void (*sw_scan_start
)(struct ieee80211_hw
*hw
);
1712 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
);
1713 int (*get_stats
)(struct ieee80211_hw
*hw
,
1714 struct ieee80211_low_level_stats
*stats
);
1715 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
1716 u32
*iv32
, u16
*iv16
);
1717 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1718 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1719 struct ieee80211_sta
*sta
);
1720 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1721 struct ieee80211_sta
*sta
);
1722 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1723 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
1724 int (*conf_tx
)(struct ieee80211_hw
*hw
, u16 queue
,
1725 const struct ieee80211_tx_queue_params
*params
);
1726 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
1727 void (*set_tsf
)(struct ieee80211_hw
*hw
, u64 tsf
);
1728 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
1729 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
1730 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
1731 struct ieee80211_vif
*vif
,
1732 enum ieee80211_ampdu_mlme_action action
,
1733 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
);
1734 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
1735 struct survey_info
*survey
);
1736 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
1737 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, u8 coverage_class
);
1738 #ifdef CONFIG_NL80211_TESTMODE
1739 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, void *data
, int len
);
1741 void (*flush
)(struct ieee80211_hw
*hw
, bool drop
);
1742 void (*channel_switch
)(struct ieee80211_hw
*hw
,
1743 struct ieee80211_channel_switch
*ch_switch
);
1747 * ieee80211_alloc_hw - Allocate a new hardware device
1749 * This must be called once for each hardware device. The returned pointer
1750 * must be used to refer to this device when calling other functions.
1751 * mac80211 allocates a private data area for the driver pointed to by
1752 * @priv in &struct ieee80211_hw, the size of this area is given as
1755 * @priv_data_len: length of private data
1756 * @ops: callbacks for this device
1758 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
1759 const struct ieee80211_ops
*ops
);
1762 * ieee80211_register_hw - Register hardware device
1764 * You must call this function before any other functions in
1765 * mac80211. Note that before a hardware can be registered, you
1766 * need to fill the contained wiphy's information.
1768 * @hw: the device to register as returned by ieee80211_alloc_hw()
1770 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
1772 #ifdef CONFIG_MAC80211_LEDS
1773 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
1774 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
1775 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
1776 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
1779 * ieee80211_get_tx_led_name - get name of TX LED
1781 * mac80211 creates a transmit LED trigger for each wireless hardware
1782 * that can be used to drive LEDs if your driver registers a LED device.
1783 * This function returns the name (or %NULL if not configured for LEDs)
1784 * of the trigger so you can automatically link the LED device.
1786 * @hw: the hardware to get the LED trigger name for
1788 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
1790 #ifdef CONFIG_MAC80211_LEDS
1791 return __ieee80211_get_tx_led_name(hw
);
1798 * ieee80211_get_rx_led_name - get name of RX LED
1800 * mac80211 creates a receive LED trigger for each wireless hardware
1801 * that can be used to drive LEDs if your driver registers a LED device.
1802 * This function returns the name (or %NULL if not configured for LEDs)
1803 * of the trigger so you can automatically link the LED device.
1805 * @hw: the hardware to get the LED trigger name for
1807 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
1809 #ifdef CONFIG_MAC80211_LEDS
1810 return __ieee80211_get_rx_led_name(hw
);
1817 * ieee80211_get_assoc_led_name - get name of association LED
1819 * mac80211 creates a association LED trigger for each wireless hardware
1820 * that can be used to drive LEDs if your driver registers a LED device.
1821 * This function returns the name (or %NULL if not configured for LEDs)
1822 * of the trigger so you can automatically link the LED device.
1824 * @hw: the hardware to get the LED trigger name for
1826 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
1828 #ifdef CONFIG_MAC80211_LEDS
1829 return __ieee80211_get_assoc_led_name(hw
);
1836 * ieee80211_get_radio_led_name - get name of radio LED
1838 * mac80211 creates a radio change LED trigger for each wireless hardware
1839 * that can be used to drive LEDs if your driver registers a LED device.
1840 * This function returns the name (or %NULL if not configured for LEDs)
1841 * of the trigger so you can automatically link the LED device.
1843 * @hw: the hardware to get the LED trigger name for
1845 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
1847 #ifdef CONFIG_MAC80211_LEDS
1848 return __ieee80211_get_radio_led_name(hw
);
1855 * ieee80211_unregister_hw - Unregister a hardware device
1857 * This function instructs mac80211 to free allocated resources
1858 * and unregister netdevices from the networking subsystem.
1860 * @hw: the hardware to unregister
1862 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
1865 * ieee80211_free_hw - free hardware descriptor
1867 * This function frees everything that was allocated, including the
1868 * private data for the driver. You must call ieee80211_unregister_hw()
1869 * before calling this function.
1871 * @hw: the hardware to free
1873 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
1876 * ieee80211_restart_hw - restart hardware completely
1878 * Call this function when the hardware was restarted for some reason
1879 * (hardware error, ...) and the driver is unable to restore its state
1880 * by itself. mac80211 assumes that at this point the driver/hardware
1881 * is completely uninitialised and stopped, it starts the process by
1882 * calling the ->start() operation. The driver will need to reset all
1883 * internal state that it has prior to calling this function.
1885 * @hw: the hardware to restart
1887 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
1890 * ieee80211_rx - receive frame
1892 * Use this function to hand received frames to mac80211. The receive
1893 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1894 * paged @skb is used, the driver is recommended to put the ieee80211
1895 * header of the frame on the linear part of the @skb to avoid memory
1896 * allocation and/or memcpy by the stack.
1898 * This function may not be called in IRQ context. Calls to this function
1899 * for a single hardware must be synchronized against each other. Calls to
1900 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1901 * mixed for a single hardware.
1903 * In process context use instead ieee80211_rx_ni().
1905 * @hw: the hardware this frame came in on
1906 * @skb: the buffer to receive, owned by mac80211 after this call
1908 void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1911 * ieee80211_rx_irqsafe - receive frame
1913 * Like ieee80211_rx() but can be called in IRQ context
1914 * (internally defers to a tasklet.)
1916 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1917 * be mixed for a single hardware.
1919 * @hw: the hardware this frame came in on
1920 * @skb: the buffer to receive, owned by mac80211 after this call
1922 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1925 * ieee80211_rx_ni - receive frame (in process context)
1927 * Like ieee80211_rx() but can be called in process context
1928 * (internally disables bottom halves).
1930 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1931 * not be mixed for a single hardware.
1933 * @hw: the hardware this frame came in on
1934 * @skb: the buffer to receive, owned by mac80211 after this call
1936 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
1937 struct sk_buff
*skb
)
1940 ieee80211_rx(hw
, skb
);
1945 * The TX headroom reserved by mac80211 for its own tx_status functions.
1946 * This is enough for the radiotap header.
1948 #define IEEE80211_TX_STATUS_HEADROOM 13
1951 * ieee80211_tx_status - transmit status callback
1953 * Call this function for all transmitted frames after they have been
1954 * transmitted. It is permissible to not call this function for
1955 * multicast frames but this can affect statistics.
1957 * This function may not be called in IRQ context. Calls to this function
1958 * for a single hardware must be synchronized against each other. Calls
1959 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1960 * for a single hardware.
1962 * @hw: the hardware the frame was transmitted by
1963 * @skb: the frame that was transmitted, owned by mac80211 after this call
1965 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
1966 struct sk_buff
*skb
);
1969 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1971 * Like ieee80211_tx_status() but can be called in IRQ context
1972 * (internally defers to a tasklet.)
1974 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1977 * @hw: the hardware the frame was transmitted by
1978 * @skb: the frame that was transmitted, owned by mac80211 after this call
1980 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
1981 struct sk_buff
*skb
);
1984 * ieee80211_beacon_get_tim - beacon generation function
1985 * @hw: pointer obtained from ieee80211_alloc_hw().
1986 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1987 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1988 * Set to 0 if invalid (in non-AP modes).
1989 * @tim_length: pointer to variable that will receive the TIM IE length,
1990 * (including the ID and length bytes!).
1991 * Set to 0 if invalid (in non-AP modes).
1993 * If the driver implements beaconing modes, it must use this function to
1994 * obtain the beacon frame/template.
1996 * If the beacon frames are generated by the host system (i.e., not in
1997 * hardware/firmware), the driver uses this function to get each beacon
1998 * frame from mac80211 -- it is responsible for calling this function
1999 * before the beacon is needed (e.g. based on hardware interrupt).
2001 * If the beacon frames are generated by the device, then the driver
2002 * must use the returned beacon as the template and change the TIM IE
2003 * according to the current DTIM parameters/TIM bitmap.
2005 * The driver is responsible for freeing the returned skb.
2007 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
2008 struct ieee80211_vif
*vif
,
2009 u16
*tim_offset
, u16
*tim_length
);
2012 * ieee80211_beacon_get - beacon generation function
2013 * @hw: pointer obtained from ieee80211_alloc_hw().
2014 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2016 * See ieee80211_beacon_get_tim().
2018 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
2019 struct ieee80211_vif
*vif
)
2021 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
2025 * ieee80211_pspoll_get - retrieve a PS Poll template
2026 * @hw: pointer obtained from ieee80211_alloc_hw().
2027 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2029 * Creates a PS Poll a template which can, for example, uploaded to
2030 * hardware. The template must be updated after association so that correct
2031 * AID, BSSID and MAC address is used.
2033 * Note: Caller (or hardware) is responsible for setting the
2034 * &IEEE80211_FCTL_PM bit.
2036 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
2037 struct ieee80211_vif
*vif
);
2040 * ieee80211_nullfunc_get - retrieve a nullfunc template
2041 * @hw: pointer obtained from ieee80211_alloc_hw().
2042 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2044 * Creates a Nullfunc template which can, for example, uploaded to
2045 * hardware. The template must be updated after association so that correct
2046 * BSSID and address is used.
2048 * Note: Caller (or hardware) is responsible for setting the
2049 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2051 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
2052 struct ieee80211_vif
*vif
);
2055 * ieee80211_probereq_get - retrieve a Probe Request template
2056 * @hw: pointer obtained from ieee80211_alloc_hw().
2057 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2058 * @ssid: SSID buffer
2059 * @ssid_len: length of SSID
2060 * @ie: buffer containing all IEs except SSID for the template
2061 * @ie_len: length of the IE buffer
2063 * Creates a Probe Request template which can, for example, be uploaded to
2066 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
2067 struct ieee80211_vif
*vif
,
2068 const u8
*ssid
, size_t ssid_len
,
2069 const u8
*ie
, size_t ie_len
);
2072 * ieee80211_rts_get - RTS frame generation function
2073 * @hw: pointer obtained from ieee80211_alloc_hw().
2074 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2075 * @frame: pointer to the frame that is going to be protected by the RTS.
2076 * @frame_len: the frame length (in octets).
2077 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2078 * @rts: The buffer where to store the RTS frame.
2080 * If the RTS frames are generated by the host system (i.e., not in
2081 * hardware/firmware), the low-level driver uses this function to receive
2082 * the next RTS frame from the 802.11 code. The low-level is responsible
2083 * for calling this function before and RTS frame is needed.
2085 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
2086 const void *frame
, size_t frame_len
,
2087 const struct ieee80211_tx_info
*frame_txctl
,
2088 struct ieee80211_rts
*rts
);
2091 * ieee80211_rts_duration - Get the duration field for an RTS frame
2092 * @hw: pointer obtained from ieee80211_alloc_hw().
2093 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2094 * @frame_len: the length of the frame that is going to be protected by the RTS.
2095 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2097 * If the RTS is generated in firmware, but the host system must provide
2098 * the duration field, the low-level driver uses this function to receive
2099 * the duration field value in little-endian byteorder.
2101 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
2102 struct ieee80211_vif
*vif
, size_t frame_len
,
2103 const struct ieee80211_tx_info
*frame_txctl
);
2106 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2107 * @hw: pointer obtained from ieee80211_alloc_hw().
2108 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2109 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2110 * @frame_len: the frame length (in octets).
2111 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2112 * @cts: The buffer where to store the CTS-to-self frame.
2114 * If the CTS-to-self frames are generated by the host system (i.e., not in
2115 * hardware/firmware), the low-level driver uses this function to receive
2116 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2117 * for calling this function before and CTS-to-self frame is needed.
2119 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
2120 struct ieee80211_vif
*vif
,
2121 const void *frame
, size_t frame_len
,
2122 const struct ieee80211_tx_info
*frame_txctl
,
2123 struct ieee80211_cts
*cts
);
2126 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2127 * @hw: pointer obtained from ieee80211_alloc_hw().
2128 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2129 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2130 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2132 * If the CTS-to-self is generated in firmware, but the host system must provide
2133 * the duration field, the low-level driver uses this function to receive
2134 * the duration field value in little-endian byteorder.
2136 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
2137 struct ieee80211_vif
*vif
,
2139 const struct ieee80211_tx_info
*frame_txctl
);
2142 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2143 * @hw: pointer obtained from ieee80211_alloc_hw().
2144 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2145 * @frame_len: the length of the frame.
2146 * @rate: the rate at which the frame is going to be transmitted.
2148 * Calculate the duration field of some generic frame, given its
2149 * length and transmission rate (in 100kbps).
2151 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
2152 struct ieee80211_vif
*vif
,
2154 struct ieee80211_rate
*rate
);
2157 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2158 * @hw: pointer as obtained from ieee80211_alloc_hw().
2159 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2161 * Function for accessing buffered broadcast and multicast frames. If
2162 * hardware/firmware does not implement buffering of broadcast/multicast
2163 * frames when power saving is used, 802.11 code buffers them in the host
2164 * memory. The low-level driver uses this function to fetch next buffered
2165 * frame. In most cases, this is used when generating beacon frame. This
2166 * function returns a pointer to the next buffered skb or NULL if no more
2167 * buffered frames are available.
2169 * Note: buffered frames are returned only after DTIM beacon frame was
2170 * generated with ieee80211_beacon_get() and the low-level driver must thus
2171 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2172 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2173 * does not need to check for DTIM beacons separately and should be able to
2174 * use common code for all beacons.
2177 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
2180 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2182 * This function computes a TKIP rc4 key for an skb. It computes
2183 * a phase 1 key if needed (iv16 wraps around). This function is to
2184 * be used by drivers which can do HW encryption but need to compute
2185 * to phase 1/2 key in SW.
2187 * @keyconf: the parameter passed with the set key
2188 * @skb: the skb for which the key is needed
2190 * @key: a buffer to which the key will be written
2192 void ieee80211_get_tkip_key(struct ieee80211_key_conf
*keyconf
,
2193 struct sk_buff
*skb
,
2194 enum ieee80211_tkip_key_type type
, u8
*key
);
2196 * ieee80211_wake_queue - wake specific queue
2197 * @hw: pointer as obtained from ieee80211_alloc_hw().
2198 * @queue: queue number (counted from zero).
2200 * Drivers should use this function instead of netif_wake_queue.
2202 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
2205 * ieee80211_stop_queue - stop specific queue
2206 * @hw: pointer as obtained from ieee80211_alloc_hw().
2207 * @queue: queue number (counted from zero).
2209 * Drivers should use this function instead of netif_stop_queue.
2211 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
2214 * ieee80211_queue_stopped - test status of the queue
2215 * @hw: pointer as obtained from ieee80211_alloc_hw().
2216 * @queue: queue number (counted from zero).
2218 * Drivers should use this function instead of netif_stop_queue.
2221 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
2224 * ieee80211_stop_queues - stop all queues
2225 * @hw: pointer as obtained from ieee80211_alloc_hw().
2227 * Drivers should use this function instead of netif_stop_queue.
2229 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
2232 * ieee80211_wake_queues - wake all queues
2233 * @hw: pointer as obtained from ieee80211_alloc_hw().
2235 * Drivers should use this function instead of netif_wake_queue.
2237 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
2240 * ieee80211_scan_completed - completed hardware scan
2242 * When hardware scan offload is used (i.e. the hw_scan() callback is
2243 * assigned) this function needs to be called by the driver to notify
2244 * mac80211 that the scan finished.
2246 * @hw: the hardware that finished the scan
2247 * @aborted: set to true if scan was aborted
2249 void ieee80211_scan_completed(struct ieee80211_hw
*hw
, bool aborted
);
2252 * ieee80211_iterate_active_interfaces - iterate active interfaces
2254 * This function iterates over the interfaces associated with a given
2255 * hardware that are currently active and calls the callback for them.
2256 * This function allows the iterator function to sleep, when the iterator
2257 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2260 * @hw: the hardware struct of which the interfaces should be iterated over
2261 * @iterator: the iterator function to call
2262 * @data: first argument of the iterator function
2264 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
2265 void (*iterator
)(void *data
, u8
*mac
,
2266 struct ieee80211_vif
*vif
),
2270 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2272 * This function iterates over the interfaces associated with a given
2273 * hardware that are currently active and calls the callback for them.
2274 * This function requires the iterator callback function to be atomic,
2275 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2277 * @hw: the hardware struct of which the interfaces should be iterated over
2278 * @iterator: the iterator function to call, cannot sleep
2279 * @data: first argument of the iterator function
2281 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
2282 void (*iterator
)(void *data
,
2284 struct ieee80211_vif
*vif
),
2288 * ieee80211_queue_work - add work onto the mac80211 workqueue
2290 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2291 * This helper ensures drivers are not queueing work when they should not be.
2293 * @hw: the hardware struct for the interface we are adding work for
2294 * @work: the work we want to add onto the mac80211 workqueue
2296 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
2299 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2301 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2304 * @hw: the hardware struct for the interface we are adding work for
2305 * @dwork: delayable work to queue onto the mac80211 workqueue
2306 * @delay: number of jiffies to wait before queueing
2308 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
2309 struct delayed_work
*dwork
,
2310 unsigned long delay
);
2313 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2314 * @sta: the station for which to start a BA session
2315 * @tid: the TID to BA on.
2317 * Return: success if addBA request was sent, failure otherwise
2319 * Although mac80211/low level driver/user space application can estimate
2320 * the need to start aggregation on a certain RA/TID, the session level
2321 * will be managed by the mac80211.
2323 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
2326 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2327 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2328 * @ra: receiver address of the BA session recipient.
2329 * @tid: the TID to BA on.
2331 * This function must be called by low level driver once it has
2332 * finished with preparations for the BA session.
2334 void ieee80211_start_tx_ba_cb(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
);
2337 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2338 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2339 * @ra: receiver address of the BA session recipient.
2340 * @tid: the TID to BA on.
2342 * This function must be called by low level driver once it has
2343 * finished with preparations for the BA session.
2344 * This version of the function is IRQ-safe.
2346 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
2350 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2351 * @sta: the station whose BA session to stop
2352 * @tid: the TID to stop BA.
2353 * @initiator: if indicates initiator DELBA frame will be sent.
2355 * Return: error if no sta with matching da found, success otherwise
2357 * Although mac80211/low level driver/user space application can estimate
2358 * the need to stop aggregation on a certain RA/TID, the session level
2359 * will be managed by the mac80211.
2361 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
2362 enum ieee80211_back_parties initiator
);
2365 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2366 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2367 * @ra: receiver address of the BA session recipient.
2368 * @tid: the desired TID to BA on.
2370 * This function must be called by low level driver once it has
2371 * finished with preparations for the BA session tear down.
2373 void ieee80211_stop_tx_ba_cb(struct ieee80211_vif
*vif
, u8
*ra
, u8 tid
);
2376 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2377 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2378 * @ra: receiver address of the BA session recipient.
2379 * @tid: the desired TID to BA on.
2381 * This function must be called by low level driver once it has
2382 * finished with preparations for the BA session tear down.
2383 * This version of the function is IRQ-safe.
2385 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
2389 * ieee80211_find_sta - find a station
2391 * @vif: virtual interface to look for station on
2392 * @addr: station's address
2394 * This function must be called under RCU lock and the
2395 * resulting pointer is only valid under RCU lock as well.
2397 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
2401 * ieee80211_find_sta_by_hw - find a station on hardware
2403 * @hw: pointer as obtained from ieee80211_alloc_hw()
2404 * @addr: station's address
2406 * This function must be called under RCU lock and the
2407 * resulting pointer is only valid under RCU lock as well.
2409 * NOTE: This function should not be used! When mac80211 is converted
2410 * internally to properly keep track of stations on multiple
2411 * virtual interfaces, it will not always know which station to
2412 * return here since a single address might be used by multiple
2413 * logical stations (e.g. consider a station connecting to another
2414 * BSSID on the same AP hardware without disconnecting first).
2416 * DO NOT USE THIS FUNCTION.
2418 struct ieee80211_sta
*ieee80211_find_sta_by_hw(struct ieee80211_hw
*hw
,
2422 * ieee80211_sta_block_awake - block station from waking up
2424 * @pubsta: the station
2425 * @block: whether to block or unblock
2427 * Some devices require that all frames that are on the queues
2428 * for a specific station that went to sleep are flushed before
2429 * a poll response or frames after the station woke up can be
2430 * delivered to that it. Note that such frames must be rejected
2431 * by the driver as filtered, with the appropriate status flag.
2433 * This function allows implementing this mode in a race-free
2436 * To do this, a driver must keep track of the number of frames
2437 * still enqueued for a specific station. If this number is not
2438 * zero when the station goes to sleep, the driver must call
2439 * this function to force mac80211 to consider the station to
2440 * be asleep regardless of the station's actual state. Once the
2441 * number of outstanding frames reaches zero, the driver must
2442 * call this function again to unblock the station. That will
2443 * cause mac80211 to be able to send ps-poll responses, and if
2444 * the station queried in the meantime then frames will also
2445 * be sent out as a result of this. Additionally, the driver
2446 * will be notified that the station woke up some time after
2447 * it is unblocked, regardless of whether the station actually
2448 * woke up while blocked or not.
2450 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
2451 struct ieee80211_sta
*pubsta
, bool block
);
2454 * ieee80211_beacon_loss - inform hardware does not receive beacons
2456 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2458 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and
2459 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2460 * hardware is not receiving beacons with this function.
2462 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
2465 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2467 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2469 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and
2470 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2471 * needs to inform if the connection to the AP has been lost.
2473 * This function will cause immediate change to disassociated state,
2474 * without connection recovery attempts.
2476 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
2479 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2480 * rssi threshold triggered
2482 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2483 * @rssi_event: the RSSI trigger event type
2484 * @gfp: context flags
2486 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2487 * monitoring is configured with an rssi threshold, the driver will inform
2488 * whenever the rssi level reaches the threshold.
2490 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
2491 enum nl80211_cqm_rssi_threshold_event rssi_event
,
2495 * ieee80211_chswitch_done - Complete channel switch process
2496 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2497 * @success: make the channel switch successful or not
2499 * Complete the channel switch post-process: set the new operational channel
2500 * and wake up the suspended queues.
2502 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
2504 /* Rate control API */
2507 * enum rate_control_changed - flags to indicate which parameter changed
2509 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2510 * changed, rate control algorithm can update its internal state if needed.
2512 enum rate_control_changed
{
2513 IEEE80211_RC_HT_CHANGED
= BIT(0)
2517 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2519 * @hw: The hardware the algorithm is invoked for.
2520 * @sband: The band this frame is being transmitted on.
2521 * @bss_conf: the current BSS configuration
2522 * @reported_rate: The rate control algorithm can fill this in to indicate
2523 * which rate should be reported to userspace as the current rate and
2524 * used for rate calculations in the mesh network.
2525 * @rts: whether RTS will be used for this frame because it is longer than the
2527 * @short_preamble: whether mac80211 will request short-preamble transmission
2528 * if the selected rate supports it
2529 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2530 * (deprecated; this will be removed once drivers get updated to use
2532 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2533 * @skb: the skb that will be transmitted, the control information in it needs
2535 * @ap: whether this frame is sent out in AP mode
2537 struct ieee80211_tx_rate_control
{
2538 struct ieee80211_hw
*hw
;
2539 struct ieee80211_supported_band
*sband
;
2540 struct ieee80211_bss_conf
*bss_conf
;
2541 struct sk_buff
*skb
;
2542 struct ieee80211_tx_rate reported_rate
;
2543 bool rts
, short_preamble
;
2549 struct rate_control_ops
{
2550 struct module
*module
;
2552 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
2553 void (*free
)(void *priv
);
2555 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
2556 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
2557 struct ieee80211_sta
*sta
, void *priv_sta
);
2558 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
2559 struct ieee80211_sta
*sta
,
2560 void *priv_sta
, u32 changed
,
2561 enum nl80211_channel_type oper_chan_type
);
2562 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
2565 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
2566 struct ieee80211_sta
*sta
, void *priv_sta
,
2567 struct sk_buff
*skb
);
2568 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
2569 struct ieee80211_tx_rate_control
*txrc
);
2571 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
2572 struct dentry
*dir
);
2573 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
2576 static inline int rate_supported(struct ieee80211_sta
*sta
,
2577 enum ieee80211_band band
,
2580 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
2584 * rate_control_send_low - helper for drivers for management/no-ack frames
2586 * Rate control algorithms that agree to use the lowest rate to
2587 * send management frames and NO_ACK data with the respective hw
2588 * retries should use this in the beginning of their mac80211 get_rate
2589 * callback. If true is returned the rate control can simply return.
2590 * If false is returned we guarantee that sta and sta and priv_sta is
2593 * Rate control algorithms wishing to do more intelligent selection of
2594 * rate for multicast/broadcast frames may choose to not use this.
2596 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2597 * that this may be null.
2598 * @priv_sta: private rate control structure. This may be null.
2599 * @txrc: rate control information we sholud populate for mac80211.
2601 bool rate_control_send_low(struct ieee80211_sta
*sta
,
2603 struct ieee80211_tx_rate_control
*txrc
);
2607 rate_lowest_index(struct ieee80211_supported_band
*sband
,
2608 struct ieee80211_sta
*sta
)
2612 for (i
= 0; i
< sband
->n_bitrates
; i
++)
2613 if (rate_supported(sta
, sband
->band
, i
))
2616 /* warn when we cannot find a rate. */
2623 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
2624 struct ieee80211_sta
*sta
)
2628 for (i
= 0; i
< sband
->n_bitrates
; i
++)
2629 if (rate_supported(sta
, sband
->band
, i
))
2634 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
2635 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
2638 conf_is_ht20(struct ieee80211_conf
*conf
)
2640 return conf
->channel_type
== NL80211_CHAN_HT20
;
2644 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
2646 return conf
->channel_type
== NL80211_CHAN_HT40MINUS
;
2650 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
2652 return conf
->channel_type
== NL80211_CHAN_HT40PLUS
;
2656 conf_is_ht40(struct ieee80211_conf
*conf
)
2658 return conf_is_ht40_minus(conf
) || conf_is_ht40_plus(conf
);
2662 conf_is_ht(struct ieee80211_conf
*conf
)
2664 return conf
->channel_type
!= NL80211_CHAN_NO_HT
;
2667 #endif /* MAC80211_H */