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