[SCSI] st: convert st_flush to use st_scsi_kern_execute
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / net / mac80211.h
blobb3bd00a9d9928ce228c1e3d6e855cdf8a9b17682
1 /*
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.
13 #ifndef MAC80211_H
14 #define MAC80211_H
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>
25 /**
26 * DOC: Introduction
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
31 * drivers.
34 /**
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
42 * tasklet function.
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
48 /**
49 * DOC: Warning
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.
55 /**
56 * DOC: Frame format
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
61 * hardware.
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.
76 /**
77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
79 * This structure describes most essential parameters needed
80 * to describe 802.11n HT characteristics in a BSS.
82 * @primary_channel: channel number of primery channel
83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
86 struct ieee80211_ht_bss_info {
87 u8 primary_channel;
88 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
89 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
92 /**
93 * enum ieee80211_max_queues - maximum number of queues
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
97 * for A-MPDU operation.
99 enum ieee80211_max_queues {
100 IEEE80211_MAX_QUEUES = 16,
101 IEEE80211_MAX_AMPDU_QUEUES = 16,
105 * struct ieee80211_tx_queue_params - transmit queue configuration
107 * The information provided in this structure is required for QoS
108 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
110 * @aifs: arbitration interframe space [0..255]
111 * @cw_min: minimum contention window [a value of the form
112 * 2^n-1 in the range 1..32767]
113 * @cw_max: maximum contention window [like @cw_min]
114 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
116 struct ieee80211_tx_queue_params {
117 u16 txop;
118 u16 cw_min;
119 u16 cw_max;
120 u8 aifs;
124 * struct ieee80211_tx_queue_stats - transmit queue statistics
126 * @len: number of packets in queue
127 * @limit: queue length limit
128 * @count: number of frames sent
130 struct ieee80211_tx_queue_stats {
131 unsigned int len;
132 unsigned int limit;
133 unsigned int count;
136 struct ieee80211_low_level_stats {
137 unsigned int dot11ACKFailureCount;
138 unsigned int dot11RTSFailureCount;
139 unsigned int dot11FCSErrorCount;
140 unsigned int dot11RTSSuccessCount;
144 * enum ieee80211_bss_change - BSS change notification flags
146 * These flags are used with the bss_info_changed() callback
147 * to indicate which BSS parameter changed.
149 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
150 * also implies a change in the AID.
151 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
152 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
153 * @BSS_CHANGED_ERP_SLOT: slot timing changed
154 * @BSS_CHANGED_HT: 802.11n parameters changed
155 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
157 enum ieee80211_bss_change {
158 BSS_CHANGED_ASSOC = 1<<0,
159 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
160 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
161 BSS_CHANGED_ERP_SLOT = 1<<3,
162 BSS_CHANGED_HT = 1<<4,
163 BSS_CHANGED_BASIC_RATES = 1<<5,
167 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
168 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
170 struct ieee80211_bss_ht_conf {
171 u16 operation_mode;
175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
183 * @use_short_preamble: use 802.11b short preamble;
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186 * @use_short_slot: use short slot time (only relevant for ERP);
187 * if the hardware cannot handle this it must set the
188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
189 * @dtim_period: num of beacons before the next DTIM, for PSM
190 * @timestamp: beacon timestamp
191 * @beacon_int: beacon interval
192 * @assoc_capability: capabilities taken from assoc resp
193 * @ht: BSS's HT configuration
194 * @basic_rates: bitmap of basic rates, each bit stands for an
195 * index into the rate table configured by the driver in
196 * the current band.
198 struct ieee80211_bss_conf {
199 /* association related data */
200 bool assoc;
201 u16 aid;
202 /* erp related data */
203 bool use_cts_prot;
204 bool use_short_preamble;
205 bool use_short_slot;
206 u8 dtim_period;
207 u16 beacon_int;
208 u16 assoc_capability;
209 u64 timestamp;
210 u64 basic_rates;
211 struct ieee80211_bss_ht_conf ht;
215 * enum mac80211_tx_control_flags - flags to describe transmission information/status
217 * These flags are used with the @flags member of &ieee80211_tx_info.
219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221 * number to this frame, taking care of not overwriting the fragment
222 * number and increasing the sequence number only when the
223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224 * assign sequence numbers to QoS-data frames but cannot do so correctly
225 * for non-QoS-data and management frames because beacons need them from
226 * that counter as well and mac80211 cannot guarantee proper sequencing.
227 * If this flag is set, the driver should instruct the hardware to
228 * assign a sequence number to the frame or assign one itself. Cf. IEEE
229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230 * beacons and always be clear for frames without a sequence number field.
231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
233 * station
234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode.
240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246 * set by rate control algorithms to indicate probe rate, will
247 * be cleared for fragmented frames (except on the last fragment)
249 enum mac80211_tx_control_flags {
250 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
251 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
252 IEEE80211_TX_CTL_NO_ACK = BIT(2),
253 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
254 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
255 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
256 IEEE80211_TX_CTL_AMPDU = BIT(6),
257 IEEE80211_TX_CTL_INJECTED = BIT(7),
258 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
259 IEEE80211_TX_STAT_ACK = BIT(9),
260 IEEE80211_TX_STAT_AMPDU = BIT(10),
261 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
262 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
265 enum mac80211_rate_control_flags {
266 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
267 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
268 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
270 /* rate index is an MCS rate number instead of an index */
271 IEEE80211_TX_RC_MCS = BIT(3),
272 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
273 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
274 IEEE80211_TX_RC_DUP_DATA = BIT(6),
275 IEEE80211_TX_RC_SHORT_GI = BIT(7),
279 /* there are 40 bytes if you don't need the rateset to be kept */
280 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
282 /* if you do need the rateset, then you have less space */
283 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
285 /* maximum number of rate stages */
286 #define IEEE80211_TX_MAX_RATES 5
289 * struct ieee80211_tx_rate - rate selection/status
291 * @idx: rate index to attempt to send with
292 * @flags: rate control flags (&enum mac80211_rate_control_flags)
293 * @count: number of tries in this rate before going to the next rate
295 * A value of -1 for @idx indicates an invalid rate and, if used
296 * in an array of retry rates, that no more rates should be tried.
298 * When used for transmit status reporting, the driver should
299 * always report the rate along with the flags it used.
301 struct ieee80211_tx_rate {
302 s8 idx;
303 u8 count;
304 u8 flags;
305 } __attribute__((packed));
308 * struct ieee80211_tx_info - skb transmit information
310 * This structure is placed in skb->cb for three uses:
311 * (1) mac80211 TX control - mac80211 tells the driver what to do
312 * (2) driver internal use (if applicable)
313 * (3) TX status information - driver tells mac80211 what happened
315 * The TX control's sta pointer is only valid during the ->tx call,
316 * it may be NULL.
318 * @flags: transmit info flags, defined above
319 * @band: the band to transmit on (use for checking for races)
320 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
321 * @pad: padding, ignore
322 * @control: union for control data
323 * @status: union for status data
324 * @driver_data: array of driver_data pointers
325 * @retry_count: number of retries
326 * @ampdu_ack_len: number of aggregated frames.
327 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
328 * @ampdu_ack_map: block ack bit map for the aggregation.
329 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
330 * @ack_signal: signal strength of the ACK frame
332 struct ieee80211_tx_info {
333 /* common information */
334 u32 flags;
335 u8 band;
337 u8 antenna_sel_tx;
339 /* 2 byte hole */
340 u8 pad[2];
342 union {
343 struct {
344 union {
345 /* rate control */
346 struct {
347 struct ieee80211_tx_rate rates[
348 IEEE80211_TX_MAX_RATES];
349 s8 rts_cts_rate_idx;
351 /* only needed before rate control */
352 unsigned long jiffies;
354 /* NB: vif can be NULL for injected frames */
355 struct ieee80211_vif *vif;
356 struct ieee80211_key_conf *hw_key;
357 struct ieee80211_sta *sta;
358 } control;
359 struct {
360 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
361 u8 ampdu_ack_len;
362 u64 ampdu_ack_map;
363 int ack_signal;
364 /* 8 bytes free */
365 } status;
366 struct {
367 struct ieee80211_tx_rate driver_rates[
368 IEEE80211_TX_MAX_RATES];
369 void *rate_driver_data[
370 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
372 void *driver_data[
373 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
377 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
379 return (struct ieee80211_tx_info *)skb->cb;
383 * ieee80211_tx_info_clear_status - clear TX status
385 * @info: The &struct ieee80211_tx_info to be cleared.
387 * When the driver passes an skb back to mac80211, it must report
388 * a number of things in TX status. This function clears everything
389 * in the TX status but the rate control information (it does clear
390 * the count since you need to fill that in anyway).
392 * NOTE: You can only use this function if you do NOT use
393 * info->driver_data! Use info->rate_driver_data
394 * instead if you need only the less space that allows.
396 static inline void
397 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
399 int i;
401 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
402 offsetof(struct ieee80211_tx_info, control.rates));
403 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
404 offsetof(struct ieee80211_tx_info, driver_rates));
405 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
406 /* clear the rate counts */
407 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
408 info->status.rates[i].count = 0;
410 BUILD_BUG_ON(
411 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
412 memset(&info->status.ampdu_ack_len, 0,
413 sizeof(struct ieee80211_tx_info) -
414 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
419 * enum mac80211_rx_flags - receive flags
421 * These flags are used with the @flag member of &struct ieee80211_rx_status.
422 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
423 * Use together with %RX_FLAG_MMIC_STRIPPED.
424 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
425 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
426 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
427 * verification has been done by the hardware.
428 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
429 * If this flag is set, the stack cannot do any replay detection
430 * hence the driver or hardware will have to do that.
431 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
432 * the frame.
433 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
434 * the frame.
435 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
436 * is valid. This is useful in monitor mode and necessary for beacon frames
437 * to enable IBSS merging.
438 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
439 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
440 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
441 * @RX_FLAG_SHORT_GI: Short guard interval was used
443 enum mac80211_rx_flags {
444 RX_FLAG_MMIC_ERROR = 1<<0,
445 RX_FLAG_DECRYPTED = 1<<1,
446 RX_FLAG_RADIOTAP = 1<<2,
447 RX_FLAG_MMIC_STRIPPED = 1<<3,
448 RX_FLAG_IV_STRIPPED = 1<<4,
449 RX_FLAG_FAILED_FCS_CRC = 1<<5,
450 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
451 RX_FLAG_TSFT = 1<<7,
452 RX_FLAG_SHORTPRE = 1<<8,
453 RX_FLAG_HT = 1<<9,
454 RX_FLAG_40MHZ = 1<<10,
455 RX_FLAG_SHORT_GI = 1<<11,
459 * struct ieee80211_rx_status - receive status
461 * The low-level driver should provide this information (the subset
462 * supported by hardware) to the 802.11 code with each received
463 * frame.
465 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
466 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
467 * @band: the active band when this frame was received
468 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
469 * @signal: signal strength when receiving this frame, either in dBm, in dB or
470 * unspecified depending on the hardware capabilities flags
471 * @IEEE80211_HW_SIGNAL_*
472 * @noise: noise when receiving this frame, in dBm.
473 * @qual: overall signal quality indication, in percent (0-100).
474 * @antenna: antenna used
475 * @rate_idx: index of data rate into band's supported rates or MCS index if
476 * HT rates are use (RX_FLAG_HT)
477 * @flag: %RX_FLAG_*
479 struct ieee80211_rx_status {
480 u64 mactime;
481 enum ieee80211_band band;
482 int freq;
483 int signal;
484 int noise;
485 int qual;
486 int antenna;
487 int rate_idx;
488 int flag;
492 * enum ieee80211_conf_flags - configuration flags
494 * Flags to define PHY configuration options
496 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
497 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
499 enum ieee80211_conf_flags {
500 IEEE80211_CONF_RADIOTAP = (1<<0),
501 IEEE80211_CONF_PS = (1<<1),
504 /* XXX: remove all this once drivers stop trying to use it */
505 static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void)
507 return 0;
509 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
511 struct ieee80211_ht_conf {
512 bool enabled;
513 enum nl80211_channel_type channel_type;
517 * enum ieee80211_conf_changed - denotes which configuration changed
519 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
520 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
521 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
522 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
523 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
524 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
525 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed
526 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
527 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed
529 enum ieee80211_conf_changed {
530 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
531 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1),
532 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
533 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
534 IEEE80211_CONF_CHANGE_PS = BIT(4),
535 IEEE80211_CONF_CHANGE_POWER = BIT(5),
536 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
537 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
538 IEEE80211_CONF_CHANGE_HT = BIT(8),
542 * struct ieee80211_conf - configuration of the device
544 * This struct indicates how the driver shall configure the hardware.
546 * @radio_enabled: when zero, driver is required to switch off the radio.
547 * @beacon_int: beacon interval (TODO make interface config)
548 * @listen_interval: listen interval in units of beacon interval
549 * @flags: configuration flags defined above
550 * @power_level: requested transmit power (in dBm)
551 * @channel: the channel to tune to
552 * @ht: the HT configuration for the device
553 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
554 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
555 * but actually means the number of transmissions not the number of retries
556 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
557 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
558 * number of transmissions not the number of retries
560 struct ieee80211_conf {
561 int beacon_int;
562 u32 flags;
563 int power_level;
565 u16 listen_interval;
566 bool radio_enabled;
568 u8 long_frame_max_tx_count, short_frame_max_tx_count;
570 struct ieee80211_channel *channel;
571 struct ieee80211_ht_conf ht;
575 * struct ieee80211_vif - per-interface data
577 * Data in this structure is continually present for driver
578 * use during the life of a virtual interface.
580 * @type: type of this virtual interface
581 * @bss_conf: BSS configuration for this interface, either our own
582 * or the BSS we're associated to
583 * @drv_priv: data area for driver use, will always be aligned to
584 * sizeof(void *).
586 struct ieee80211_vif {
587 enum nl80211_iftype type;
588 struct ieee80211_bss_conf bss_conf;
589 /* must be last */
590 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
593 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
595 #ifdef CONFIG_MAC80211_MESH
596 return vif->type == NL80211_IFTYPE_MESH_POINT;
597 #endif
598 return false;
602 * struct ieee80211_if_init_conf - initial configuration of an interface
604 * @vif: pointer to a driver-use per-interface structure. The pointer
605 * itself is also used for various functions including
606 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
607 * @type: one of &enum nl80211_iftype constants. Determines the type of
608 * added/removed interface.
609 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
610 * until the interface is removed (i.e. it cannot be used after
611 * remove_interface() callback was called for this interface).
613 * This structure is used in add_interface() and remove_interface()
614 * callbacks of &struct ieee80211_hw.
616 * When you allow multiple interfaces to be added to your PHY, take care
617 * that the hardware can actually handle multiple MAC addresses. However,
618 * also take care that when there's no interface left with mac_addr != %NULL
619 * you remove the MAC address from the device to avoid acknowledging packets
620 * in pure monitor mode.
622 struct ieee80211_if_init_conf {
623 enum nl80211_iftype type;
624 struct ieee80211_vif *vif;
625 void *mac_addr;
629 * enum ieee80211_if_conf_change - interface config change flags
631 * @IEEE80211_IFCC_BSSID: The BSSID changed.
632 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
633 * (currently AP and MESH only), use ieee80211_beacon_get().
635 enum ieee80211_if_conf_change {
636 IEEE80211_IFCC_BSSID = BIT(0),
637 IEEE80211_IFCC_BEACON = BIT(1),
641 * struct ieee80211_if_conf - configuration of an interface
643 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
644 * @bssid: BSSID of the network we are associated to/creating.
646 * This structure is passed to the config_interface() callback of
647 * &struct ieee80211_hw.
649 struct ieee80211_if_conf {
650 u32 changed;
651 u8 *bssid;
655 * enum ieee80211_key_alg - key algorithm
656 * @ALG_WEP: WEP40 or WEP104
657 * @ALG_TKIP: TKIP
658 * @ALG_CCMP: CCMP (AES)
660 enum ieee80211_key_alg {
661 ALG_WEP,
662 ALG_TKIP,
663 ALG_CCMP,
667 * enum ieee80211_key_len - key length
668 * @LEN_WEP40: WEP 5-byte long key
669 * @LEN_WEP104: WEP 13-byte long key
671 enum ieee80211_key_len {
672 LEN_WEP40 = 5,
673 LEN_WEP104 = 13,
677 * enum ieee80211_key_flags - key flags
679 * These flags are used for communication about keys between the driver
680 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
682 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
683 * that the STA this key will be used with could be using QoS.
684 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
685 * driver to indicate that it requires IV generation for this
686 * particular key.
687 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
688 * the driver for a TKIP key if it requires Michael MIC
689 * generation in software.
690 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
691 * that the key is pairwise rather then a shared key.
693 enum ieee80211_key_flags {
694 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
695 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
696 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
697 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
701 * struct ieee80211_key_conf - key information
703 * This key information is given by mac80211 to the driver by
704 * the set_key() callback in &struct ieee80211_ops.
706 * @hw_key_idx: To be set by the driver, this is the key index the driver
707 * wants to be given when a frame is transmitted and needs to be
708 * encrypted in hardware.
709 * @alg: The key algorithm.
710 * @flags: key flags, see &enum ieee80211_key_flags.
711 * @keyidx: the key index (0-3)
712 * @keylen: key material length
713 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
714 * data block:
715 * - Temporal Encryption Key (128 bits)
716 * - Temporal Authenticator Tx MIC Key (64 bits)
717 * - Temporal Authenticator Rx MIC Key (64 bits)
718 * @icv_len: FIXME
719 * @iv_len: FIXME
721 struct ieee80211_key_conf {
722 enum ieee80211_key_alg alg;
723 u8 icv_len;
724 u8 iv_len;
725 u8 hw_key_idx;
726 u8 flags;
727 s8 keyidx;
728 u8 keylen;
729 u8 key[0];
733 * enum set_key_cmd - key command
735 * Used with the set_key() callback in &struct ieee80211_ops, this
736 * indicates whether a key is being removed or added.
738 * @SET_KEY: a key is set
739 * @DISABLE_KEY: a key must be disabled
741 enum set_key_cmd {
742 SET_KEY, DISABLE_KEY,
746 * struct ieee80211_sta - station table entry
748 * A station table entry represents a station we are possibly
749 * communicating with. Since stations are RCU-managed in
750 * mac80211, any ieee80211_sta pointer you get access to must
751 * either be protected by rcu_read_lock() explicitly or implicitly,
752 * or you must take good care to not use such a pointer after a
753 * call to your sta_notify callback that removed it.
755 * @addr: MAC address
756 * @aid: AID we assigned to the station if we're an AP
757 * @supp_rates: Bitmap of supported rates (per band)
758 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
759 * @drv_priv: data area for driver use, will always be aligned to
760 * sizeof(void *), size is determined in hw information.
762 struct ieee80211_sta {
763 u64 supp_rates[IEEE80211_NUM_BANDS];
764 u8 addr[ETH_ALEN];
765 u16 aid;
766 struct ieee80211_sta_ht_cap ht_cap;
768 /* must be last */
769 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
773 * enum sta_notify_cmd - sta notify command
775 * Used with the sta_notify() callback in &struct ieee80211_ops, this
776 * indicates addition and removal of a station to station table,
777 * or if a associated station made a power state transition.
779 * @STA_NOTIFY_ADD: a station was added to the station table
780 * @STA_NOTIFY_REMOVE: a station being removed from the station table
781 * @STA_NOTIFY_SLEEP: a station is now sleeping
782 * @STA_NOTIFY_AWAKE: a sleeping station woke up
784 enum sta_notify_cmd {
785 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
786 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
790 * enum ieee80211_tkip_key_type - get tkip key
792 * Used by drivers which need to get a tkip key for skb. Some drivers need a
793 * phase 1 key, others need a phase 2 key. A single function allows the driver
794 * to get the key, this enum indicates what type of key is required.
796 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
797 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
799 enum ieee80211_tkip_key_type {
800 IEEE80211_TKIP_P1_KEY,
801 IEEE80211_TKIP_P2_KEY,
805 * enum ieee80211_hw_flags - hardware flags
807 * These flags are used to indicate hardware capabilities to
808 * the stack. Generally, flags here should have their meaning
809 * done in a way that the simplest hardware doesn't need setting
810 * any particular flags. There are some exceptions to this rule,
811 * however, so you are advised to review these flags carefully.
813 * @IEEE80211_HW_RX_INCLUDES_FCS:
814 * Indicates that received frames passed to the stack include
815 * the FCS at the end.
817 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
818 * Some wireless LAN chipsets buffer broadcast/multicast frames
819 * for power saving stations in the hardware/firmware and others
820 * rely on the host system for such buffering. This option is used
821 * to configure the IEEE 802.11 upper layer to buffer broadcast and
822 * multicast frames when there are power saving stations so that
823 * the driver can fetch them with ieee80211_get_buffered_bc().
825 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
826 * Hardware is not capable of short slot operation on the 2.4 GHz band.
828 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
829 * Hardware is not capable of receiving frames with short preamble on
830 * the 2.4 GHz band.
832 * @IEEE80211_HW_SIGNAL_UNSPEC:
833 * Hardware can provide signal values but we don't know its units. We
834 * expect values between 0 and @max_signal.
835 * If possible please provide dB or dBm instead.
837 * @IEEE80211_HW_SIGNAL_DB:
838 * Hardware gives signal values in dB, decibel difference from an
839 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
840 * If possible please provide dBm instead.
842 * @IEEE80211_HW_SIGNAL_DBM:
843 * Hardware gives signal values in dBm, decibel difference from
844 * one milliwatt. This is the preferred method since it is standardized
845 * between different devices. @max_signal does not need to be set.
847 * @IEEE80211_HW_NOISE_DBM:
848 * Hardware can provide noise (radio interference) values in units dBm,
849 * decibel difference from one milliwatt.
851 * @IEEE80211_HW_SPECTRUM_MGMT:
852 * Hardware supports spectrum management defined in 802.11h
853 * Measurement, Channel Switch, Quieting, TPC
855 * @IEEE80211_HW_AMPDU_AGGREGATION:
856 * Hardware supports 11n A-MPDU aggregation.
858 * @IEEE80211_HW_NO_STACK_DYNAMIC_PS:
859 * Hardware which has dynamic power save support, meaning
860 * that power save is enabled in idle periods, and don't need support
861 * from stack.
863 enum ieee80211_hw_flags {
864 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
865 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
866 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
867 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
868 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
869 IEEE80211_HW_SIGNAL_DB = 1<<6,
870 IEEE80211_HW_SIGNAL_DBM = 1<<7,
871 IEEE80211_HW_NOISE_DBM = 1<<8,
872 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
873 IEEE80211_HW_AMPDU_AGGREGATION = 1<<10,
874 IEEE80211_HW_NO_STACK_DYNAMIC_PS = 1<<11,
878 * struct ieee80211_hw - hardware information and state
880 * This structure contains the configuration and hardware
881 * information for an 802.11 PHY.
883 * @wiphy: This points to the &struct wiphy allocated for this
884 * 802.11 PHY. You must fill in the @perm_addr and @dev
885 * members of this structure using SET_IEEE80211_DEV()
886 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
887 * bands (with channels, bitrates) are registered here.
889 * @conf: &struct ieee80211_conf, device configuration, don't use.
891 * @workqueue: single threaded workqueue available for driver use,
892 * allocated by mac80211 on registration and flushed when an
893 * interface is removed.
894 * NOTICE: All work performed on this workqueue should NEVER
895 * acquire the RTNL lock (i.e. Don't use the function
896 * ieee80211_iterate_active_interfaces())
898 * @priv: pointer to private area that was allocated for driver use
899 * along with this structure.
901 * @flags: hardware flags, see &enum ieee80211_hw_flags.
903 * @extra_tx_headroom: headroom to reserve in each transmit skb
904 * for use by the driver (e.g. for transmit headers.)
906 * @channel_change_time: time (in microseconds) it takes to change channels.
908 * @max_signal: Maximum value for signal (rssi) in RX information, used
909 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
911 * @max_listen_interval: max listen interval in units of beacon interval
912 * that HW supports
914 * @queues: number of available hardware transmit queues for
915 * data packets. WMM/QoS requires at least four, these
916 * queues need to have configurable access parameters.
918 * @ampdu_queues: number of available hardware transmit queues
919 * for A-MPDU packets, these have no access parameters
920 * because they're used only for A-MPDU frames. Note that
921 * mac80211 will not currently use any of the regular queues
922 * for aggregation.
924 * @rate_control_algorithm: rate control algorithm for this hardware.
925 * If unset (NULL), the default algorithm will be used. Must be
926 * set before calling ieee80211_register_hw().
928 * @vif_data_size: size (in bytes) of the drv_priv data area
929 * within &struct ieee80211_vif.
930 * @sta_data_size: size (in bytes) of the drv_priv data area
931 * within &struct ieee80211_sta.
933 * @max_rates: maximum number of alternate rate retry stages
934 * @max_rate_tries: maximum number of tries for each stage
936 struct ieee80211_hw {
937 struct ieee80211_conf conf;
938 struct wiphy *wiphy;
939 struct workqueue_struct *workqueue;
940 const char *rate_control_algorithm;
941 void *priv;
942 u32 flags;
943 unsigned int extra_tx_headroom;
944 int channel_change_time;
945 int vif_data_size;
946 int sta_data_size;
947 u16 queues;
948 u16 ampdu_queues;
949 u16 max_listen_interval;
950 s8 max_signal;
951 u8 max_rates;
952 u8 max_rate_tries;
956 * SET_IEEE80211_DEV - set device for 802.11 hardware
958 * @hw: the &struct ieee80211_hw to set the device for
959 * @dev: the &struct device of this 802.11 device
961 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
963 set_wiphy_dev(hw->wiphy, dev);
967 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
969 * @hw: the &struct ieee80211_hw to set the MAC address for
970 * @addr: the address to set
972 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
974 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
977 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
979 return hw->queues;
982 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
984 return hw->queues + hw->ampdu_queues;
987 static inline struct ieee80211_rate *
988 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
989 const struct ieee80211_tx_info *c)
991 if (WARN_ON(c->control.rates[0].idx < 0))
992 return NULL;
993 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
996 static inline struct ieee80211_rate *
997 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
998 const struct ieee80211_tx_info *c)
1000 if (c->control.rts_cts_rate_idx < 0)
1001 return NULL;
1002 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1005 static inline struct ieee80211_rate *
1006 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1007 const struct ieee80211_tx_info *c, int idx)
1009 if (c->control.rates[idx + 1].idx < 0)
1010 return NULL;
1011 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1015 * DOC: Hardware crypto acceleration
1017 * mac80211 is capable of taking advantage of many hardware
1018 * acceleration designs for encryption and decryption operations.
1020 * The set_key() callback in the &struct ieee80211_ops for a given
1021 * device is called to enable hardware acceleration of encryption and
1022 * decryption. The callback takes an @address parameter that will be
1023 * the broadcast address for default keys, the other station's hardware
1024 * address for individual keys or the zero address for keys that will
1025 * be used only for transmission.
1026 * Multiple transmission keys with the same key index may be used when
1027 * VLANs are configured for an access point.
1029 * The @local_address parameter will always be set to our own address,
1030 * this is only relevant if you support multiple local addresses.
1032 * When transmitting, the TX control data will use the @hw_key_idx
1033 * selected by the driver by modifying the &struct ieee80211_key_conf
1034 * pointed to by the @key parameter to the set_key() function.
1036 * The set_key() call for the %SET_KEY command should return 0 if
1037 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1038 * added; if you return 0 then hw_key_idx must be assigned to the
1039 * hardware key index, you are free to use the full u8 range.
1041 * When the cmd is %DISABLE_KEY then it must succeed.
1043 * Note that it is permissible to not decrypt a frame even if a key
1044 * for it has been uploaded to hardware, the stack will not make any
1045 * decision based on whether a key has been uploaded or not but rather
1046 * based on the receive flags.
1048 * The &struct ieee80211_key_conf structure pointed to by the @key
1049 * parameter is guaranteed to be valid until another call to set_key()
1050 * removes it, but it can only be used as a cookie to differentiate
1051 * keys.
1053 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1054 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1055 * handler.
1056 * The update_tkip_key() call updates the driver with the new phase 1 key.
1057 * This happens everytime the iv16 wraps around (every 65536 packets). The
1058 * set_key() call will happen only once for each key (unless the AP did
1059 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1060 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1061 * handler is software decryption with wrap around of iv16.
1065 * DOC: Frame filtering
1067 * mac80211 requires to see many management frames for proper
1068 * operation, and users may want to see many more frames when
1069 * in monitor mode. However, for best CPU usage and power consumption,
1070 * having as few frames as possible percolate through the stack is
1071 * desirable. Hence, the hardware should filter as much as possible.
1073 * To achieve this, mac80211 uses filter flags (see below) to tell
1074 * the driver's configure_filter() function which frames should be
1075 * passed to mac80211 and which should be filtered out.
1077 * The configure_filter() callback is invoked with the parameters
1078 * @mc_count and @mc_list for the combined multicast address list
1079 * of all virtual interfaces, @changed_flags telling which flags
1080 * were changed and @total_flags with the new flag states.
1082 * If your device has no multicast address filters your driver will
1083 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1084 * parameter to see whether multicast frames should be accepted
1085 * or dropped.
1087 * All unsupported flags in @total_flags must be cleared.
1088 * Hardware does not support a flag if it is incapable of _passing_
1089 * the frame to the stack. Otherwise the driver must ignore
1090 * the flag, but not clear it.
1091 * You must _only_ clear the flag (announce no support for the
1092 * flag to mac80211) if you are not able to pass the packet type
1093 * to the stack (so the hardware always filters it).
1094 * So for example, you should clear @FIF_CONTROL, if your hardware
1095 * always filters control frames. If your hardware always passes
1096 * control frames to the kernel and is incapable of filtering them,
1097 * you do _not_ clear the @FIF_CONTROL flag.
1098 * This rule applies to all other FIF flags as well.
1102 * enum ieee80211_filter_flags - hardware filter flags
1104 * These flags determine what the filter in hardware should be
1105 * programmed to let through and what should not be passed to the
1106 * stack. It is always safe to pass more frames than requested,
1107 * but this has negative impact on power consumption.
1109 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1110 * think of the BSS as your network segment and then this corresponds
1111 * to the regular ethernet device promiscuous mode.
1113 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1114 * by the user or if the hardware is not capable of filtering by
1115 * multicast address.
1117 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1118 * %RX_FLAG_FAILED_FCS_CRC for them)
1120 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1121 * the %RX_FLAG_FAILED_PLCP_CRC for them
1123 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1124 * to the hardware that it should not filter beacons or probe responses
1125 * by BSSID. Filtering them can greatly reduce the amount of processing
1126 * mac80211 needs to do and the amount of CPU wakeups, so you should
1127 * honour this flag if possible.
1129 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1130 * only those addressed to this station
1132 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1134 enum ieee80211_filter_flags {
1135 FIF_PROMISC_IN_BSS = 1<<0,
1136 FIF_ALLMULTI = 1<<1,
1137 FIF_FCSFAIL = 1<<2,
1138 FIF_PLCPFAIL = 1<<3,
1139 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1140 FIF_CONTROL = 1<<5,
1141 FIF_OTHER_BSS = 1<<6,
1145 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1147 * These flags are used with the ampdu_action() callback in
1148 * &struct ieee80211_ops to indicate which action is needed.
1149 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1150 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1151 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1152 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1153 * @IEEE80211_AMPDU_TX_RESUME: resume TX aggregation
1155 enum ieee80211_ampdu_mlme_action {
1156 IEEE80211_AMPDU_RX_START,
1157 IEEE80211_AMPDU_RX_STOP,
1158 IEEE80211_AMPDU_TX_START,
1159 IEEE80211_AMPDU_TX_STOP,
1160 IEEE80211_AMPDU_TX_RESUME,
1164 * struct ieee80211_ops - callbacks from mac80211 to the driver
1166 * This structure contains various callbacks that the driver may
1167 * handle or, in some cases, must handle, for example to configure
1168 * the hardware to a new channel or to transmit a frame.
1170 * @tx: Handler that 802.11 module calls for each transmitted frame.
1171 * skb contains the buffer starting from the IEEE 802.11 header.
1172 * The low-level driver should send the frame out based on
1173 * configuration in the TX control data. This handler should,
1174 * preferably, never fail and stop queues appropriately, more
1175 * importantly, however, it must never fail for A-MPDU-queues.
1176 * Must be implemented and atomic.
1178 * @start: Called before the first netdevice attached to the hardware
1179 * is enabled. This should turn on the hardware and must turn on
1180 * frame reception (for possibly enabled monitor interfaces.)
1181 * Returns negative error codes, these may be seen in userspace,
1182 * or zero.
1183 * When the device is started it should not have a MAC address
1184 * to avoid acknowledging frames before a non-monitor device
1185 * is added.
1186 * Must be implemented.
1188 * @stop: Called after last netdevice attached to the hardware
1189 * is disabled. This should turn off the hardware (at least
1190 * it must turn off frame reception.)
1191 * May be called right after add_interface if that rejects
1192 * an interface.
1193 * Must be implemented.
1195 * @add_interface: Called when a netdevice attached to the hardware is
1196 * enabled. Because it is not called for monitor mode devices, @start
1197 * and @stop must be implemented.
1198 * The driver should perform any initialization it needs before
1199 * the device can be enabled. The initial configuration for the
1200 * interface is given in the conf parameter.
1201 * The callback may refuse to add an interface by returning a
1202 * negative error code (which will be seen in userspace.)
1203 * Must be implemented.
1205 * @remove_interface: Notifies a driver that an interface is going down.
1206 * The @stop callback is called after this if it is the last interface
1207 * and no monitor interfaces are present.
1208 * When all interfaces are removed, the MAC address in the hardware
1209 * must be cleared so the device no longer acknowledges packets,
1210 * the mac_addr member of the conf structure is, however, set to the
1211 * MAC address of the device going away.
1212 * Hence, this callback must be implemented.
1214 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1215 * function to change hardware configuration, e.g., channel.
1217 * @config_interface: Handler for configuration requests related to interfaces
1218 * (e.g. BSSID changes.)
1220 * @bss_info_changed: Handler for configuration requests related to BSS
1221 * parameters that may vary during BSS's lifespan, and may affect low
1222 * level driver (e.g. assoc/disassoc status, erp parameters).
1223 * This function should not be used if no BSS has been set, unless
1224 * for association indication. The @changed parameter indicates which
1225 * of the bss parameters has changed when a call is made.
1227 * @configure_filter: Configure the device's RX filter.
1228 * See the section "Frame filtering" for more information.
1229 * This callback must be implemented and atomic.
1231 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1232 * must be set or cleared for a given STA. Must be atomic.
1234 * @set_key: See the section "Hardware crypto acceleration"
1235 * This callback can sleep, and is only called between add_interface
1236 * and remove_interface calls, i.e. while the interface with the
1237 * given local_address is enabled.
1239 * @update_tkip_key: See the section "Hardware crypto acceleration"
1240 * This callback will be called in the context of Rx. Called for drivers
1241 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1243 * @hw_scan: Ask the hardware to service the scan request, no need to start
1244 * the scan state machine in stack. The scan must honour the channel
1245 * configuration done by the regulatory agent in the wiphy's registered
1246 * bands. When the scan finishes, ieee80211_scan_completed() must be
1247 * called; note that it also must be called when the scan cannot finish
1248 * because the hardware is turned off! Anything else is a bug!
1250 * @get_stats: return low-level statistics
1252 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1253 * callback should be provided to read the TKIP transmit IVs (both IV32
1254 * and IV16) for the given key from hardware.
1256 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1258 * @sta_notify: Notifies low level driver about addition, removal or power
1259 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1260 * Must be atomic.
1262 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1263 * bursting) for a hardware TX queue.
1265 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1266 * to get number of currently queued packets (queue length), maximum queue
1267 * size (limit), and total number of packets sent using each TX queue
1268 * (count). The 'stats' pointer points to an array that has hw->queues +
1269 * hw->ampdu_queues items.
1271 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1272 * this is only used for IBSS mode debugging and, as such, is not a
1273 * required function. Must be atomic.
1275 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1276 * with other STAs in the IBSS. This is only used in IBSS mode. This
1277 * function is optional if the firmware/hardware takes full care of
1278 * TSF synchronization.
1280 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1281 * This is needed only for IBSS mode and the result of this function is
1282 * used to determine whether to reply to Probe Requests.
1284 * @ampdu_action: Perform a certain A-MPDU action
1285 * The RA/TID combination determines the destination and TID we want
1286 * the ampdu action to be performed for. The action is defined through
1287 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1288 * is the first frame we expect to perform the action on. notice
1289 * that TX/RX_STOP can pass NULL for this parameter.
1291 struct ieee80211_ops {
1292 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1293 int (*start)(struct ieee80211_hw *hw);
1294 void (*stop)(struct ieee80211_hw *hw);
1295 int (*add_interface)(struct ieee80211_hw *hw,
1296 struct ieee80211_if_init_conf *conf);
1297 void (*remove_interface)(struct ieee80211_hw *hw,
1298 struct ieee80211_if_init_conf *conf);
1299 int (*config)(struct ieee80211_hw *hw, u32 changed);
1300 int (*config_interface)(struct ieee80211_hw *hw,
1301 struct ieee80211_vif *vif,
1302 struct ieee80211_if_conf *conf);
1303 void (*bss_info_changed)(struct ieee80211_hw *hw,
1304 struct ieee80211_vif *vif,
1305 struct ieee80211_bss_conf *info,
1306 u32 changed);
1307 void (*configure_filter)(struct ieee80211_hw *hw,
1308 unsigned int changed_flags,
1309 unsigned int *total_flags,
1310 int mc_count, struct dev_addr_list *mc_list);
1311 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1312 bool set);
1313 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1314 const u8 *local_address, const u8 *address,
1315 struct ieee80211_key_conf *key);
1316 void (*update_tkip_key)(struct ieee80211_hw *hw,
1317 struct ieee80211_key_conf *conf, const u8 *address,
1318 u32 iv32, u16 *phase1key);
1319 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1320 int (*get_stats)(struct ieee80211_hw *hw,
1321 struct ieee80211_low_level_stats *stats);
1322 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1323 u32 *iv32, u16 *iv16);
1324 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1325 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1326 enum sta_notify_cmd, struct ieee80211_sta *sta);
1327 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1328 const struct ieee80211_tx_queue_params *params);
1329 int (*get_tx_stats)(struct ieee80211_hw *hw,
1330 struct ieee80211_tx_queue_stats *stats);
1331 u64 (*get_tsf)(struct ieee80211_hw *hw);
1332 void (*reset_tsf)(struct ieee80211_hw *hw);
1333 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1334 int (*ampdu_action)(struct ieee80211_hw *hw,
1335 enum ieee80211_ampdu_mlme_action action,
1336 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1340 * ieee80211_alloc_hw - Allocate a new hardware device
1342 * This must be called once for each hardware device. The returned pointer
1343 * must be used to refer to this device when calling other functions.
1344 * mac80211 allocates a private data area for the driver pointed to by
1345 * @priv in &struct ieee80211_hw, the size of this area is given as
1346 * @priv_data_len.
1348 * @priv_data_len: length of private data
1349 * @ops: callbacks for this device
1351 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1352 const struct ieee80211_ops *ops);
1355 * ieee80211_register_hw - Register hardware device
1357 * You must call this function before any other functions in
1358 * mac80211. Note that before a hardware can be registered, you
1359 * need to fill the contained wiphy's information.
1361 * @hw: the device to register as returned by ieee80211_alloc_hw()
1363 int ieee80211_register_hw(struct ieee80211_hw *hw);
1365 #ifdef CONFIG_MAC80211_LEDS
1366 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1367 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1368 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1369 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1370 #endif
1372 * ieee80211_get_tx_led_name - get name of TX LED
1374 * mac80211 creates a transmit LED trigger for each wireless hardware
1375 * that can be used to drive LEDs if your driver registers a LED device.
1376 * This function returns the name (or %NULL if not configured for LEDs)
1377 * of the trigger so you can automatically link the LED device.
1379 * @hw: the hardware to get the LED trigger name for
1381 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1383 #ifdef CONFIG_MAC80211_LEDS
1384 return __ieee80211_get_tx_led_name(hw);
1385 #else
1386 return NULL;
1387 #endif
1391 * ieee80211_get_rx_led_name - get name of RX LED
1393 * mac80211 creates a receive LED trigger for each wireless hardware
1394 * that can be used to drive LEDs if your driver registers a LED device.
1395 * This function returns the name (or %NULL if not configured for LEDs)
1396 * of the trigger so you can automatically link the LED device.
1398 * @hw: the hardware to get the LED trigger name for
1400 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1402 #ifdef CONFIG_MAC80211_LEDS
1403 return __ieee80211_get_rx_led_name(hw);
1404 #else
1405 return NULL;
1406 #endif
1410 * ieee80211_get_assoc_led_name - get name of association LED
1412 * mac80211 creates a association LED trigger for each wireless hardware
1413 * that can be used to drive LEDs if your driver registers a LED device.
1414 * This function returns the name (or %NULL if not configured for LEDs)
1415 * of the trigger so you can automatically link the LED device.
1417 * @hw: the hardware to get the LED trigger name for
1419 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1421 #ifdef CONFIG_MAC80211_LEDS
1422 return __ieee80211_get_assoc_led_name(hw);
1423 #else
1424 return NULL;
1425 #endif
1429 * ieee80211_get_radio_led_name - get name of radio LED
1431 * mac80211 creates a radio change LED trigger for each wireless hardware
1432 * that can be used to drive LEDs if your driver registers a LED device.
1433 * This function returns the name (or %NULL if not configured for LEDs)
1434 * of the trigger so you can automatically link the LED device.
1436 * @hw: the hardware to get the LED trigger name for
1438 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1440 #ifdef CONFIG_MAC80211_LEDS
1441 return __ieee80211_get_radio_led_name(hw);
1442 #else
1443 return NULL;
1444 #endif
1448 * ieee80211_unregister_hw - Unregister a hardware device
1450 * This function instructs mac80211 to free allocated resources
1451 * and unregister netdevices from the networking subsystem.
1453 * @hw: the hardware to unregister
1455 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1458 * ieee80211_free_hw - free hardware descriptor
1460 * This function frees everything that was allocated, including the
1461 * private data for the driver. You must call ieee80211_unregister_hw()
1462 * before calling this function.
1464 * @hw: the hardware to free
1466 void ieee80211_free_hw(struct ieee80211_hw *hw);
1468 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1469 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1470 struct ieee80211_rx_status *status);
1473 * ieee80211_rx - receive frame
1475 * Use this function to hand received frames to mac80211. The receive
1476 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1477 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1479 * This function may not be called in IRQ context. Calls to this function
1480 * for a single hardware must be synchronized against each other. Calls
1481 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1482 * single hardware.
1484 * @hw: the hardware this frame came in on
1485 * @skb: the buffer to receive, owned by mac80211 after this call
1486 * @status: status of this frame; the status pointer need not be valid
1487 * after this function returns
1489 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1490 struct ieee80211_rx_status *status)
1492 __ieee80211_rx(hw, skb, status);
1496 * ieee80211_rx_irqsafe - receive frame
1498 * Like ieee80211_rx() but can be called in IRQ context
1499 * (internally defers to a tasklet.)
1501 * Calls to this function and ieee80211_rx() may not be mixed for a
1502 * single hardware.
1504 * @hw: the hardware this frame came in on
1505 * @skb: the buffer to receive, owned by mac80211 after this call
1506 * @status: status of this frame; the status pointer need not be valid
1507 * after this function returns and is not freed by mac80211,
1508 * it is recommended that it points to a stack area
1510 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1511 struct sk_buff *skb,
1512 struct ieee80211_rx_status *status);
1515 * ieee80211_tx_status - transmit status callback
1517 * Call this function for all transmitted frames after they have been
1518 * transmitted. It is permissible to not call this function for
1519 * multicast frames but this can affect statistics.
1521 * This function may not be called in IRQ context. Calls to this function
1522 * for a single hardware must be synchronized against each other. Calls
1523 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1524 * for a single hardware.
1526 * @hw: the hardware the frame was transmitted by
1527 * @skb: the frame that was transmitted, owned by mac80211 after this call
1529 void ieee80211_tx_status(struct ieee80211_hw *hw,
1530 struct sk_buff *skb);
1533 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1535 * Like ieee80211_tx_status() but can be called in IRQ context
1536 * (internally defers to a tasklet.)
1538 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1539 * single hardware.
1541 * @hw: the hardware the frame was transmitted by
1542 * @skb: the frame that was transmitted, owned by mac80211 after this call
1544 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1545 struct sk_buff *skb);
1548 * ieee80211_beacon_get - beacon generation function
1549 * @hw: pointer obtained from ieee80211_alloc_hw().
1550 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1552 * If the beacon frames are generated by the host system (i.e., not in
1553 * hardware/firmware), the low-level driver uses this function to receive
1554 * the next beacon frame from the 802.11 code. The low-level is responsible
1555 * for calling this function before beacon data is needed (e.g., based on
1556 * hardware interrupt). Returned skb is used only once and low-level driver
1557 * is responsible for freeing it.
1559 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1560 struct ieee80211_vif *vif);
1563 * ieee80211_rts_get - RTS frame generation function
1564 * @hw: pointer obtained from ieee80211_alloc_hw().
1565 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1566 * @frame: pointer to the frame that is going to be protected by the RTS.
1567 * @frame_len: the frame length (in octets).
1568 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1569 * @rts: The buffer where to store the RTS frame.
1571 * If the RTS frames are generated by the host system (i.e., not in
1572 * hardware/firmware), the low-level driver uses this function to receive
1573 * the next RTS frame from the 802.11 code. The low-level is responsible
1574 * for calling this function before and RTS frame is needed.
1576 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1577 const void *frame, size_t frame_len,
1578 const struct ieee80211_tx_info *frame_txctl,
1579 struct ieee80211_rts *rts);
1582 * ieee80211_rts_duration - Get the duration field for an RTS frame
1583 * @hw: pointer obtained from ieee80211_alloc_hw().
1584 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1585 * @frame_len: the length of the frame that is going to be protected by the RTS.
1586 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1588 * If the RTS is generated in firmware, but the host system must provide
1589 * the duration field, the low-level driver uses this function to receive
1590 * the duration field value in little-endian byteorder.
1592 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1593 struct ieee80211_vif *vif, size_t frame_len,
1594 const struct ieee80211_tx_info *frame_txctl);
1597 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1598 * @hw: pointer obtained from ieee80211_alloc_hw().
1599 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1600 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1601 * @frame_len: the frame length (in octets).
1602 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1603 * @cts: The buffer where to store the CTS-to-self frame.
1605 * If the CTS-to-self frames are generated by the host system (i.e., not in
1606 * hardware/firmware), the low-level driver uses this function to receive
1607 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1608 * for calling this function before and CTS-to-self frame is needed.
1610 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1611 struct ieee80211_vif *vif,
1612 const void *frame, size_t frame_len,
1613 const struct ieee80211_tx_info *frame_txctl,
1614 struct ieee80211_cts *cts);
1617 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1618 * @hw: pointer obtained from ieee80211_alloc_hw().
1619 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1620 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1621 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1623 * If the CTS-to-self is generated in firmware, but the host system must provide
1624 * the duration field, the low-level driver uses this function to receive
1625 * the duration field value in little-endian byteorder.
1627 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1628 struct ieee80211_vif *vif,
1629 size_t frame_len,
1630 const struct ieee80211_tx_info *frame_txctl);
1633 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1634 * @hw: pointer obtained from ieee80211_alloc_hw().
1635 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1636 * @frame_len: the length of the frame.
1637 * @rate: the rate at which the frame is going to be transmitted.
1639 * Calculate the duration field of some generic frame, given its
1640 * length and transmission rate (in 100kbps).
1642 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1643 struct ieee80211_vif *vif,
1644 size_t frame_len,
1645 struct ieee80211_rate *rate);
1648 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1649 * @hw: pointer as obtained from ieee80211_alloc_hw().
1650 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1652 * Function for accessing buffered broadcast and multicast frames. If
1653 * hardware/firmware does not implement buffering of broadcast/multicast
1654 * frames when power saving is used, 802.11 code buffers them in the host
1655 * memory. The low-level driver uses this function to fetch next buffered
1656 * frame. In most cases, this is used when generating beacon frame. This
1657 * function returns a pointer to the next buffered skb or NULL if no more
1658 * buffered frames are available.
1660 * Note: buffered frames are returned only after DTIM beacon frame was
1661 * generated with ieee80211_beacon_get() and the low-level driver must thus
1662 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1663 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1664 * does not need to check for DTIM beacons separately and should be able to
1665 * use common code for all beacons.
1667 struct sk_buff *
1668 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1671 * ieee80211_get_hdrlen_from_skb - get header length from data
1673 * Given an skb with a raw 802.11 header at the data pointer this function
1674 * returns the 802.11 header length in bytes (not including encryption
1675 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1676 * header the function returns 0.
1678 * @skb: the frame
1680 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1683 * ieee80211_hdrlen - get header length in bytes from frame control
1684 * @fc: frame control field in little-endian format
1686 unsigned int ieee80211_hdrlen(__le16 fc);
1689 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1691 * This function computes a TKIP rc4 key for an skb. It computes
1692 * a phase 1 key if needed (iv16 wraps around). This function is to
1693 * be used by drivers which can do HW encryption but need to compute
1694 * to phase 1/2 key in SW.
1696 * @keyconf: the parameter passed with the set key
1697 * @skb: the skb for which the key is needed
1698 * @type: TBD
1699 * @key: a buffer to which the key will be written
1701 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1702 struct sk_buff *skb,
1703 enum ieee80211_tkip_key_type type, u8 *key);
1705 * ieee80211_wake_queue - wake specific queue
1706 * @hw: pointer as obtained from ieee80211_alloc_hw().
1707 * @queue: queue number (counted from zero).
1709 * Drivers should use this function instead of netif_wake_queue.
1711 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1714 * ieee80211_stop_queue - stop specific queue
1715 * @hw: pointer as obtained from ieee80211_alloc_hw().
1716 * @queue: queue number (counted from zero).
1718 * Drivers should use this function instead of netif_stop_queue.
1720 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1723 * ieee80211_queue_stopped - test status of the queue
1724 * @hw: pointer as obtained from ieee80211_alloc_hw().
1725 * @queue: queue number (counted from zero).
1727 * Drivers should use this function instead of netif_stop_queue.
1730 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1733 * ieee80211_stop_queues - stop all queues
1734 * @hw: pointer as obtained from ieee80211_alloc_hw().
1736 * Drivers should use this function instead of netif_stop_queue.
1738 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1741 * ieee80211_wake_queues - wake all queues
1742 * @hw: pointer as obtained from ieee80211_alloc_hw().
1744 * Drivers should use this function instead of netif_wake_queue.
1746 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1749 * ieee80211_scan_completed - completed hardware scan
1751 * When hardware scan offload is used (i.e. the hw_scan() callback is
1752 * assigned) this function needs to be called by the driver to notify
1753 * mac80211 that the scan finished.
1755 * @hw: the hardware that finished the scan
1757 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1760 * ieee80211_iterate_active_interfaces - iterate active interfaces
1762 * This function iterates over the interfaces associated with a given
1763 * hardware that are currently active and calls the callback for them.
1764 * This function allows the iterator function to sleep, when the iterator
1765 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1766 * be used.
1768 * @hw: the hardware struct of which the interfaces should be iterated over
1769 * @iterator: the iterator function to call
1770 * @data: first argument of the iterator function
1772 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1773 void (*iterator)(void *data, u8 *mac,
1774 struct ieee80211_vif *vif),
1775 void *data);
1778 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1780 * This function iterates over the interfaces associated with a given
1781 * hardware that are currently active and calls the callback for them.
1782 * This function requires the iterator callback function to be atomic,
1783 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1785 * @hw: the hardware struct of which the interfaces should be iterated over
1786 * @iterator: the iterator function to call, cannot sleep
1787 * @data: first argument of the iterator function
1789 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1790 void (*iterator)(void *data,
1791 u8 *mac,
1792 struct ieee80211_vif *vif),
1793 void *data);
1796 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1797 * @hw: pointer as obtained from ieee80211_alloc_hw().
1798 * @ra: receiver address of the BA session recipient
1799 * @tid: the TID to BA on.
1801 * Return: success if addBA request was sent, failure otherwise
1803 * Although mac80211/low level driver/user space application can estimate
1804 * the need to start aggregation on a certain RA/TID, the session level
1805 * will be managed by the mac80211.
1807 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1810 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1811 * @hw: pointer as obtained from ieee80211_alloc_hw().
1812 * @ra: receiver address of the BA session recipient.
1813 * @tid: the TID to BA on.
1815 * This function must be called by low level driver once it has
1816 * finished with preparations for the BA session.
1818 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1821 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1822 * @hw: pointer as obtained from ieee80211_alloc_hw().
1823 * @ra: receiver address of the BA session recipient.
1824 * @tid: the TID to BA on.
1826 * This function must be called by low level driver once it has
1827 * finished with preparations for the BA session.
1828 * This version of the function is IRQ-safe.
1830 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1831 u16 tid);
1834 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1835 * @hw: pointer as obtained from ieee80211_alloc_hw().
1836 * @ra: receiver address of the BA session recipient
1837 * @tid: the TID to stop BA.
1838 * @initiator: if indicates initiator DELBA frame will be sent.
1840 * Return: error if no sta with matching da found, success otherwise
1842 * Although mac80211/low level driver/user space application can estimate
1843 * the need to stop aggregation on a certain RA/TID, the session level
1844 * will be managed by the mac80211.
1846 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1847 u8 *ra, u16 tid,
1848 enum ieee80211_back_parties initiator);
1851 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1852 * @hw: pointer as obtained from ieee80211_alloc_hw().
1853 * @ra: receiver address of the BA session recipient.
1854 * @tid: the desired TID to BA on.
1856 * This function must be called by low level driver once it has
1857 * finished with preparations for the BA session tear down.
1859 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1862 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1863 * @hw: pointer as obtained from ieee80211_alloc_hw().
1864 * @ra: receiver address of the BA session recipient.
1865 * @tid: the desired TID to BA on.
1867 * This function must be called by low level driver once it has
1868 * finished with preparations for the BA session tear down.
1869 * This version of the function is IRQ-safe.
1871 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1872 u16 tid);
1875 * ieee80211_find_sta - find a station
1877 * @hw: pointer as obtained from ieee80211_alloc_hw()
1878 * @addr: station's address
1880 * This function must be called under RCU lock and the
1881 * resulting pointer is only valid under RCU lock as well.
1883 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1884 const u8 *addr);
1887 /* Rate control API */
1890 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
1892 * @hw: The hardware the algorithm is invoked for.
1893 * @sband: The band this frame is being transmitted on.
1894 * @bss_conf: the current BSS configuration
1895 * @reported_rate: The rate control algorithm can fill this in to indicate
1896 * which rate should be reported to userspace as the current rate and
1897 * used for rate calculations in the mesh network.
1898 * @rts: whether RTS will be used for this frame because it is longer than the
1899 * RTS threshold
1900 * @short_preamble: whether mac80211 will request short-preamble transmission
1901 * if the selected rate supports it
1902 * @max_rate_idx: user-requested maximum rate (not MCS for now)
1903 * @skb: the skb that will be transmitted, the control information in it needs
1904 * to be filled in
1906 struct ieee80211_tx_rate_control {
1907 struct ieee80211_hw *hw;
1908 struct ieee80211_supported_band *sband;
1909 struct ieee80211_bss_conf *bss_conf;
1910 struct sk_buff *skb;
1911 struct ieee80211_tx_rate reported_rate;
1912 bool rts, short_preamble;
1913 u8 max_rate_idx;
1916 struct rate_control_ops {
1917 struct module *module;
1918 const char *name;
1919 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
1920 void (*free)(void *priv);
1922 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
1923 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
1924 struct ieee80211_sta *sta, void *priv_sta);
1925 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
1926 void *priv_sta);
1928 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
1929 struct ieee80211_sta *sta, void *priv_sta,
1930 struct sk_buff *skb);
1931 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
1932 struct ieee80211_tx_rate_control *txrc);
1934 void (*add_sta_debugfs)(void *priv, void *priv_sta,
1935 struct dentry *dir);
1936 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
1939 static inline int rate_supported(struct ieee80211_sta *sta,
1940 enum ieee80211_band band,
1941 int index)
1943 return (sta == NULL || sta->supp_rates[band] & BIT(index));
1946 static inline s8
1947 rate_lowest_index(struct ieee80211_supported_band *sband,
1948 struct ieee80211_sta *sta)
1950 int i;
1952 for (i = 0; i < sband->n_bitrates; i++)
1953 if (rate_supported(sta, sband->band, i))
1954 return i;
1956 /* warn when we cannot find a rate. */
1957 WARN_ON(1);
1959 return 0;
1963 int ieee80211_rate_control_register(struct rate_control_ops *ops);
1964 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
1966 #endif /* MAC80211_H */