c143ac8965dbce6726b0b329f3a258144567c380
[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 function.
42  */
43
44 /**
45  * DOC: Warning
46  *
47  * If you're reading this document and not the header file itself, it will
48  * be incomplete because not all documentation has been converted yet.
49  */
50
51 /**
52  * DOC: Frame format
53  *
54  * As a general rule, when frames are passed between mac80211 and the driver,
55  * they start with the IEEE 802.11 header and include the same octets that are
56  * sent over the air except for the FCS which should be calculated by the
57  * hardware.
58  *
59  * There are, however, various exceptions to this rule for advanced features:
60  *
61  * The first exception is for hardware encryption and decryption offload
62  * where the IV/ICV may or may not be generated in hardware.
63  *
64  * Secondly, when the hardware handles fragmentation, the frame handed to
65  * the driver from mac80211 is the MSDU, not the MPDU.
66  *
67  * Finally, for received frames, the driver is able to indicate that it has
68  * filled a radiotap header and put that in front of the frame; if it does
69  * not do so then mac80211 may add this under certain circumstances.
70  */
71
72 #define IEEE80211_CHAN_W_SCAN 0x00000001
73 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
74 #define IEEE80211_CHAN_W_IBSS 0x00000004
75
76 /* Channel information structure. Low-level driver is expected to fill in chan,
77  * freq, and val fields. Other fields will be filled in by 80211.o based on
78  * hostapd information and low-level driver does not need to use them. The
79  * limits for each channel will be provided in 'struct ieee80211_conf' when
80  * configuring the low-level driver with hw->config callback. If a device has
81  * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
82  * can be set to let the driver configure all fields */
83 struct ieee80211_channel {
84         short chan; /* channel number (IEEE 802.11) */
85         short freq; /* frequency in MHz */
86         int val; /* hw specific value for the channel */
87         int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
88         unsigned char power_level;
89         unsigned char antenna_max;
90 };
91
92 #define IEEE80211_RATE_ERP 0x00000001
93 #define IEEE80211_RATE_BASIC 0x00000002
94 #define IEEE80211_RATE_PREAMBLE2 0x00000004
95 #define IEEE80211_RATE_SUPPORTED 0x00000010
96 #define IEEE80211_RATE_OFDM 0x00000020
97 #define IEEE80211_RATE_CCK 0x00000040
98 #define IEEE80211_RATE_MANDATORY 0x00000100
99
100 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
101 #define IEEE80211_RATE_MODULATION(f) \
102         (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
103
104 /* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
105  * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
106  * configuration. */
107 struct ieee80211_rate {
108         int rate; /* rate in 100 kbps */
109         int val; /* hw specific value for the rate */
110         int flags; /* IEEE80211_RATE_ flags */
111         int val2; /* hw specific value for the rate when using short preamble
112                    * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
113                    * 2, 5.5, and 11 Mbps) */
114         signed char min_rssi_ack;
115         unsigned char min_rssi_ack_delta;
116
117         /* following fields are set by 80211.o and need not be filled by the
118          * low-level driver */
119         int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
120                        * optimizing channel utilization estimates */
121 };
122
123 /**
124  * enum ieee80211_phymode - PHY modes
125  *
126  * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h
127  * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b
128  * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM),
129  *      backwards compatible with 11b mode
130  * @NUM_IEEE80211_MODES: internal
131  */
132 enum ieee80211_phymode {
133         MODE_IEEE80211A,
134         MODE_IEEE80211B,
135         MODE_IEEE80211G,
136
137         /* keep last */
138         NUM_IEEE80211_MODES
139 };
140
141 /**
142  * struct ieee80211_hw_mode - PHY mode definition
143  *
144  * This structure describes the capabilities supported by the device
145  * in a single PHY mode.
146  *
147  * @mode: the PHY mode for this definition
148  * @num_channels: number of supported channels
149  * @channels: pointer to array of supported channels
150  * @num_rates: number of supported bitrates
151  * @rates: pointer to array of supported bitrates
152  * @list: internal
153  */
154 struct ieee80211_hw_mode {
155         struct list_head list;
156         struct ieee80211_channel *channels;
157         struct ieee80211_rate *rates;
158         enum ieee80211_phymode mode;
159         int num_channels;
160         int num_rates;
161 };
162
163 /**
164  * struct ieee80211_tx_queue_params - transmit queue configuration
165  *
166  * The information provided in this structure is required for QoS
167  * transmit queue configuration.
168  *
169  * @aifs: arbitration interface space [0..255, -1: use default]
170  * @cw_min: minimum contention window [will be a value of the form
171  *      2^n-1 in the range 1..1023; 0: use default]
172  * @cw_max: maximum contention window [like @cw_min]
173  * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled
174  */
175 struct ieee80211_tx_queue_params {
176         int aifs;
177         int cw_min;
178         int cw_max;
179         int burst_time;
180 };
181
182 /**
183  * struct ieee80211_tx_queue_stats_data - transmit queue statistics
184  *
185  * @len: number of packets in queue
186  * @limit: queue length limit
187  * @count: number of frames sent
188  */
189 struct ieee80211_tx_queue_stats_data {
190         unsigned int len;
191         unsigned int limit;
192         unsigned int count;
193 };
194
195 /**
196  * enum ieee80211_tx_queue - transmit queue number
197  *
198  * These constants are used with some callbacks that take a
199  * queue number to set parameters for a queue.
200  *
201  * @IEEE80211_TX_QUEUE_DATA0: data queue 0
202  * @IEEE80211_TX_QUEUE_DATA1: data queue 1
203  * @IEEE80211_TX_QUEUE_DATA2: data queue 2
204  * @IEEE80211_TX_QUEUE_DATA3: data queue 3
205  * @IEEE80211_TX_QUEUE_DATA4: data queue 4
206  * @IEEE80211_TX_QUEUE_SVP: ??
207  * @NUM_TX_DATA_QUEUES: number of data queues
208  * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
209  *      sent after a beacon
210  * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
211  */
212 enum ieee80211_tx_queue {
213         IEEE80211_TX_QUEUE_DATA0,
214         IEEE80211_TX_QUEUE_DATA1,
215         IEEE80211_TX_QUEUE_DATA2,
216         IEEE80211_TX_QUEUE_DATA3,
217         IEEE80211_TX_QUEUE_DATA4,
218         IEEE80211_TX_QUEUE_SVP,
219
220         NUM_TX_DATA_QUEUES,
221
222 /* due to stupidity in the sub-ioctl userspace interface, the items in
223  * this struct need to have fixed values. As soon as it is removed, we can
224  * fix these entries. */
225         IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
226         IEEE80211_TX_QUEUE_BEACON = 7
227 };
228
229 struct ieee80211_tx_queue_stats {
230         struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
231 };
232
233 struct ieee80211_low_level_stats {
234         unsigned int dot11ACKFailureCount;
235         unsigned int dot11RTSFailureCount;
236         unsigned int dot11FCSErrorCount;
237         unsigned int dot11RTSSuccessCount;
238 };
239
240 /* Transmit control fields. This data structure is passed to low-level driver
241  * with each TX frame. The low-level driver is responsible for configuring
242  * the hardware to use given values (depending on what is supported). */
243
244 struct ieee80211_tx_control {
245         int tx_rate; /* Transmit rate, given as the hw specific value for the
246                       * rate (from struct ieee80211_rate) */
247         int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
248                            * specific value for the rate (from
249                            * struct ieee80211_rate) */
250
251 #define IEEE80211_TXCTL_REQ_TX_STATUS   (1<<0)/* request TX status callback for
252                                                 * this frame */
253 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT  (1<<1) /* send this frame without
254                                                 * encryption; e.g., for EAPOL
255                                                 * frames */
256 #define IEEE80211_TXCTL_USE_RTS_CTS     (1<<2) /* use RTS-CTS before sending
257                                                 * frame */
258 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
259                                                 * frame (e.g., for combined
260                                                 * 802.11g / 802.11b networks) */
261 #define IEEE80211_TXCTL_NO_ACK          (1<<4) /* tell the low level not to
262                                                 * wait for an ack */
263 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
264 #define IEEE80211_TXCTL_CLEAR_DST_MASK  (1<<6)
265 #define IEEE80211_TXCTL_REQUEUE         (1<<7)
266 #define IEEE80211_TXCTL_FIRST_FRAGMENT  (1<<8) /* this is a first fragment of
267                                                 * the frame */
268 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
269                                                   * using the through
270                                                   * set_retry_limit configured
271                                                   * long retry value */
272         u32 flags;                             /* tx control flags defined
273                                                 * above */
274         u8 key_idx;             /* keyidx from hw->set_key(), undefined if
275                                  * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
276         u8 retry_limit;         /* 1 = only first attempt, 2 = one retry, ..
277                                  * This could be used when set_retry_limit
278                                  * is not implemented by the driver */
279         u8 power_level;         /* per-packet transmit power level, in dBm */
280         u8 antenna_sel_tx;      /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
281         u8 icv_len;             /* length of the ICV/MIC field in octets */
282         u8 iv_len;              /* length of the IV field in octets */
283         u8 queue;               /* hardware queue to use for this frame;
284                                  * 0 = highest, hw->queues-1 = lowest */
285         struct ieee80211_rate *rate;            /* internal 80211.o rate */
286         struct ieee80211_rate *rts_rate;        /* internal 80211.o rate
287                                                  * for RTS/CTS */
288         int alt_retry_rate; /* retry rate for the last retries, given as the
289                              * hw specific value for the rate (from
290                              * struct ieee80211_rate). To be used to limit
291                              * packet dropping when probing higher rates, if hw
292                              * supports multiple retry rates. -1 = not used */
293         int type;       /* internal */
294         int ifindex;    /* internal */
295 };
296
297
298 /**
299  * enum mac80211_rx_flags - receive flags
300  *
301  * These flags are used with the @flag member of &struct ieee80211_rx_status.
302  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
303  *      Use together with %RX_FLAG_MMIC_STRIPPED.
304  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
305  * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
306  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
307  *      verification has been done by the hardware.
308  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
309  *      If this flag is set, the stack cannot do any replay detection
310  *      hence the driver or hardware will have to do that.
311  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
312  *      the frame.
313  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
314  *      the frame.
315  */
316 enum mac80211_rx_flags {
317         RX_FLAG_MMIC_ERROR      = 1<<0,
318         RX_FLAG_DECRYPTED       = 1<<1,
319         RX_FLAG_RADIOTAP        = 1<<2,
320         RX_FLAG_MMIC_STRIPPED   = 1<<3,
321         RX_FLAG_IV_STRIPPED     = 1<<4,
322         RX_FLAG_FAILED_FCS_CRC  = 1<<5,
323         RX_FLAG_FAILED_PLCP_CRC = 1<<6,
324 };
325
326 /**
327  * struct ieee80211_rx_status - receive status
328  *
329  * The low-level driver should provide this information (the subset
330  * supported by hardware) to the 802.11 code with each received
331  * frame.
332  * @mactime: MAC timestamp as defined by 802.11
333  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
334  * @channel: channel the radio was tuned to
335  * @phymode: active PHY mode
336  * @ssi: signal strength when receiving this frame
337  * @signal: used as 'qual' in statistics reporting
338  * @noise: PHY noise when receiving this frame
339  * @antenna: antenna used
340  * @rate: data rate
341  * @flag: %RX_FLAG_*
342  */
343 struct ieee80211_rx_status {
344         u64 mactime;
345         int freq;
346         int channel;
347         enum ieee80211_phymode phymode;
348         int ssi;
349         int signal;
350         int noise;
351         int antenna;
352         int rate;
353         int flag;
354 };
355
356 /**
357  * enum ieee80211_tx_status_flags - transmit status flags
358  *
359  * Status flags to indicate various transmit conditions.
360  *
361  * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
362  *      because the destination STA was in powersave mode.
363  *
364  * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
365  */
366 enum ieee80211_tx_status_flags {
367         IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
368         IEEE80211_TX_STATUS_ACK         = 1<<1,
369 };
370
371 /**
372  * struct ieee80211_tx_status - transmit status
373  *
374  * As much information as possible should be provided for each transmitted
375  * frame with ieee80211_tx_status().
376  *
377  * @control: a copy of the &struct ieee80211_tx_control passed to the driver
378  *      in the tx() callback.
379  *
380  * @flags: transmit status flags, defined above
381  *
382  * @ack_signal: signal strength of the ACK frame
383  *
384  * @excessive_retries: set to 1 if the frame was retried many times
385  *      but not acknowledged
386  *
387  * @retry_count: number of retries
388  *
389  * @queue_length: ?? REMOVE
390  * @queue_number: ?? REMOVE
391  */
392 struct ieee80211_tx_status {
393         struct ieee80211_tx_control control;
394         u8 flags;
395         bool excessive_retries;
396         u8 retry_count;
397         int ack_signal;
398         int queue_length;
399         int queue_number;
400 };
401
402 /**
403  * enum ieee80211_conf_flags - configuration flags
404  *
405  * Flags to define PHY configuration options
406  *
407  * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
408  * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
409  *
410  */
411 enum ieee80211_conf_flags {
412         IEEE80211_CONF_SHORT_SLOT_TIME  = 1<<0,
413         IEEE80211_CONF_RADIOTAP         = 1<<1,
414 };
415
416 /**
417  * struct ieee80211_conf - configuration of the device
418  *
419  * This struct indicates how the driver shall configure the hardware.
420  *
421  * @radio_enabled: when zero, driver is required to switch off the radio.
422  *      TODO make a flag
423  * @channel: IEEE 802.11 channel number
424  * @freq: frequency in MHz
425  * @channel_val: hardware specific channel value for the channel
426  * @phymode: PHY mode to activate (REMOVE)
427  * @chan: channel to switch to, pointer to the channel information
428  * @mode: pointer to mode definition
429  * @regulatory_domain: ??
430  * @beacon_int: beacon interval (TODO make interface config)
431  * @flags: configuration flags defined above
432  * @power_level: transmit power limit for current regulatory domain in dBm
433  * @antenna_max: maximum antenna gain
434  * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
435  *      1/2: antenna 0/1
436  * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
437  */
438 struct ieee80211_conf {
439         int channel;                    /* IEEE 802.11 channel number */
440         int freq;                       /* MHz */
441         int channel_val;                /* hw specific value for the channel */
442
443         enum ieee80211_phymode phymode;
444         struct ieee80211_channel *chan;
445         struct ieee80211_hw_mode *mode;
446         unsigned int regulatory_domain;
447         int radio_enabled;
448
449         int beacon_int;
450         u32 flags;
451         u8 power_level;
452         u8 antenna_max;
453         u8 antenna_sel_tx;
454         u8 antenna_sel_rx;
455 };
456
457 /**
458  * enum ieee80211_if_types - types of 802.11 network interfaces
459  *
460  * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
461  *      by mac80211 itself
462  * @IEEE80211_IF_TYPE_AP: interface in AP mode.
463  * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
464  *      daemon. Drivers should never see this type.
465  * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
466  * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
467  * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
468  * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
469  * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
470  *      will never see this type.
471  */
472 enum ieee80211_if_types {
473         IEEE80211_IF_TYPE_INVALID,
474         IEEE80211_IF_TYPE_AP,
475         IEEE80211_IF_TYPE_STA,
476         IEEE80211_IF_TYPE_IBSS,
477         IEEE80211_IF_TYPE_MNTR,
478         IEEE80211_IF_TYPE_WDS,
479         IEEE80211_IF_TYPE_VLAN,
480 };
481
482 /**
483  * struct ieee80211_if_init_conf - initial configuration of an interface
484  *
485  * @if_id: internal interface ID. This number has no particular meaning to
486  *      drivers and the only allowed usage is to pass it to
487  *      ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
488  *      This field is not valid for monitor interfaces
489  *      (interfaces of %IEEE80211_IF_TYPE_MNTR type).
490  * @type: one of &enum ieee80211_if_types constants. Determines the type of
491  *      added/removed interface.
492  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
493  *      until the interface is removed (i.e. it cannot be used after
494  *      remove_interface() callback was called for this interface).
495  *
496  * This structure is used in add_interface() and remove_interface()
497  * callbacks of &struct ieee80211_hw.
498  *
499  * When you allow multiple interfaces to be added to your PHY, take care
500  * that the hardware can actually handle multiple MAC addresses. However,
501  * also take care that when there's no interface left with mac_addr != %NULL
502  * you remove the MAC address from the device to avoid acknowledging packets
503  * in pure monitor mode.
504  */
505 struct ieee80211_if_init_conf {
506         int if_id;
507         enum ieee80211_if_types type;
508         void *mac_addr;
509 };
510
511 /**
512  * struct ieee80211_if_conf - configuration of an interface
513  *
514  * @type: type of the interface. This is always the same as was specified in
515  *      &struct ieee80211_if_init_conf. The type of an interface never changes
516  *      during the life of the interface; this field is present only for
517  *      convenience.
518  * @bssid: BSSID of the network we are associated to/creating.
519  * @ssid: used (together with @ssid_len) by drivers for hardware that
520  *      generate beacons independently. The pointer is valid only during the
521  *      config_interface() call, so copy the value somewhere if you need
522  *      it.
523  * @ssid_len: length of the @ssid field.
524  * @beacon: beacon template. Valid only if @host_gen_beacon_template in
525  *      &struct ieee80211_hw is set. The driver is responsible of freeing
526  *      the sk_buff.
527  * @beacon_control: tx_control for the beacon template, this field is only
528  *      valid when the @beacon field was set.
529  *
530  * This structure is passed to the config_interface() callback of
531  * &struct ieee80211_hw.
532  */
533 struct ieee80211_if_conf {
534         int type;
535         u8 *bssid;
536         u8 *ssid;
537         size_t ssid_len;
538         struct sk_buff *beacon;
539         struct ieee80211_tx_control *beacon_control;
540 };
541
542 /**
543  * enum ieee80211_key_alg - key algorithm
544  * @ALG_NONE: Unset key algorithm, will never be passed to the driver
545  * @ALG_WEP: WEP40 or WEP104
546  * @ALG_TKIP: TKIP
547  * @ALG_CCMP: CCMP (AES)
548  */
549 enum ieee80211_key_alg {
550         ALG_NONE,
551         ALG_WEP,
552         ALG_TKIP,
553         ALG_CCMP,
554 };
555
556
557 /**
558  * enum ieee80211_key_flags - key flags
559  *
560  * These flags are used for communication about keys between the driver
561  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
562  *
563  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
564  *      that the STA this key will be used with could be using QoS.
565  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
566  *      driver to indicate that it requires IV generation for this
567  *      particular key.
568  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
569  *      the driver for a TKIP key if it requires Michael MIC
570  *      generation in software.
571  */
572 enum ieee80211_key_flags {
573         IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
574         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
575         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
576 };
577
578 /**
579  * struct ieee80211_key_conf - key information
580  *
581  * This key information is given by mac80211 to the driver by
582  * the set_key() callback in &struct ieee80211_ops.
583  *
584  * @hw_key_idx: To be set by the driver, this is the key index the driver
585  *      wants to be given when a frame is transmitted and needs to be
586  *      encrypted in hardware.
587  * @alg: The key algorithm.
588  * @flags: key flags, see &enum ieee80211_key_flags.
589  * @keyidx: the key index (0-3)
590  * @keylen: key material length
591  * @key: key material
592  */
593 struct ieee80211_key_conf {
594         enum ieee80211_key_alg alg;
595         u8 hw_key_idx;
596         u8 flags;
597         s8 keyidx;
598         u8 keylen;
599         u8 key[0];
600 };
601
602 #define IEEE80211_SEQ_COUNTER_RX        0
603 #define IEEE80211_SEQ_COUNTER_TX        1
604
605 /**
606  * enum set_key_cmd - key command
607  *
608  * Used with the set_key() callback in &struct ieee80211_ops, this
609  * indicates whether a key is being removed or added.
610  *
611  * @SET_KEY: a key is set
612  * @DISABLE_KEY: a key must be disabled
613  */
614 enum set_key_cmd {
615         SET_KEY, DISABLE_KEY,
616 };
617
618
619 /**
620  * enum ieee80211_hw_flags - hardware flags
621  *
622  * These flags are used to indicate hardware capabilities to
623  * the stack. Generally, flags here should have their meaning
624  * done in a way that the simplest hardware doesn't need setting
625  * any particular flags. There are some exceptions to this rule,
626  * however, so you are advised to review these flags carefully.
627  *
628  * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
629  *      The device only needs to be supplied with a beacon template.
630  *      If you need the host to generate each beacon then don't use
631  *      this flag and call ieee80211_beacon_get() when you need the
632  *      next beacon frame. Note that if you set this flag, you must
633  *      implement the set_tim() callback for powersave mode to work
634  *      properly.
635  *      This flag is only relevant for access-point mode.
636  *
637  * @IEEE80211_HW_RX_INCLUDES_FCS:
638  *      Indicates that received frames passed to the stack include
639  *      the FCS at the end.
640  *
641  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
642  *      Some wireless LAN chipsets buffer broadcast/multicast frames
643  *      for power saving stations in the hardware/firmware and others
644  *      rely on the host system for such buffering. This option is used
645  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
646  *      multicast frames when there are power saving stations so that
647  *      the driver can fetch them with ieee80211_get_buffered_bc(). Note
648  *      that not setting this flag works properly only when the
649  *      %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
650  *      otherwise the stack will not know when the DTIM beacon was sent.
651  *
652  * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
653  *      Channels are already configured to the default regulatory domain
654  *      specified in the device's EEPROM
655  */
656 enum ieee80211_hw_flags {
657         IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE           = 1<<0,
658         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
659         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
660         IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED      = 1<<3,
661 };
662
663 /**
664  * struct ieee80211_hw - hardware information and state
665  *
666  * This structure contains the configuration and hardware
667  * information for an 802.11 PHY.
668  *
669  * @wiphy: This points to the &struct wiphy allocated for this
670  *      802.11 PHY. You must fill in the @perm_addr and @dev
671  *      members of this structure using SET_IEEE80211_DEV()
672  *      and SET_IEEE80211_PERM_ADDR().
673  *
674  * @conf: &struct ieee80211_conf, device configuration, don't use.
675  *
676  * @workqueue: single threaded workqueue available for driver use,
677  *      allocated by mac80211 on registration and flushed on
678  *      unregistration.
679  *
680  * @priv: pointer to private area that was allocated for driver use
681  *      along with this structure.
682  *
683  * @flags: hardware flags, see &enum ieee80211_hw_flags.
684  *
685  * @extra_tx_headroom: headroom to reserve in each transmit skb
686  *      for use by the driver (e.g. for transmit headers.)
687  *
688  * @channel_change_time: time (in microseconds) it takes to change channels.
689  *
690  * @max_rssi: Maximum value for ssi in RX information, use
691  *      negative numbers for dBm and 0 to indicate no support.
692  *
693  * @max_signal: like @max_rssi, but for the signal value.
694  *
695  * @max_noise: like @max_rssi, but for the noise value.
696  *
697  * @queues: number of available hardware transmit queues for
698  *      data packets. WMM/QoS requires at least four.
699  */
700 struct ieee80211_hw {
701         struct ieee80211_conf conf;
702         struct wiphy *wiphy;
703         struct workqueue_struct *workqueue;
704         void *priv;
705         u32 flags;
706         unsigned int extra_tx_headroom;
707         int channel_change_time;
708         u8 queues;
709         s8 max_rssi;
710         s8 max_signal;
711         s8 max_noise;
712 };
713
714 /**
715  * SET_IEEE80211_DEV - set device for 802.11 hardware
716  *
717  * @hw: the &struct ieee80211_hw to set the device for
718  * @dev: the &struct device of this 802.11 device
719  */
720 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
721 {
722         set_wiphy_dev(hw->wiphy, dev);
723 }
724
725 /**
726  * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
727  *
728  * @hw: the &struct ieee80211_hw to set the MAC address for
729  * @addr: the address to set
730  */
731 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
732 {
733         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
734 }
735
736 /**
737  * DOC: Hardware crypto acceleration
738  *
739  * mac80211 is capable of taking advantage of many hardware
740  * acceleration designs for encryption and decryption operations.
741  *
742  * The set_key() callback in the &struct ieee80211_ops for a given
743  * device is called to enable hardware acceleration of encryption and
744  * decryption. The callback takes an @address parameter that will be
745  * the broadcast address for default keys, the other station's hardware
746  * address for individual keys or the zero address for keys that will
747  * be used only for transmission.
748  * Multiple transmission keys with the same key index may be used when
749  * VLANs are configured for an access point.
750  *
751  * The @local_address parameter will always be set to our own address,
752  * this is only relevant if you support multiple local addresses.
753  *
754  * When transmitting, the TX control data will use the @hw_key_idx
755  * selected by the driver by modifying the &struct ieee80211_key_conf
756  * pointed to by the @key parameter to the set_key() function.
757  *
758  * The set_key() call for the %SET_KEY command should return 0 if
759  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
760  * added; if you return 0 then hw_key_idx must be assigned to the
761  * hardware key index, you are free to use the full u8 range.
762  *
763  * When the cmd is %DISABLE_KEY then it must succeed.
764  *
765  * Note that it is permissible to not decrypt a frame even if a key
766  * for it has been uploaded to hardware, the stack will not make any
767  * decision based on whether a key has been uploaded or not but rather
768  * based on the receive flags.
769  *
770  * The &struct ieee80211_key_conf structure pointed to by the @key
771  * parameter is guaranteed to be valid until another call to set_key()
772  * removes it, but it can only be used as a cookie to differentiate
773  * keys.
774  */
775
776 /**
777  * DOC: Frame filtering
778  *
779  * mac80211 requires to see many management frames for proper
780  * operation, and users may want to see many more frames when
781  * in monitor mode. However, for best CPU usage and power consumption,
782  * having as few frames as possible percolate through the stack is
783  * desirable. Hence, the hardware should filter as much as possible.
784  *
785  * To achieve this, mac80211 uses filter flags (see below) to tell
786  * the driver's configure_filter() function which frames should be
787  * passed to mac80211 and which should be filtered out.
788  *
789  * The configure_filter() callback is invoked with the parameters
790  * @mc_count and @mc_list for the combined multicast address list
791  * of all virtual interfaces, @changed_flags telling which flags
792  * were changed and @total_flags with the new flag states.
793  *
794  * If your device has no multicast address filters your driver will
795  * need to check both the %FIF_ALLMULTI flag and the @mc_count
796  * parameter to see whether multicast frames should be accepted
797  * or dropped.
798  *
799  * All unsupported flags in @total_flags must be cleared, i.e. you
800  * should clear all bits except those you honoured.
801  */
802
803 /**
804  * enum ieee80211_filter_flags - hardware filter flags
805  *
806  * These flags determine what the filter in hardware should be
807  * programmed to let through and what should not be passed to the
808  * stack. It is always safe to pass more frames than requested,
809  * but this has negative impact on power consumption.
810  *
811  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
812  *      think of the BSS as your network segment and then this corresponds
813  *      to the regular ethernet device promiscuous mode.
814  *
815  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
816  *      by the user or if the hardware is not capable of filtering by
817  *      multicast address.
818  *
819  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
820  *      %RX_FLAG_FAILED_FCS_CRC for them)
821  *
822  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
823  *      the %RX_FLAG_FAILED_PLCP_CRC for them
824  *
825  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
826  *      to the hardware that it should not filter beacons or probe responses
827  *      by BSSID. Filtering them can greatly reduce the amount of processing
828  *      mac80211 needs to do and the amount of CPU wakeups, so you should
829  *      honour this flag if possible.
830  *
831  * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
832  *      only those addressed to this station
833  *
834  * @FIF_OTHER_BSS: pass frames destined to other BSSes
835  */
836 enum ieee80211_filter_flags {
837         FIF_PROMISC_IN_BSS      = 1<<0,
838         FIF_ALLMULTI            = 1<<1,
839         FIF_FCSFAIL             = 1<<2,
840         FIF_PLCPFAIL            = 1<<3,
841         FIF_BCN_PRBRESP_PROMISC = 1<<4,
842         FIF_CONTROL             = 1<<5,
843         FIF_OTHER_BSS           = 1<<6,
844 };
845
846 /**
847  * enum ieee80211_erp_change_flags - erp change flags
848  *
849  * These flags are used with the erp_ie_changed() callback in
850  * &struct ieee80211_ops to indicate which parameter(s) changed.
851  * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed
852  * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed
853  */
854 enum ieee80211_erp_change_flags {
855         IEEE80211_ERP_CHANGE_PROTECTION = 1<<0,
856         IEEE80211_ERP_CHANGE_PREAMBLE   = 1<<1,
857 };
858
859
860 /**
861  * struct ieee80211_ops - callbacks from mac80211 to the driver
862  *
863  * This structure contains various callbacks that the driver may
864  * handle or, in some cases, must handle, for example to configure
865  * the hardware to a new channel or to transmit a frame.
866  *
867  * @tx: Handler that 802.11 module calls for each transmitted frame.
868  *      skb contains the buffer starting from the IEEE 802.11 header.
869  *      The low-level driver should send the frame out based on
870  *      configuration in the TX control data. Must be implemented and
871  *      atomic.
872  *
873  * @start: Called before the first netdevice attached to the hardware
874  *      is enabled. This should turn on the hardware and must turn on
875  *      frame reception (for possibly enabled monitor interfaces.)
876  *      Returns negative error codes, these may be seen in userspace,
877  *      or zero.
878  *      When the device is started it should not have a MAC address
879  *      to avoid acknowledging frames before a non-monitor device
880  *      is added.
881  *      Must be implemented.
882  *
883  * @stop: Called after last netdevice attached to the hardware
884  *      is disabled. This should turn off the hardware (at least
885  *      it must turn off frame reception.)
886  *      May be called right after add_interface if that rejects
887  *      an interface.
888  *      Must be implemented.
889  *
890  * @add_interface: Called when a netdevice attached to the hardware is
891  *      enabled. Because it is not called for monitor mode devices, @open
892  *      and @stop must be implemented.
893  *      The driver should perform any initialization it needs before
894  *      the device can be enabled. The initial configuration for the
895  *      interface is given in the conf parameter.
896  *      The callback may refuse to add an interface by returning a
897  *      negative error code (which will be seen in userspace.)
898  *      Must be implemented.
899  *
900  * @remove_interface: Notifies a driver that an interface is going down.
901  *      The @stop callback is called after this if it is the last interface
902  *      and no monitor interfaces are present.
903  *      When all interfaces are removed, the MAC address in the hardware
904  *      must be cleared so the device no longer acknowledges packets,
905  *      the mac_addr member of the conf structure is, however, set to the
906  *      MAC address of the device going away.
907  *      Hence, this callback must be implemented.
908  *
909  * @config: Handler for configuration requests. IEEE 802.11 code calls this
910  *      function to change hardware configuration, e.g., channel.
911  *
912  * @config_interface: Handler for configuration requests related to interfaces
913  *      (e.g. BSSID changes.)
914  *
915  * @configure_filter: Configure the device's RX filter.
916  *      See the section "Frame filtering" for more information.
917  *      This callback must be implemented and atomic.
918  *
919  * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
920  *      generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
921  *      mac80211 calls this function when a TIM bit must be set or cleared
922  *      for a given AID. Must be atomic.
923  *
924  * @set_key: See the section "Hardware crypto acceleration"
925  *      This callback can sleep, and is only called between add_interface
926  *      and remove_interface calls, i.e. while the interface with the
927  *      given local_address is enabled.
928  *
929  * @set_ieee8021x: Enable/disable IEEE 802.1X. This item requests wlan card
930  *      to pass unencrypted EAPOL-Key frames even when encryption is
931  *      configured. If the wlan card does not require such a configuration,
932  *      this function pointer can be set to NULL.
933  *
934  * @set_port_auth: Set port authorization state (IEEE 802.1X PAE) to be
935  *      authorized (@authorized=1) or unauthorized (=0). This function can be
936  *      used if the wlan hardware or low-level driver implements PAE.
937  *      mac80211 will filter frames based on authorization state in any case,
938  *      so this function pointer can be NULL if low-level driver does not
939  *      require event notification about port state changes.
940  *
941  * @hw_scan: Ask the hardware to service the scan request, no need to start
942  *      the scan state machine in stack.
943  *
944  * @get_stats: return low-level statistics
945  *
946  * @set_privacy_invoked: For devices that generate their own beacons and probe
947  *      response or association responses this updates the state of privacy_invoked
948  *      returns 0 for success or an error number.
949  *
950  * @get_sequence_counter: For devices that have internal sequence counters this
951  *      callback allows mac80211 to access the current value of a counter.
952  *      This callback seems not well-defined, tell us if you need it.
953  *
954  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
955  *
956  * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
957  *      the device does fragmentation by itself; if this method is assigned then
958  *      the stack will not do fragmentation.
959  *
960  * @set_retry_limit: Configuration of retry limits (if device needs it)
961  *
962  * @sta_table_notification: Number of STAs in STA table notification. Must
963  *      be atomic.
964  *
965  * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic.
966  *
967  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
968  *      bursting) for a hardware TX queue. The @queue parameter uses the
969  *      %IEEE80211_TX_QUEUE_* constants. Must be atomic.
970  *
971  * @get_tx_stats: Get statistics of the current TX queue status. This is used
972  *      to get number of currently queued packets (queue length), maximum queue
973  *      size (limit), and total number of packets sent using each TX queue
974  *      (count). This information is used for WMM to find out which TX
975  *      queues have room for more packets and by hostapd to provide
976  *      statistics about the current queueing state to external programs.
977  *
978  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
979  *      this is only used for IBSS mode debugging and, as such, is not a
980  *      required function. Must be atomic.
981  *
982  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
983  *      with other STAs in the IBSS. This is only used in IBSS mode. This
984  *      function is optional if the firmware/hardware takes full care of
985  *      TSF synchronization.
986  *
987  * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
988  *      IBSS uses a fixed beacon frame which is configured using this
989  *      function. This handler is required only for IBSS mode.
990  *
991  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
992  *      This is needed only for IBSS mode and the result of this function is
993  *      used to determine whether to reply to Probe Requests.
994  */
995 struct ieee80211_ops {
996         int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
997                   struct ieee80211_tx_control *control);
998         int (*start)(struct ieee80211_hw *hw);
999         void (*stop)(struct ieee80211_hw *hw);
1000         int (*add_interface)(struct ieee80211_hw *hw,
1001                              struct ieee80211_if_init_conf *conf);
1002         void (*remove_interface)(struct ieee80211_hw *hw,
1003                                  struct ieee80211_if_init_conf *conf);
1004         int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1005         int (*config_interface)(struct ieee80211_hw *hw,
1006                                 int if_id, struct ieee80211_if_conf *conf);
1007         void (*configure_filter)(struct ieee80211_hw *hw,
1008                                  unsigned int changed_flags,
1009                                  unsigned int *total_flags,
1010                                  int mc_count, struct dev_addr_list *mc_list);
1011         int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1012         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1013                        const u8 *local_address, const u8 *address,
1014                        struct ieee80211_key_conf *key);
1015         int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
1016         int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
1017                              int authorized);
1018         int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1019         int (*get_stats)(struct ieee80211_hw *hw,
1020                          struct ieee80211_low_level_stats *stats);
1021         int (*set_privacy_invoked)(struct ieee80211_hw *hw,
1022                                    int privacy_invoked);
1023         int (*get_sequence_counter)(struct ieee80211_hw *hw,
1024                                     u8* addr, u8 keyidx, u8 txrx,
1025                                     u32* iv32, u16* iv16);
1026         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1027         int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1028         int (*set_retry_limit)(struct ieee80211_hw *hw,
1029                                u32 short_retry, u32 long_retr);
1030         void (*sta_table_notification)(struct ieee80211_hw *hw,
1031                                        int num_sta);
1032         void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
1033                                int cts_protection, int preamble);
1034         int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1035                        const struct ieee80211_tx_queue_params *params);
1036         int (*get_tx_stats)(struct ieee80211_hw *hw,
1037                             struct ieee80211_tx_queue_stats *stats);
1038         u64 (*get_tsf)(struct ieee80211_hw *hw);
1039         void (*reset_tsf)(struct ieee80211_hw *hw);
1040         int (*beacon_update)(struct ieee80211_hw *hw,
1041                              struct sk_buff *skb,
1042                              struct ieee80211_tx_control *control);
1043         int (*tx_last_beacon)(struct ieee80211_hw *hw);
1044 };
1045
1046 /**
1047  * ieee80211_alloc_hw -  Allocate a new hardware device
1048  *
1049  * This must be called once for each hardware device. The returned pointer
1050  * must be used to refer to this device when calling other functions.
1051  * mac80211 allocates a private data area for the driver pointed to by
1052  * @priv in &struct ieee80211_hw, the size of this area is given as
1053  * @priv_data_len.
1054  *
1055  * @priv_data_len: length of private data
1056  * @ops: callbacks for this device
1057  */
1058 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1059                                         const struct ieee80211_ops *ops);
1060
1061 /**
1062  * ieee80211_register_hw - Register hardware device
1063  *
1064  * You must call this function before any other functions
1065  * except ieee80211_register_hwmode.
1066  *
1067  * @hw: the device to register as returned by ieee80211_alloc_hw()
1068  */
1069 int ieee80211_register_hw(struct ieee80211_hw *hw);
1070
1071 #ifdef CONFIG_MAC80211_LEDS
1072 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1073 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1074 #endif
1075 /**
1076  * ieee80211_get_tx_led_name - get name of TX LED
1077  *
1078  * mac80211 creates a transmit LED trigger for each wireless hardware
1079  * that can be used to drive LEDs if your driver registers a LED device.
1080  * This function returns the name (or %NULL if not configured for LEDs)
1081  * of the trigger so you can automatically link the LED device.
1082  *
1083  * @hw: the hardware to get the LED trigger name for
1084  */
1085 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1086 {
1087 #ifdef CONFIG_MAC80211_LEDS
1088         return __ieee80211_get_tx_led_name(hw);
1089 #else
1090         return NULL;
1091 #endif
1092 }
1093
1094 /**
1095  * ieee80211_get_rx_led_name - get name of RX LED
1096  *
1097  * mac80211 creates a receive LED trigger for each wireless hardware
1098  * that can be used to drive LEDs if your driver registers a LED device.
1099  * This function returns the name (or %NULL if not configured for LEDs)
1100  * of the trigger so you can automatically link the LED device.
1101  *
1102  * @hw: the hardware to get the LED trigger name for
1103  */
1104 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1105 {
1106 #ifdef CONFIG_MAC80211_LEDS
1107         return __ieee80211_get_rx_led_name(hw);
1108 #else
1109         return NULL;
1110 #endif
1111 }
1112
1113 /* Register a new hardware PHYMODE capability to the stack. */
1114 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1115                               struct ieee80211_hw_mode *mode);
1116
1117 /**
1118  * ieee80211_unregister_hw - Unregister a hardware device
1119  *
1120  * This function instructs mac80211 to free allocated resources
1121  * and unregister netdevices from the networking subsystem.
1122  *
1123  * @hw: the hardware to unregister
1124  */
1125 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1126
1127 /**
1128  * ieee80211_free_hw - free hardware descriptor
1129  *
1130  * This function frees everything that was allocated, including the
1131  * private data for the driver. You must call ieee80211_unregister_hw()
1132  * before calling this function
1133  *
1134  * @hw: the hardware to free
1135  */
1136 void ieee80211_free_hw(struct ieee80211_hw *hw);
1137
1138 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1139 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1140                     struct ieee80211_rx_status *status);
1141
1142 /**
1143  * ieee80211_rx - receive frame
1144  *
1145  * Use this function to hand received frames to mac80211. The receive
1146  * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1147  * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1148  *
1149  * This function may not be called in IRQ context.
1150  *
1151  * @hw: the hardware this frame came in on
1152  * @skb: the buffer to receive, owned by mac80211 after this call
1153  * @status: status of this frame; the status pointer need not be valid
1154  *      after this function returns
1155  */
1156 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1157                                 struct ieee80211_rx_status *status)
1158 {
1159         __ieee80211_rx(hw, skb, status);
1160 }
1161
1162 /**
1163  * ieee80211_rx_irqsafe - receive frame
1164  *
1165  * Like ieee80211_rx() but can be called in IRQ context
1166  * (internally defers to a workqueue.)
1167  *
1168  * @hw: the hardware this frame came in on
1169  * @skb: the buffer to receive, owned by mac80211 after this call
1170  * @status: status of this frame; the status pointer need not be valid
1171  *      after this function returns and is not freed by mac80211,
1172  *      it is recommended that it points to a stack area
1173  */
1174 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1175                           struct sk_buff *skb,
1176                           struct ieee80211_rx_status *status);
1177
1178 /**
1179  * ieee80211_tx_status - transmit status callback
1180  *
1181  * Call this function for all transmitted frames after they have been
1182  * transmitted. It is permissible to not call this function for
1183  * multicast frames but this can affect statistics.
1184  *
1185  * @hw: the hardware the frame was transmitted by
1186  * @skb: the frame that was transmitted, owned by mac80211 after this call
1187  * @status: status information for this frame; the status pointer need not
1188  *      be valid after this function returns and is not freed by mac80211,
1189  *      it is recommended that it points to a stack area
1190  */
1191 void ieee80211_tx_status(struct ieee80211_hw *hw,
1192                          struct sk_buff *skb,
1193                          struct ieee80211_tx_status *status);
1194 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1195                                  struct sk_buff *skb,
1196                                  struct ieee80211_tx_status *status);
1197
1198 /**
1199  * ieee80211_beacon_get - beacon generation function
1200  * @hw: pointer obtained from ieee80211_alloc_hw().
1201  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1202  * @control: will be filled with information needed to send this beacon.
1203  *
1204  * If the beacon frames are generated by the host system (i.e., not in
1205  * hardware/firmware), the low-level driver uses this function to receive
1206  * the next beacon frame from the 802.11 code. The low-level is responsible
1207  * for calling this function before beacon data is needed (e.g., based on
1208  * hardware interrupt). Returned skb is used only once and low-level driver
1209  * is responsible of freeing it.
1210  */
1211 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1212                                      int if_id,
1213                                      struct ieee80211_tx_control *control);
1214
1215 /**
1216  * ieee80211_rts_get - RTS frame generation function
1217  * @hw: pointer obtained from ieee80211_alloc_hw().
1218  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1219  * @frame: pointer to the frame that is going to be protected by the RTS.
1220  * @frame_len: the frame length (in octets).
1221  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1222  * @rts: The buffer where to store the RTS frame.
1223  *
1224  * If the RTS frames are generated by the host system (i.e., not in
1225  * hardware/firmware), the low-level driver uses this function to receive
1226  * the next RTS frame from the 802.11 code. The low-level is responsible
1227  * for calling this function before and RTS frame is needed.
1228  */
1229 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
1230                        const void *frame, size_t frame_len,
1231                        const struct ieee80211_tx_control *frame_txctl,
1232                        struct ieee80211_rts *rts);
1233
1234 /**
1235  * ieee80211_rts_duration - Get the duration field for an RTS frame
1236  * @hw: pointer obtained from ieee80211_alloc_hw().
1237  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1238  * @frame_len: the length of the frame that is going to be protected by the RTS.
1239  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1240  *
1241  * If the RTS is generated in firmware, but the host system must provide
1242  * the duration field, the low-level driver uses this function to receive
1243  * the duration field value in little-endian byteorder.
1244  */
1245 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
1246                               size_t frame_len,
1247                               const struct ieee80211_tx_control *frame_txctl);
1248
1249 /**
1250  * ieee80211_ctstoself_get - CTS-to-self frame generation function
1251  * @hw: pointer obtained from ieee80211_alloc_hw().
1252  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1253  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1254  * @frame_len: the frame length (in octets).
1255  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1256  * @cts: The buffer where to store the CTS-to-self frame.
1257  *
1258  * If the CTS-to-self frames are generated by the host system (i.e., not in
1259  * hardware/firmware), the low-level driver uses this function to receive
1260  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1261  * for calling this function before and CTS-to-self frame is needed.
1262  */
1263 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
1264                              const void *frame, size_t frame_len,
1265                              const struct ieee80211_tx_control *frame_txctl,
1266                              struct ieee80211_cts *cts);
1267
1268 /**
1269  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1270  * @hw: pointer obtained from ieee80211_alloc_hw().
1271  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1272  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1273  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1274  *
1275  * If the CTS-to-self is generated in firmware, but the host system must provide
1276  * the duration field, the low-level driver uses this function to receive
1277  * the duration field value in little-endian byteorder.
1278  */
1279 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
1280                                     size_t frame_len,
1281                                     const struct ieee80211_tx_control *frame_txctl);
1282
1283 /**
1284  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1285  * @hw: pointer obtained from ieee80211_alloc_hw().
1286  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1287  * @frame_len: the length of the frame.
1288  * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1289  *
1290  * Calculate the duration field of some generic frame, given its
1291  * length and transmission rate (in 100kbps).
1292  */
1293 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
1294                                         size_t frame_len,
1295                                         int rate);
1296
1297 /**
1298  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1299  * @hw: pointer as obtained from ieee80211_alloc_hw().
1300  * @if_id: interface ID from &struct ieee80211_if_init_conf.
1301  * @control: will be filled with information needed to send returned frame.
1302  *
1303  * Function for accessing buffered broadcast and multicast frames. If
1304  * hardware/firmware does not implement buffering of broadcast/multicast
1305  * frames when power saving is used, 802.11 code buffers them in the host
1306  * memory. The low-level driver uses this function to fetch next buffered
1307  * frame. In most cases, this is used when generating beacon frame. This
1308  * function returns a pointer to the next buffered skb or NULL if no more
1309  * buffered frames are available.
1310  *
1311  * Note: buffered frames are returned only after DTIM beacon frame was
1312  * generated with ieee80211_beacon_get() and the low-level driver must thus
1313  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1314  * NULL if the previous generated beacon was not DTIM, so the low-level driver
1315  * does not need to check for DTIM beacons separately and should be able to
1316  * use common code for all beacons.
1317  */
1318 struct sk_buff *
1319 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
1320                           struct ieee80211_tx_control *control);
1321
1322 /**
1323  * ieee80211_get_hdrlen_from_skb - get header length from data
1324  *
1325  * Given an skb with a raw 802.11 header at the data pointer this function
1326  * returns the 802.11 header length in bytes (not including encryption
1327  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1328  * header the function returns 0.
1329  *
1330  * @skb: the frame
1331  */
1332 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1333
1334 /**
1335  * ieee80211_get_hdrlen - get header length from frame control
1336  *
1337  * This function returns the 802.11 header length in bytes (not including
1338  * encryption headers.)
1339  *
1340  * @fc: the frame control field (in CPU endianness)
1341  */
1342 int ieee80211_get_hdrlen(u16 fc);
1343
1344 /**
1345  * ieee80211_wake_queue - wake specific queue
1346  * @hw: pointer as obtained from ieee80211_alloc_hw().
1347  * @queue: queue number (counted from zero).
1348  *
1349  * Drivers should use this function instead of netif_wake_queue.
1350  */
1351 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1352
1353 /**
1354  * ieee80211_stop_queue - stop specific queue
1355  * @hw: pointer as obtained from ieee80211_alloc_hw().
1356  * @queue: queue number (counted from zero).
1357  *
1358  * Drivers should use this function instead of netif_stop_queue.
1359  */
1360 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1361
1362 /**
1363  * ieee80211_start_queues - start all queues
1364  * @hw: pointer to as obtained from ieee80211_alloc_hw().
1365  *
1366  * Drivers should use this function instead of netif_start_queue.
1367  */
1368 void ieee80211_start_queues(struct ieee80211_hw *hw);
1369
1370 /**
1371  * ieee80211_stop_queues - stop all queues
1372  * @hw: pointer as obtained from ieee80211_alloc_hw().
1373  *
1374  * Drivers should use this function instead of netif_stop_queue.
1375  */
1376 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1377
1378 /**
1379  * ieee80211_wake_queues - wake all queues
1380  * @hw: pointer as obtained from ieee80211_alloc_hw().
1381  *
1382  * Drivers should use this function instead of netif_wake_queue.
1383  */
1384 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1385
1386 /**
1387  * ieee80211_scan_completed - completed hardware scan
1388  *
1389  * When hardware scan offload is used (i.e. the hw_scan() callback is
1390  * assigned) this function needs to be called by the driver to notify
1391  * mac80211 that the scan finished.
1392  *
1393  * @hw: the hardware that finished the scan
1394  */
1395 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1396
1397 #endif /* MAC80211_H */