blob: 8650e7bf2ed021c12006f913e1f6c3ffe593bb26 [file] [log] [blame]
Jiri Bencf0706e822007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e822007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e822007-05-05 11:45:53 -07007 *
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>
Jiri Bencf0706e822007-05-05 11:45:53 -070022#include <net/cfg80211.h>
23
Johannes Berg75a5f0c2007-09-18 17:29:20 -040024/**
25 * DOC: Introduction
26 *
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
30 * drivers.
31 */
32
33/**
34 * DOC: Calling mac80211 from interrupts
35 *
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e822007-05-05 11:45:53 -070037 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010040 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41 * tasklet function.
42 *
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070044 * use the non-IRQ-safe functions!
Jiri Bencf0706e822007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e822007-05-05 11:45:53 -070049 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040050 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
52 */
53
54/**
55 * DOC: Frame format
Jiri Bencf0706e822007-05-05 11:45:53 -070056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040057 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
60 * hardware.
61 *
62 * There are, however, various exceptions to this rule for advanced features:
63 *
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
66 *
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
69 *
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e822007-05-05 11:45:53 -070073 */
74
Ron Rindjunsky10816d42007-11-26 16:14:30 +020075/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040076 * DOC: mac80211 workqueue
77 *
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 *
83 * mac80211 will flushed the workqueue upon interface removal and during
84 * suspend.
85 *
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87 *
88 */
89
90/**
Johannes Berge100bb62008-04-30 18:51:21 +020091 * enum ieee80211_max_queues - maximum number of queues
92 *
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020094 */
95enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010096 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020097};
98
99/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800100 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101 * @IEEE80211_AC_VO: voice
102 * @IEEE80211_AC_VI: video
103 * @IEEE80211_AC_BE: best effort
104 * @IEEE80211_AC_BK: background
105 */
106enum ieee80211_ac_numbers {
107 IEEE80211_AC_VO = 0,
108 IEEE80211_AC_VI = 1,
109 IEEE80211_AC_BE = 2,
110 IEEE80211_AC_BK = 3,
111};
112
113/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400114 * struct ieee80211_tx_queue_params - transmit queue configuration
115 *
116 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100117 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400118 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400119 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200120 * @cw_min: minimum contention window [a value of the form
121 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400122 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100123 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200124 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700126struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200127 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100128 u16 cw_min;
129 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200130 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200131 bool uapsd;
Jiri Bencf0706e822007-05-05 11:45:53 -0700132};
133
Jiri Bencf0706e822007-05-05 11:45:53 -0700134struct ieee80211_low_level_stats {
135 unsigned int dot11ACKFailureCount;
136 unsigned int dot11RTSFailureCount;
137 unsigned int dot11FCSErrorCount;
138 unsigned int dot11RTSSuccessCount;
139};
140
Johannes Berg471b3ef2007-12-28 14:32:58 +0100141/**
142 * enum ieee80211_bss_change - BSS change notification flags
143 *
144 * These flags are used with the bss_info_changed() callback
145 * to indicate which BSS parameter changed.
146 *
147 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
148 * also implies a change in the AID.
149 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
150 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300151 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700152 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200153 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200154 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200155 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
156 * reason (IBSS and managed mode)
157 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
158 * new beacon (beaconing modes)
159 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
160 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200161 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200162 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300163 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200164 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
165 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200166 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100167 */
168enum ieee80211_bss_change {
169 BSS_CHANGED_ASSOC = 1<<0,
170 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
171 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300172 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700173 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200174 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200175 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200176 BSS_CHANGED_BSSID = 1<<7,
177 BSS_CHANGED_BEACON = 1<<8,
178 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200179 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200180 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300181 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200182 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200183 BSS_CHANGED_IDLE = 1<<14,
Johannes Bergac8dd502010-05-05 09:44:02 +0200184
185 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100186};
187
Juuso Oikarinen68542962010-06-09 13:43:26 +0300188/*
189 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
190 * of addresses for an interface increase beyond this value, hardware ARP
191 * filtering will be disabled.
192 */
193#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
194
Johannes Berg471b3ef2007-12-28 14:32:58 +0100195/**
196 * struct ieee80211_bss_conf - holds the BSS's changing parameters
197 *
198 * This structure keeps information about a BSS (and an association
199 * to that BSS) that can change during the lifetime of the BSS.
200 *
201 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200202 * @ibss_joined: indicates whether this station is part of an IBSS
203 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100204 * @aid: association ID number, valid only when @assoc is true
205 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200206 * @use_short_preamble: use 802.11b short preamble;
207 * if the hardware cannot handle this it must set the
208 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
209 * @use_short_slot: use short slot time (only relevant for ERP);
210 * if the hardware cannot handle this it must set the
211 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100212 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Johannes Berge5b900d2010-07-29 16:08:55 +0200213 * valid in station mode only while @assoc is true and if also
214 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
215 * @ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700216 * @timestamp: beacon timestamp
217 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800218 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200219 * @basic_rates: bitmap of basic rates, each bit stands for an
220 * index into the rate table configured by the driver in
221 * the current band.
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100222 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200223 * @bssid: The BSSID for this BSS
224 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200225 * @channel_type: Channel type for this BSS -- the hardware might be
226 * configured for HT40+ while this BSS only uses no-HT, for
227 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200228 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
229 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200230 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
231 * implies disabled
232 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300233 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
234 * may filter ARP queries targeted for other addresses than listed here.
235 * The driver must allow ARP queries targeted for all address listed here
236 * to pass through. An empty list implies no ARP queries need to pass.
237 * @arp_addr_cnt: Number of addresses currently on the list.
238 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
239 * filter ARP queries based on the @arp_addr_list, if disabled, the
240 * hardware must not perform any ARP filtering. Note, that the filter will
241 * be enabled also in promiscuous mode.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200242 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200243 * @idle: This interface is idle. There's also a global idle flag in the
244 * hardware config which may be more appropriate depending on what
245 * your driver/device needs to do.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100246 */
247struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200248 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100249 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200250 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100251 u16 aid;
252 /* erp related data */
253 bool use_cts_prot;
254 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300255 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200256 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800257 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700258 u16 beacon_int;
259 u16 assoc_capability;
260 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100261 u32 basic_rates;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100262 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200263 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200264 s32 cqm_rssi_thold;
265 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200266 enum nl80211_channel_type channel_type;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300267 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
268 u8 arp_addr_cnt;
269 bool arp_filter_enabled;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200270 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200271 bool idle;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100272};
273
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800274/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700275 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800276 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700277 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800278 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100279 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200280 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
281 * number to this frame, taking care of not overwriting the fragment
282 * number and increasing the sequence number only when the
283 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
284 * assign sequence numbers to QoS-data frames but cannot do so correctly
285 * for non-QoS-data and management frames because beacons need them from
286 * that counter as well and mac80211 cannot guarantee proper sequencing.
287 * If this flag is set, the driver should instruct the hardware to
288 * assign a sequence number to the frame or assign one itself. Cf. IEEE
289 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
290 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200291 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200292 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
293 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200294 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200295 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
296 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200297 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200298 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200299 * because the destination STA was in powersave mode. Note that to
300 * avoid race conditions, the filter must be set by the hardware or
301 * firmware upon receiving a frame that indicates that the station
302 * went to sleep (must be done on device to filter frames already on
303 * the queue) and may only be unset after mac80211 gives the OK for
304 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
305 * since only then is it guaranteed that no more frames are in the
306 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200307 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
308 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
309 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300310 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
311 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200312 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
313 * set by rate control algorithms to indicate probe rate, will
314 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100315 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
316 * used to indicate that a pending frame requires TX processing before
317 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200318 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
319 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200320 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
321 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200322 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
323 * This frame is a response to a PS-poll frame and should be sent
324 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200325 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
326 * transmit function after the current frame, this can be used
327 * by drivers to kick the DMA queue only if unset or when the
328 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100329 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
330 * after TX status because the destination was asleep, it must not
331 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100332 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
333 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200334 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
335 * MLME command (internal to mac80211 to figure out whether to send TX
336 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400337 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200338 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
339 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100340 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
341 * the off-channel channel when a remain-on-channel offload is done
342 * in hardware -- normal packets still flow and are expected to be
343 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200344 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
345 * testing. It will be sent out with incorrect Michael MIC key to allow
346 * TKIP countermeasures to be tested.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200347 *
348 * Note: If you have to add new flags to the enumeration, then don't
349 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800350 */
351enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200352 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200353 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
354 IEEE80211_TX_CTL_NO_ACK = BIT(2),
355 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
356 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
357 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
358 IEEE80211_TX_CTL_AMPDU = BIT(6),
359 IEEE80211_TX_CTL_INJECTED = BIT(7),
360 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
361 IEEE80211_TX_STAT_ACK = BIT(9),
362 IEEE80211_TX_STAT_AMPDU = BIT(10),
363 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
364 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100365 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200366 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200367 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200368 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200369 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100370 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100371 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200372 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400373 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200374 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100375 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200376 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Johannes Berge6a98542008-10-21 12:40:02 +0200377};
378
Johannes Bergabe37c42010-06-07 11:12:27 +0200379#define IEEE80211_TX_CTL_STBC_SHIFT 23
380
Christian Lampartereb7d3062010-09-21 21:36:18 +0200381/*
382 * This definition is used as a mask to clear all temporary flags, which are
383 * set by the tx handlers for each transmission attempt by the mac80211 stack.
384 */
385#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
386 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
387 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
388 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
389 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
390 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
391 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
392 IEEE80211_TX_CTL_STBC)
393
Sujith2134e7e2009-01-22 09:00:52 +0530394/**
395 * enum mac80211_rate_control_flags - per-rate flags set by the
396 * Rate Control algorithm.
397 *
398 * These flags are set by the Rate control algorithm for each rate during tx,
399 * in the @flags member of struct ieee80211_tx_rate.
400 *
401 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
402 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
403 * This is set if the current BSS requires ERP protection.
404 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
405 * @IEEE80211_TX_RC_MCS: HT rate.
406 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
407 * Greenfield mode.
408 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
409 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
410 * adjacent 20 MHz channels, if the current channel type is
411 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
412 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
413 */
Johannes Berge6a98542008-10-21 12:40:02 +0200414enum mac80211_rate_control_flags {
415 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
416 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
417 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
418
419 /* rate index is an MCS rate number instead of an index */
420 IEEE80211_TX_RC_MCS = BIT(3),
421 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
422 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
423 IEEE80211_TX_RC_DUP_DATA = BIT(6),
424 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800425};
426
Johannes Berge039fa42008-05-15 12:55:29 +0200427
Johannes Berge6a98542008-10-21 12:40:02 +0200428/* there are 40 bytes if you don't need the rateset to be kept */
429#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200430
Johannes Berge6a98542008-10-21 12:40:02 +0200431/* if you do need the rateset, then you have less space */
432#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
433
434/* maximum number of rate stages */
435#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200436
437/**
Johannes Berge6a98542008-10-21 12:40:02 +0200438 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200439 *
Johannes Berge6a98542008-10-21 12:40:02 +0200440 * @idx: rate index to attempt to send with
441 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200442 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200443 *
444 * A value of -1 for @idx indicates an invalid rate and, if used
445 * in an array of retry rates, that no more rates should be tried.
446 *
447 * When used for transmit status reporting, the driver should
448 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200449 *
450 * &struct ieee80211_tx_info contains an array of these structs
451 * in the control information, and it will be filled by the rate
452 * control algorithm according to what should be sent. For example,
453 * if this array contains, in the format { <idx>, <count> } the
454 * information
455 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
456 * then this means that the frame should be transmitted
457 * up to twice at rate 3, up to twice at rate 2, and up to four
458 * times at rate 1 if it doesn't get acknowledged. Say it gets
459 * acknowledged by the peer after the fifth attempt, the status
460 * information should then contain
461 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
462 * since it was transmitted twice at rate 3, twice at rate 2
463 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200464 */
Johannes Berge6a98542008-10-21 12:40:02 +0200465struct ieee80211_tx_rate {
466 s8 idx;
467 u8 count;
468 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000469} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200470
Johannes Berge039fa42008-05-15 12:55:29 +0200471/**
472 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200473 *
Johannes Berge039fa42008-05-15 12:55:29 +0200474 * This structure is placed in skb->cb for three uses:
475 * (1) mac80211 TX control - mac80211 tells the driver what to do
476 * (2) driver internal use (if applicable)
477 * (3) TX status information - driver tells mac80211 what happened
478 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200479 * The TX control's sta pointer is only valid during the ->tx call,
480 * it may be NULL.
481 *
Johannes Berge039fa42008-05-15 12:55:29 +0200482 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200483 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200484 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200485 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700486 * @control: union for control data
487 * @status: union for status data
488 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100489 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700490 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100491 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700492 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200493 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200494 */
Johannes Berge039fa42008-05-15 12:55:29 +0200495struct ieee80211_tx_info {
496 /* common information */
497 u32 flags;
498 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200499
Johannes Berge039fa42008-05-15 12:55:29 +0200500 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100501
Johannes Berge6a98542008-10-21 12:40:02 +0200502 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500503 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100504
Johannes Berge039fa42008-05-15 12:55:29 +0200505 union {
506 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200507 union {
508 /* rate control */
509 struct {
510 struct ieee80211_tx_rate rates[
511 IEEE80211_TX_MAX_RATES];
512 s8 rts_cts_rate_idx;
513 };
514 /* only needed before rate control */
515 unsigned long jiffies;
516 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200517 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200518 struct ieee80211_vif *vif;
519 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200520 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200521 } control;
522 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200523 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
524 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200525 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100526 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200527 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200528 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200529 struct {
530 struct ieee80211_tx_rate driver_rates[
531 IEEE80211_TX_MAX_RATES];
532 void *rate_driver_data[
533 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
534 };
535 void *driver_data[
536 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200537 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700538};
539
Johannes Berge039fa42008-05-15 12:55:29 +0200540static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
541{
542 return (struct ieee80211_tx_info *)skb->cb;
543}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400544
Johannes Bergf1d58c22009-06-17 13:13:00 +0200545static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
546{
547 return (struct ieee80211_rx_status *)skb->cb;
548}
549
Johannes Berge6a98542008-10-21 12:40:02 +0200550/**
551 * ieee80211_tx_info_clear_status - clear TX status
552 *
553 * @info: The &struct ieee80211_tx_info to be cleared.
554 *
555 * When the driver passes an skb back to mac80211, it must report
556 * a number of things in TX status. This function clears everything
557 * in the TX status but the rate control information (it does clear
558 * the count since you need to fill that in anyway).
559 *
560 * NOTE: You can only use this function if you do NOT use
561 * info->driver_data! Use info->rate_driver_data
562 * instead if you need only the less space that allows.
563 */
564static inline void
565ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
566{
567 int i;
568
569 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
570 offsetof(struct ieee80211_tx_info, control.rates));
571 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
572 offsetof(struct ieee80211_tx_info, driver_rates));
573 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
574 /* clear the rate counts */
575 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
576 info->status.rates[i].count = 0;
577
578 BUILD_BUG_ON(
579 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
580 memset(&info->status.ampdu_ack_len, 0,
581 sizeof(struct ieee80211_tx_info) -
582 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
583}
584
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400585
586/**
587 * enum mac80211_rx_flags - receive flags
588 *
589 * These flags are used with the @flag member of &struct ieee80211_rx_status.
590 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
591 * Use together with %RX_FLAG_MMIC_STRIPPED.
592 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400593 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
594 * verification has been done by the hardware.
595 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
596 * If this flag is set, the stack cannot do any replay detection
597 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400598 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
599 * the frame.
600 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
601 * the frame.
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100602 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
603 * field) is valid and contains the time the first symbol of the MPDU
604 * was received. This is useful in monitor mode and for proper IBSS
605 * merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200606 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200607 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
608 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
609 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400610 */
611enum mac80211_rx_flags {
612 RX_FLAG_MMIC_ERROR = 1<<0,
613 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400614 RX_FLAG_MMIC_STRIPPED = 1<<3,
615 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400616 RX_FLAG_FAILED_FCS_CRC = 1<<5,
617 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100618 RX_FLAG_MACTIME_MPDU = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200619 RX_FLAG_SHORTPRE = 1<<8,
620 RX_FLAG_HT = 1<<9,
621 RX_FLAG_40MHZ = 1<<10,
622 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400623};
624
625/**
626 * struct ieee80211_rx_status - receive status
627 *
628 * The low-level driver should provide this information (the subset
629 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200630 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200631 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900632 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
633 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100634 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400635 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200636 * @signal: signal strength when receiving this frame, either in dBm, in dB or
637 * unspecified depending on the hardware capabilities flags
638 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400639 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200640 * @rate_idx: index of data rate into band's supported rates or MCS index if
641 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400642 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200643 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400644 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700645struct ieee80211_rx_status {
646 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100647 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400648 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400649 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700650 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100651 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700652 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200653 unsigned int rx_flags;
Jiri Bencf0706e822007-05-05 11:45:53 -0700654};
655
Johannes Berg6b301cd2007-09-18 17:29:20 -0400656/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400657 * enum ieee80211_conf_flags - configuration flags
658 *
659 * Flags to define PHY configuration options
660 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100661 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
662 * to determine for example whether to calculate timestamps for packets
663 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200664 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
665 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
666 * meaning that the hardware still wakes up for beacons, is able to
667 * transmit frames and receive the possible acknowledgment frames.
668 * Not to be confused with hardware specific wakeup/sleep states,
669 * driver is responsible for that. See the section "Powersave support"
670 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200671 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
672 * the driver should be prepared to handle configuration requests but
673 * may turn the device off as much as possible. Typically, this flag will
674 * be set when an interface is set UP but not associated or scanning, but
675 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200676 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
677 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400678 */
679enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100680 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200681 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200682 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200683 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400684};
Jiri Bencf0706e822007-05-05 11:45:53 -0700685
Johannes Berg7a5158e2008-10-08 10:59:33 +0200686
Jiri Bencf0706e822007-05-05 11:45:53 -0700687/**
Johannes Berge8975582008-10-09 12:18:51 +0200688 * enum ieee80211_conf_changed - denotes which configuration changed
689 *
Johannes Berge8975582008-10-09 12:18:51 +0200690 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100691 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200692 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200693 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100694 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200695 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200696 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100697 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200698 */
699enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100700 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200701 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100702 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200703 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200704 IEEE80211_CONF_CHANGE_POWER = BIT(5),
705 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
706 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200707 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200708};
709
710/**
Johannes Berg0f782312009-12-01 13:37:02 +0100711 * enum ieee80211_smps_mode - spatial multiplexing power save mode
712 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200713 * @IEEE80211_SMPS_AUTOMATIC: automatic
714 * @IEEE80211_SMPS_OFF: off
715 * @IEEE80211_SMPS_STATIC: static
716 * @IEEE80211_SMPS_DYNAMIC: dynamic
717 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100718 */
719enum ieee80211_smps_mode {
720 IEEE80211_SMPS_AUTOMATIC,
721 IEEE80211_SMPS_OFF,
722 IEEE80211_SMPS_STATIC,
723 IEEE80211_SMPS_DYNAMIC,
724
725 /* keep last */
726 IEEE80211_SMPS_NUM_MODES,
727};
728
729/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700730 * struct ieee80211_conf - configuration of the device
731 *
732 * This struct indicates how the driver shall configure the hardware.
733 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200734 * @flags: configuration flags defined above
735 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800736 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200737 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200738 * before checking the beacon for a TIM bit (managed mode only); this
739 * value will be only achievable between DTIM frames, the hardware
740 * needs to check for the multicast traffic bit in DTIM beacons.
741 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100742 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
743 * in power saving. Power saving will not be enabled until a beacon
744 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200745 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
746 * powersave documentation below. This variable is valid only when
747 * the CONF_PS flag is set.
748 *
Johannes Berg8318d782008-01-24 19:38:38 +0100749 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200750 *
Johannes Berg8318d782008-01-24 19:38:38 +0100751 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100752 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200753 *
Johannes Berg9124b072008-10-14 19:17:54 +0200754 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
755 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
756 * but actually means the number of transmissions not the number of retries
757 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
758 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
759 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100760 *
761 * @smps_mode: spatial multiplexing powersave mode; note that
762 * %IEEE80211_SMPS_STATIC is used when the device is not
763 * configured for an HT channel
Jiri Bencf0706e822007-05-05 11:45:53 -0700764 */
765struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400766 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300767 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200768 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200769
Johannes Berge8975582008-10-09 12:18:51 +0200770 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100771 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200772
Johannes Berg9124b072008-10-14 19:17:54 +0200773 u8 long_frame_max_tx_count, short_frame_max_tx_count;
774
Johannes Berg8318d782008-01-24 19:38:38 +0100775 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100776 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100777 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e822007-05-05 11:45:53 -0700778};
779
780/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200781 * struct ieee80211_channel_switch - holds the channel switch data
782 *
783 * The information provided in this structure is required for channel switch
784 * operation.
785 *
786 * @timestamp: value in microseconds of the 64-bit Time Synchronization
787 * Function (TSF) timer when the frame containing the channel switch
788 * announcement was received. This is simply the rx.mactime parameter
789 * the driver passed into mac80211.
790 * @block_tx: Indicates whether transmission must be blocked before the
791 * scheduled channel switch, as indicated by the AP.
792 * @channel: the new channel to switch to
793 * @count: the number of TBTT's until the channel switch event
794 */
795struct ieee80211_channel_switch {
796 u64 timestamp;
797 bool block_tx;
798 struct ieee80211_channel *channel;
799 u8 count;
800};
801
802/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100803 * struct ieee80211_vif - per-interface data
804 *
805 * Data in this structure is continually present for driver
806 * use during the life of a virtual interface.
807 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100808 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200809 * @bss_conf: BSS configuration for this interface, either our own
810 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100811 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200812 * @p2p: indicates whether this AP or STA interface is a p2p
813 * interface, i.e. a GO or p2p-sta respectively
Johannes Berg32bfd352007-12-19 01:31:26 +0100814 * @drv_priv: data area for driver use, will always be aligned to
815 * sizeof(void *).
816 */
817struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200818 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200819 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100820 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200821 bool p2p;
Johannes Berg32bfd352007-12-19 01:31:26 +0100822 /* must be last */
823 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
824};
825
Johannes Berg902acc72008-02-23 15:17:19 +0100826static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
827{
828#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200829 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100830#endif
831 return false;
832}
833
Johannes Berg32bfd352007-12-19 01:31:26 +0100834/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400835 * enum ieee80211_key_flags - key flags
836 *
837 * These flags are used for communication about keys between the driver
838 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
839 *
840 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
841 * that the STA this key will be used with could be using QoS.
842 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
843 * driver to indicate that it requires IV generation for this
844 * particular key.
845 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
846 * the driver for a TKIP key if it requires Michael MIC
847 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200848 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
849 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200850 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
851 * CCMP key if it requires CCMP encryption of management frames (MFP) to
852 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400853 */
854enum ieee80211_key_flags {
855 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
856 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
857 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200858 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200859 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400860};
861
862/**
863 * struct ieee80211_key_conf - key information
864 *
865 * This key information is given by mac80211 to the driver by
866 * the set_key() callback in &struct ieee80211_ops.
867 *
868 * @hw_key_idx: To be set by the driver, this is the key index the driver
869 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400870 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200871 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400872 * @flags: key flags, see &enum ieee80211_key_flags.
873 * @keyidx: the key index (0-3)
874 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400875 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
876 * data block:
877 * - Temporal Encryption Key (128 bits)
878 * - Temporal Authenticator Tx MIC Key (64 bits)
879 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100880 * @icv_len: The ICV length for this key type
881 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400882 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700883struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200884 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200885 u8 icv_len;
886 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400887 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400888 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400889 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400890 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700891 u8 key[0];
892};
893
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400894/**
895 * enum set_key_cmd - key command
896 *
897 * Used with the set_key() callback in &struct ieee80211_ops, this
898 * indicates whether a key is being removed or added.
899 *
900 * @SET_KEY: a key is set
901 * @DISABLE_KEY: a key must be disabled
902 */
Johannes Bergea49c352007-09-18 17:29:21 -0400903enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400904 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400905};
Jiri Bencf0706e822007-05-05 11:45:53 -0700906
Tomas Winkler478f8d22007-09-30 13:52:37 +0200907/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200908 * struct ieee80211_sta - station table entry
909 *
910 * A station table entry represents a station we are possibly
911 * communicating with. Since stations are RCU-managed in
912 * mac80211, any ieee80211_sta pointer you get access to must
913 * either be protected by rcu_read_lock() explicitly or implicitly,
914 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100915 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200916 *
917 * @addr: MAC address
918 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200919 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200920 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200921 * @drv_priv: data area for driver use, will always be aligned to
922 * sizeof(void *), size is determined in hw information.
923 */
924struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100925 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200926 u8 addr[ETH_ALEN];
927 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200928 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200929
930 /* must be last */
931 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
932};
933
934/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200935 * enum sta_notify_cmd - sta notify command
936 *
937 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +0530938 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200939 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100940 * @STA_NOTIFY_SLEEP: a station is now sleeping
941 * @STA_NOTIFY_AWAKE: a sleeping station woke up
942 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100943enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100944 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
945};
946
947/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200948 * enum ieee80211_tkip_key_type - get tkip key
949 *
950 * Used by drivers which need to get a tkip key for skb. Some drivers need a
951 * phase 1 key, others need a phase 2 key. A single function allows the driver
952 * to get the key, this enum indicates what type of key is required.
953 *
954 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
955 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
956 */
957enum ieee80211_tkip_key_type {
958 IEEE80211_TKIP_P1_KEY,
959 IEEE80211_TKIP_P2_KEY,
960};
961
962/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400963 * enum ieee80211_hw_flags - hardware flags
964 *
965 * These flags are used to indicate hardware capabilities to
966 * the stack. Generally, flags here should have their meaning
967 * done in a way that the simplest hardware doesn't need setting
968 * any particular flags. There are some exceptions to this rule,
969 * however, so you are advised to review these flags carefully.
970 *
Johannes Bergaf65cd92009-11-17 18:18:36 +0100971 * @IEEE80211_HW_HAS_RATE_CONTROL:
972 * The hardware or firmware includes rate control, and cannot be
973 * controlled by the stack. As such, no rate control algorithm
974 * should be instantiated, and the TX rate reported to userspace
975 * will be taken from the TX status instead of the rate control
976 * algorithm.
977 * Note that this requires that the driver implement a number of
978 * callbacks so it has the correct information, it needs to have
979 * the @set_rts_threshold callback and must look at the BSS config
980 * @use_cts_prot for G/N protection, @use_short_slot for slot
981 * timing in 2.4 GHz and @use_short_preamble for preambles for
982 * CCK frames.
983 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400984 * @IEEE80211_HW_RX_INCLUDES_FCS:
985 * Indicates that received frames passed to the stack include
986 * the FCS at the end.
987 *
988 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
989 * Some wireless LAN chipsets buffer broadcast/multicast frames
990 * for power saving stations in the hardware/firmware and others
991 * rely on the host system for such buffering. This option is used
992 * to configure the IEEE 802.11 upper layer to buffer broadcast and
993 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700994 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400995 *
Johannes Berg8318d782008-01-24 19:38:38 +0100996 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
997 * Hardware is not capable of short slot operation on the 2.4 GHz band.
998 *
999 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1000 * Hardware is not capable of receiving frames with short preamble on
1001 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001002 *
1003 * @IEEE80211_HW_SIGNAL_UNSPEC:
1004 * Hardware can provide signal values but we don't know its units. We
1005 * expect values between 0 and @max_signal.
1006 * If possible please provide dB or dBm instead.
1007 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001008 * @IEEE80211_HW_SIGNAL_DBM:
1009 * Hardware gives signal values in dBm, decibel difference from
1010 * one milliwatt. This is the preferred method since it is standardized
1011 * between different devices. @max_signal does not need to be set.
1012 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001013 * @IEEE80211_HW_SPECTRUM_MGMT:
1014 * Hardware supports spectrum management defined in 802.11h
1015 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301016 *
1017 * @IEEE80211_HW_AMPDU_AGGREGATION:
1018 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001019 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001020 * @IEEE80211_HW_SUPPORTS_PS:
1021 * Hardware has power save support (i.e. can go to sleep).
1022 *
1023 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1024 * Hardware requires nullfunc frame handling in stack, implies
1025 * stack support for dynamic PS.
1026 *
1027 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1028 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001029 *
1030 * @IEEE80211_HW_MFP_CAPABLE:
1031 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001032 *
1033 * @IEEE80211_HW_BEACON_FILTER:
1034 * Hardware supports dropping of irrelevant beacon frames to
1035 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +01001036 *
1037 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1038 * Hardware supports static spatial multiplexing powersave,
1039 * ie. can turn off all but one chain even on HT connections
1040 * that should be using more chains.
1041 *
1042 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1043 * Hardware supports dynamic spatial multiplexing powersave,
1044 * ie. can turn off all but one chain and then wake the rest
1045 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001046 *
1047 * @IEEE80211_HW_SUPPORTS_UAPSD:
1048 * Hardware supports Unscheduled Automatic Power Save Delivery
1049 * (U-APSD) in managed mode. The mode is configured with
1050 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301051 *
1052 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1053 * Hardware can provide ack status reports of Tx frames to
1054 * the stack.
1055 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001056 * @IEEE80211_HW_CONNECTION_MONITOR:
1057 * The hardware performs its own connection monitoring, including
1058 * periodic keep-alives to the AP and probing the AP on beacon loss.
1059 * When this flag is set, signaling beacon-loss will cause an immediate
1060 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001061 *
1062 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1063 * Hardware can do connection quality monitoring - i.e. it can monitor
1064 * connection quality related parameters, such as the RSSI level and
1065 * provide notifications if configured trigger levels are reached.
1066 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001067 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1068 * This device needs to know the DTIM period for the BSS before
1069 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001070 *
1071 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1072 * per-station GTKs as used by IBSS RSN or during fast transition. If
1073 * the device doesn't support per-station GTKs, but can be asked not
1074 * to decrypt group addressed frames, then IBSS RSN support is still
1075 * possible but software crypto will be used. Advertise the wiphy flag
1076 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001077 *
1078 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1079 * autonomously manages the PS status of connected stations. When
1080 * this flag is set mac80211 will not trigger PS mode for connected
1081 * stations based on the PM bit of incoming frames.
1082 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1083 * the PS mode of connected stations.
Johannes Berg1bc08262007-09-18 17:29:15 -04001084 */
1085enum ieee80211_hw_flags {
Johannes Bergaf65cd92009-11-17 18:18:36 +01001086 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001087 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1088 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001089 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1090 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001091 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001092 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001093 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001094 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1095 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1096 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1097 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1098 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1099 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001100 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001101 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1102 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001103 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301104 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001105 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001106 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001107 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001108 IEEE80211_HW_AP_LINK_PS = 1<<22,
Johannes Berg1bc08262007-09-18 17:29:15 -04001109};
1110
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001111/**
1112 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001113 *
1114 * This structure contains the configuration and hardware
1115 * information for an 802.11 PHY.
1116 *
1117 * @wiphy: This points to the &struct wiphy allocated for this
1118 * 802.11 PHY. You must fill in the @perm_addr and @dev
1119 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001120 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1121 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001122 *
1123 * @conf: &struct ieee80211_conf, device configuration, don't use.
1124 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001125 * @priv: pointer to private area that was allocated for driver use
1126 * along with this structure.
1127 *
1128 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1129 *
1130 * @extra_tx_headroom: headroom to reserve in each transmit skb
1131 * for use by the driver (e.g. for transmit headers.)
1132 *
1133 * @channel_change_time: time (in microseconds) it takes to change channels.
1134 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001135 * @max_signal: Maximum value for signal (rssi) in RX information, used
1136 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001137 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001138 * @max_listen_interval: max listen interval in units of beacon interval
1139 * that HW supports
1140 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001141 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001142 * data packets. WMM/QoS requires at least four, these
1143 * queues need to have configurable access parameters.
1144 *
Johannes Berg830f9032007-10-28 14:51:05 +01001145 * @rate_control_algorithm: rate control algorithm for this hardware.
1146 * If unset (NULL), the default algorithm will be used. Must be
1147 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001148 *
1149 * @vif_data_size: size (in bytes) of the drv_priv data area
1150 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001151 * @sta_data_size: size (in bytes) of the drv_priv data area
1152 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001153 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001154 * @max_rates: maximum number of alternate rate retry stages the hw
1155 * can handle.
1156 * @max_report_rates: maximum number of alternate rate retry stages
1157 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001158 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001159 *
1160 * @napi_weight: weight used for NAPI polling. You must specify an
1161 * appropriate value here if a napi_poll operation is provided
1162 * by your driver.
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001163
1164 * @max_rx_aggregation_subframes: maximum buffer size (number of
1165 * sub-frames) to be used for A-MPDU block ack receiver
1166 * aggregation.
1167 * This is only relevant if the device has restrictions on the
1168 * number of subframes, if it relies on mac80211 to do reordering
1169 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001170 *
1171 * @max_tx_aggregation_subframes: maximum number of subframes in an
1172 * aggregate an HT driver will transmit, used by the peer as a
1173 * hint to size its reorder buffer.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001174 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001175struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -07001176 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001177 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001178 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -07001179 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001180 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -07001181 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -07001182 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001183 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001184 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001185 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001186 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001187 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -07001188 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001189 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001190 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001191 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001192 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001193 u8 max_tx_aggregation_subframes;
Jiri Bencf0706e822007-05-05 11:45:53 -07001194};
1195
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001196/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001197 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1198 *
1199 * @wiphy: the &struct wiphy which we want to query
1200 *
1201 * mac80211 drivers can use this to get to their respective
1202 * &struct ieee80211_hw. Drivers wishing to get to their own private
1203 * structure can then access it via hw->priv. Note that mac802111 drivers should
1204 * not use wiphy_priv() to try to get their private driver structure as this
1205 * is already used internally by mac80211.
1206 */
1207struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1208
1209/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001210 * SET_IEEE80211_DEV - set device for 802.11 hardware
1211 *
1212 * @hw: the &struct ieee80211_hw to set the device for
1213 * @dev: the &struct device of this 802.11 device
1214 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001215static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1216{
1217 set_wiphy_dev(hw->wiphy, dev);
1218}
1219
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001220/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001221 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001222 *
1223 * @hw: the &struct ieee80211_hw to set the MAC address for
1224 * @addr: the address to set
1225 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001226static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1227{
1228 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1229}
1230
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001231static inline struct ieee80211_rate *
1232ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001233 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001234{
Johannes Berge6a98542008-10-21 12:40:02 +02001235 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001236 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001237 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001238}
1239
1240static inline struct ieee80211_rate *
1241ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001242 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001243{
Johannes Berge039fa42008-05-15 12:55:29 +02001244 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001245 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001246 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001247}
1248
1249static inline struct ieee80211_rate *
1250ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001251 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001252{
Johannes Berge6a98542008-10-21 12:40:02 +02001253 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001254 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001255 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001256}
1257
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001258/**
1259 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001260 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001261 * mac80211 is capable of taking advantage of many hardware
1262 * acceleration designs for encryption and decryption operations.
1263 *
1264 * The set_key() callback in the &struct ieee80211_ops for a given
1265 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001266 * decryption. The callback takes a @sta parameter that will be NULL
1267 * for default keys or keys used for transmission only, or point to
1268 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001269 * Multiple transmission keys with the same key index may be used when
1270 * VLANs are configured for an access point.
1271 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001272 * When transmitting, the TX control data will use the @hw_key_idx
1273 * selected by the driver by modifying the &struct ieee80211_key_conf
1274 * pointed to by the @key parameter to the set_key() function.
1275 *
1276 * The set_key() call for the %SET_KEY command should return 0 if
1277 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1278 * added; if you return 0 then hw_key_idx must be assigned to the
1279 * hardware key index, you are free to use the full u8 range.
1280 *
1281 * When the cmd is %DISABLE_KEY then it must succeed.
1282 *
1283 * Note that it is permissible to not decrypt a frame even if a key
1284 * for it has been uploaded to hardware, the stack will not make any
1285 * decision based on whether a key has been uploaded or not but rather
1286 * based on the receive flags.
1287 *
1288 * The &struct ieee80211_key_conf structure pointed to by the @key
1289 * parameter is guaranteed to be valid until another call to set_key()
1290 * removes it, but it can only be used as a cookie to differentiate
1291 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001292 *
1293 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1294 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1295 * handler.
1296 * The update_tkip_key() call updates the driver with the new phase 1 key.
1297 * This happens everytime the iv16 wraps around (every 65536 packets). The
1298 * set_key() call will happen only once for each key (unless the AP did
1299 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001300 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001301 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001302 */
Johannes Berg4150c572007-09-17 01:29:23 -04001303
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001304/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001305 * DOC: Powersave support
1306 *
1307 * mac80211 has support for various powersave implementations.
1308 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001309 * First, it can support hardware that handles all powersaving by itself,
1310 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1311 * flag. In that case, it will be told about the desired powersave mode
1312 * with the %IEEE80211_CONF_PS flag depending on the association status.
1313 * The hardware must take care of sending nullfunc frames when necessary,
1314 * i.e. when entering and leaving powersave mode. The hardware is required
1315 * to look at the AID in beacons and signal to the AP that it woke up when
1316 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001317 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001318 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1319 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1320 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001321 * up the hardware before issuing commands to the hardware and putting it
1322 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001323 *
1324 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1325 * buffered multicast/broadcast frames after the beacon. Also it must be
1326 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001327 *
1328 * Other hardware designs cannot send nullfunc frames by themselves and also
1329 * need software support for parsing the TIM bitmap. This is also supported
1330 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1331 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001332 * required to pass up beacons. The hardware is still required to handle
1333 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001334 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001335 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001336 * Dynamic powersave is an extension to normal powersave in which the
1337 * hardware stays awake for a user-specified period of time after sending a
1338 * frame so that reply frames need not be buffered and therefore delayed to
1339 * the next wakeup. It's compromise of getting good enough latency when
1340 * there's data traffic and still saving significantly power in idle
1341 * periods.
1342 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001343 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001344 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1345 * flag and mac80211 will handle everything automatically. Additionally,
1346 * hardware having support for the dynamic PS feature may set the
1347 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1348 * dynamic PS mode itself. The driver needs to look at the
1349 * @dynamic_ps_timeout hardware configuration value and use it that value
1350 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1351 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1352 * enabled whenever user has enabled powersave.
1353 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001354 * Some hardware need to toggle a single shared antenna between WLAN and
1355 * Bluetooth to facilitate co-existence. These types of hardware set
1356 * limitations on the use of host controlled dynamic powersave whenever there
1357 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1358 * driver may request temporarily going into full power save, in order to
1359 * enable toggling the antenna between BT and WLAN. If the driver requests
1360 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1361 * temporarily set to zero until the driver re-enables dynamic powersave.
1362 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001363 * Driver informs U-APSD client support by enabling
1364 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1365 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1366 * Nullfunc frames and stay awake until the service period has ended. To
1367 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1368 * from that AC are transmitted with powersave enabled.
1369 *
1370 * Note: U-APSD client mode is not yet supported with
1371 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001372 */
1373
1374/**
Kalle Valo04de8382009-03-22 21:57:35 +02001375 * DOC: Beacon filter support
1376 *
1377 * Some hardware have beacon filter support to reduce host cpu wakeups
1378 * which will reduce system power consumption. It usuallly works so that
1379 * the firmware creates a checksum of the beacon but omits all constantly
1380 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1381 * beacon is forwarded to the host, otherwise it will be just dropped. That
1382 * way the host will only receive beacons where some relevant information
1383 * (for example ERP protection or WMM settings) have changed.
1384 *
Johannes Berg955394c2009-04-16 17:04:25 +02001385 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1386 * hardware capability. The driver needs to enable beacon filter support
1387 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1388 * power save is enabled, the stack will not check for beacon loss and the
1389 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1390 *
1391 * The time (or number of beacons missed) until the firmware notifies the
1392 * driver of a beacon loss event (which in turn causes the driver to call
1393 * ieee80211_beacon_loss()) should be configurable and will be controlled
1394 * by mac80211 and the roaming algorithm in the future.
1395 *
1396 * Since there may be constantly changing information elements that nothing
1397 * in the software stack cares about, we will, in the future, have mac80211
1398 * tell the driver which information elements are interesting in the sense
1399 * that we want to see changes in them. This will include
1400 * - a list of information element IDs
1401 * - a list of OUIs for the vendor information element
1402 *
1403 * Ideally, the hardware would filter out any beacons without changes in the
1404 * requested elements, but if it cannot support that it may, at the expense
1405 * of some efficiency, filter out only a subset. For example, if the device
1406 * doesn't support checking for OUIs it should pass up all changes in all
1407 * vendor information elements.
1408 *
1409 * Note that change, for the sake of simplification, also includes information
1410 * elements appearing or disappearing from the beacon.
1411 *
1412 * Some hardware supports an "ignore list" instead, just make sure nothing
1413 * that was requested is on the ignore list, and include commonly changing
1414 * information element IDs in the ignore list, for example 11 (BSS load) and
1415 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1416 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1417 * it could also include some currently unused IDs.
1418 *
1419 *
1420 * In addition to these capabilities, hardware should support notifying the
1421 * host of changes in the beacon RSSI. This is relevant to implement roaming
1422 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1423 * the received data packets). This can consist in notifying the host when
1424 * the RSSI changes significantly or when it drops below or rises above
1425 * configurable thresholds. In the future these thresholds will also be
1426 * configured by mac80211 (which gets them from userspace) to implement
1427 * them as the roaming algorithm requires.
1428 *
1429 * If the hardware cannot implement this, the driver should ask it to
1430 * periodically pass beacon frames to the host so that software can do the
1431 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001432 */
1433
1434/**
Johannes Berg0f782312009-12-01 13:37:02 +01001435 * DOC: Spatial multiplexing power save
1436 *
1437 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1438 * power in an 802.11n implementation. For details on the mechanism
1439 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1440 * "11.2.3 SM power save".
1441 *
1442 * The mac80211 implementation is capable of sending action frames
1443 * to update the AP about the station's SMPS mode, and will instruct
1444 * the driver to enter the specific mode. It will also announce the
1445 * requested SMPS mode during the association handshake. Hardware
1446 * support for this feature is required, and can be indicated by
1447 * hardware flags.
1448 *
1449 * The default mode will be "automatic", which nl80211/cfg80211
1450 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1451 * turned off otherwise.
1452 *
1453 * To support this feature, the driver must set the appropriate
1454 * hardware support flags, and handle the SMPS flag to the config()
1455 * operation. It will then with this mechanism be instructed to
1456 * enter the requested SMPS mode while associated to an HT AP.
1457 */
1458
1459/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001460 * DOC: Frame filtering
1461 *
1462 * mac80211 requires to see many management frames for proper
1463 * operation, and users may want to see many more frames when
1464 * in monitor mode. However, for best CPU usage and power consumption,
1465 * having as few frames as possible percolate through the stack is
1466 * desirable. Hence, the hardware should filter as much as possible.
1467 *
1468 * To achieve this, mac80211 uses filter flags (see below) to tell
1469 * the driver's configure_filter() function which frames should be
1470 * passed to mac80211 and which should be filtered out.
1471 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001472 * Before configure_filter() is invoked, the prepare_multicast()
1473 * callback is invoked with the parameters @mc_count and @mc_list
1474 * for the combined multicast address list of all virtual interfaces.
1475 * It's use is optional, and it returns a u64 that is passed to
1476 * configure_filter(). Additionally, configure_filter() has the
1477 * arguments @changed_flags telling which flags were changed and
1478 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001479 *
1480 * If your device has no multicast address filters your driver will
1481 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1482 * parameter to see whether multicast frames should be accepted
1483 * or dropped.
1484 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001485 * All unsupported flags in @total_flags must be cleared.
1486 * Hardware does not support a flag if it is incapable of _passing_
1487 * the frame to the stack. Otherwise the driver must ignore
1488 * the flag, but not clear it.
1489 * You must _only_ clear the flag (announce no support for the
1490 * flag to mac80211) if you are not able to pass the packet type
1491 * to the stack (so the hardware always filters it).
1492 * So for example, you should clear @FIF_CONTROL, if your hardware
1493 * always filters control frames. If your hardware always passes
1494 * control frames to the kernel and is incapable of filtering them,
1495 * you do _not_ clear the @FIF_CONTROL flag.
1496 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001497 */
1498
1499/**
1500 * enum ieee80211_filter_flags - hardware filter flags
1501 *
1502 * These flags determine what the filter in hardware should be
1503 * programmed to let through and what should not be passed to the
1504 * stack. It is always safe to pass more frames than requested,
1505 * but this has negative impact on power consumption.
1506 *
1507 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1508 * think of the BSS as your network segment and then this corresponds
1509 * to the regular ethernet device promiscuous mode.
1510 *
1511 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1512 * by the user or if the hardware is not capable of filtering by
1513 * multicast address.
1514 *
1515 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1516 * %RX_FLAG_FAILED_FCS_CRC for them)
1517 *
1518 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1519 * the %RX_FLAG_FAILED_PLCP_CRC for them
1520 *
1521 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1522 * to the hardware that it should not filter beacons or probe responses
1523 * by BSSID. Filtering them can greatly reduce the amount of processing
1524 * mac80211 needs to do and the amount of CPU wakeups, so you should
1525 * honour this flag if possible.
1526 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001527 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001528 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001529 *
1530 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001531 *
Johannes Berg7be50862010-10-13 12:06:24 +02001532 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1533 * those addressed to this station.
1534 *
1535 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001536 */
1537enum ieee80211_filter_flags {
1538 FIF_PROMISC_IN_BSS = 1<<0,
1539 FIF_ALLMULTI = 1<<1,
1540 FIF_FCSFAIL = 1<<2,
1541 FIF_PLCPFAIL = 1<<3,
1542 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1543 FIF_CONTROL = 1<<5,
1544 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001545 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001546 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001547};
1548
1549/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001550 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1551 *
1552 * These flags are used with the ampdu_action() callback in
1553 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001554 *
1555 * Note that drivers MUST be able to deal with a TX aggregation
1556 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001557 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001558 * might receive the addBA frame and send a delBA right away!
1559 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001560 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1561 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001562 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1563 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001564 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001565 */
1566enum ieee80211_ampdu_mlme_action {
1567 IEEE80211_AMPDU_RX_START,
1568 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001569 IEEE80211_AMPDU_TX_START,
1570 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001571 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001572};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001573
1574/**
1575 * struct ieee80211_ops - callbacks from mac80211 to the driver
1576 *
1577 * This structure contains various callbacks that the driver may
1578 * handle or, in some cases, must handle, for example to configure
1579 * the hardware to a new channel or to transmit a frame.
1580 *
1581 * @tx: Handler that 802.11 module calls for each transmitted frame.
1582 * skb contains the buffer starting from the IEEE 802.11 header.
1583 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001584 * configuration in the TX control data. This handler should,
1585 * preferably, never fail and stop queues appropriately, more
1586 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001587 * This function should return NETDEV_TX_OK except in very
1588 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001589 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001590 *
1591 * @start: Called before the first netdevice attached to the hardware
1592 * is enabled. This should turn on the hardware and must turn on
1593 * frame reception (for possibly enabled monitor interfaces.)
1594 * Returns negative error codes, these may be seen in userspace,
1595 * or zero.
1596 * When the device is started it should not have a MAC address
1597 * to avoid acknowledging frames before a non-monitor device
1598 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001599 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001600 *
1601 * @stop: Called after last netdevice attached to the hardware
1602 * is disabled. This should turn off the hardware (at least
1603 * it must turn off frame reception.)
1604 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001605 * an interface. If you added any work onto the mac80211 workqueue
1606 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001607 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001608 *
1609 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001610 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001611 * and @stop must be implemented.
1612 * The driver should perform any initialization it needs before
1613 * the device can be enabled. The initial configuration for the
1614 * interface is given in the conf parameter.
1615 * The callback may refuse to add an interface by returning a
1616 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001617 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001618 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001619 * @change_interface: Called when a netdevice changes type. This callback
1620 * is optional, but only if it is supported can interface types be
1621 * switched while the interface is UP. The callback may sleep.
1622 * Note that while an interface is being switched, it will not be
1623 * found by the interface iteration callbacks.
1624 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001625 * @remove_interface: Notifies a driver that an interface is going down.
1626 * The @stop callback is called after this if it is the last interface
1627 * and no monitor interfaces are present.
1628 * When all interfaces are removed, the MAC address in the hardware
1629 * must be cleared so the device no longer acknowledges packets,
1630 * the mac_addr member of the conf structure is, however, set to the
1631 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001632 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001633 *
1634 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1635 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001636 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001637 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001638 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001639 * @bss_info_changed: Handler for configuration requests related to BSS
1640 * parameters that may vary during BSS's lifespan, and may affect low
1641 * level driver (e.g. assoc/disassoc status, erp parameters).
1642 * This function should not be used if no BSS has been set, unless
1643 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001644 * of the bss parameters has changed when a call is made. The callback
1645 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001646 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001647 * @prepare_multicast: Prepare for multicast filter configuration.
1648 * This callback is optional, and its return value is passed
1649 * to configure_filter(). This callback must be atomic.
1650 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001651 * @configure_filter: Configure the device's RX filter.
1652 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001653 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001654 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001655 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001656 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001657 *
1658 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001659 * This callback is only called between add_interface and
1660 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001661 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001662 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001663 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001664 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001665 * @update_tkip_key: See the section "Hardware crypto acceleration"
1666 * This callback will be called in the context of Rx. Called for drivers
1667 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001668 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001669 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001670 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001671 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001672 * configuration done by the regulatory agent in the wiphy's
1673 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001674 * that power save is disabled.
1675 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1676 * entire IEs after the SSID, so that drivers need not look at these
1677 * at all but just send them after the SSID -- mac80211 includes the
1678 * (extended) supported rates and HT information (where applicable).
1679 * When the scan finishes, ieee80211_scan_completed() must be called;
1680 * note that it also must be called when the scan cannot finish due to
1681 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001682 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001683 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001684 * @sw_scan_start: Notifier function that is called just before a software scan
1685 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001686 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001687 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001688 * @sw_scan_complete: Notifier function that is called just after a
1689 * software scan finished. Can be NULL, if the driver doesn't need
1690 * this notification.
1691 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001692 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001693 * @get_stats: Return low-level statistics.
1694 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001695 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001696 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001697 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1698 * callback should be provided to read the TKIP transmit IVs (both IV32
1699 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001700 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001701 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001702 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1703 * if the device does fragmentation by itself; if this callback is
1704 * implemented then the stack will not do fragmentation.
1705 * The callback can sleep.
1706 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001707 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001708 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001709 *
Johannes Berg34e89502010-02-03 13:59:58 +01001710 * @sta_add: Notifies low level driver about addition of an associated station,
1711 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1712 *
1713 * @sta_remove: Notifies low level driver about removal of an associated
1714 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1715 *
1716 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001717 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1718 * in AP mode, this callback will not be called when the flag
1719 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001720 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001721 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001722 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001723 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001724 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001725 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001726 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001727 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001728 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001729 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001730 *
1731 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1732 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001733 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001734 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001735 *
1736 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1737 * with other STAs in the IBSS. This is only used in IBSS mode. This
1738 * function is optional if the firmware/hardware takes full care of
1739 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001740 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001741 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001742 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1743 * This is needed only for IBSS mode and the result of this function is
1744 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001745 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001746 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001747 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001748 * @ampdu_action: Perform a certain A-MPDU action
1749 * The RA/TID combination determines the destination and TID we want
1750 * the ampdu action to be performed for. The action is defined through
1751 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001752 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001753 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01001754 * The @buf_size parameter is only valid when the action is set to
1755 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1756 * buffer size (number of subframes) for this session -- aggregates
1757 * containing more subframes than this may not be transmitted to the peer.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001758 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02001759 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001760 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001761 * @get_survey: Return per-channel survey information
1762 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001763 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1764 * need to set wiphy->rfkill_poll to %true before registration,
1765 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001766 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001767 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001768 * @set_coverage_class: Set slot time for given coverage class as specified
1769 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1770 * accordingly. This callback is not required and may sleep.
1771 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001772 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001773 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001774 *
1775 * @flush: Flush all pending frames from the hardware queue, making sure
1776 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001777 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001778 *
1779 * @channel_switch: Drivers that need (or want) to offload the channel
1780 * switch operation for CSAs received from the AP may implement this
1781 * callback. They must then call ieee80211_chswitch_done() to indicate
1782 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001783 *
1784 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09001785 *
1786 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1787 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1788 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1789 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1790 *
1791 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01001792 *
1793 * @remain_on_channel: Starts an off-channel period on the given channel, must
1794 * call back to ieee80211_ready_on_channel() when on that channel. Note
1795 * that normal channel traffic is not stopped as this is intended for hw
1796 * offload. Frames to transmit on the off-channel channel are transmitted
1797 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1798 * duration (which will always be non-zero) expires, the driver must call
1799 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1800 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1801 * aborted before it expires. This callback may sleep.
Johannes Berg5f16a432011-02-25 15:36:57 +01001802 * @offchannel_tx: Transmit frame on another channel, wait for a response
1803 * and return. Reliable TX status must be reported for the frame. If the
1804 * return value is 1, then the @remain_on_channel will be used with a
1805 * regular transmission (if supported.)
1806 * @offchannel_tx_cancel_wait: cancel wait associated with offchannel TX
John W. Linville38c09152011-03-07 16:19:18 -05001807 *
1808 * @set_ringparam: Set tx and rx ring sizes.
1809 *
1810 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001811 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001812struct ieee80211_ops {
Johannes Berg7bb45682011-02-24 14:42:06 +01001813 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001814 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001815 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001816 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001817 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02001818 int (*change_interface)(struct ieee80211_hw *hw,
1819 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001820 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e822007-05-05 11:45:53 -07001821 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001822 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001823 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001824 void (*bss_info_changed)(struct ieee80211_hw *hw,
1825 struct ieee80211_vif *vif,
1826 struct ieee80211_bss_conf *info,
1827 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001828 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad2010-04-01 21:22:57 +00001829 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001830 void (*configure_filter)(struct ieee80211_hw *hw,
1831 unsigned int changed_flags,
1832 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001833 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001834 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1835 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001836 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001837 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001838 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001839 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001840 struct ieee80211_vif *vif,
1841 struct ieee80211_key_conf *conf,
1842 struct ieee80211_sta *sta,
1843 u32 iv32, u16 *phase1key);
Johannes Berga060bbf2010-04-27 11:59:34 +02001844 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001845 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001846 void (*sw_scan_start)(struct ieee80211_hw *hw);
1847 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001848 int (*get_stats)(struct ieee80211_hw *hw,
1849 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001850 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1851 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001852 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e822007-05-05 11:45:53 -07001853 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001854 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1855 struct ieee80211_sta *sta);
1856 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1857 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001858 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001859 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001860 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001861 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001862 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001863 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001864 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001865 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001866 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001867 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001868 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01001869 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
1870 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02001871 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1872 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001873 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001874 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001875#ifdef CONFIG_NL80211_TESTMODE
1876 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1877#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001878 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02001879 void (*channel_switch)(struct ieee80211_hw *hw,
1880 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001881 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09001882 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1883 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01001884
1885 int (*remain_on_channel)(struct ieee80211_hw *hw,
1886 struct ieee80211_channel *chan,
1887 enum nl80211_channel_type channel_type,
1888 int duration);
1889 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
Johannes Berg5f16a432011-02-25 15:36:57 +01001890 int (*offchannel_tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1891 struct ieee80211_channel *chan,
1892 enum nl80211_channel_type channel_type,
1893 unsigned int wait);
1894 int (*offchannel_tx_cancel_wait)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05001895 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
1896 void (*get_ringparam)(struct ieee80211_hw *hw,
1897 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Jiri Bencf0706e822007-05-05 11:45:53 -07001898};
1899
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001900/**
1901 * ieee80211_alloc_hw - Allocate a new hardware device
1902 *
1903 * This must be called once for each hardware device. The returned pointer
1904 * must be used to refer to this device when calling other functions.
1905 * mac80211 allocates a private data area for the driver pointed to by
1906 * @priv in &struct ieee80211_hw, the size of this area is given as
1907 * @priv_data_len.
1908 *
1909 * @priv_data_len: length of private data
1910 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001911 */
1912struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1913 const struct ieee80211_ops *ops);
1914
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001915/**
1916 * ieee80211_register_hw - Register hardware device
1917 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001918 * You must call this function before any other functions in
1919 * mac80211. Note that before a hardware can be registered, you
1920 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001921 *
1922 * @hw: the device to register as returned by ieee80211_alloc_hw()
1923 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001924int ieee80211_register_hw(struct ieee80211_hw *hw);
1925
Johannes Berge1e54062010-11-30 08:58:45 +01001926/**
1927 * struct ieee80211_tpt_blink - throughput blink description
1928 * @throughput: throughput in Kbit/sec
1929 * @blink_time: blink time in milliseconds
1930 * (full cycle, ie. one off + one on period)
1931 */
1932struct ieee80211_tpt_blink {
1933 int throughput;
1934 int blink_time;
1935};
1936
Johannes Berg67408c82010-11-30 08:59:23 +01001937/**
1938 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
1939 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
1940 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
1941 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
1942 * interface is connected in some way, including being an AP
1943 */
1944enum ieee80211_tpt_led_trigger_flags {
1945 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
1946 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
1947 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
1948};
1949
Jiri Bencf0706e822007-05-05 11:45:53 -07001950#ifdef CONFIG_MAC80211_LEDS
1951extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1952extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001953extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001954extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01001955extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01001956 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01001957 const struct ieee80211_tpt_blink *blink_table,
1958 unsigned int blink_table_len);
Jiri Bencf0706e822007-05-05 11:45:53 -07001959#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001960/**
1961 * ieee80211_get_tx_led_name - get name of TX LED
1962 *
1963 * mac80211 creates a transmit LED trigger for each wireless hardware
1964 * that can be used to drive LEDs if your driver registers a LED device.
1965 * This function returns the name (or %NULL if not configured for LEDs)
1966 * of the trigger so you can automatically link the LED device.
1967 *
1968 * @hw: the hardware to get the LED trigger name for
1969 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001970static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1971{
1972#ifdef CONFIG_MAC80211_LEDS
1973 return __ieee80211_get_tx_led_name(hw);
1974#else
1975 return NULL;
1976#endif
1977}
1978
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001979/**
1980 * ieee80211_get_rx_led_name - get name of RX LED
1981 *
1982 * mac80211 creates a receive LED trigger for each wireless hardware
1983 * that can be used to drive LEDs if your driver registers a LED device.
1984 * This function returns the name (or %NULL if not configured for LEDs)
1985 * of the trigger so you can automatically link the LED device.
1986 *
1987 * @hw: the hardware to get the LED trigger name for
1988 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001989static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1990{
1991#ifdef CONFIG_MAC80211_LEDS
1992 return __ieee80211_get_rx_led_name(hw);
1993#else
1994 return NULL;
1995#endif
1996}
1997
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001998/**
1999 * ieee80211_get_assoc_led_name - get name of association LED
2000 *
2001 * mac80211 creates a association LED trigger for each wireless hardware
2002 * that can be used to drive LEDs if your driver registers a LED device.
2003 * This function returns the name (or %NULL if not configured for LEDs)
2004 * of the trigger so you can automatically link the LED device.
2005 *
2006 * @hw: the hardware to get the LED trigger name for
2007 */
Michael Buesch47f0c502007-09-27 15:10:44 +02002008static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2009{
2010#ifdef CONFIG_MAC80211_LEDS
2011 return __ieee80211_get_assoc_led_name(hw);
2012#else
2013 return NULL;
2014#endif
2015}
2016
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002017/**
2018 * ieee80211_get_radio_led_name - get name of radio LED
2019 *
2020 * mac80211 creates a radio change LED trigger for each wireless hardware
2021 * that can be used to drive LEDs if your driver registers a LED device.
2022 * This function returns the name (or %NULL if not configured for LEDs)
2023 * of the trigger so you can automatically link the LED device.
2024 *
2025 * @hw: the hardware to get the LED trigger name for
2026 */
2027static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2028{
2029#ifdef CONFIG_MAC80211_LEDS
2030 return __ieee80211_get_radio_led_name(hw);
2031#else
2032 return NULL;
2033#endif
2034}
Michael Buesch47f0c502007-09-27 15:10:44 +02002035
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002036/**
Johannes Berge1e54062010-11-30 08:58:45 +01002037 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2038 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01002039 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01002040 * @blink_table: the blink table -- needs to be ordered by throughput
2041 * @blink_table_len: size of the blink table
2042 *
2043 * This function returns %NULL (in case of error, or if no LED
2044 * triggers are configured) or the name of the new trigger.
2045 * This function must be called before ieee80211_register_hw().
2046 */
2047static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01002048ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002049 const struct ieee80211_tpt_blink *blink_table,
2050 unsigned int blink_table_len)
2051{
2052#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01002053 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002054 blink_table_len);
2055#else
2056 return NULL;
2057#endif
2058}
2059
2060/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002061 * ieee80211_unregister_hw - Unregister a hardware device
2062 *
2063 * This function instructs mac80211 to free allocated resources
2064 * and unregister netdevices from the networking subsystem.
2065 *
2066 * @hw: the hardware to unregister
2067 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002068void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2069
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002070/**
2071 * ieee80211_free_hw - free hardware descriptor
2072 *
2073 * This function frees everything that was allocated, including the
2074 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002075 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002076 *
2077 * @hw: the hardware to free
2078 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002079void ieee80211_free_hw(struct ieee80211_hw *hw);
2080
Johannes Bergf2753dd2009-04-14 10:09:24 +02002081/**
2082 * ieee80211_restart_hw - restart hardware completely
2083 *
2084 * Call this function when the hardware was restarted for some reason
2085 * (hardware error, ...) and the driver is unable to restore its state
2086 * by itself. mac80211 assumes that at this point the driver/hardware
2087 * is completely uninitialised and stopped, it starts the process by
2088 * calling the ->start() operation. The driver will need to reset all
2089 * internal state that it has prior to calling this function.
2090 *
2091 * @hw: the hardware to restart
2092 */
2093void ieee80211_restart_hw(struct ieee80211_hw *hw);
2094
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002095/** ieee80211_napi_schedule - schedule NAPI poll
2096 *
2097 * Use this function to schedule NAPI polling on a device.
2098 *
2099 * @hw: the hardware to start polling
2100 */
2101void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2102
2103/** ieee80211_napi_complete - complete NAPI polling
2104 *
2105 * Use this function to finish NAPI polling on a device.
2106 *
2107 * @hw: the hardware to stop polling
2108 */
2109void ieee80211_napi_complete(struct ieee80211_hw *hw);
2110
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002111/**
2112 * ieee80211_rx - receive frame
2113 *
2114 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002115 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2116 * paged @skb is used, the driver is recommended to put the ieee80211
2117 * header of the frame on the linear part of the @skb to avoid memory
2118 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002119 *
Johannes Berg2485f712008-02-25 16:27:41 +01002120 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03002121 * for a single hardware must be synchronized against each other. Calls to
2122 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2123 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002124 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002125 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02002126 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002127 * @hw: the hardware this frame came in on
2128 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002129 */
John W. Linville103bf9f2009-08-20 16:34:15 -04002130void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002131
2132/**
2133 * ieee80211_rx_irqsafe - receive frame
2134 *
2135 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01002136 * (internally defers to a tasklet.)
2137 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002138 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2139 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002140 *
2141 * @hw: the hardware this frame came in on
2142 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002143 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02002144void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07002145
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002146/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03002147 * ieee80211_rx_ni - receive frame (in process context)
2148 *
2149 * Like ieee80211_rx() but can be called in process context
2150 * (internally disables bottom halves).
2151 *
2152 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2153 * not be mixed for a single hardware.
2154 *
2155 * @hw: the hardware this frame came in on
2156 * @skb: the buffer to receive, owned by mac80211 after this call
2157 */
2158static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2159 struct sk_buff *skb)
2160{
2161 local_bh_disable();
2162 ieee80211_rx(hw, skb);
2163 local_bh_enable();
2164}
2165
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002166/**
2167 * ieee80211_sta_ps_transition - PS transition for connected sta
2168 *
2169 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2170 * flag set, use this function to inform mac80211 about a connected station
2171 * entering/leaving PS mode.
2172 *
2173 * This function may not be called in IRQ context or with softirqs enabled.
2174 *
2175 * Calls to this function for a single hardware must be synchronized against
2176 * each other.
2177 *
2178 * The function returns -EINVAL when the requested PS mode is already set.
2179 *
2180 * @sta: currently connected sta
2181 * @start: start or stop PS
2182 */
2183int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2184
2185/**
2186 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2187 * (in process context)
2188 *
2189 * Like ieee80211_sta_ps_transition() but can be called in process context
2190 * (internally disables bottom halves). Concurrent call restriction still
2191 * applies.
2192 *
2193 * @sta: currently connected sta
2194 * @start: start or stop PS
2195 */
2196static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2197 bool start)
2198{
2199 int ret;
2200
2201 local_bh_disable();
2202 ret = ieee80211_sta_ps_transition(sta, start);
2203 local_bh_enable();
2204
2205 return ret;
2206}
2207
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002208/*
2209 * The TX headroom reserved by mac80211 for its own tx_status functions.
2210 * This is enough for the radiotap header.
2211 */
2212#define IEEE80211_TX_STATUS_HEADROOM 13
2213
Kalle Valoe36e49f2009-10-13 20:33:13 +03002214/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002215 * ieee80211_tx_status - transmit status callback
2216 *
2217 * Call this function for all transmitted frames after they have been
2218 * transmitted. It is permissible to not call this function for
2219 * multicast frames but this can affect statistics.
2220 *
Johannes Berg2485f712008-02-25 16:27:41 +01002221 * This function may not be called in IRQ context. Calls to this function
2222 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002223 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2224 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002225 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002226 * @hw: the hardware the frame was transmitted by
2227 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002228 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002229void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002230 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002231
2232/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002233 * ieee80211_tx_status_ni - transmit status callback (in process context)
2234 *
2235 * Like ieee80211_tx_status() but can be called in process context.
2236 *
2237 * Calls to this function, ieee80211_tx_status() and
2238 * ieee80211_tx_status_irqsafe() may not be mixed
2239 * for a single hardware.
2240 *
2241 * @hw: the hardware the frame was transmitted by
2242 * @skb: the frame that was transmitted, owned by mac80211 after this call
2243 */
2244static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2245 struct sk_buff *skb)
2246{
2247 local_bh_disable();
2248 ieee80211_tx_status(hw, skb);
2249 local_bh_enable();
2250}
2251
2252/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002253 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002254 *
2255 * Like ieee80211_tx_status() but can be called in IRQ context
2256 * (internally defers to a tasklet.)
2257 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002258 * Calls to this function, ieee80211_tx_status() and
2259 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002260 *
2261 * @hw: the hardware the frame was transmitted by
2262 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002263 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002264void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002265 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07002266
2267/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01002268 * ieee80211_beacon_get_tim - beacon generation function
2269 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002270 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01002271 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2272 * Set to 0 if invalid (in non-AP modes).
2273 * @tim_length: pointer to variable that will receive the TIM IE length,
2274 * (including the ID and length bytes!).
2275 * Set to 0 if invalid (in non-AP modes).
2276 *
2277 * If the driver implements beaconing modes, it must use this function to
2278 * obtain the beacon frame/template.
2279 *
2280 * If the beacon frames are generated by the host system (i.e., not in
2281 * hardware/firmware), the driver uses this function to get each beacon
2282 * frame from mac80211 -- it is responsible for calling this function
2283 * before the beacon is needed (e.g. based on hardware interrupt).
2284 *
2285 * If the beacon frames are generated by the device, then the driver
2286 * must use the returned beacon as the template and change the TIM IE
2287 * according to the current DTIM parameters/TIM bitmap.
2288 *
2289 * The driver is responsible for freeing the returned skb.
2290 */
2291struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2292 struct ieee80211_vif *vif,
2293 u16 *tim_offset, u16 *tim_length);
2294
2295/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002296 * ieee80211_beacon_get - beacon generation function
2297 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002298 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002299 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002300 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e822007-05-05 11:45:53 -07002301 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002302static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2303 struct ieee80211_vif *vif)
2304{
2305 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2306}
Jiri Bencf0706e822007-05-05 11:45:53 -07002307
2308/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002309 * ieee80211_pspoll_get - retrieve a PS Poll template
2310 * @hw: pointer obtained from ieee80211_alloc_hw().
2311 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2312 *
2313 * Creates a PS Poll a template which can, for example, uploaded to
2314 * hardware. The template must be updated after association so that correct
2315 * AID, BSSID and MAC address is used.
2316 *
2317 * Note: Caller (or hardware) is responsible for setting the
2318 * &IEEE80211_FCTL_PM bit.
2319 */
2320struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2321 struct ieee80211_vif *vif);
2322
2323/**
2324 * ieee80211_nullfunc_get - retrieve a nullfunc template
2325 * @hw: pointer obtained from ieee80211_alloc_hw().
2326 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2327 *
2328 * Creates a Nullfunc template which can, for example, uploaded to
2329 * hardware. The template must be updated after association so that correct
2330 * BSSID and address is used.
2331 *
2332 * Note: Caller (or hardware) is responsible for setting the
2333 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2334 */
2335struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2336 struct ieee80211_vif *vif);
2337
2338/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002339 * ieee80211_probereq_get - retrieve a Probe Request template
2340 * @hw: pointer obtained from ieee80211_alloc_hw().
2341 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2342 * @ssid: SSID buffer
2343 * @ssid_len: length of SSID
2344 * @ie: buffer containing all IEs except SSID for the template
2345 * @ie_len: length of the IE buffer
2346 *
2347 * Creates a Probe Request template which can, for example, be uploaded to
2348 * hardware.
2349 */
2350struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2351 struct ieee80211_vif *vif,
2352 const u8 *ssid, size_t ssid_len,
2353 const u8 *ie, size_t ie_len);
2354
2355/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002356 * ieee80211_rts_get - RTS frame generation function
2357 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002358 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002359 * @frame: pointer to the frame that is going to be protected by the RTS.
2360 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002361 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002362 * @rts: The buffer where to store the RTS frame.
2363 *
2364 * If the RTS frames are generated by the host system (i.e., not in
2365 * hardware/firmware), the low-level driver uses this function to receive
2366 * the next RTS frame from the 802.11 code. The low-level is responsible
2367 * for calling this function before and RTS frame is needed.
2368 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002369void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002370 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002371 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002372 struct ieee80211_rts *rts);
2373
2374/**
2375 * ieee80211_rts_duration - Get the duration field for an RTS frame
2376 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002377 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002378 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002379 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002380 *
2381 * If the RTS is generated in firmware, but the host system must provide
2382 * the duration field, the low-level driver uses this function to receive
2383 * the duration field value in little-endian byteorder.
2384 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002385__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2386 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002387 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002388
2389/**
2390 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2391 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002392 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002393 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2394 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002395 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002396 * @cts: The buffer where to store the CTS-to-self frame.
2397 *
2398 * If the CTS-to-self frames are generated by the host system (i.e., not in
2399 * hardware/firmware), the low-level driver uses this function to receive
2400 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2401 * for calling this function before and CTS-to-self frame is needed.
2402 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002403void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2404 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002405 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002406 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002407 struct ieee80211_cts *cts);
2408
2409/**
2410 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2411 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002412 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002413 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
Johannes Berge039fa42008-05-15 12:55:29 +02002414 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002415 *
2416 * If the CTS-to-self is generated in firmware, but the host system must provide
2417 * the duration field, the low-level driver uses this function to receive
2418 * the duration field value in little-endian byteorder.
2419 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002420__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2421 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002422 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002423 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002424
2425/**
2426 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2427 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002428 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002429 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002430 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07002431 *
2432 * Calculate the duration field of some generic frame, given its
2433 * length and transmission rate (in 100kbps).
2434 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002435__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2436 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002437 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002438 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07002439
2440/**
2441 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2442 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002443 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002444 *
2445 * Function for accessing buffered broadcast and multicast frames. If
2446 * hardware/firmware does not implement buffering of broadcast/multicast
2447 * frames when power saving is used, 802.11 code buffers them in the host
2448 * memory. The low-level driver uses this function to fetch next buffered
2449 * frame. In most cases, this is used when generating beacon frame. This
2450 * function returns a pointer to the next buffered skb or NULL if no more
2451 * buffered frames are available.
2452 *
2453 * Note: buffered frames are returned only after DTIM beacon frame was
2454 * generated with ieee80211_beacon_get() and the low-level driver must thus
2455 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2456 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2457 * does not need to check for DTIM beacons separately and should be able to
2458 * use common code for all beacons.
2459 */
2460struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002461ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07002462
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002463/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002464 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2465 *
2466 * This function computes a TKIP rc4 key for an skb. It computes
2467 * a phase 1 key if needed (iv16 wraps around). This function is to
2468 * be used by drivers which can do HW encryption but need to compute
2469 * to phase 1/2 key in SW.
2470 *
2471 * @keyconf: the parameter passed with the set key
2472 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002473 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002474 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002475 */
2476void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2477 struct sk_buff *skb,
2478 enum ieee80211_tkip_key_type type, u8 *key);
2479/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002480 * ieee80211_wake_queue - wake specific queue
2481 * @hw: pointer as obtained from ieee80211_alloc_hw().
2482 * @queue: queue number (counted from zero).
2483 *
2484 * Drivers should use this function instead of netif_wake_queue.
2485 */
2486void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2487
2488/**
2489 * ieee80211_stop_queue - stop specific queue
2490 * @hw: pointer as obtained from ieee80211_alloc_hw().
2491 * @queue: queue number (counted from zero).
2492 *
2493 * Drivers should use this function instead of netif_stop_queue.
2494 */
2495void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2496
2497/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002498 * ieee80211_queue_stopped - test status of the queue
2499 * @hw: pointer as obtained from ieee80211_alloc_hw().
2500 * @queue: queue number (counted from zero).
2501 *
2502 * Drivers should use this function instead of netif_stop_queue.
2503 */
2504
2505int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2506
2507/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002508 * ieee80211_stop_queues - stop all queues
2509 * @hw: pointer as obtained from ieee80211_alloc_hw().
2510 *
2511 * Drivers should use this function instead of netif_stop_queue.
2512 */
2513void ieee80211_stop_queues(struct ieee80211_hw *hw);
2514
2515/**
2516 * ieee80211_wake_queues - wake all queues
2517 * @hw: pointer as obtained from ieee80211_alloc_hw().
2518 *
2519 * Drivers should use this function instead of netif_wake_queue.
2520 */
2521void ieee80211_wake_queues(struct ieee80211_hw *hw);
2522
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002523/**
2524 * ieee80211_scan_completed - completed hardware scan
2525 *
2526 * When hardware scan offload is used (i.e. the hw_scan() callback is
2527 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02002528 * mac80211 that the scan finished. This function can be called from
2529 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002530 *
2531 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002532 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002533 */
Johannes Berg2a519312009-02-10 21:25:55 +01002534void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07002535
Johannes Bergdabeb342007-11-09 01:57:29 +01002536/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002537 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002538 *
2539 * This function iterates over the interfaces associated with a given
2540 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002541 * This function allows the iterator function to sleep, when the iterator
2542 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2543 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02002544 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01002545 *
2546 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002547 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002548 * @data: first argument of the iterator function
2549 */
2550void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2551 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002552 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002553 void *data);
2554
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002555/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002556 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2557 *
2558 * This function iterates over the interfaces associated with a given
2559 * hardware that are currently active and calls the callback for them.
2560 * This function requires the iterator callback function to be atomic,
2561 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02002562 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002563 *
2564 * @hw: the hardware struct of which the interfaces should be iterated over
2565 * @iterator: the iterator function to call, cannot sleep
2566 * @data: first argument of the iterator function
2567 */
2568void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2569 void (*iterator)(void *data,
2570 u8 *mac,
2571 struct ieee80211_vif *vif),
2572 void *data);
2573
2574/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002575 * ieee80211_queue_work - add work onto the mac80211 workqueue
2576 *
2577 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2578 * This helper ensures drivers are not queueing work when they should not be.
2579 *
2580 * @hw: the hardware struct for the interface we are adding work for
2581 * @work: the work we want to add onto the mac80211 workqueue
2582 */
2583void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2584
2585/**
2586 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2587 *
2588 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2589 * workqueue.
2590 *
2591 * @hw: the hardware struct for the interface we are adding work for
2592 * @dwork: delayable work to queue onto the mac80211 workqueue
2593 * @delay: number of jiffies to wait before queueing
2594 */
2595void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2596 struct delayed_work *dwork,
2597 unsigned long delay);
2598
2599/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002600 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002601 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002602 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302603 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002604 *
2605 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002606 *
2607 * Although mac80211/low level driver/user space application can estimate
2608 * the need to start aggregation on a certain RA/TID, the session level
2609 * will be managed by the mac80211.
2610 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302611int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2612 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002613
2614/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002615 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002616 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002617 * @ra: receiver address of the BA session recipient.
2618 * @tid: the TID to BA on.
2619 *
2620 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002621 * finished with preparations for the BA session. It can be called
2622 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002623 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002624void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002625 u16 tid);
2626
2627/**
2628 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002629 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002630 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002631 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02002632 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002633 *
2634 * Although mac80211/low level driver/user space application can estimate
2635 * the need to stop aggregation on a certain RA/TID, the session level
2636 * will be managed by the mac80211.
2637 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02002638int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002639
2640/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002641 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002642 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002643 * @ra: receiver address of the BA session recipient.
2644 * @tid: the desired TID to BA on.
2645 *
2646 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002647 * finished with preparations for the BA session tear down. It
2648 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002649 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002650void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002651 u16 tid);
2652
Mohamed Abbas84363e62008-04-04 16:59:58 -07002653/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002654 * ieee80211_find_sta - find a station
2655 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002656 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002657 * @addr: station's address
2658 *
2659 * This function must be called under RCU lock and the
2660 * resulting pointer is only valid under RCU lock as well.
2661 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002662struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002663 const u8 *addr);
2664
Kalle Valo04de8382009-03-22 21:57:35 +02002665/**
Ben Greear686b9cb2010-09-23 09:44:36 -07002666 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01002667 *
2668 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07002669 * @addr: remote station's address
2670 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002671 *
2672 * This function must be called under RCU lock and the
2673 * resulting pointer is only valid under RCU lock as well.
2674 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002675 * NOTE: You may pass NULL for localaddr, but then you will just get
2676 * the first STA that matches the remote address 'addr'.
2677 * We can have multiple STA associated with multiple
2678 * logical stations (e.g. consider a station connecting to another
2679 * BSSID on the same AP hardware without disconnecting first).
2680 * In this case, the result of this method with localaddr NULL
2681 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002682 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002683 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002684 */
Ben Greear686b9cb2010-09-23 09:44:36 -07002685struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2686 const u8 *addr,
2687 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01002688
2689/**
Johannes Bergaf818582009-11-06 11:35:50 +01002690 * ieee80211_sta_block_awake - block station from waking up
2691 * @hw: the hardware
2692 * @pubsta: the station
2693 * @block: whether to block or unblock
2694 *
2695 * Some devices require that all frames that are on the queues
2696 * for a specific station that went to sleep are flushed before
2697 * a poll response or frames after the station woke up can be
2698 * delivered to that it. Note that such frames must be rejected
2699 * by the driver as filtered, with the appropriate status flag.
2700 *
2701 * This function allows implementing this mode in a race-free
2702 * manner.
2703 *
2704 * To do this, a driver must keep track of the number of frames
2705 * still enqueued for a specific station. If this number is not
2706 * zero when the station goes to sleep, the driver must call
2707 * this function to force mac80211 to consider the station to
2708 * be asleep regardless of the station's actual state. Once the
2709 * number of outstanding frames reaches zero, the driver must
2710 * call this function again to unblock the station. That will
2711 * cause mac80211 to be able to send ps-poll responses, and if
2712 * the station queried in the meantime then frames will also
2713 * be sent out as a result of this. Additionally, the driver
2714 * will be notified that the station woke up some time after
2715 * it is unblocked, regardless of whether the station actually
2716 * woke up while blocked or not.
2717 */
2718void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2719 struct ieee80211_sta *pubsta, bool block);
2720
2721/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02002722 * ieee80211_ap_probereq_get - retrieve a Probe Request template
2723 * @hw: pointer obtained from ieee80211_alloc_hw().
2724 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2725 *
2726 * Creates a Probe Request template which can, for example, be uploaded to
2727 * hardware. The template is filled with bssid, ssid and supported rate
2728 * information. This function must only be called from within the
2729 * .bss_info_changed callback function and only in managed mode. The function
2730 * is only useful when the interface is associated, otherwise it will return
2731 * NULL.
2732 */
2733struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
2734 struct ieee80211_vif *vif);
2735
2736/**
Kalle Valo04de8382009-03-22 21:57:35 +02002737 * ieee80211_beacon_loss - inform hardware does not receive beacons
2738 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002739 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002740 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002741 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002742 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02002743 * hardware is not receiving beacons with this function.
2744 */
2745void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002746
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002747/**
2748 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2749 *
2750 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2751 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002752 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002753 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2754 * needs to inform if the connection to the AP has been lost.
2755 *
2756 * This function will cause immediate change to disassociated state,
2757 * without connection recovery attempts.
2758 */
2759void ieee80211_connection_loss(struct ieee80211_vif *vif);
2760
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002761/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03002762 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2763 *
2764 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2765 *
2766 * Some hardware require full power save to manage simultaneous BT traffic
2767 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2768 * burst of BT traffic. The hardware gets information of BT traffic via
2769 * hardware co-existence lines, and consequentially requests mac80211 to
2770 * (temporarily) enter full psm.
2771 * This function will only temporarily disable dynamic PS, not enable PSM if
2772 * it was not already enabled.
2773 * The driver must make sure to re-enable dynamic PS using
2774 * ieee80211_enable_dyn_ps() if the driver has disabled it.
2775 *
2776 */
2777void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2778
2779/**
2780 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2781 *
2782 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2783 *
2784 * This function restores dynamic PS after being temporarily disabled via
2785 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2786 * be coupled with an eventual call to this function.
2787 *
2788 */
2789void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2790
2791/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002792 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2793 * rssi threshold triggered
2794 *
2795 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2796 * @rssi_event: the RSSI trigger event type
2797 * @gfp: context flags
2798 *
2799 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2800 * monitoring is configured with an rssi threshold, the driver will inform
2801 * whenever the rssi level reaches the threshold.
2802 */
2803void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2804 enum nl80211_cqm_rssi_threshold_event rssi_event,
2805 gfp_t gfp);
2806
Johannes Berg5ce6e432010-05-11 16:20:57 +02002807/**
2808 * ieee80211_chswitch_done - Complete channel switch process
2809 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2810 * @success: make the channel switch successful or not
2811 *
2812 * Complete the channel switch post-process: set the new operational channel
2813 * and wake up the suspended queues.
2814 */
2815void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2816
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002817/**
2818 * ieee80211_request_smps - request SM PS transition
2819 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02002820 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002821 *
2822 * This allows the driver to request an SM PS transition in managed
2823 * mode. This is useful when the driver has more information than
2824 * the stack about possible interference, for example by bluetooth.
2825 */
2826void ieee80211_request_smps(struct ieee80211_vif *vif,
2827 enum ieee80211_smps_mode smps_mode);
2828
Johannes Berge31b8212010-10-05 19:39:30 +02002829/**
2830 * ieee80211_key_removed - disable hw acceleration for key
2831 * @key_conf: The key hw acceleration should be disabled for
2832 *
2833 * This allows drivers to indicate that the given key has been
2834 * removed from hardware acceleration, due to a new key that
2835 * was added. Don't use this if the key can continue to be used
2836 * for TX, if the key restriction is on RX only it is permitted
2837 * to keep the key for TX only and not call this function.
2838 *
2839 * Due to locking constraints, it may only be called during
2840 * @set_key. This function must be allowed to sleep, and the
2841 * key it tries to disable may still be used until it returns.
2842 */
2843void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
2844
Johannes Berg21f83582010-12-18 17:20:47 +01002845/**
2846 * ieee80211_ready_on_channel - notification of remain-on-channel start
2847 * @hw: pointer as obtained from ieee80211_alloc_hw()
2848 */
2849void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
2850
2851/**
2852 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
2853 * @hw: pointer as obtained from ieee80211_alloc_hw()
2854 */
2855void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
2856
Johannes Berg4b7679a2008-09-18 18:14:18 +02002857/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002858
Johannes Berg4b7679a2008-09-18 18:14:18 +02002859/**
Sujith81cb7622009-02-12 11:38:37 +05302860 * enum rate_control_changed - flags to indicate which parameter changed
2861 *
2862 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2863 * changed, rate control algorithm can update its internal state if needed.
2864 */
2865enum rate_control_changed {
2866 IEEE80211_RC_HT_CHANGED = BIT(0)
2867};
2868
2869/**
Johannes Berge6a98542008-10-21 12:40:02 +02002870 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002871 *
Johannes Berge6a98542008-10-21 12:40:02 +02002872 * @hw: The hardware the algorithm is invoked for.
2873 * @sband: The band this frame is being transmitted on.
2874 * @bss_conf: the current BSS configuration
2875 * @reported_rate: The rate control algorithm can fill this in to indicate
2876 * which rate should be reported to userspace as the current rate and
2877 * used for rate calculations in the mesh network.
2878 * @rts: whether RTS will be used for this frame because it is longer than the
2879 * RTS threshold
2880 * @short_preamble: whether mac80211 will request short-preamble transmission
2881 * if the selected rate supports it
2882 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002883 * (deprecated; this will be removed once drivers get updated to use
2884 * rate_idx_mask)
2885 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002886 * @skb: the skb that will be transmitted, the control information in it needs
2887 * to be filled in
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002888 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002889 */
Johannes Berge6a98542008-10-21 12:40:02 +02002890struct ieee80211_tx_rate_control {
2891 struct ieee80211_hw *hw;
2892 struct ieee80211_supported_band *sband;
2893 struct ieee80211_bss_conf *bss_conf;
2894 struct sk_buff *skb;
2895 struct ieee80211_tx_rate reported_rate;
2896 bool rts, short_preamble;
2897 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002898 u32 rate_idx_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002899 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002900};
2901
2902struct rate_control_ops {
2903 struct module *module;
2904 const char *name;
2905 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002906 void (*free)(void *priv);
2907
2908 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2909 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2910 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302911 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2912 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302913 void *priv_sta, u32 changed,
2914 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002915 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2916 void *priv_sta);
2917
2918 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2919 struct ieee80211_sta *sta, void *priv_sta,
2920 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002921 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2922 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002923
2924 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2925 struct dentry *dir);
2926 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2927};
2928
2929static inline int rate_supported(struct ieee80211_sta *sta,
2930 enum ieee80211_band band,
2931 int index)
2932{
2933 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2934}
2935
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002936/**
2937 * rate_control_send_low - helper for drivers for management/no-ack frames
2938 *
2939 * Rate control algorithms that agree to use the lowest rate to
2940 * send management frames and NO_ACK data with the respective hw
2941 * retries should use this in the beginning of their mac80211 get_rate
2942 * callback. If true is returned the rate control can simply return.
2943 * If false is returned we guarantee that sta and sta and priv_sta is
2944 * not null.
2945 *
2946 * Rate control algorithms wishing to do more intelligent selection of
2947 * rate for multicast/broadcast frames may choose to not use this.
2948 *
2949 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2950 * that this may be null.
2951 * @priv_sta: private rate control structure. This may be null.
2952 * @txrc: rate control information we sholud populate for mac80211.
2953 */
2954bool rate_control_send_low(struct ieee80211_sta *sta,
2955 void *priv_sta,
2956 struct ieee80211_tx_rate_control *txrc);
2957
2958
Johannes Berg4b7679a2008-09-18 18:14:18 +02002959static inline s8
2960rate_lowest_index(struct ieee80211_supported_band *sband,
2961 struct ieee80211_sta *sta)
2962{
2963 int i;
2964
2965 for (i = 0; i < sband->n_bitrates; i++)
2966 if (rate_supported(sta, sband->band, i))
2967 return i;
2968
2969 /* warn when we cannot find a rate. */
2970 WARN_ON(1);
2971
2972 return 0;
2973}
2974
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002975static inline
2976bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2977 struct ieee80211_sta *sta)
2978{
2979 unsigned int i;
2980
2981 for (i = 0; i < sband->n_bitrates; i++)
2982 if (rate_supported(sta, sband->band, i))
2983 return true;
2984 return false;
2985}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002986
2987int ieee80211_rate_control_register(struct rate_control_ops *ops);
2988void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2989
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002990static inline bool
2991conf_is_ht20(struct ieee80211_conf *conf)
2992{
Johannes Berg47979382009-01-07 10:13:27 +01002993 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002994}
2995
2996static inline bool
2997conf_is_ht40_minus(struct ieee80211_conf *conf)
2998{
Johannes Berg47979382009-01-07 10:13:27 +01002999 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003000}
3001
3002static inline bool
3003conf_is_ht40_plus(struct ieee80211_conf *conf)
3004{
Johannes Berg47979382009-01-07 10:13:27 +01003005 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003006}
3007
3008static inline bool
3009conf_is_ht40(struct ieee80211_conf *conf)
3010{
3011 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3012}
3013
3014static inline bool
3015conf_is_ht(struct ieee80211_conf *conf)
3016{
Johannes Berg47979382009-01-07 10:13:27 +01003017 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003018}
3019
Johannes Berg2ca27bc2010-09-16 14:58:23 +02003020static inline enum nl80211_iftype
3021ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3022{
3023 if (p2p) {
3024 switch (type) {
3025 case NL80211_IFTYPE_STATION:
3026 return NL80211_IFTYPE_P2P_CLIENT;
3027 case NL80211_IFTYPE_AP:
3028 return NL80211_IFTYPE_P2P_GO;
3029 default:
3030 break;
3031 }
3032 }
3033 return type;
3034}
3035
3036static inline enum nl80211_iftype
3037ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3038{
3039 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3040}
3041
Jiri Bencf0706e822007-05-05 11:45:53 -07003042#endif /* MAC80211_H */