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