mac80211: rewrite HT handling
[linux-2.6.git] / include / net / mac80211.h
1 /*
2  * mac80211 <-> driver interface
3  *
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>
7  *
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.
11  */
12
13 #ifndef MAC80211_H
14 #define MAC80211_H
15
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>
24
25 /**
26  * DOC: Introduction
27  *
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.
32  */
33
34 /**
35  * DOC: Calling mac80211 from interrupts
36  *
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.
43  *
44  * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45  *       use the non-IRQ-safe functions!
46  */
47
48 /**
49  * DOC: Warning
50  *
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.
53  */
54
55 /**
56  * DOC: Frame format
57  *
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.
62  *
63  * There are, however, various exceptions to this rule for advanced features:
64  *
65  * The first exception is for hardware encryption and decryption offload
66  * where the IV/ICV may or may not be generated in hardware.
67  *
68  * Secondly, when the hardware handles fragmentation, the frame handed to
69  * the driver from mac80211 is the MSDU, not the MPDU.
70  *
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.
74  */
75
76 /**
77  * enum ieee80211_notification_type - Low level driver notification
78  * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
79  */
80 enum ieee80211_notification_types {
81         IEEE80211_NOTIFY_RE_ASSOC,
82 };
83
84 /**
85  * enum ieee80211_max_queues - maximum number of queues
86  *
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.
90  */
91 enum ieee80211_max_queues {
92         IEEE80211_MAX_QUEUES =          16,
93         IEEE80211_MAX_AMPDU_QUEUES =    16,
94 };
95
96 /**
97  * struct ieee80211_tx_queue_params - transmit queue configuration
98  *
99  * The information provided in this structure is required for QoS
100  * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
101  *
102  * @aifs: arbitration interface 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
107  */
108 struct ieee80211_tx_queue_params {
109         u16 txop;
110         u16 cw_min;
111         u16 cw_max;
112         u8 aifs;
113 };
114
115 /**
116  * struct ieee80211_tx_queue_stats - transmit queue statistics
117  *
118  * @len: number of packets in queue
119  * @limit: queue length limit
120  * @count: number of frames sent
121  */
122 struct ieee80211_tx_queue_stats {
123         unsigned int len;
124         unsigned int limit;
125         unsigned int count;
126 };
127
128 struct ieee80211_low_level_stats {
129         unsigned int dot11ACKFailureCount;
130         unsigned int dot11RTSFailureCount;
131         unsigned int dot11FCSErrorCount;
132         unsigned int dot11RTSSuccessCount;
133 };
134
135 /**
136  * enum ieee80211_bss_change - BSS change notification flags
137  *
138  * These flags are used with the bss_info_changed() callback
139  * to indicate which BSS parameter changed.
140  *
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
148  */
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,
156 };
157
158 /**
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)
164  */
165 struct ieee80211_bss_ht_conf {
166         u8 secondary_channel_offset;
167         bool width_40_ok;
168         u16 operation_mode;
169 };
170
171 /**
172  * struct ieee80211_bss_conf - holds the BSS's changing parameters
173  *
174  * This structure keeps information about a BSS (and an association
175  * to that BSS) that can change during the lifetime of the BSS.
176  *
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
193  *      the current band.
194  */
195 struct ieee80211_bss_conf {
196         /* association related data */
197         bool assoc;
198         u16 aid;
199         /* erp related data */
200         bool use_cts_prot;
201         bool use_short_preamble;
202         bool use_short_slot;
203         u8 dtim_period;
204         u16 beacon_int;
205         u16 assoc_capability;
206         u64 timestamp;
207         u64 basic_rates;
208         struct ieee80211_bss_ht_conf ht;
209 };
210
211 /**
212  * enum mac80211_tx_control_flags - flags to describe transmission information/status
213  *
214  * These flags are used with the @flags member of &ieee80211_tx_info.
215  *
216  * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
217  * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
218  * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
219  *      for combined 802.11g / 802.11b networks)
220  * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
221  * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
222  * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
223  *      station
224  * @IEEE80211_TX_CTL_REQUEUE: TBD
225  * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
226  * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
227  * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
228  *      through set_retry_limit configured long retry value
229  * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
230  * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
231  * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
232  *      of streams when this flag is on can be extracted from antenna_sel_tx,
233  *      so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
234  *      antennas marked use MIMO_n.
235  * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
236  * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
237  * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
238  * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
239  * @IEEE80211_TX_CTL_INJECTED: TBD
240  * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
241  *      because the destination STA was in powersave mode.
242  * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
243  * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
244  *      is for the whole aggregation.
245  * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
246  *      so consider using block ack request (BAR).
247  * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
248  *      number to this frame, taking care of not overwriting the fragment
249  *      number and increasing the sequence number only when the
250  *      IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
251  *      assign sequence numbers to QoS-data frames but cannot do so correctly
252  *      for non-QoS-data and management frames because beacons need them from
253  *      that counter as well and mac80211 cannot guarantee proper sequencing.
254  *      If this flag is set, the driver should instruct the hardware to
255  *      assign a sequence number to the frame or assign one itself. Cf. IEEE
256  *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
257  *      beacons always be clear for frames without a sequence number field.
258  */
259 enum mac80211_tx_control_flags {
260         IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
261         IEEE80211_TX_CTL_USE_RTS_CTS            = BIT(2),
262         IEEE80211_TX_CTL_USE_CTS_PROTECT        = BIT(3),
263         IEEE80211_TX_CTL_NO_ACK                 = BIT(4),
264         IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(5),
265         IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(6),
266         IEEE80211_TX_CTL_REQUEUE                = BIT(7),
267         IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(8),
268         IEEE80211_TX_CTL_SHORT_PREAMBLE         = BIT(9),
269         IEEE80211_TX_CTL_LONG_RETRY_LIMIT       = BIT(10),
270         IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(12),
271         IEEE80211_TX_CTL_AMPDU                  = BIT(13),
272         IEEE80211_TX_CTL_OFDM_HT                = BIT(14),
273         IEEE80211_TX_CTL_GREEN_FIELD            = BIT(15),
274         IEEE80211_TX_CTL_40_MHZ_WIDTH           = BIT(16),
275         IEEE80211_TX_CTL_DUP_DATA               = BIT(17),
276         IEEE80211_TX_CTL_SHORT_GI               = BIT(18),
277         IEEE80211_TX_CTL_INJECTED               = BIT(19),
278         IEEE80211_TX_STAT_TX_FILTERED           = BIT(20),
279         IEEE80211_TX_STAT_ACK                   = BIT(21),
280         IEEE80211_TX_STAT_AMPDU                 = BIT(22),
281         IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(23),
282         IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(24),
283 };
284
285
286 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
287         (sizeof(((struct sk_buff *)0)->cb) - 8)
288 #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
289         (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
290
291 /* maximum number of alternate rate retry stages */
292 #define IEEE80211_TX_MAX_ALTRATE        3
293
294 /**
295  * struct ieee80211_tx_altrate - alternate rate selection/status
296  *
297  * @rate_idx: rate index to attempt to send with
298  * @limit: number of retries before fallback
299  */
300 struct ieee80211_tx_altrate {
301         s8 rate_idx;
302         u8 limit;
303 };
304
305 /**
306  * struct ieee80211_tx_info - skb transmit information
307  *
308  * This structure is placed in skb->cb for three uses:
309  *  (1) mac80211 TX control - mac80211 tells the driver what to do
310  *  (2) driver internal use (if applicable)
311  *  (3) TX status information - driver tells mac80211 what happened
312  *
313  * The TX control's sta pointer is only valid during the ->tx call,
314  * it may be NULL.
315  *
316  * @flags: transmit info flags, defined above
317  * @band: TBD
318  * @tx_rate_idx: TBD
319  * @antenna_sel_tx: antenna to use, 0 for automatic diversity
320  * @control: union for control data
321  * @status: union for status data
322  * @driver_data: array of driver_data pointers
323  * @retry_count: number of retries
324  * @excessive_retries: set to 1 if the frame was retried many times
325  *      but not acknowledged
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
331  */
332 struct ieee80211_tx_info {
333         /* common information */
334         u32 flags;
335         u8 band;
336         s8 tx_rate_idx;
337         u8 antenna_sel_tx;
338
339         /* 1 byte hole */
340
341         union {
342                 struct {
343                         /* NB: vif can be NULL for injected frames */
344                         struct ieee80211_vif *vif;
345                         struct ieee80211_key_conf *hw_key;
346                         struct ieee80211_sta *sta;
347                         unsigned long jiffies;
348                         s8 rts_cts_rate_idx;
349                         u8 retry_limit;
350                         struct ieee80211_tx_altrate retries[IEEE80211_TX_MAX_ALTRATE];
351                 } control;
352                 struct {
353                         u64 ampdu_ack_map;
354                         int ack_signal;
355                         struct ieee80211_tx_altrate retries[IEEE80211_TX_MAX_ALTRATE + 1];
356                         u8 retry_count;
357                         bool excessive_retries;
358                         u8 ampdu_ack_len;
359                 } status;
360                 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
361         };
362 };
363
364 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
365 {
366         return (struct ieee80211_tx_info *)skb->cb;
367 }
368
369
370 /**
371  * enum mac80211_rx_flags - receive flags
372  *
373  * These flags are used with the @flag member of &struct ieee80211_rx_status.
374  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
375  *      Use together with %RX_FLAG_MMIC_STRIPPED.
376  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
377  * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
378  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
379  *      verification has been done by the hardware.
380  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
381  *      If this flag is set, the stack cannot do any replay detection
382  *      hence the driver or hardware will have to do that.
383  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
384  *      the frame.
385  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
386  *      the frame.
387  * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
388  *      is valid. This is useful in monitor mode and necessary for beacon frames
389  *      to enable IBSS merging.
390  * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
391  */
392 enum mac80211_rx_flags {
393         RX_FLAG_MMIC_ERROR      = 1<<0,
394         RX_FLAG_DECRYPTED       = 1<<1,
395         RX_FLAG_RADIOTAP        = 1<<2,
396         RX_FLAG_MMIC_STRIPPED   = 1<<3,
397         RX_FLAG_IV_STRIPPED     = 1<<4,
398         RX_FLAG_FAILED_FCS_CRC  = 1<<5,
399         RX_FLAG_FAILED_PLCP_CRC = 1<<6,
400         RX_FLAG_TSFT            = 1<<7,
401         RX_FLAG_SHORTPRE        = 1<<8
402 };
403
404 /**
405  * struct ieee80211_rx_status - receive status
406  *
407  * The low-level driver should provide this information (the subset
408  * supported by hardware) to the 802.11 code with each received
409  * frame.
410  *
411  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
412  *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
413  * @band: the active band when this frame was received
414  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
415  * @signal: signal strength when receiving this frame, either in dBm, in dB or
416  *      unspecified depending on the hardware capabilities flags
417  *      @IEEE80211_HW_SIGNAL_*
418  * @noise: noise when receiving this frame, in dBm.
419  * @qual: overall signal quality indication, in percent (0-100).
420  * @antenna: antenna used
421  * @rate_idx: index of data rate into band's supported rates
422  * @flag: %RX_FLAG_*
423  */
424 struct ieee80211_rx_status {
425         u64 mactime;
426         enum ieee80211_band band;
427         int freq;
428         int signal;
429         int noise;
430         int qual;
431         int antenna;
432         int rate_idx;
433         int flag;
434 };
435
436 /**
437  * enum ieee80211_conf_flags - configuration flags
438  *
439  * Flags to define PHY configuration options
440  *
441  * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
442  * @IEEE80211_CONF_PS: Enable 802.11 power save mode
443  */
444 enum ieee80211_conf_flags {
445         IEEE80211_CONF_RADIOTAP         = (1<<0),
446         IEEE80211_CONF_PS               = (1<<1),
447 };
448
449 /* XXX: remove all this once drivers stop trying to use it */
450 static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void)
451 {
452         return 0;
453 }
454 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
455
456 struct ieee80211_ht_conf {
457         bool enabled;
458 };
459
460 /**
461  * enum ieee80211_conf_changed - denotes which configuration changed
462  *
463  * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
464  * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
465  * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
466  * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
467  * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
468  * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
469  * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed
470  * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
471  * @IEEE80211_CONF_CHANGE_HT: HT configuration changed
472  */
473 enum ieee80211_conf_changed {
474         IEEE80211_CONF_CHANGE_RADIO_ENABLED     = BIT(0),
475         IEEE80211_CONF_CHANGE_BEACON_INTERVAL   = BIT(1),
476         IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
477         IEEE80211_CONF_CHANGE_RADIOTAP          = BIT(3),
478         IEEE80211_CONF_CHANGE_PS                = BIT(4),
479         IEEE80211_CONF_CHANGE_POWER             = BIT(5),
480         IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
481         IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
482         IEEE80211_CONF_CHANGE_HT                = BIT(8),
483 };
484
485 /**
486  * struct ieee80211_conf - configuration of the device
487  *
488  * This struct indicates how the driver shall configure the hardware.
489  *
490  * @radio_enabled: when zero, driver is required to switch off the radio.
491  * @beacon_int: beacon interval (TODO make interface config)
492  * @listen_interval: listen interval in units of beacon interval
493  * @flags: configuration flags defined above
494  * @power_level: requested transmit power (in dBm)
495  * @channel: the channel to tune to
496  * @ht: the HT configuration for the device
497  * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
498  *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
499  *    but actually means the number of transmissions not the number of retries
500  * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
501  *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
502  *    number of transmissions not the number of retries
503  */
504 struct ieee80211_conf {
505         int beacon_int;
506         u32 flags;
507         int power_level;
508
509         u16 listen_interval;
510         bool radio_enabled;
511
512         u8 long_frame_max_tx_count, short_frame_max_tx_count;
513
514         struct ieee80211_channel *channel;
515         struct ieee80211_ht_conf ht;
516 };
517
518 /**
519  * struct ieee80211_vif - per-interface data
520  *
521  * Data in this structure is continually present for driver
522  * use during the life of a virtual interface.
523  *
524  * @type: type of this virtual interface
525  * @bss_conf: BSS configuration for this interface, either our own
526  *      or the BSS we're associated to
527  * @drv_priv: data area for driver use, will always be aligned to
528  *      sizeof(void *).
529  */
530 struct ieee80211_vif {
531         enum nl80211_iftype type;
532         struct ieee80211_bss_conf bss_conf;
533         /* must be last */
534         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
535 };
536
537 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
538 {
539 #ifdef CONFIG_MAC80211_MESH
540         return vif->type == NL80211_IFTYPE_MESH_POINT;
541 #endif
542         return false;
543 }
544
545 /**
546  * struct ieee80211_if_init_conf - initial configuration of an interface
547  *
548  * @vif: pointer to a driver-use per-interface structure. The pointer
549  *      itself is also used for various functions including
550  *      ieee80211_beacon_get() and ieee80211_get_buffered_bc().
551  * @type: one of &enum nl80211_iftype constants. Determines the type of
552  *      added/removed interface.
553  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
554  *      until the interface is removed (i.e. it cannot be used after
555  *      remove_interface() callback was called for this interface).
556  *
557  * This structure is used in add_interface() and remove_interface()
558  * callbacks of &struct ieee80211_hw.
559  *
560  * When you allow multiple interfaces to be added to your PHY, take care
561  * that the hardware can actually handle multiple MAC addresses. However,
562  * also take care that when there's no interface left with mac_addr != %NULL
563  * you remove the MAC address from the device to avoid acknowledging packets
564  * in pure monitor mode.
565  */
566 struct ieee80211_if_init_conf {
567         enum nl80211_iftype type;
568         struct ieee80211_vif *vif;
569         void *mac_addr;
570 };
571
572 /**
573  * enum ieee80211_if_conf_change - interface config change flags
574  *
575  * @IEEE80211_IFCC_BSSID: The BSSID changed.
576  * @IEEE80211_IFCC_SSID: The SSID changed.
577  * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
578  *      (currently AP and MESH only), use ieee80211_beacon_get().
579  */
580 enum ieee80211_if_conf_change {
581         IEEE80211_IFCC_BSSID    = BIT(0),
582         IEEE80211_IFCC_SSID     = BIT(1),
583         IEEE80211_IFCC_BEACON   = BIT(2),
584 };
585
586 /**
587  * struct ieee80211_if_conf - configuration of an interface
588  *
589  * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
590  * @bssid: BSSID of the network we are associated to/creating.
591  * @ssid: used (together with @ssid_len) by drivers for hardware that
592  *      generate beacons independently. The pointer is valid only during the
593  *      config_interface() call, so copy the value somewhere if you need
594  *      it.
595  * @ssid_len: length of the @ssid field.
596  *
597  * This structure is passed to the config_interface() callback of
598  * &struct ieee80211_hw.
599  */
600 struct ieee80211_if_conf {
601         u32 changed;
602         u8 *bssid;
603         u8 *ssid;
604         size_t ssid_len;
605 };
606
607 /**
608  * enum ieee80211_key_alg - key algorithm
609  * @ALG_WEP: WEP40 or WEP104
610  * @ALG_TKIP: TKIP
611  * @ALG_CCMP: CCMP (AES)
612  */
613 enum ieee80211_key_alg {
614         ALG_WEP,
615         ALG_TKIP,
616         ALG_CCMP,
617 };
618
619 /**
620  * enum ieee80211_key_len - key length
621  * @LEN_WEP40: WEP 5-byte long key
622  * @LEN_WEP104: WEP 13-byte long key
623  */
624 enum ieee80211_key_len {
625         LEN_WEP40 = 5,
626         LEN_WEP104 = 13,
627 };
628
629 /**
630  * enum ieee80211_key_flags - key flags
631  *
632  * These flags are used for communication about keys between the driver
633  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
634  *
635  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
636  *      that the STA this key will be used with could be using QoS.
637  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
638  *      driver to indicate that it requires IV generation for this
639  *      particular key.
640  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
641  *      the driver for a TKIP key if it requires Michael MIC
642  *      generation in software.
643  * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
644  *      that the key is pairwise rather then a shared key.
645  */
646 enum ieee80211_key_flags {
647         IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
648         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
649         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
650         IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
651 };
652
653 /**
654  * struct ieee80211_key_conf - key information
655  *
656  * This key information is given by mac80211 to the driver by
657  * the set_key() callback in &struct ieee80211_ops.
658  *
659  * @hw_key_idx: To be set by the driver, this is the key index the driver
660  *      wants to be given when a frame is transmitted and needs to be
661  *      encrypted in hardware.
662  * @alg: The key algorithm.
663  * @flags: key flags, see &enum ieee80211_key_flags.
664  * @keyidx: the key index (0-3)
665  * @keylen: key material length
666  * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
667  *      data block:
668  *      - Temporal Encryption Key (128 bits)
669  *      - Temporal Authenticator Tx MIC Key (64 bits)
670  *      - Temporal Authenticator Rx MIC Key (64 bits)
671  * @icv_len: FIXME
672  * @iv_len: FIXME
673  */
674 struct ieee80211_key_conf {
675         enum ieee80211_key_alg alg;
676         u8 icv_len;
677         u8 iv_len;
678         u8 hw_key_idx;
679         u8 flags;
680         s8 keyidx;
681         u8 keylen;
682         u8 key[0];
683 };
684
685 /**
686  * enum set_key_cmd - key command
687  *
688  * Used with the set_key() callback in &struct ieee80211_ops, this
689  * indicates whether a key is being removed or added.
690  *
691  * @SET_KEY: a key is set
692  * @DISABLE_KEY: a key must be disabled
693  */
694 enum set_key_cmd {
695         SET_KEY, DISABLE_KEY,
696 };
697
698 /**
699  * struct ieee80211_sta - station table entry
700  *
701  * A station table entry represents a station we are possibly
702  * communicating with. Since stations are RCU-managed in
703  * mac80211, any ieee80211_sta pointer you get access to must
704  * either be protected by rcu_read_lock() explicitly or implicitly,
705  * or you must take good care to not use such a pointer after a
706  * call to your sta_notify callback that removed it.
707  *
708  * @addr: MAC address
709  * @aid: AID we assigned to the station if we're an AP
710  * @supp_rates: Bitmap of supported rates (per band)
711  * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
712  * @drv_priv: data area for driver use, will always be aligned to
713  *      sizeof(void *), size is determined in hw information.
714  */
715 struct ieee80211_sta {
716         u64 supp_rates[IEEE80211_NUM_BANDS];
717         u8 addr[ETH_ALEN];
718         u16 aid;
719         struct ieee80211_sta_ht_cap ht_cap;
720
721         /* must be last */
722         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
723 };
724
725 /**
726  * enum sta_notify_cmd - sta notify command
727  *
728  * Used with the sta_notify() callback in &struct ieee80211_ops, this
729  * indicates addition and removal of a station to station table.
730  *
731  * @STA_NOTIFY_ADD: a station was added to the station table
732  * @STA_NOTIFY_REMOVE: a station being removed from the station table
733  */
734 enum sta_notify_cmd {
735         STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
736 };
737
738 /**
739  * enum ieee80211_tkip_key_type - get tkip key
740  *
741  * Used by drivers which need to get a tkip key for skb. Some drivers need a
742  * phase 1 key, others need a phase 2 key. A single function allows the driver
743  * to get the key, this enum indicates what type of key is required.
744  *
745  * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
746  * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
747  */
748 enum ieee80211_tkip_key_type {
749         IEEE80211_TKIP_P1_KEY,
750         IEEE80211_TKIP_P2_KEY,
751 };
752
753 /**
754  * enum ieee80211_hw_flags - hardware flags
755  *
756  * These flags are used to indicate hardware capabilities to
757  * the stack. Generally, flags here should have their meaning
758  * done in a way that the simplest hardware doesn't need setting
759  * any particular flags. There are some exceptions to this rule,
760  * however, so you are advised to review these flags carefully.
761  *
762  * @IEEE80211_HW_RX_INCLUDES_FCS:
763  *      Indicates that received frames passed to the stack include
764  *      the FCS at the end.
765  *
766  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
767  *      Some wireless LAN chipsets buffer broadcast/multicast frames
768  *      for power saving stations in the hardware/firmware and others
769  *      rely on the host system for such buffering. This option is used
770  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
771  *      multicast frames when there are power saving stations so that
772  *      the driver can fetch them with ieee80211_get_buffered_bc().
773  *
774  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
775  *      Hardware is not capable of short slot operation on the 2.4 GHz band.
776  *
777  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
778  *      Hardware is not capable of receiving frames with short preamble on
779  *      the 2.4 GHz band.
780  *
781  * @IEEE80211_HW_SIGNAL_UNSPEC:
782  *      Hardware can provide signal values but we don't know its units. We
783  *      expect values between 0 and @max_signal.
784  *      If possible please provide dB or dBm instead.
785  *
786  * @IEEE80211_HW_SIGNAL_DB:
787  *      Hardware gives signal values in dB, decibel difference from an
788  *      arbitrary, fixed reference. We expect values between 0 and @max_signal.
789  *      If possible please provide dBm instead.
790  *
791  * @IEEE80211_HW_SIGNAL_DBM:
792  *      Hardware gives signal values in dBm, decibel difference from
793  *      one milliwatt. This is the preferred method since it is standardized
794  *      between different devices. @max_signal does not need to be set.
795  *
796  * @IEEE80211_HW_NOISE_DBM:
797  *      Hardware can provide noise (radio interference) values in units dBm,
798  *      decibel difference from one milliwatt.
799  *
800  * @IEEE80211_HW_SPECTRUM_MGMT:
801  *      Hardware supports spectrum management defined in 802.11h
802  *      Measurement, Channel Switch, Quieting, TPC
803  */
804 enum ieee80211_hw_flags {
805         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
806         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
807         IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
808         IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
809         IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
810         IEEE80211_HW_SIGNAL_DB                          = 1<<6,
811         IEEE80211_HW_SIGNAL_DBM                         = 1<<7,
812         IEEE80211_HW_NOISE_DBM                          = 1<<8,
813         IEEE80211_HW_SPECTRUM_MGMT                      = 1<<9,
814 };
815
816 /**
817  * struct ieee80211_hw - hardware information and state
818  *
819  * This structure contains the configuration and hardware
820  * information for an 802.11 PHY.
821  *
822  * @wiphy: This points to the &struct wiphy allocated for this
823  *      802.11 PHY. You must fill in the @perm_addr and @dev
824  *      members of this structure using SET_IEEE80211_DEV()
825  *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
826  *      bands (with channels, bitrates) are registered here.
827  *
828  * @conf: &struct ieee80211_conf, device configuration, don't use.
829  *
830  * @workqueue: single threaded workqueue available for driver use,
831  *      allocated by mac80211 on registration and flushed when an
832  *      interface is removed.
833  *      NOTICE: All work performed on this workqueue should NEVER
834  *      acquire the RTNL lock (i.e. Don't use the function
835  *      ieee80211_iterate_active_interfaces())
836  *
837  * @priv: pointer to private area that was allocated for driver use
838  *      along with this structure.
839  *
840  * @flags: hardware flags, see &enum ieee80211_hw_flags.
841  *
842  * @extra_tx_headroom: headroom to reserve in each transmit skb
843  *      for use by the driver (e.g. for transmit headers.)
844  *
845  * @channel_change_time: time (in microseconds) it takes to change channels.
846  *
847  * @max_signal: Maximum value for signal (rssi) in RX information, used
848  *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
849  *
850  * @max_listen_interval: max listen interval in units of beacon interval
851  *     that HW supports
852  *
853  * @queues: number of available hardware transmit queues for
854  *      data packets. WMM/QoS requires at least four, these
855  *      queues need to have configurable access parameters.
856  *
857  * @ampdu_queues: number of available hardware transmit queues
858  *      for A-MPDU packets, these have no access parameters
859  *      because they're used only for A-MPDU frames. Note that
860  *      mac80211 will not currently use any of the regular queues
861  *      for aggregation.
862  *
863  * @rate_control_algorithm: rate control algorithm for this hardware.
864  *      If unset (NULL), the default algorithm will be used. Must be
865  *      set before calling ieee80211_register_hw().
866  *
867  * @vif_data_size: size (in bytes) of the drv_priv data area
868  *      within &struct ieee80211_vif.
869  * @sta_data_size: size (in bytes) of the drv_priv data area
870  *      within &struct ieee80211_sta.
871  *
872  * @max_altrates: maximum number of alternate rate retry stages
873  * @max_altrate_tries: maximum number of tries for each stage
874  */
875 struct ieee80211_hw {
876         struct ieee80211_conf conf;
877         struct wiphy *wiphy;
878         struct workqueue_struct *workqueue;
879         const char *rate_control_algorithm;
880         void *priv;
881         u32 flags;
882         unsigned int extra_tx_headroom;
883         int channel_change_time;
884         int vif_data_size;
885         int sta_data_size;
886         u16 queues;
887         u16 ampdu_queues;
888         u16 max_listen_interval;
889         s8 max_signal;
890         u8 max_altrates;
891         u8 max_altrate_tries;
892 };
893
894 /**
895  * SET_IEEE80211_DEV - set device for 802.11 hardware
896  *
897  * @hw: the &struct ieee80211_hw to set the device for
898  * @dev: the &struct device of this 802.11 device
899  */
900 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
901 {
902         set_wiphy_dev(hw->wiphy, dev);
903 }
904
905 /**
906  * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
907  *
908  * @hw: the &struct ieee80211_hw to set the MAC address for
909  * @addr: the address to set
910  */
911 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
912 {
913         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
914 }
915
916 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
917 {
918         return hw->queues;
919 }
920
921 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
922 {
923         return hw->queues + hw->ampdu_queues;
924 }
925
926 static inline struct ieee80211_rate *
927 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
928                       const struct ieee80211_tx_info *c)
929 {
930         if (WARN_ON(c->tx_rate_idx < 0))
931                 return NULL;
932         return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
933 }
934
935 static inline struct ieee80211_rate *
936 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
937                            const struct ieee80211_tx_info *c)
938 {
939         if (c->control.rts_cts_rate_idx < 0)
940                 return NULL;
941         return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
942 }
943
944 static inline struct ieee80211_rate *
945 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
946                              const struct ieee80211_tx_info *c, int idx)
947 {
948         if (c->control.retries[idx].rate_idx < 0)
949                 return NULL;
950         return &hw->wiphy->bands[c->band]->bitrates[c->control.retries[idx].rate_idx];
951 }
952
953 /**
954  * DOC: Hardware crypto acceleration
955  *
956  * mac80211 is capable of taking advantage of many hardware
957  * acceleration designs for encryption and decryption operations.
958  *
959  * The set_key() callback in the &struct ieee80211_ops for a given
960  * device is called to enable hardware acceleration of encryption and
961  * decryption. The callback takes an @address parameter that will be
962  * the broadcast address for default keys, the other station's hardware
963  * address for individual keys or the zero address for keys that will
964  * be used only for transmission.
965  * Multiple transmission keys with the same key index may be used when
966  * VLANs are configured for an access point.
967  *
968  * The @local_address parameter will always be set to our own address,
969  * this is only relevant if you support multiple local addresses.
970  *
971  * When transmitting, the TX control data will use the @hw_key_idx
972  * selected by the driver by modifying the &struct ieee80211_key_conf
973  * pointed to by the @key parameter to the set_key() function.
974  *
975  * The set_key() call for the %SET_KEY command should return 0 if
976  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
977  * added; if you return 0 then hw_key_idx must be assigned to the
978  * hardware key index, you are free to use the full u8 range.
979  *
980  * When the cmd is %DISABLE_KEY then it must succeed.
981  *
982  * Note that it is permissible to not decrypt a frame even if a key
983  * for it has been uploaded to hardware, the stack will not make any
984  * decision based on whether a key has been uploaded or not but rather
985  * based on the receive flags.
986  *
987  * The &struct ieee80211_key_conf structure pointed to by the @key
988  * parameter is guaranteed to be valid until another call to set_key()
989  * removes it, but it can only be used as a cookie to differentiate
990  * keys.
991  *
992  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
993  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
994  * handler.
995  * The update_tkip_key() call updates the driver with the new phase 1 key.
996  * This happens everytime the iv16 wraps around (every 65536 packets). The
997  * set_key() call will happen only once for each key (unless the AP did
998  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
999  * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
1000  * handler is software decryption with wrap around of iv16.
1001  */
1002
1003 /**
1004  * DOC: Frame filtering
1005  *
1006  * mac80211 requires to see many management frames for proper
1007  * operation, and users may want to see many more frames when
1008  * in monitor mode. However, for best CPU usage and power consumption,
1009  * having as few frames as possible percolate through the stack is
1010  * desirable. Hence, the hardware should filter as much as possible.
1011  *
1012  * To achieve this, mac80211 uses filter flags (see below) to tell
1013  * the driver's configure_filter() function which frames should be
1014  * passed to mac80211 and which should be filtered out.
1015  *
1016  * The configure_filter() callback is invoked with the parameters
1017  * @mc_count and @mc_list for the combined multicast address list
1018  * of all virtual interfaces, @changed_flags telling which flags
1019  * were changed and @total_flags with the new flag states.
1020  *
1021  * If your device has no multicast address filters your driver will
1022  * need to check both the %FIF_ALLMULTI flag and the @mc_count
1023  * parameter to see whether multicast frames should be accepted
1024  * or dropped.
1025  *
1026  * All unsupported flags in @total_flags must be cleared.
1027  * Hardware does not support a flag if it is incapable of _passing_
1028  * the frame to the stack. Otherwise the driver must ignore
1029  * the flag, but not clear it.
1030  * You must _only_ clear the flag (announce no support for the
1031  * flag to mac80211) if you are not able to pass the packet type
1032  * to the stack (so the hardware always filters it).
1033  * So for example, you should clear @FIF_CONTROL, if your hardware
1034  * always filters control frames. If your hardware always passes
1035  * control frames to the kernel and is incapable of filtering them,
1036  * you do _not_ clear the @FIF_CONTROL flag.
1037  * This rule applies to all other FIF flags as well.
1038  */
1039
1040 /**
1041  * enum ieee80211_filter_flags - hardware filter flags
1042  *
1043  * These flags determine what the filter in hardware should be
1044  * programmed to let through and what should not be passed to the
1045  * stack. It is always safe to pass more frames than requested,
1046  * but this has negative impact on power consumption.
1047  *
1048  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1049  *      think of the BSS as your network segment and then this corresponds
1050  *      to the regular ethernet device promiscuous mode.
1051  *
1052  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1053  *      by the user or if the hardware is not capable of filtering by
1054  *      multicast address.
1055  *
1056  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1057  *      %RX_FLAG_FAILED_FCS_CRC for them)
1058  *
1059  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1060  *      the %RX_FLAG_FAILED_PLCP_CRC for them
1061  *
1062  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1063  *      to the hardware that it should not filter beacons or probe responses
1064  *      by BSSID. Filtering them can greatly reduce the amount of processing
1065  *      mac80211 needs to do and the amount of CPU wakeups, so you should
1066  *      honour this flag if possible.
1067  *
1068  * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1069  *      only those addressed to this station
1070  *
1071  * @FIF_OTHER_BSS: pass frames destined to other BSSes
1072  */
1073 enum ieee80211_filter_flags {
1074         FIF_PROMISC_IN_BSS      = 1<<0,
1075         FIF_ALLMULTI            = 1<<1,
1076         FIF_FCSFAIL             = 1<<2,
1077         FIF_PLCPFAIL            = 1<<3,
1078         FIF_BCN_PRBRESP_PROMISC = 1<<4,
1079         FIF_CONTROL             = 1<<5,
1080         FIF_OTHER_BSS           = 1<<6,
1081 };
1082
1083 /**
1084  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1085  *
1086  * These flags are used with the ampdu_action() callback in
1087  * &struct ieee80211_ops to indicate which action is needed.
1088  * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1089  * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1090  * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1091  * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1092  */
1093 enum ieee80211_ampdu_mlme_action {
1094         IEEE80211_AMPDU_RX_START,
1095         IEEE80211_AMPDU_RX_STOP,
1096         IEEE80211_AMPDU_TX_START,
1097         IEEE80211_AMPDU_TX_STOP,
1098 };
1099
1100 /**
1101  * struct ieee80211_ops - callbacks from mac80211 to the driver
1102  *
1103  * This structure contains various callbacks that the driver may
1104  * handle or, in some cases, must handle, for example to configure
1105  * the hardware to a new channel or to transmit a frame.
1106  *
1107  * @tx: Handler that 802.11 module calls for each transmitted frame.
1108  *      skb contains the buffer starting from the IEEE 802.11 header.
1109  *      The low-level driver should send the frame out based on
1110  *      configuration in the TX control data. This handler should,
1111  *      preferably, never fail and stop queues appropriately, more
1112  *      importantly, however, it must never fail for A-MPDU-queues.
1113  *      Must be implemented and atomic.
1114  *
1115  * @start: Called before the first netdevice attached to the hardware
1116  *      is enabled. This should turn on the hardware and must turn on
1117  *      frame reception (for possibly enabled monitor interfaces.)
1118  *      Returns negative error codes, these may be seen in userspace,
1119  *      or zero.
1120  *      When the device is started it should not have a MAC address
1121  *      to avoid acknowledging frames before a non-monitor device
1122  *      is added.
1123  *      Must be implemented.
1124  *
1125  * @stop: Called after last netdevice attached to the hardware
1126  *      is disabled. This should turn off the hardware (at least
1127  *      it must turn off frame reception.)
1128  *      May be called right after add_interface if that rejects
1129  *      an interface.
1130  *      Must be implemented.
1131  *
1132  * @add_interface: Called when a netdevice attached to the hardware is
1133  *      enabled. Because it is not called for monitor mode devices, @open
1134  *      and @stop must be implemented.
1135  *      The driver should perform any initialization it needs before
1136  *      the device can be enabled. The initial configuration for the
1137  *      interface is given in the conf parameter.
1138  *      The callback may refuse to add an interface by returning a
1139  *      negative error code (which will be seen in userspace.)
1140  *      Must be implemented.
1141  *
1142  * @remove_interface: Notifies a driver that an interface is going down.
1143  *      The @stop callback is called after this if it is the last interface
1144  *      and no monitor interfaces are present.
1145  *      When all interfaces are removed, the MAC address in the hardware
1146  *      must be cleared so the device no longer acknowledges packets,
1147  *      the mac_addr member of the conf structure is, however, set to the
1148  *      MAC address of the device going away.
1149  *      Hence, this callback must be implemented.
1150  *
1151  * @config: Handler for configuration requests. IEEE 802.11 code calls this
1152  *      function to change hardware configuration, e.g., channel.
1153  *
1154  * @config_interface: Handler for configuration requests related to interfaces
1155  *      (e.g. BSSID changes.)
1156  *
1157  * @bss_info_changed: Handler for configuration requests related to BSS
1158  *      parameters that may vary during BSS's lifespan, and may affect low
1159  *      level driver (e.g. assoc/disassoc status, erp parameters).
1160  *      This function should not be used if no BSS has been set, unless
1161  *      for association indication. The @changed parameter indicates which
1162  *      of the bss parameters has changed when a call is made.
1163  *
1164  * @configure_filter: Configure the device's RX filter.
1165  *      See the section "Frame filtering" for more information.
1166  *      This callback must be implemented and atomic.
1167  *
1168  * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1169  *      must be set or cleared for a given STA. Must be atomic.
1170  *
1171  * @set_key: See the section "Hardware crypto acceleration"
1172  *      This callback can sleep, and is only called between add_interface
1173  *      and remove_interface calls, i.e. while the interface with the
1174  *      given local_address is enabled.
1175  *
1176  * @update_tkip_key: See the section "Hardware crypto acceleration"
1177  *      This callback will be called in the context of Rx. Called for drivers
1178  *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1179  *
1180  * @hw_scan: Ask the hardware to service the scan request, no need to start
1181  *      the scan state machine in stack. The scan must honour the channel
1182  *      configuration done by the regulatory agent in the wiphy's registered
1183  *      bands. When the scan finishes, ieee80211_scan_completed() must be
1184  *      called; note that it also must be called when the scan cannot finish
1185  *      because the hardware is turned off! Anything else is a bug!
1186  *
1187  * @get_stats: return low-level statistics
1188  *
1189  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1190  *      callback should be provided to read the TKIP transmit IVs (both IV32
1191  *      and IV16) for the given key from hardware.
1192  *
1193  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1194  *
1195  * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1196  *      the device does fragmentation by itself; if this method is assigned then
1197  *      the stack will not do fragmentation.
1198  *
1199  * @sta_notify: Notifies low level driver about addition or removal
1200  *      of assocaited station or AP.
1201  *
1202  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1203  *      bursting) for a hardware TX queue.
1204  *
1205  * @get_tx_stats: Get statistics of the current TX queue status. This is used
1206  *      to get number of currently queued packets (queue length), maximum queue
1207  *      size (limit), and total number of packets sent using each TX queue
1208  *      (count). The 'stats' pointer points to an array that has hw->queues +
1209  *      hw->ampdu_queues items.
1210  *
1211  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1212  *      this is only used for IBSS mode debugging and, as such, is not a
1213  *      required function. Must be atomic.
1214  *
1215  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1216  *      with other STAs in the IBSS. This is only used in IBSS mode. This
1217  *      function is optional if the firmware/hardware takes full care of
1218  *      TSF synchronization.
1219  *
1220  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1221  *      This is needed only for IBSS mode and the result of this function is
1222  *      used to determine whether to reply to Probe Requests.
1223  *
1224  * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1225  *
1226  * @ampdu_action: Perform a certain A-MPDU action
1227  *      The RA/TID combination determines the destination and TID we want
1228  *      the ampdu action to be performed for. The action is defined through
1229  *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1230  *      is the first frame we expect to perform the action on. notice
1231  *      that TX/RX_STOP can pass NULL for this parameter.
1232  */
1233 struct ieee80211_ops {
1234         int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1235         int (*start)(struct ieee80211_hw *hw);
1236         void (*stop)(struct ieee80211_hw *hw);
1237         int (*add_interface)(struct ieee80211_hw *hw,
1238                              struct ieee80211_if_init_conf *conf);
1239         void (*remove_interface)(struct ieee80211_hw *hw,
1240                                  struct ieee80211_if_init_conf *conf);
1241         int (*config)(struct ieee80211_hw *hw, u32 changed);
1242         int (*config_interface)(struct ieee80211_hw *hw,
1243                                 struct ieee80211_vif *vif,
1244                                 struct ieee80211_if_conf *conf);
1245         void (*bss_info_changed)(struct ieee80211_hw *hw,
1246                                  struct ieee80211_vif *vif,
1247                                  struct ieee80211_bss_conf *info,
1248                                  u32 changed);
1249         void (*configure_filter)(struct ieee80211_hw *hw,
1250                                  unsigned int changed_flags,
1251                                  unsigned int *total_flags,
1252                                  int mc_count, struct dev_addr_list *mc_list);
1253         int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1254                        bool set);
1255         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1256                        const u8 *local_address, const u8 *address,
1257                        struct ieee80211_key_conf *key);
1258         void (*update_tkip_key)(struct ieee80211_hw *hw,
1259                         struct ieee80211_key_conf *conf, const u8 *address,
1260                         u32 iv32, u16 *phase1key);
1261         int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1262         int (*get_stats)(struct ieee80211_hw *hw,
1263                          struct ieee80211_low_level_stats *stats);
1264         void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1265                              u32 *iv32, u16 *iv16);
1266         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1267         int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1268         void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1269                         enum sta_notify_cmd, struct ieee80211_sta *sta);
1270         int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1271                        const struct ieee80211_tx_queue_params *params);
1272         int (*get_tx_stats)(struct ieee80211_hw *hw,
1273                             struct ieee80211_tx_queue_stats *stats);
1274         u64 (*get_tsf)(struct ieee80211_hw *hw);
1275         void (*reset_tsf)(struct ieee80211_hw *hw);
1276         int (*tx_last_beacon)(struct ieee80211_hw *hw);
1277         int (*ampdu_action)(struct ieee80211_hw *hw,
1278                             enum ieee80211_ampdu_mlme_action action,
1279                             struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1280 };
1281
1282 /**
1283  * ieee80211_alloc_hw -  Allocate a new hardware device
1284  *
1285  * This must be called once for each hardware device. The returned pointer
1286  * must be used to refer to this device when calling other functions.
1287  * mac80211 allocates a private data area for the driver pointed to by
1288  * @priv in &struct ieee80211_hw, the size of this area is given as
1289  * @priv_data_len.
1290  *
1291  * @priv_data_len: length of private data
1292  * @ops: callbacks for this device
1293  */
1294 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1295                                         const struct ieee80211_ops *ops);
1296
1297 /**
1298  * ieee80211_register_hw - Register hardware device
1299  *
1300  * You must call this function before any other functions in
1301  * mac80211. Note that before a hardware can be registered, you
1302  * need to fill the contained wiphy's information.
1303  *
1304  * @hw: the device to register as returned by ieee80211_alloc_hw()
1305  */
1306 int ieee80211_register_hw(struct ieee80211_hw *hw);
1307
1308 #ifdef CONFIG_MAC80211_LEDS
1309 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1310 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1311 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1312 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1313 #endif
1314 /**
1315  * ieee80211_get_tx_led_name - get name of TX LED
1316  *
1317  * mac80211 creates a transmit LED trigger for each wireless hardware
1318  * that can be used to drive LEDs if your driver registers a LED device.
1319  * This function returns the name (or %NULL if not configured for LEDs)
1320  * of the trigger so you can automatically link the LED device.
1321  *
1322  * @hw: the hardware to get the LED trigger name for
1323  */
1324 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1325 {
1326 #ifdef CONFIG_MAC80211_LEDS
1327         return __ieee80211_get_tx_led_name(hw);
1328 #else
1329         return NULL;
1330 #endif
1331 }
1332
1333 /**
1334  * ieee80211_get_rx_led_name - get name of RX LED
1335  *
1336  * mac80211 creates a receive LED trigger for each wireless hardware
1337  * that can be used to drive LEDs if your driver registers a LED device.
1338  * This function returns the name (or %NULL if not configured for LEDs)
1339  * of the trigger so you can automatically link the LED device.
1340  *
1341  * @hw: the hardware to get the LED trigger name for
1342  */
1343 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1344 {
1345 #ifdef CONFIG_MAC80211_LEDS
1346         return __ieee80211_get_rx_led_name(hw);
1347 #else
1348         return NULL;
1349 #endif
1350 }
1351
1352 /**
1353  * ieee80211_get_assoc_led_name - get name of association LED
1354  *
1355  * mac80211 creates a association LED trigger for each wireless hardware
1356  * that can be used to drive LEDs if your driver registers a LED device.
1357  * This function returns the name (or %NULL if not configured for LEDs)
1358  * of the trigger so you can automatically link the LED device.
1359  *
1360  * @hw: the hardware to get the LED trigger name for
1361  */
1362 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1363 {
1364 #ifdef CONFIG_MAC80211_LEDS
1365         return __ieee80211_get_assoc_led_name(hw);
1366 #else
1367         return NULL;
1368 #endif
1369 }
1370
1371 /**
1372  * ieee80211_get_radio_led_name - get name of radio LED
1373  *
1374  * mac80211 creates a radio change 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.
1378  *
1379  * @hw: the hardware to get the LED trigger name for
1380  */
1381 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1382 {
1383 #ifdef CONFIG_MAC80211_LEDS
1384         return __ieee80211_get_radio_led_name(hw);
1385 #else
1386         return NULL;
1387 #endif
1388 }
1389
1390 /**
1391  * ieee80211_unregister_hw - Unregister a hardware device
1392  *
1393  * This function instructs mac80211 to free allocated resources
1394  * and unregister netdevices from the networking subsystem.
1395  *
1396  * @hw: the hardware to unregister
1397  */
1398 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1399
1400 /**
1401  * ieee80211_free_hw - free hardware descriptor
1402  *
1403  * This function frees everything that was allocated, including the
1404  * private data for the driver. You must call ieee80211_unregister_hw()
1405  * before calling this function.
1406  *
1407  * @hw: the hardware to free
1408  */
1409 void ieee80211_free_hw(struct ieee80211_hw *hw);
1410
1411 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1412 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1413                     struct ieee80211_rx_status *status);
1414
1415 /**
1416  * ieee80211_rx - receive frame
1417  *
1418  * Use this function to hand received frames to mac80211. The receive
1419  * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1420  * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1421  *
1422  * This function may not be called in IRQ context. Calls to this function
1423  * for a single hardware must be synchronized against each other. Calls
1424  * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1425  * single hardware.
1426  *
1427  * @hw: the hardware this frame came in on
1428  * @skb: the buffer to receive, owned by mac80211 after this call
1429  * @status: status of this frame; the status pointer need not be valid
1430  *      after this function returns
1431  */
1432 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1433                                 struct ieee80211_rx_status *status)
1434 {
1435         __ieee80211_rx(hw, skb, status);
1436 }
1437
1438 /**
1439  * ieee80211_rx_irqsafe - receive frame
1440  *
1441  * Like ieee80211_rx() but can be called in IRQ context
1442  * (internally defers to a tasklet.)
1443  *
1444  * Calls to this function and ieee80211_rx() may not be mixed for a
1445  * single hardware.
1446  *
1447  * @hw: the hardware this frame came in on
1448  * @skb: the buffer to receive, owned by mac80211 after this call
1449  * @status: status of this frame; the status pointer need not be valid
1450  *      after this function returns and is not freed by mac80211,
1451  *      it is recommended that it points to a stack area
1452  */
1453 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1454                           struct sk_buff *skb,
1455                           struct ieee80211_rx_status *status);
1456
1457 /**
1458  * ieee80211_tx_status - transmit status callback
1459  *
1460  * Call this function for all transmitted frames after they have been
1461  * transmitted. It is permissible to not call this function for
1462  * multicast frames but this can affect statistics.
1463  *
1464  * This function may not be called in IRQ context. Calls to this function
1465  * for a single hardware must be synchronized against each other. Calls
1466  * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1467  * for a single hardware.
1468  *
1469  * @hw: the hardware the frame was transmitted by
1470  * @skb: the frame that was transmitted, owned by mac80211 after this call
1471  */
1472 void ieee80211_tx_status(struct ieee80211_hw *hw,
1473                          struct sk_buff *skb);
1474
1475 /**
1476  * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1477  *
1478  * Like ieee80211_tx_status() but can be called in IRQ context
1479  * (internally defers to a tasklet.)
1480  *
1481  * Calls to this function and ieee80211_tx_status() may not be mixed for a
1482  * single hardware.
1483  *
1484  * @hw: the hardware the frame was transmitted by
1485  * @skb: the frame that was transmitted, owned by mac80211 after this call
1486  */
1487 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1488                                  struct sk_buff *skb);
1489
1490 /**
1491  * ieee80211_beacon_get - beacon generation function
1492  * @hw: pointer obtained from ieee80211_alloc_hw().
1493  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1494  *
1495  * If the beacon frames are generated by the host system (i.e., not in
1496  * hardware/firmware), the low-level driver uses this function to receive
1497  * the next beacon frame from the 802.11 code. The low-level is responsible
1498  * for calling this function before beacon data is needed (e.g., based on
1499  * hardware interrupt). Returned skb is used only once and low-level driver
1500  * is responsible of freeing it.
1501  */
1502 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1503                                      struct ieee80211_vif *vif);
1504
1505 /**
1506  * ieee80211_rts_get - RTS frame generation function
1507  * @hw: pointer obtained from ieee80211_alloc_hw().
1508  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1509  * @frame: pointer to the frame that is going to be protected by the RTS.
1510  * @frame_len: the frame length (in octets).
1511  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1512  * @rts: The buffer where to store the RTS frame.
1513  *
1514  * If the RTS frames are generated by the host system (i.e., not in
1515  * hardware/firmware), the low-level driver uses this function to receive
1516  * the next RTS frame from the 802.11 code. The low-level is responsible
1517  * for calling this function before and RTS frame is needed.
1518  */
1519 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1520                        const void *frame, size_t frame_len,
1521                        const struct ieee80211_tx_info *frame_txctl,
1522                        struct ieee80211_rts *rts);
1523
1524 /**
1525  * ieee80211_rts_duration - Get the duration field for an RTS frame
1526  * @hw: pointer obtained from ieee80211_alloc_hw().
1527  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1528  * @frame_len: the length of the frame that is going to be protected by the RTS.
1529  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1530  *
1531  * If the RTS is generated in firmware, but the host system must provide
1532  * the duration field, the low-level driver uses this function to receive
1533  * the duration field value in little-endian byteorder.
1534  */
1535 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1536                               struct ieee80211_vif *vif, size_t frame_len,
1537                               const struct ieee80211_tx_info *frame_txctl);
1538
1539 /**
1540  * ieee80211_ctstoself_get - CTS-to-self frame generation function
1541  * @hw: pointer obtained from ieee80211_alloc_hw().
1542  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1543  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1544  * @frame_len: the frame length (in octets).
1545  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1546  * @cts: The buffer where to store the CTS-to-self frame.
1547  *
1548  * If the CTS-to-self frames are generated by the host system (i.e., not in
1549  * hardware/firmware), the low-level driver uses this function to receive
1550  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1551  * for calling this function before and CTS-to-self frame is needed.
1552  */
1553 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1554                              struct ieee80211_vif *vif,
1555                              const void *frame, size_t frame_len,
1556                              const struct ieee80211_tx_info *frame_txctl,
1557                              struct ieee80211_cts *cts);
1558
1559 /**
1560  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1561  * @hw: pointer obtained from ieee80211_alloc_hw().
1562  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1563  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1564  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1565  *
1566  * If the CTS-to-self is generated in firmware, but the host system must provide
1567  * the duration field, the low-level driver uses this function to receive
1568  * the duration field value in little-endian byteorder.
1569  */
1570 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1571                                     struct ieee80211_vif *vif,
1572                                     size_t frame_len,
1573                                     const struct ieee80211_tx_info *frame_txctl);
1574
1575 /**
1576  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1577  * @hw: pointer obtained from ieee80211_alloc_hw().
1578  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1579  * @frame_len: the length of the frame.
1580  * @rate: the rate at which the frame is going to be transmitted.
1581  *
1582  * Calculate the duration field of some generic frame, given its
1583  * length and transmission rate (in 100kbps).
1584  */
1585 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1586                                         struct ieee80211_vif *vif,
1587                                         size_t frame_len,
1588                                         struct ieee80211_rate *rate);
1589
1590 /**
1591  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1592  * @hw: pointer as obtained from ieee80211_alloc_hw().
1593  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1594  *
1595  * Function for accessing buffered broadcast and multicast frames. If
1596  * hardware/firmware does not implement buffering of broadcast/multicast
1597  * frames when power saving is used, 802.11 code buffers them in the host
1598  * memory. The low-level driver uses this function to fetch next buffered
1599  * frame. In most cases, this is used when generating beacon frame. This
1600  * function returns a pointer to the next buffered skb or NULL if no more
1601  * buffered frames are available.
1602  *
1603  * Note: buffered frames are returned only after DTIM beacon frame was
1604  * generated with ieee80211_beacon_get() and the low-level driver must thus
1605  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1606  * NULL if the previous generated beacon was not DTIM, so the low-level driver
1607  * does not need to check for DTIM beacons separately and should be able to
1608  * use common code for all beacons.
1609  */
1610 struct sk_buff *
1611 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1612
1613 /**
1614  * ieee80211_get_hdrlen_from_skb - get header length from data
1615  *
1616  * Given an skb with a raw 802.11 header at the data pointer this function
1617  * returns the 802.11 header length in bytes (not including encryption
1618  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1619  * header the function returns 0.
1620  *
1621  * @skb: the frame
1622  */
1623 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1624
1625 /**
1626  * ieee80211_hdrlen - get header length in bytes from frame control
1627  * @fc: frame control field in little-endian format
1628  */
1629 unsigned int ieee80211_hdrlen(__le16 fc);
1630
1631 /**
1632  * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1633  *
1634  * This function computes a TKIP rc4 key for an skb. It computes
1635  * a phase 1 key if needed (iv16 wraps around). This function is to
1636  * be used by drivers which can do HW encryption but need to compute
1637  * to phase 1/2 key in SW.
1638  *
1639  * @keyconf: the parameter passed with the set key
1640  * @skb: the skb for which the key is needed
1641  * @type: TBD
1642  * @key: a buffer to which the key will be written
1643  */
1644 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1645                                 struct sk_buff *skb,
1646                                 enum ieee80211_tkip_key_type type, u8 *key);
1647 /**
1648  * ieee80211_wake_queue - wake specific queue
1649  * @hw: pointer as obtained from ieee80211_alloc_hw().
1650  * @queue: queue number (counted from zero).
1651  *
1652  * Drivers should use this function instead of netif_wake_queue.
1653  */
1654 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1655
1656 /**
1657  * ieee80211_stop_queue - stop specific queue
1658  * @hw: pointer as obtained from ieee80211_alloc_hw().
1659  * @queue: queue number (counted from zero).
1660  *
1661  * Drivers should use this function instead of netif_stop_queue.
1662  */
1663 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1664
1665 /**
1666  * ieee80211_queue_stopped - test status of the queue
1667  * @hw: pointer as obtained from ieee80211_alloc_hw().
1668  * @queue: queue number (counted from zero).
1669  *
1670  * Drivers should use this function instead of netif_stop_queue.
1671  */
1672
1673 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1674
1675 /**
1676  * ieee80211_stop_queues - stop all queues
1677  * @hw: pointer as obtained from ieee80211_alloc_hw().
1678  *
1679  * Drivers should use this function instead of netif_stop_queue.
1680  */
1681 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1682
1683 /**
1684  * ieee80211_wake_queues - wake all queues
1685  * @hw: pointer as obtained from ieee80211_alloc_hw().
1686  *
1687  * Drivers should use this function instead of netif_wake_queue.
1688  */
1689 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1690
1691 /**
1692  * ieee80211_scan_completed - completed hardware scan
1693  *
1694  * When hardware scan offload is used (i.e. the hw_scan() callback is
1695  * assigned) this function needs to be called by the driver to notify
1696  * mac80211 that the scan finished.
1697  *
1698  * @hw: the hardware that finished the scan
1699  */
1700 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1701
1702 /**
1703  * ieee80211_iterate_active_interfaces - iterate active interfaces
1704  *
1705  * This function iterates over the interfaces associated with a given
1706  * hardware that are currently active and calls the callback for them.
1707  * This function allows the iterator function to sleep, when the iterator
1708  * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1709  * be used.
1710  *
1711  * @hw: the hardware struct of which the interfaces should be iterated over
1712  * @iterator: the iterator function to call
1713  * @data: first argument of the iterator function
1714  */
1715 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1716                                          void (*iterator)(void *data, u8 *mac,
1717                                                 struct ieee80211_vif *vif),
1718                                          void *data);
1719
1720 /**
1721  * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1722  *
1723  * This function iterates over the interfaces associated with a given
1724  * hardware that are currently active and calls the callback for them.
1725  * This function requires the iterator callback function to be atomic,
1726  * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1727  *
1728  * @hw: the hardware struct of which the interfaces should be iterated over
1729  * @iterator: the iterator function to call, cannot sleep
1730  * @data: first argument of the iterator function
1731  */
1732 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1733                                                 void (*iterator)(void *data,
1734                                                     u8 *mac,
1735                                                     struct ieee80211_vif *vif),
1736                                                 void *data);
1737
1738 /**
1739  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1740  * @hw: pointer as obtained from ieee80211_alloc_hw().
1741  * @ra: receiver address of the BA session recipient
1742  * @tid: the TID to BA on.
1743  *
1744  * Return: success if addBA request was sent, failure otherwise
1745  *
1746  * Although mac80211/low level driver/user space application can estimate
1747  * the need to start aggregation on a certain RA/TID, the session level
1748  * will be managed by the mac80211.
1749  */
1750 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1751
1752 /**
1753  * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1754  * @hw: pointer as obtained from ieee80211_alloc_hw().
1755  * @ra: receiver address of the BA session recipient.
1756  * @tid: the TID to BA on.
1757  *
1758  * This function must be called by low level driver once it has
1759  * finished with preparations for the BA session.
1760  */
1761 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1762
1763 /**
1764  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1765  * @hw: pointer as obtained from ieee80211_alloc_hw().
1766  * @ra: receiver address of the BA session recipient.
1767  * @tid: the TID to BA on.
1768  *
1769  * This function must be called by low level driver once it has
1770  * finished with preparations for the BA session.
1771  * This version of the function is IRQ-safe.
1772  */
1773 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1774                                       u16 tid);
1775
1776 /**
1777  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1778  * @hw: pointer as obtained from ieee80211_alloc_hw().
1779  * @ra: receiver address of the BA session recipient
1780  * @tid: the TID to stop BA.
1781  * @initiator: if indicates initiator DELBA frame will be sent.
1782  *
1783  * Return: error if no sta with matching da found, success otherwise
1784  *
1785  * Although mac80211/low level driver/user space application can estimate
1786  * the need to stop aggregation on a certain RA/TID, the session level
1787  * will be managed by the mac80211.
1788  */
1789 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1790                                  u8 *ra, u16 tid,
1791                                  enum ieee80211_back_parties initiator);
1792
1793 /**
1794  * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1795  * @hw: pointer as obtained from ieee80211_alloc_hw().
1796  * @ra: receiver address of the BA session recipient.
1797  * @tid: the desired TID to BA on.
1798  *
1799  * This function must be called by low level driver once it has
1800  * finished with preparations for the BA session tear down.
1801  */
1802 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1803
1804 /**
1805  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1806  * @hw: pointer as obtained from ieee80211_alloc_hw().
1807  * @ra: receiver address of the BA session recipient.
1808  * @tid: the desired TID to BA on.
1809  *
1810  * This function must be called by low level driver once it has
1811  * finished with preparations for the BA session tear down.
1812  * This version of the function is IRQ-safe.
1813  */
1814 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1815                                      u16 tid);
1816
1817 /**
1818  * ieee80211_notify_mac - low level driver notification
1819  * @hw: pointer as obtained from ieee80211_alloc_hw().
1820  * @notif_type: enum ieee80211_notification_types
1821  *
1822  * This function must be called by low level driver to inform mac80211 of
1823  * low level driver status change or force mac80211 to re-assoc for low
1824  * level driver internal error that require re-assoc.
1825  */
1826 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1827                           enum ieee80211_notification_types  notif_type);
1828
1829 /**
1830  * ieee80211_find_sta - find a station
1831  *
1832  * @hw: pointer as obtained from ieee80211_alloc_hw()
1833  * @addr: station's address
1834  *
1835  * This function must be called under RCU lock and the
1836  * resulting pointer is only valid under RCU lock as well.
1837  */
1838 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1839                                          const u8 *addr);
1840
1841
1842 /* Rate control API */
1843 /**
1844  * struct rate_selection - rate information for/from rate control algorithms
1845  *
1846  * @rate_idx: selected transmission rate index
1847  * @nonerp_idx: Non-ERP rate to use instead if ERP cannot be used
1848  * @probe_idx: rate for probing (or -1)
1849  * @max_rate_idx: maximum rate index that can be used, this is
1850  *      input to the algorithm and will be enforced
1851  */
1852 struct rate_selection {
1853         s8 rate_idx, nonerp_idx, probe_idx, max_rate_idx;
1854 };
1855
1856 struct rate_control_ops {
1857         struct module *module;
1858         const char *name;
1859         void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
1860         void (*clear)(void *priv);
1861         void (*free)(void *priv);
1862
1863         void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
1864         void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
1865                           struct ieee80211_sta *sta, void *priv_sta);
1866         void (*free_sta)(void *priv, struct ieee80211_sta *sta,
1867                          void *priv_sta);
1868
1869         void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
1870                           struct ieee80211_sta *sta, void *priv_sta,
1871                           struct sk_buff *skb);
1872         void (*get_rate)(void *priv, struct ieee80211_supported_band *sband,
1873                          struct ieee80211_sta *sta, void *priv_sta,
1874                          struct sk_buff *skb,
1875                          struct rate_selection *sel);
1876
1877         void (*add_sta_debugfs)(void *priv, void *priv_sta,
1878                                 struct dentry *dir);
1879         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
1880 };
1881
1882 static inline int rate_supported(struct ieee80211_sta *sta,
1883                                  enum ieee80211_band band,
1884                                  int index)
1885 {
1886         return (sta == NULL || sta->supp_rates[band] & BIT(index));
1887 }
1888
1889 static inline s8
1890 rate_lowest_index(struct ieee80211_supported_band *sband,
1891                   struct ieee80211_sta *sta)
1892 {
1893         int i;
1894
1895         for (i = 0; i < sband->n_bitrates; i++)
1896                 if (rate_supported(sta, sband->band, i))
1897                         return i;
1898
1899         /* warn when we cannot find a rate. */
1900         WARN_ON(1);
1901
1902         return 0;
1903 }
1904
1905
1906 int ieee80211_rate_control_register(struct rate_control_ops *ops);
1907 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
1908
1909 #endif /* MAC80211_H */