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