2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/wireless.h>
23 #include <net/cfg80211.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
77 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
80 enum ieee80211_notification_types
{
81 IEEE80211_NOTIFY_RE_ASSOC
,
85 * enum ieee80211_max_queues - maximum number of queues
87 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
88 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
89 * for A-MPDU operation.
91 enum ieee80211_max_queues
{
92 IEEE80211_MAX_QUEUES
= 16,
93 IEEE80211_MAX_AMPDU_QUEUES
= 16,
97 * struct ieee80211_tx_queue_params - transmit queue configuration
99 * The information provided in this structure is required for QoS
100 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
102 * @aifs: arbitration interframe space [0..255]
103 * @cw_min: minimum contention window [a value of the form
104 * 2^n-1 in the range 1..32767]
105 * @cw_max: maximum contention window [like @cw_min]
106 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
108 struct ieee80211_tx_queue_params
{
116 * struct ieee80211_tx_queue_stats - transmit queue statistics
118 * @len: number of packets in queue
119 * @limit: queue length limit
120 * @count: number of frames sent
122 struct ieee80211_tx_queue_stats
{
128 struct ieee80211_low_level_stats
{
129 unsigned int dot11ACKFailureCount
;
130 unsigned int dot11RTSFailureCount
;
131 unsigned int dot11FCSErrorCount
;
132 unsigned int dot11RTSSuccessCount
;
136 * enum ieee80211_bss_change - BSS change notification flags
138 * These flags are used with the bss_info_changed() callback
139 * to indicate which BSS parameter changed.
141 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
142 * also implies a change in the AID.
143 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
144 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
145 * @BSS_CHANGED_ERP_SLOT: slot timing changed
146 * @BSS_CHANGED_HT: 802.11n parameters changed
147 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
149 enum ieee80211_bss_change
{
150 BSS_CHANGED_ASSOC
= 1<<0,
151 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
152 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
153 BSS_CHANGED_ERP_SLOT
= 1<<3,
154 BSS_CHANGED_HT
= 1<<4,
155 BSS_CHANGED_BASIC_RATES
= 1<<5,
159 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
160 * @secondary_channel_offset: secondary channel offset, uses
161 * %IEEE80211_HT_PARAM_CHA_SEC_ values
162 * @width_40_ok: indicates that 40 MHz bandwidth may be used for TX
163 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
165 struct ieee80211_bss_ht_conf
{
166 u8 secondary_channel_offset
;
172 * struct ieee80211_bss_conf - holds the BSS's changing parameters
174 * This structure keeps information about a BSS (and an association
175 * to that BSS) that can change during the lifetime of the BSS.
177 * @assoc: association status
178 * @aid: association ID number, valid only when @assoc is true
179 * @use_cts_prot: use CTS protection
180 * @use_short_preamble: use 802.11b short preamble;
181 * if the hardware cannot handle this it must set the
182 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
183 * @use_short_slot: use short slot time (only relevant for ERP);
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
186 * @dtim_period: num of beacons before the next DTIM, for PSM
187 * @timestamp: beacon timestamp
188 * @beacon_int: beacon interval
189 * @assoc_capability: capabilities taken from assoc resp
190 * @ht: BSS's HT configuration
191 * @basic_rates: bitmap of basic rates, each bit stands for an
192 * index into the rate table configured by the driver in
195 struct ieee80211_bss_conf
{
196 /* association related data */
199 /* erp related data */
201 bool use_short_preamble
;
205 u16 assoc_capability
;
208 struct ieee80211_bss_ht_conf ht
;
212 * enum mac80211_tx_control_flags - flags to describe transmission information/status
214 * These flags are used with the @flags member of &ieee80211_tx_info.
216 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
217 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
218 * number to this frame, taking care of not overwriting the fragment
219 * number and increasing the sequence number only when the
220 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
221 * assign sequence numbers to QoS-data frames but cannot do so correctly
222 * for non-QoS-data and management frames because beacons need them from
223 * that counter as well and mac80211 cannot guarantee proper sequencing.
224 * If this flag is set, the driver should instruct the hardware to
225 * assign a sequence number to the frame or assign one itself. Cf. IEEE
226 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
227 * beacons and always be clear for frames without a sequence number field.
228 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
229 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
231 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
232 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
233 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
234 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
235 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
236 * because the destination STA was in powersave mode.
237 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
238 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
239 * is for the whole aggregation.
240 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
241 * so consider using block ack request (BAR).
242 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
243 * set by rate control algorithms to indicate probe rate, will
244 * be cleared for fragmented frames (except on the last fragment)
246 enum mac80211_tx_control_flags
{
247 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
248 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
249 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
250 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
251 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
252 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
253 IEEE80211_TX_CTL_AMPDU
= BIT(6),
254 IEEE80211_TX_CTL_INJECTED
= BIT(7),
255 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
256 IEEE80211_TX_STAT_ACK
= BIT(9),
257 IEEE80211_TX_STAT_AMPDU
= BIT(10),
258 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
259 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
262 enum mac80211_rate_control_flags
{
263 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
264 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
265 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
267 /* rate index is an MCS rate number instead of an index */
268 IEEE80211_TX_RC_MCS
= BIT(3),
269 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
270 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
271 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
272 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
276 /* there are 40 bytes if you don't need the rateset to be kept */
277 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
279 /* if you do need the rateset, then you have less space */
280 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
282 /* maximum number of rate stages */
283 #define IEEE80211_TX_MAX_RATES 5
286 * struct ieee80211_tx_rate - rate selection/status
288 * @idx: rate index to attempt to send with
289 * @flags: rate control flags (&enum mac80211_rate_control_flags)
290 * @count: number of tries in this rate before going to the next rate
292 * A value of -1 for @idx indicates an invalid rate and, if used
293 * in an array of retry rates, that no more rates should be tried.
295 * When used for transmit status reporting, the driver should
296 * always report the rate along with the flags it used.
298 struct ieee80211_tx_rate
{
305 * struct ieee80211_tx_info - skb transmit information
307 * This structure is placed in skb->cb for three uses:
308 * (1) mac80211 TX control - mac80211 tells the driver what to do
309 * (2) driver internal use (if applicable)
310 * (3) TX status information - driver tells mac80211 what happened
312 * The TX control's sta pointer is only valid during the ->tx call,
315 * @flags: transmit info flags, defined above
316 * @band: the band to transmit on (use for checking for races)
317 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
318 * @control: union for control data
319 * @status: union for status data
320 * @driver_data: array of driver_data pointers
321 * @retry_count: number of retries
322 * @ampdu_ack_len: number of aggregated frames.
323 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
324 * @ampdu_ack_map: block ack bit map for the aggregation.
325 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
326 * @ack_signal: signal strength of the ACK frame
328 struct ieee80211_tx_info
{
329 /* common information */
342 struct ieee80211_tx_rate rates
[
343 IEEE80211_TX_MAX_RATES
];
346 /* only needed before rate control */
347 unsigned long jiffies
;
349 /* NB: vif can be NULL for injected frames */
350 struct ieee80211_vif
*vif
;
351 struct ieee80211_key_conf
*hw_key
;
352 struct ieee80211_sta
*sta
;
355 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
362 struct ieee80211_tx_rate driver_rates
[
363 IEEE80211_TX_MAX_RATES
];
364 void *rate_driver_data
[
365 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
368 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
372 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
374 return (struct ieee80211_tx_info
*)skb
->cb
;
378 * ieee80211_tx_info_clear_status - clear TX status
380 * @info: The &struct ieee80211_tx_info to be cleared.
382 * When the driver passes an skb back to mac80211, it must report
383 * a number of things in TX status. This function clears everything
384 * in the TX status but the rate control information (it does clear
385 * the count since you need to fill that in anyway).
387 * NOTE: You can only use this function if you do NOT use
388 * info->driver_data! Use info->rate_driver_data
389 * instead if you need only the less space that allows.
392 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
396 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
397 offsetof(struct ieee80211_tx_info
, control
.rates
));
398 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
399 offsetof(struct ieee80211_tx_info
, driver_rates
));
400 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
401 /* clear the rate counts */
402 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
403 info
->status
.rates
[i
].count
= 0;
406 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
) != 23);
407 memset(&info
->status
.ampdu_ack_len
, 0,
408 sizeof(struct ieee80211_tx_info
) -
409 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
414 * enum mac80211_rx_flags - receive flags
416 * These flags are used with the @flag member of &struct ieee80211_rx_status.
417 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
418 * Use together with %RX_FLAG_MMIC_STRIPPED.
419 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
420 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
421 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
422 * verification has been done by the hardware.
423 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
424 * If this flag is set, the stack cannot do any replay detection
425 * hence the driver or hardware will have to do that.
426 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
428 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
430 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
431 * is valid. This is useful in monitor mode and necessary for beacon frames
432 * to enable IBSS merging.
433 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
435 enum mac80211_rx_flags
{
436 RX_FLAG_MMIC_ERROR
= 1<<0,
437 RX_FLAG_DECRYPTED
= 1<<1,
438 RX_FLAG_RADIOTAP
= 1<<2,
439 RX_FLAG_MMIC_STRIPPED
= 1<<3,
440 RX_FLAG_IV_STRIPPED
= 1<<4,
441 RX_FLAG_FAILED_FCS_CRC
= 1<<5,
442 RX_FLAG_FAILED_PLCP_CRC
= 1<<6,
444 RX_FLAG_SHORTPRE
= 1<<8
448 * struct ieee80211_rx_status - receive status
450 * The low-level driver should provide this information (the subset
451 * supported by hardware) to the 802.11 code with each received
454 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
455 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
456 * @band: the active band when this frame was received
457 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
458 * @signal: signal strength when receiving this frame, either in dBm, in dB or
459 * unspecified depending on the hardware capabilities flags
460 * @IEEE80211_HW_SIGNAL_*
461 * @noise: noise when receiving this frame, in dBm.
462 * @qual: overall signal quality indication, in percent (0-100).
463 * @antenna: antenna used
464 * @rate_idx: index of data rate into band's supported rates
467 struct ieee80211_rx_status
{
469 enum ieee80211_band band
;
480 * enum ieee80211_conf_flags - configuration flags
482 * Flags to define PHY configuration options
484 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
485 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
487 enum ieee80211_conf_flags
{
488 IEEE80211_CONF_RADIOTAP
= (1<<0),
489 IEEE80211_CONF_PS
= (1<<1),
492 /* XXX: remove all this once drivers stop trying to use it */
493 static inline int __deprecated
__IEEE80211_CONF_SHORT_SLOT_TIME(void)
497 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
499 struct ieee80211_ht_conf
{
504 * enum ieee80211_conf_changed - denotes which configuration changed
506 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
507 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
508 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
509 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
510 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
511 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
512 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed
513 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
514 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed
516 enum ieee80211_conf_changed
{
517 IEEE80211_CONF_CHANGE_RADIO_ENABLED
= BIT(0),
518 IEEE80211_CONF_CHANGE_BEACON_INTERVAL
= BIT(1),
519 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
520 IEEE80211_CONF_CHANGE_RADIOTAP
= BIT(3),
521 IEEE80211_CONF_CHANGE_PS
= BIT(4),
522 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
523 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
524 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
525 IEEE80211_CONF_CHANGE_HT
= BIT(8),
529 * struct ieee80211_conf - configuration of the device
531 * This struct indicates how the driver shall configure the hardware.
533 * @radio_enabled: when zero, driver is required to switch off the radio.
534 * @beacon_int: beacon interval (TODO make interface config)
535 * @listen_interval: listen interval in units of beacon interval
536 * @flags: configuration flags defined above
537 * @power_level: requested transmit power (in dBm)
538 * @channel: the channel to tune to
539 * @ht: the HT configuration for the device
540 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
541 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
542 * but actually means the number of transmissions not the number of retries
543 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
544 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
545 * number of transmissions not the number of retries
547 struct ieee80211_conf
{
555 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
557 struct ieee80211_channel
*channel
;
558 struct ieee80211_ht_conf ht
;
562 * struct ieee80211_vif - per-interface data
564 * Data in this structure is continually present for driver
565 * use during the life of a virtual interface.
567 * @type: type of this virtual interface
568 * @bss_conf: BSS configuration for this interface, either our own
569 * or the BSS we're associated to
570 * @drv_priv: data area for driver use, will always be aligned to
573 struct ieee80211_vif
{
574 enum nl80211_iftype type
;
575 struct ieee80211_bss_conf bss_conf
;
577 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
580 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
582 #ifdef CONFIG_MAC80211_MESH
583 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
589 * struct ieee80211_if_init_conf - initial configuration of an interface
591 * @vif: pointer to a driver-use per-interface structure. The pointer
592 * itself is also used for various functions including
593 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
594 * @type: one of &enum nl80211_iftype constants. Determines the type of
595 * added/removed interface.
596 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
597 * until the interface is removed (i.e. it cannot be used after
598 * remove_interface() callback was called for this interface).
600 * This structure is used in add_interface() and remove_interface()
601 * callbacks of &struct ieee80211_hw.
603 * When you allow multiple interfaces to be added to your PHY, take care
604 * that the hardware can actually handle multiple MAC addresses. However,
605 * also take care that when there's no interface left with mac_addr != %NULL
606 * you remove the MAC address from the device to avoid acknowledging packets
607 * in pure monitor mode.
609 struct ieee80211_if_init_conf
{
610 enum nl80211_iftype type
;
611 struct ieee80211_vif
*vif
;
616 * enum ieee80211_if_conf_change - interface config change flags
618 * @IEEE80211_IFCC_BSSID: The BSSID changed.
619 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
620 * (currently AP and MESH only), use ieee80211_beacon_get().
622 enum ieee80211_if_conf_change
{
623 IEEE80211_IFCC_BSSID
= BIT(0),
624 IEEE80211_IFCC_BEACON
= BIT(1),
628 * struct ieee80211_if_conf - configuration of an interface
630 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
631 * @bssid: BSSID of the network we are associated to/creating.
633 * This structure is passed to the config_interface() callback of
634 * &struct ieee80211_hw.
636 struct ieee80211_if_conf
{
642 * enum ieee80211_key_alg - key algorithm
643 * @ALG_WEP: WEP40 or WEP104
645 * @ALG_CCMP: CCMP (AES)
647 enum ieee80211_key_alg
{
654 * enum ieee80211_key_len - key length
655 * @LEN_WEP40: WEP 5-byte long key
656 * @LEN_WEP104: WEP 13-byte long key
658 enum ieee80211_key_len
{
664 * enum ieee80211_key_flags - key flags
666 * These flags are used for communication about keys between the driver
667 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
669 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
670 * that the STA this key will be used with could be using QoS.
671 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
672 * driver to indicate that it requires IV generation for this
674 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
675 * the driver for a TKIP key if it requires Michael MIC
676 * generation in software.
677 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
678 * that the key is pairwise rather then a shared key.
680 enum ieee80211_key_flags
{
681 IEEE80211_KEY_FLAG_WMM_STA
= 1<<0,
682 IEEE80211_KEY_FLAG_GENERATE_IV
= 1<<1,
683 IEEE80211_KEY_FLAG_GENERATE_MMIC
= 1<<2,
684 IEEE80211_KEY_FLAG_PAIRWISE
= 1<<3,
688 * struct ieee80211_key_conf - key information
690 * This key information is given by mac80211 to the driver by
691 * the set_key() callback in &struct ieee80211_ops.
693 * @hw_key_idx: To be set by the driver, this is the key index the driver
694 * wants to be given when a frame is transmitted and needs to be
695 * encrypted in hardware.
696 * @alg: The key algorithm.
697 * @flags: key flags, see &enum ieee80211_key_flags.
698 * @keyidx: the key index (0-3)
699 * @keylen: key material length
700 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
702 * - Temporal Encryption Key (128 bits)
703 * - Temporal Authenticator Tx MIC Key (64 bits)
704 * - Temporal Authenticator Rx MIC Key (64 bits)
708 struct ieee80211_key_conf
{
709 enum ieee80211_key_alg alg
;
720 * enum set_key_cmd - key command
722 * Used with the set_key() callback in &struct ieee80211_ops, this
723 * indicates whether a key is being removed or added.
725 * @SET_KEY: a key is set
726 * @DISABLE_KEY: a key must be disabled
729 SET_KEY
, DISABLE_KEY
,
733 * struct ieee80211_sta - station table entry
735 * A station table entry represents a station we are possibly
736 * communicating with. Since stations are RCU-managed in
737 * mac80211, any ieee80211_sta pointer you get access to must
738 * either be protected by rcu_read_lock() explicitly or implicitly,
739 * or you must take good care to not use such a pointer after a
740 * call to your sta_notify callback that removed it.
743 * @aid: AID we assigned to the station if we're an AP
744 * @supp_rates: Bitmap of supported rates (per band)
745 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
746 * @drv_priv: data area for driver use, will always be aligned to
747 * sizeof(void *), size is determined in hw information.
749 struct ieee80211_sta
{
750 u64 supp_rates
[IEEE80211_NUM_BANDS
];
753 struct ieee80211_sta_ht_cap ht_cap
;
756 u8 drv_priv
[0] __attribute__((__aligned__(sizeof(void *))));
760 * enum sta_notify_cmd - sta notify command
762 * Used with the sta_notify() callback in &struct ieee80211_ops, this
763 * indicates addition and removal of a station to station table.
765 * @STA_NOTIFY_ADD: a station was added to the station table
766 * @STA_NOTIFY_REMOVE: a station being removed from the station table
768 enum sta_notify_cmd
{
769 STA_NOTIFY_ADD
, STA_NOTIFY_REMOVE
773 * enum ieee80211_tkip_key_type - get tkip key
775 * Used by drivers which need to get a tkip key for skb. Some drivers need a
776 * phase 1 key, others need a phase 2 key. A single function allows the driver
777 * to get the key, this enum indicates what type of key is required.
779 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
780 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
782 enum ieee80211_tkip_key_type
{
783 IEEE80211_TKIP_P1_KEY
,
784 IEEE80211_TKIP_P2_KEY
,
788 * enum ieee80211_hw_flags - hardware flags
790 * These flags are used to indicate hardware capabilities to
791 * the stack. Generally, flags here should have their meaning
792 * done in a way that the simplest hardware doesn't need setting
793 * any particular flags. There are some exceptions to this rule,
794 * however, so you are advised to review these flags carefully.
796 * @IEEE80211_HW_RX_INCLUDES_FCS:
797 * Indicates that received frames passed to the stack include
798 * the FCS at the end.
800 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
801 * Some wireless LAN chipsets buffer broadcast/multicast frames
802 * for power saving stations in the hardware/firmware and others
803 * rely on the host system for such buffering. This option is used
804 * to configure the IEEE 802.11 upper layer to buffer broadcast and
805 * multicast frames when there are power saving stations so that
806 * the driver can fetch them with ieee80211_get_buffered_bc().
808 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
809 * Hardware is not capable of short slot operation on the 2.4 GHz band.
811 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
812 * Hardware is not capable of receiving frames with short preamble on
815 * @IEEE80211_HW_SIGNAL_UNSPEC:
816 * Hardware can provide signal values but we don't know its units. We
817 * expect values between 0 and @max_signal.
818 * If possible please provide dB or dBm instead.
820 * @IEEE80211_HW_SIGNAL_DB:
821 * Hardware gives signal values in dB, decibel difference from an
822 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
823 * If possible please provide dBm instead.
825 * @IEEE80211_HW_SIGNAL_DBM:
826 * Hardware gives signal values in dBm, decibel difference from
827 * one milliwatt. This is the preferred method since it is standardized
828 * between different devices. @max_signal does not need to be set.
830 * @IEEE80211_HW_NOISE_DBM:
831 * Hardware can provide noise (radio interference) values in units dBm,
832 * decibel difference from one milliwatt.
834 * @IEEE80211_HW_SPECTRUM_MGMT:
835 * Hardware supports spectrum management defined in 802.11h
836 * Measurement, Channel Switch, Quieting, TPC
838 * @IEEE80211_HW_AMPDU_AGGREGATION:
839 * Hardware supports 11n A-MPDU aggregation.
841 enum ieee80211_hw_flags
{
842 IEEE80211_HW_RX_INCLUDES_FCS
= 1<<1,
843 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
= 1<<2,
844 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE
= 1<<3,
845 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE
= 1<<4,
846 IEEE80211_HW_SIGNAL_UNSPEC
= 1<<5,
847 IEEE80211_HW_SIGNAL_DB
= 1<<6,
848 IEEE80211_HW_SIGNAL_DBM
= 1<<7,
849 IEEE80211_HW_NOISE_DBM
= 1<<8,
850 IEEE80211_HW_SPECTRUM_MGMT
= 1<<9,
851 IEEE80211_HW_AMPDU_AGGREGATION
= 1<<10,
855 * struct ieee80211_hw - hardware information and state
857 * This structure contains the configuration and hardware
858 * information for an 802.11 PHY.
860 * @wiphy: This points to the &struct wiphy allocated for this
861 * 802.11 PHY. You must fill in the @perm_addr and @dev
862 * members of this structure using SET_IEEE80211_DEV()
863 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
864 * bands (with channels, bitrates) are registered here.
866 * @conf: &struct ieee80211_conf, device configuration, don't use.
868 * @workqueue: single threaded workqueue available for driver use,
869 * allocated by mac80211 on registration and flushed when an
870 * interface is removed.
871 * NOTICE: All work performed on this workqueue should NEVER
872 * acquire the RTNL lock (i.e. Don't use the function
873 * ieee80211_iterate_active_interfaces())
875 * @priv: pointer to private area that was allocated for driver use
876 * along with this structure.
878 * @flags: hardware flags, see &enum ieee80211_hw_flags.
880 * @extra_tx_headroom: headroom to reserve in each transmit skb
881 * for use by the driver (e.g. for transmit headers.)
883 * @channel_change_time: time (in microseconds) it takes to change channels.
885 * @max_signal: Maximum value for signal (rssi) in RX information, used
886 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
888 * @max_listen_interval: max listen interval in units of beacon interval
891 * @queues: number of available hardware transmit queues for
892 * data packets. WMM/QoS requires at least four, these
893 * queues need to have configurable access parameters.
895 * @ampdu_queues: number of available hardware transmit queues
896 * for A-MPDU packets, these have no access parameters
897 * because they're used only for A-MPDU frames. Note that
898 * mac80211 will not currently use any of the regular queues
901 * @rate_control_algorithm: rate control algorithm for this hardware.
902 * If unset (NULL), the default algorithm will be used. Must be
903 * set before calling ieee80211_register_hw().
905 * @vif_data_size: size (in bytes) of the drv_priv data area
906 * within &struct ieee80211_vif.
907 * @sta_data_size: size (in bytes) of the drv_priv data area
908 * within &struct ieee80211_sta.
910 * @max_rates: maximum number of alternate rate retry stages
911 * @max_rate_tries: maximum number of tries for each stage
913 struct ieee80211_hw
{
914 struct ieee80211_conf conf
;
916 struct workqueue_struct
*workqueue
;
917 const char *rate_control_algorithm
;
920 unsigned int extra_tx_headroom
;
921 int channel_change_time
;
926 u16 max_listen_interval
;
933 * SET_IEEE80211_DEV - set device for 802.11 hardware
935 * @hw: the &struct ieee80211_hw to set the device for
936 * @dev: the &struct device of this 802.11 device
938 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
940 set_wiphy_dev(hw
->wiphy
, dev
);
944 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
946 * @hw: the &struct ieee80211_hw to set the MAC address for
947 * @addr: the address to set
949 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
951 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
954 static inline int ieee80211_num_regular_queues(struct ieee80211_hw
*hw
)
959 static inline int ieee80211_num_queues(struct ieee80211_hw
*hw
)
961 return hw
->queues
+ hw
->ampdu_queues
;
964 static inline struct ieee80211_rate
*
965 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
966 const struct ieee80211_tx_info
*c
)
968 if (WARN_ON(c
->control
.rates
[0].idx
< 0))
970 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
973 static inline struct ieee80211_rate
*
974 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
975 const struct ieee80211_tx_info
*c
)
977 if (c
->control
.rts_cts_rate_idx
< 0)
979 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
982 static inline struct ieee80211_rate
*
983 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
984 const struct ieee80211_tx_info
*c
, int idx
)
986 if (c
->control
.rates
[idx
+ 1].idx
< 0)
988 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
992 * DOC: Hardware crypto acceleration
994 * mac80211 is capable of taking advantage of many hardware
995 * acceleration designs for encryption and decryption operations.
997 * The set_key() callback in the &struct ieee80211_ops for a given
998 * device is called to enable hardware acceleration of encryption and
999 * decryption. The callback takes an @address parameter that will be
1000 * the broadcast address for default keys, the other station's hardware
1001 * address for individual keys or the zero address for keys that will
1002 * be used only for transmission.
1003 * Multiple transmission keys with the same key index may be used when
1004 * VLANs are configured for an access point.
1006 * The @local_address parameter will always be set to our own address,
1007 * this is only relevant if you support multiple local addresses.
1009 * When transmitting, the TX control data will use the @hw_key_idx
1010 * selected by the driver by modifying the &struct ieee80211_key_conf
1011 * pointed to by the @key parameter to the set_key() function.
1013 * The set_key() call for the %SET_KEY command should return 0 if
1014 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1015 * added; if you return 0 then hw_key_idx must be assigned to the
1016 * hardware key index, you are free to use the full u8 range.
1018 * When the cmd is %DISABLE_KEY then it must succeed.
1020 * Note that it is permissible to not decrypt a frame even if a key
1021 * for it has been uploaded to hardware, the stack will not make any
1022 * decision based on whether a key has been uploaded or not but rather
1023 * based on the receive flags.
1025 * The &struct ieee80211_key_conf structure pointed to by the @key
1026 * parameter is guaranteed to be valid until another call to set_key()
1027 * removes it, but it can only be used as a cookie to differentiate
1030 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1031 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1033 * The update_tkip_key() call updates the driver with the new phase 1 key.
1034 * This happens everytime the iv16 wraps around (every 65536 packets). The
1035 * set_key() call will happen only once for each key (unless the AP did
1036 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1037 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1038 * handler is software decryption with wrap around of iv16.
1042 * DOC: Frame filtering
1044 * mac80211 requires to see many management frames for proper
1045 * operation, and users may want to see many more frames when
1046 * in monitor mode. However, for best CPU usage and power consumption,
1047 * having as few frames as possible percolate through the stack is
1048 * desirable. Hence, the hardware should filter as much as possible.
1050 * To achieve this, mac80211 uses filter flags (see below) to tell
1051 * the driver's configure_filter() function which frames should be
1052 * passed to mac80211 and which should be filtered out.
1054 * The configure_filter() callback is invoked with the parameters
1055 * @mc_count and @mc_list for the combined multicast address list
1056 * of all virtual interfaces, @changed_flags telling which flags
1057 * were changed and @total_flags with the new flag states.
1059 * If your device has no multicast address filters your driver will
1060 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1061 * parameter to see whether multicast frames should be accepted
1064 * All unsupported flags in @total_flags must be cleared.
1065 * Hardware does not support a flag if it is incapable of _passing_
1066 * the frame to the stack. Otherwise the driver must ignore
1067 * the flag, but not clear it.
1068 * You must _only_ clear the flag (announce no support for the
1069 * flag to mac80211) if you are not able to pass the packet type
1070 * to the stack (so the hardware always filters it).
1071 * So for example, you should clear @FIF_CONTROL, if your hardware
1072 * always filters control frames. If your hardware always passes
1073 * control frames to the kernel and is incapable of filtering them,
1074 * you do _not_ clear the @FIF_CONTROL flag.
1075 * This rule applies to all other FIF flags as well.
1079 * enum ieee80211_filter_flags - hardware filter flags
1081 * These flags determine what the filter in hardware should be
1082 * programmed to let through and what should not be passed to the
1083 * stack. It is always safe to pass more frames than requested,
1084 * but this has negative impact on power consumption.
1086 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1087 * think of the BSS as your network segment and then this corresponds
1088 * to the regular ethernet device promiscuous mode.
1090 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1091 * by the user or if the hardware is not capable of filtering by
1092 * multicast address.
1094 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1095 * %RX_FLAG_FAILED_FCS_CRC for them)
1097 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1098 * the %RX_FLAG_FAILED_PLCP_CRC for them
1100 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1101 * to the hardware that it should not filter beacons or probe responses
1102 * by BSSID. Filtering them can greatly reduce the amount of processing
1103 * mac80211 needs to do and the amount of CPU wakeups, so you should
1104 * honour this flag if possible.
1106 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1107 * only those addressed to this station
1109 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1111 enum ieee80211_filter_flags
{
1112 FIF_PROMISC_IN_BSS
= 1<<0,
1113 FIF_ALLMULTI
= 1<<1,
1115 FIF_PLCPFAIL
= 1<<3,
1116 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
1118 FIF_OTHER_BSS
= 1<<6,
1122 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1124 * These flags are used with the ampdu_action() callback in
1125 * &struct ieee80211_ops to indicate which action is needed.
1126 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1127 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1128 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1129 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1130 * @IEEE80211_AMPDU_TX_RESUME: resume TX aggregation
1132 enum ieee80211_ampdu_mlme_action
{
1133 IEEE80211_AMPDU_RX_START
,
1134 IEEE80211_AMPDU_RX_STOP
,
1135 IEEE80211_AMPDU_TX_START
,
1136 IEEE80211_AMPDU_TX_STOP
,
1137 IEEE80211_AMPDU_TX_RESUME
,
1141 * struct ieee80211_ops - callbacks from mac80211 to the driver
1143 * This structure contains various callbacks that the driver may
1144 * handle or, in some cases, must handle, for example to configure
1145 * the hardware to a new channel or to transmit a frame.
1147 * @tx: Handler that 802.11 module calls for each transmitted frame.
1148 * skb contains the buffer starting from the IEEE 802.11 header.
1149 * The low-level driver should send the frame out based on
1150 * configuration in the TX control data. This handler should,
1151 * preferably, never fail and stop queues appropriately, more
1152 * importantly, however, it must never fail for A-MPDU-queues.
1153 * Must be implemented and atomic.
1155 * @start: Called before the first netdevice attached to the hardware
1156 * is enabled. This should turn on the hardware and must turn on
1157 * frame reception (for possibly enabled monitor interfaces.)
1158 * Returns negative error codes, these may be seen in userspace,
1160 * When the device is started it should not have a MAC address
1161 * to avoid acknowledging frames before a non-monitor device
1163 * Must be implemented.
1165 * @stop: Called after last netdevice attached to the hardware
1166 * is disabled. This should turn off the hardware (at least
1167 * it must turn off frame reception.)
1168 * May be called right after add_interface if that rejects
1170 * Must be implemented.
1172 * @add_interface: Called when a netdevice attached to the hardware is
1173 * enabled. Because it is not called for monitor mode devices, @start
1174 * and @stop must be implemented.
1175 * The driver should perform any initialization it needs before
1176 * the device can be enabled. The initial configuration for the
1177 * interface is given in the conf parameter.
1178 * The callback may refuse to add an interface by returning a
1179 * negative error code (which will be seen in userspace.)
1180 * Must be implemented.
1182 * @remove_interface: Notifies a driver that an interface is going down.
1183 * The @stop callback is called after this if it is the last interface
1184 * and no monitor interfaces are present.
1185 * When all interfaces are removed, the MAC address in the hardware
1186 * must be cleared so the device no longer acknowledges packets,
1187 * the mac_addr member of the conf structure is, however, set to the
1188 * MAC address of the device going away.
1189 * Hence, this callback must be implemented.
1191 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1192 * function to change hardware configuration, e.g., channel.
1194 * @config_interface: Handler for configuration requests related to interfaces
1195 * (e.g. BSSID changes.)
1197 * @bss_info_changed: Handler for configuration requests related to BSS
1198 * parameters that may vary during BSS's lifespan, and may affect low
1199 * level driver (e.g. assoc/disassoc status, erp parameters).
1200 * This function should not be used if no BSS has been set, unless
1201 * for association indication. The @changed parameter indicates which
1202 * of the bss parameters has changed when a call is made.
1204 * @configure_filter: Configure the device's RX filter.
1205 * See the section "Frame filtering" for more information.
1206 * This callback must be implemented and atomic.
1208 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1209 * must be set or cleared for a given STA. Must be atomic.
1211 * @set_key: See the section "Hardware crypto acceleration"
1212 * This callback can sleep, and is only called between add_interface
1213 * and remove_interface calls, i.e. while the interface with the
1214 * given local_address is enabled.
1216 * @update_tkip_key: See the section "Hardware crypto acceleration"
1217 * This callback will be called in the context of Rx. Called for drivers
1218 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1220 * @hw_scan: Ask the hardware to service the scan request, no need to start
1221 * the scan state machine in stack. The scan must honour the channel
1222 * configuration done by the regulatory agent in the wiphy's registered
1223 * bands. When the scan finishes, ieee80211_scan_completed() must be
1224 * called; note that it also must be called when the scan cannot finish
1225 * because the hardware is turned off! Anything else is a bug!
1227 * @get_stats: return low-level statistics
1229 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1230 * callback should be provided to read the TKIP transmit IVs (both IV32
1231 * and IV16) for the given key from hardware.
1233 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1235 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1236 * the device does fragmentation by itself; if this method is assigned then
1237 * the stack will not do fragmentation.
1239 * @sta_notify: Notifies low level driver about addition or removal
1240 * of associated station or AP.
1242 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1243 * bursting) for a hardware TX queue.
1245 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1246 * to get number of currently queued packets (queue length), maximum queue
1247 * size (limit), and total number of packets sent using each TX queue
1248 * (count). The 'stats' pointer points to an array that has hw->queues +
1249 * hw->ampdu_queues items.
1251 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1252 * this is only used for IBSS mode debugging and, as such, is not a
1253 * required function. Must be atomic.
1255 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1256 * with other STAs in the IBSS. This is only used in IBSS mode. This
1257 * function is optional if the firmware/hardware takes full care of
1258 * TSF synchronization.
1260 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1261 * This is needed only for IBSS mode and the result of this function is
1262 * used to determine whether to reply to Probe Requests.
1264 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1266 * @ampdu_action: Perform a certain A-MPDU action
1267 * The RA/TID combination determines the destination and TID we want
1268 * the ampdu action to be performed for. The action is defined through
1269 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1270 * is the first frame we expect to perform the action on. notice
1271 * that TX/RX_STOP can pass NULL for this parameter.
1273 struct ieee80211_ops
{
1274 int (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
1275 int (*start
)(struct ieee80211_hw
*hw
);
1276 void (*stop
)(struct ieee80211_hw
*hw
);
1277 int (*add_interface
)(struct ieee80211_hw
*hw
,
1278 struct ieee80211_if_init_conf
*conf
);
1279 void (*remove_interface
)(struct ieee80211_hw
*hw
,
1280 struct ieee80211_if_init_conf
*conf
);
1281 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
1282 int (*config_interface
)(struct ieee80211_hw
*hw
,
1283 struct ieee80211_vif
*vif
,
1284 struct ieee80211_if_conf
*conf
);
1285 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
1286 struct ieee80211_vif
*vif
,
1287 struct ieee80211_bss_conf
*info
,
1289 void (*configure_filter
)(struct ieee80211_hw
*hw
,
1290 unsigned int changed_flags
,
1291 unsigned int *total_flags
,
1292 int mc_count
, struct dev_addr_list
*mc_list
);
1293 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
1295 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
1296 const u8
*local_address
, const u8
*address
,
1297 struct ieee80211_key_conf
*key
);
1298 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
1299 struct ieee80211_key_conf
*conf
, const u8
*address
,
1300 u32 iv32
, u16
*phase1key
);
1301 int (*hw_scan
)(struct ieee80211_hw
*hw
, u8
*ssid
, size_t len
);
1302 int (*get_stats
)(struct ieee80211_hw
*hw
,
1303 struct ieee80211_low_level_stats
*stats
);
1304 void (*get_tkip_seq
)(struct ieee80211_hw
*hw
, u8 hw_key_idx
,
1305 u32
*iv32
, u16
*iv16
);
1306 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1307 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
1308 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1309 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
1310 int (*conf_tx
)(struct ieee80211_hw
*hw
, u16 queue
,
1311 const struct ieee80211_tx_queue_params
*params
);
1312 int (*get_tx_stats
)(struct ieee80211_hw
*hw
,
1313 struct ieee80211_tx_queue_stats
*stats
);
1314 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
1315 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
1316 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
1317 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
1318 enum ieee80211_ampdu_mlme_action action
,
1319 struct ieee80211_sta
*sta
, u16 tid
, u16
*ssn
);
1323 * ieee80211_alloc_hw - Allocate a new hardware device
1325 * This must be called once for each hardware device. The returned pointer
1326 * must be used to refer to this device when calling other functions.
1327 * mac80211 allocates a private data area for the driver pointed to by
1328 * @priv in &struct ieee80211_hw, the size of this area is given as
1331 * @priv_data_len: length of private data
1332 * @ops: callbacks for this device
1334 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
1335 const struct ieee80211_ops
*ops
);
1338 * ieee80211_register_hw - Register hardware device
1340 * You must call this function before any other functions in
1341 * mac80211. Note that before a hardware can be registered, you
1342 * need to fill the contained wiphy's information.
1344 * @hw: the device to register as returned by ieee80211_alloc_hw()
1346 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
1348 #ifdef CONFIG_MAC80211_LEDS
1349 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
1350 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
1351 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
1352 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
1355 * ieee80211_get_tx_led_name - get name of TX LED
1357 * mac80211 creates a transmit LED trigger for each wireless hardware
1358 * that can be used to drive LEDs if your driver registers a LED device.
1359 * This function returns the name (or %NULL if not configured for LEDs)
1360 * of the trigger so you can automatically link the LED device.
1362 * @hw: the hardware to get the LED trigger name for
1364 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
1366 #ifdef CONFIG_MAC80211_LEDS
1367 return __ieee80211_get_tx_led_name(hw
);
1374 * ieee80211_get_rx_led_name - get name of RX LED
1376 * mac80211 creates a receive LED trigger for each wireless hardware
1377 * that can be used to drive LEDs if your driver registers a LED device.
1378 * This function returns the name (or %NULL if not configured for LEDs)
1379 * of the trigger so you can automatically link the LED device.
1381 * @hw: the hardware to get the LED trigger name for
1383 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
1385 #ifdef CONFIG_MAC80211_LEDS
1386 return __ieee80211_get_rx_led_name(hw
);
1393 * ieee80211_get_assoc_led_name - get name of association LED
1395 * mac80211 creates a association LED trigger for each wireless hardware
1396 * that can be used to drive LEDs if your driver registers a LED device.
1397 * This function returns the name (or %NULL if not configured for LEDs)
1398 * of the trigger so you can automatically link the LED device.
1400 * @hw: the hardware to get the LED trigger name for
1402 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
1404 #ifdef CONFIG_MAC80211_LEDS
1405 return __ieee80211_get_assoc_led_name(hw
);
1412 * ieee80211_get_radio_led_name - get name of radio LED
1414 * mac80211 creates a radio change LED trigger for each wireless hardware
1415 * that can be used to drive LEDs if your driver registers a LED device.
1416 * This function returns the name (or %NULL if not configured for LEDs)
1417 * of the trigger so you can automatically link the LED device.
1419 * @hw: the hardware to get the LED trigger name for
1421 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
1423 #ifdef CONFIG_MAC80211_LEDS
1424 return __ieee80211_get_radio_led_name(hw
);
1431 * ieee80211_unregister_hw - Unregister a hardware device
1433 * This function instructs mac80211 to free allocated resources
1434 * and unregister netdevices from the networking subsystem.
1436 * @hw: the hardware to unregister
1438 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
1441 * ieee80211_free_hw - free hardware descriptor
1443 * This function frees everything that was allocated, including the
1444 * private data for the driver. You must call ieee80211_unregister_hw()
1445 * before calling this function.
1447 * @hw: the hardware to free
1449 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
1451 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1452 void __ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1453 struct ieee80211_rx_status
*status
);
1456 * ieee80211_rx - receive frame
1458 * Use this function to hand received frames to mac80211. The receive
1459 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1460 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1462 * This function may not be called in IRQ context. Calls to this function
1463 * for a single hardware must be synchronized against each other. Calls
1464 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1467 * @hw: the hardware this frame came in on
1468 * @skb: the buffer to receive, owned by mac80211 after this call
1469 * @status: status of this frame; the status pointer need not be valid
1470 * after this function returns
1472 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
1473 struct ieee80211_rx_status
*status
)
1475 __ieee80211_rx(hw
, skb
, status
);
1479 * ieee80211_rx_irqsafe - receive frame
1481 * Like ieee80211_rx() but can be called in IRQ context
1482 * (internally defers to a tasklet.)
1484 * Calls to this function and ieee80211_rx() may not be mixed for a
1487 * @hw: the hardware this frame came in on
1488 * @skb: the buffer to receive, owned by mac80211 after this call
1489 * @status: status of this frame; the status pointer need not be valid
1490 * after this function returns and is not freed by mac80211,
1491 * it is recommended that it points to a stack area
1493 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
,
1494 struct sk_buff
*skb
,
1495 struct ieee80211_rx_status
*status
);
1498 * ieee80211_tx_status - transmit status callback
1500 * Call this function for all transmitted frames after they have been
1501 * transmitted. It is permissible to not call this function for
1502 * multicast frames but this can affect statistics.
1504 * This function may not be called in IRQ context. Calls to this function
1505 * for a single hardware must be synchronized against each other. Calls
1506 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1507 * for a single hardware.
1509 * @hw: the hardware the frame was transmitted by
1510 * @skb: the frame that was transmitted, owned by mac80211 after this call
1512 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
1513 struct sk_buff
*skb
);
1516 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1518 * Like ieee80211_tx_status() but can be called in IRQ context
1519 * (internally defers to a tasklet.)
1521 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1524 * @hw: the hardware the frame was transmitted by
1525 * @skb: the frame that was transmitted, owned by mac80211 after this call
1527 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
1528 struct sk_buff
*skb
);
1531 * ieee80211_beacon_get - beacon generation function
1532 * @hw: pointer obtained from ieee80211_alloc_hw().
1533 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1535 * If the beacon frames are generated by the host system (i.e., not in
1536 * hardware/firmware), the low-level driver uses this function to receive
1537 * the next beacon frame from the 802.11 code. The low-level is responsible
1538 * for calling this function before beacon data is needed (e.g., based on
1539 * hardware interrupt). Returned skb is used only once and low-level driver
1540 * is responsible for freeing it.
1542 struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
1543 struct ieee80211_vif
*vif
);
1546 * ieee80211_rts_get - RTS frame generation function
1547 * @hw: pointer obtained from ieee80211_alloc_hw().
1548 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1549 * @frame: pointer to the frame that is going to be protected by the RTS.
1550 * @frame_len: the frame length (in octets).
1551 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1552 * @rts: The buffer where to store the RTS frame.
1554 * If the RTS frames are generated by the host system (i.e., not in
1555 * hardware/firmware), the low-level driver uses this function to receive
1556 * the next RTS frame from the 802.11 code. The low-level is responsible
1557 * for calling this function before and RTS frame is needed.
1559 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
1560 const void *frame
, size_t frame_len
,
1561 const struct ieee80211_tx_info
*frame_txctl
,
1562 struct ieee80211_rts
*rts
);
1565 * ieee80211_rts_duration - Get the duration field for an RTS frame
1566 * @hw: pointer obtained from ieee80211_alloc_hw().
1567 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1568 * @frame_len: the length of the frame that is going to be protected by the RTS.
1569 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1571 * If the RTS is generated in firmware, but the host system must provide
1572 * the duration field, the low-level driver uses this function to receive
1573 * the duration field value in little-endian byteorder.
1575 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
1576 struct ieee80211_vif
*vif
, size_t frame_len
,
1577 const struct ieee80211_tx_info
*frame_txctl
);
1580 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1581 * @hw: pointer obtained from ieee80211_alloc_hw().
1582 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1583 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1584 * @frame_len: the frame length (in octets).
1585 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1586 * @cts: The buffer where to store the CTS-to-self frame.
1588 * If the CTS-to-self frames are generated by the host system (i.e., not in
1589 * hardware/firmware), the low-level driver uses this function to receive
1590 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1591 * for calling this function before and CTS-to-self frame is needed.
1593 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
1594 struct ieee80211_vif
*vif
,
1595 const void *frame
, size_t frame_len
,
1596 const struct ieee80211_tx_info
*frame_txctl
,
1597 struct ieee80211_cts
*cts
);
1600 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1601 * @hw: pointer obtained from ieee80211_alloc_hw().
1602 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1603 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1604 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1606 * If the CTS-to-self is generated in firmware, but the host system must provide
1607 * the duration field, the low-level driver uses this function to receive
1608 * the duration field value in little-endian byteorder.
1610 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
1611 struct ieee80211_vif
*vif
,
1613 const struct ieee80211_tx_info
*frame_txctl
);
1616 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1617 * @hw: pointer obtained from ieee80211_alloc_hw().
1618 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1619 * @frame_len: the length of the frame.
1620 * @rate: the rate at which the frame is going to be transmitted.
1622 * Calculate the duration field of some generic frame, given its
1623 * length and transmission rate (in 100kbps).
1625 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
1626 struct ieee80211_vif
*vif
,
1628 struct ieee80211_rate
*rate
);
1631 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1632 * @hw: pointer as obtained from ieee80211_alloc_hw().
1633 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1635 * Function for accessing buffered broadcast and multicast frames. If
1636 * hardware/firmware does not implement buffering of broadcast/multicast
1637 * frames when power saving is used, 802.11 code buffers them in the host
1638 * memory. The low-level driver uses this function to fetch next buffered
1639 * frame. In most cases, this is used when generating beacon frame. This
1640 * function returns a pointer to the next buffered skb or NULL if no more
1641 * buffered frames are available.
1643 * Note: buffered frames are returned only after DTIM beacon frame was
1644 * generated with ieee80211_beacon_get() and the low-level driver must thus
1645 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1646 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1647 * does not need to check for DTIM beacons separately and should be able to
1648 * use common code for all beacons.
1651 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
1654 * ieee80211_get_hdrlen_from_skb - get header length from data
1656 * Given an skb with a raw 802.11 header at the data pointer this function
1657 * returns the 802.11 header length in bytes (not including encryption
1658 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1659 * header the function returns 0.
1663 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
1666 * ieee80211_hdrlen - get header length in bytes from frame control
1667 * @fc: frame control field in little-endian format
1669 unsigned int ieee80211_hdrlen(__le16 fc
);
1672 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1674 * This function computes a TKIP rc4 key for an skb. It computes
1675 * a phase 1 key if needed (iv16 wraps around). This function is to
1676 * be used by drivers which can do HW encryption but need to compute
1677 * to phase 1/2 key in SW.
1679 * @keyconf: the parameter passed with the set key
1680 * @skb: the skb for which the key is needed
1682 * @key: a buffer to which the key will be written
1684 void ieee80211_get_tkip_key(struct ieee80211_key_conf
*keyconf
,
1685 struct sk_buff
*skb
,
1686 enum ieee80211_tkip_key_type type
, u8
*key
);
1688 * ieee80211_wake_queue - wake specific queue
1689 * @hw: pointer as obtained from ieee80211_alloc_hw().
1690 * @queue: queue number (counted from zero).
1692 * Drivers should use this function instead of netif_wake_queue.
1694 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
1697 * ieee80211_stop_queue - stop specific queue
1698 * @hw: pointer as obtained from ieee80211_alloc_hw().
1699 * @queue: queue number (counted from zero).
1701 * Drivers should use this function instead of netif_stop_queue.
1703 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
1706 * ieee80211_queue_stopped - test status of the queue
1707 * @hw: pointer as obtained from ieee80211_alloc_hw().
1708 * @queue: queue number (counted from zero).
1710 * Drivers should use this function instead of netif_stop_queue.
1713 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
1716 * ieee80211_stop_queues - stop all queues
1717 * @hw: pointer as obtained from ieee80211_alloc_hw().
1719 * Drivers should use this function instead of netif_stop_queue.
1721 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
1724 * ieee80211_wake_queues - wake all queues
1725 * @hw: pointer as obtained from ieee80211_alloc_hw().
1727 * Drivers should use this function instead of netif_wake_queue.
1729 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
1732 * ieee80211_scan_completed - completed hardware scan
1734 * When hardware scan offload is used (i.e. the hw_scan() callback is
1735 * assigned) this function needs to be called by the driver to notify
1736 * mac80211 that the scan finished.
1738 * @hw: the hardware that finished the scan
1740 void ieee80211_scan_completed(struct ieee80211_hw
*hw
);
1743 * ieee80211_iterate_active_interfaces - iterate active interfaces
1745 * This function iterates over the interfaces associated with a given
1746 * hardware that are currently active and calls the callback for them.
1747 * This function allows the iterator function to sleep, when the iterator
1748 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1751 * @hw: the hardware struct of which the interfaces should be iterated over
1752 * @iterator: the iterator function to call
1753 * @data: first argument of the iterator function
1755 void ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
,
1756 void (*iterator
)(void *data
, u8
*mac
,
1757 struct ieee80211_vif
*vif
),
1761 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1763 * This function iterates over the interfaces associated with a given
1764 * hardware that are currently active and calls the callback for them.
1765 * This function requires the iterator callback function to be atomic,
1766 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1768 * @hw: the hardware struct of which the interfaces should be iterated over
1769 * @iterator: the iterator function to call, cannot sleep
1770 * @data: first argument of the iterator function
1772 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
1773 void (*iterator
)(void *data
,
1775 struct ieee80211_vif
*vif
),
1779 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1780 * @hw: pointer as obtained from ieee80211_alloc_hw().
1781 * @ra: receiver address of the BA session recipient
1782 * @tid: the TID to BA on.
1784 * Return: success if addBA request was sent, failure otherwise
1786 * Although mac80211/low level driver/user space application can estimate
1787 * the need to start aggregation on a certain RA/TID, the session level
1788 * will be managed by the mac80211.
1790 int ieee80211_start_tx_ba_session(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1793 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1794 * @hw: pointer as obtained from ieee80211_alloc_hw().
1795 * @ra: receiver address of the BA session recipient.
1796 * @tid: the TID to BA on.
1798 * This function must be called by low level driver once it has
1799 * finished with preparations for the BA session.
1801 void ieee80211_start_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u16 tid
);
1804 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1805 * @hw: pointer as obtained from ieee80211_alloc_hw().
1806 * @ra: receiver address of the BA session recipient.
1807 * @tid: the TID to BA on.
1809 * This function must be called by low level driver once it has
1810 * finished with preparations for the BA session.
1811 * This version of the function is IRQ-safe.
1813 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1817 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1818 * @hw: pointer as obtained from ieee80211_alloc_hw().
1819 * @ra: receiver address of the BA session recipient
1820 * @tid: the TID to stop BA.
1821 * @initiator: if indicates initiator DELBA frame will be sent.
1823 * Return: error if no sta with matching da found, success otherwise
1825 * Although mac80211/low level driver/user space application can estimate
1826 * the need to stop aggregation on a certain RA/TID, the session level
1827 * will be managed by the mac80211.
1829 int ieee80211_stop_tx_ba_session(struct ieee80211_hw
*hw
,
1831 enum ieee80211_back_parties initiator
);
1834 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1835 * @hw: pointer as obtained from ieee80211_alloc_hw().
1836 * @ra: receiver address of the BA session recipient.
1837 * @tid: the desired TID to BA on.
1839 * This function must be called by low level driver once it has
1840 * finished with preparations for the BA session tear down.
1842 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw
*hw
, u8
*ra
, u8 tid
);
1845 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1846 * @hw: pointer as obtained from ieee80211_alloc_hw().
1847 * @ra: receiver address of the BA session recipient.
1848 * @tid: the desired TID to BA on.
1850 * This function must be called by low level driver once it has
1851 * finished with preparations for the BA session tear down.
1852 * This version of the function is IRQ-safe.
1854 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw
*hw
, const u8
*ra
,
1858 * ieee80211_notify_mac - low level driver notification
1859 * @hw: pointer as obtained from ieee80211_alloc_hw().
1860 * @notif_type: enum ieee80211_notification_types
1862 * This function must be called by low level driver to inform mac80211 of
1863 * low level driver status change or force mac80211 to re-assoc for low
1864 * level driver internal error that require re-assoc.
1866 void ieee80211_notify_mac(struct ieee80211_hw
*hw
,
1867 enum ieee80211_notification_types notif_type
);
1870 * ieee80211_find_sta - find a station
1872 * @hw: pointer as obtained from ieee80211_alloc_hw()
1873 * @addr: station's address
1875 * This function must be called under RCU lock and the
1876 * resulting pointer is only valid under RCU lock as well.
1878 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_hw
*hw
,
1882 /* Rate control API */
1885 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
1887 * @hw: The hardware the algorithm is invoked for.
1888 * @sband: The band this frame is being transmitted on.
1889 * @bss_conf: the current BSS configuration
1890 * @reported_rate: The rate control algorithm can fill this in to indicate
1891 * which rate should be reported to userspace as the current rate and
1892 * used for rate calculations in the mesh network.
1893 * @rts: whether RTS will be used for this frame because it is longer than the
1895 * @short_preamble: whether mac80211 will request short-preamble transmission
1896 * if the selected rate supports it
1897 * @max_rate_idx: user-requested maximum rate (not MCS for now)
1898 * @skb: the skb that will be transmitted, the control information in it needs
1901 struct ieee80211_tx_rate_control
{
1902 struct ieee80211_hw
*hw
;
1903 struct ieee80211_supported_band
*sband
;
1904 struct ieee80211_bss_conf
*bss_conf
;
1905 struct sk_buff
*skb
;
1906 struct ieee80211_tx_rate reported_rate
;
1907 bool rts
, short_preamble
;
1911 struct rate_control_ops
{
1912 struct module
*module
;
1914 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
1915 void (*free
)(void *priv
);
1917 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
1918 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
1919 struct ieee80211_sta
*sta
, void *priv_sta
);
1920 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
1923 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
1924 struct ieee80211_sta
*sta
, void *priv_sta
,
1925 struct sk_buff
*skb
);
1926 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
1927 struct ieee80211_tx_rate_control
*txrc
);
1929 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
1930 struct dentry
*dir
);
1931 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
1934 static inline int rate_supported(struct ieee80211_sta
*sta
,
1935 enum ieee80211_band band
,
1938 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
1942 rate_lowest_index(struct ieee80211_supported_band
*sband
,
1943 struct ieee80211_sta
*sta
)
1947 for (i
= 0; i
< sband
->n_bitrates
; i
++)
1948 if (rate_supported(sta
, sband
->band
, i
))
1951 /* warn when we cannot find a rate. */
1958 int ieee80211_rate_control_register(struct rate_control_ops
*ops
);
1959 void ieee80211_rate_control_unregister(struct rate_control_ops
*ops
);
1961 #endif /* MAC80211_H */