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