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