blob: 9fdf982d1286a95c02a73bae4131746f05de9343 [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 Berg6b301cd2007-09-18 17:29:20 -0400100 * struct ieee80211_tx_queue_params - transmit queue configuration
101 *
102 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400104 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400105 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200106 * @cw_min: minimum contention window [a value of the form
107 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400108 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200110 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700112struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200113 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100114 u16 cw_min;
115 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200116 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200117 bool uapsd;
Jiri Bencf0706e822007-05-05 11:45:53 -0700118};
119
Jiri Bencf0706e822007-05-05 11:45:53 -0700120struct ieee80211_low_level_stats {
121 unsigned int dot11ACKFailureCount;
122 unsigned int dot11RTSFailureCount;
123 unsigned int dot11FCSErrorCount;
124 unsigned int dot11RTSSuccessCount;
125};
126
Johannes Berg471b3ef2007-12-28 14:32:58 +0100127/**
128 * enum ieee80211_bss_change - BSS change notification flags
129 *
130 * These flags are used with the bss_info_changed() callback
131 * to indicate which BSS parameter changed.
132 *
133 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134 * also implies a change in the AID.
135 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300137 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700138 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200139 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200140 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200141 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
142 * reason (IBSS and managed mode)
143 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144 * new beacon (beaconing modes)
145 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200147 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200148 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300149 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200150 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
151 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200152 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100153 */
154enum ieee80211_bss_change {
155 BSS_CHANGED_ASSOC = 1<<0,
156 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
157 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300158 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700159 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200160 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200161 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200162 BSS_CHANGED_BSSID = 1<<7,
163 BSS_CHANGED_BEACON = 1<<8,
164 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200165 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200166 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300167 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200168 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200169 BSS_CHANGED_IDLE = 1<<14,
Johannes Bergac8dd502010-05-05 09:44:02 +0200170
171 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100172};
173
Juuso Oikarinen68542962010-06-09 13:43:26 +0300174/*
175 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
176 * of addresses for an interface increase beyond this value, hardware ARP
177 * filtering will be disabled.
178 */
179#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
180
Johannes Berg471b3ef2007-12-28 14:32:58 +0100181/**
182 * struct ieee80211_bss_conf - holds the BSS's changing parameters
183 *
184 * This structure keeps information about a BSS (and an association
185 * to that BSS) that can change during the lifetime of the BSS.
186 *
187 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200188 * @ibss_joined: indicates whether this station is part of an IBSS
189 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100190 * @aid: association ID number, valid only when @assoc is true
191 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200192 * @use_short_preamble: use 802.11b short preamble;
193 * if the hardware cannot handle this it must set the
194 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
195 * @use_short_slot: use short slot time (only relevant for ERP);
196 * if the hardware cannot handle this it must set the
197 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100198 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Johannes Berge5b900d2010-07-29 16:08:55 +0200199 * valid in station mode only while @assoc is true and if also
200 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
201 * @ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700202 * @timestamp: beacon timestamp
203 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800204 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200205 * @basic_rates: bitmap of basic rates, each bit stands for an
206 * index into the rate table configured by the driver in
207 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200208 * @bssid: The BSSID for this BSS
209 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200210 * @channel_type: Channel type for this BSS -- the hardware might be
211 * configured for HT40+ while this BSS only uses no-HT, for
212 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200213 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
214 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200215 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
216 * implies disabled
217 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300218 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
219 * may filter ARP queries targeted for other addresses than listed here.
220 * The driver must allow ARP queries targeted for all address listed here
221 * to pass through. An empty list implies no ARP queries need to pass.
222 * @arp_addr_cnt: Number of addresses currently on the list.
223 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
224 * filter ARP queries based on the @arp_addr_list, if disabled, the
225 * hardware must not perform any ARP filtering. Note, that the filter will
226 * be enabled also in promiscuous mode.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200227 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200228 * @idle: This interface is idle. There's also a global idle flag in the
229 * hardware config which may be more appropriate depending on what
230 * your driver/device needs to do.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100231 */
232struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200233 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100234 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200235 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100236 u16 aid;
237 /* erp related data */
238 bool use_cts_prot;
239 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300240 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200241 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800242 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700243 u16 beacon_int;
244 u16 assoc_capability;
245 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100246 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200247 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200248 s32 cqm_rssi_thold;
249 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200250 enum nl80211_channel_type channel_type;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300251 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
252 u8 arp_addr_cnt;
253 bool arp_filter_enabled;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200254 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200255 bool idle;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100256};
257
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800258/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700259 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800260 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700261 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800262 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100263 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200264 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
265 * number to this frame, taking care of not overwriting the fragment
266 * number and increasing the sequence number only when the
267 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
268 * assign sequence numbers to QoS-data frames but cannot do so correctly
269 * for non-QoS-data and management frames because beacons need them from
270 * that counter as well and mac80211 cannot guarantee proper sequencing.
271 * If this flag is set, the driver should instruct the hardware to
272 * assign a sequence number to the frame or assign one itself. Cf. IEEE
273 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
274 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200275 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200276 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
277 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200278 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200279 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
280 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200281 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200282 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200283 * because the destination STA was in powersave mode. Note that to
284 * avoid race conditions, the filter must be set by the hardware or
285 * firmware upon receiving a frame that indicates that the station
286 * went to sleep (must be done on device to filter frames already on
287 * the queue) and may only be unset after mac80211 gives the OK for
288 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
289 * since only then is it guaranteed that no more frames are in the
290 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200291 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
292 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
293 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300294 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
295 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200296 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
297 * set by rate control algorithms to indicate probe rate, will
298 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100299 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
300 * used to indicate that a pending frame requires TX processing before
301 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200302 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
303 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200304 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
305 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200306 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
307 * This frame is a response to a PS-poll frame and should be sent
308 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200309 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
310 * transmit function after the current frame, this can be used
311 * by drivers to kick the DMA queue only if unset or when the
312 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100313 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
314 * after TX status because the destination was asleep, it must not
315 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100316 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
317 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200318 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
319 * MLME command (internal to mac80211 to figure out whether to send TX
320 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400321 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200322 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
323 * frame and selects the maximum number of streams that it can use.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200324 *
325 * Note: If you have to add new flags to the enumeration, then don't
326 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800327 */
328enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200329 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200330 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
331 IEEE80211_TX_CTL_NO_ACK = BIT(2),
332 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
333 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
334 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
335 IEEE80211_TX_CTL_AMPDU = BIT(6),
336 IEEE80211_TX_CTL_INJECTED = BIT(7),
337 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
338 IEEE80211_TX_STAT_ACK = BIT(9),
339 IEEE80211_TX_STAT_AMPDU = BIT(10),
340 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
341 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100342 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200343 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200344 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200345 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200346 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100347 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100348 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200349 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400350 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200351 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berge6a98542008-10-21 12:40:02 +0200352};
353
Johannes Bergabe37c42010-06-07 11:12:27 +0200354#define IEEE80211_TX_CTL_STBC_SHIFT 23
355
Christian Lampartereb7d3062010-09-21 21:36:18 +0200356/*
357 * This definition is used as a mask to clear all temporary flags, which are
358 * set by the tx handlers for each transmission attempt by the mac80211 stack.
359 */
360#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
361 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
362 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
363 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
364 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
365 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
366 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
367 IEEE80211_TX_CTL_STBC)
368
Sujith2134e7e2009-01-22 09:00:52 +0530369/**
370 * enum mac80211_rate_control_flags - per-rate flags set by the
371 * Rate Control algorithm.
372 *
373 * These flags are set by the Rate control algorithm for each rate during tx,
374 * in the @flags member of struct ieee80211_tx_rate.
375 *
376 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
377 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
378 * This is set if the current BSS requires ERP protection.
379 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
380 * @IEEE80211_TX_RC_MCS: HT rate.
381 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
382 * Greenfield mode.
383 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
384 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
385 * adjacent 20 MHz channels, if the current channel type is
386 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
387 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
388 */
Johannes Berge6a98542008-10-21 12:40:02 +0200389enum mac80211_rate_control_flags {
390 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
391 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
392 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
393
394 /* rate index is an MCS rate number instead of an index */
395 IEEE80211_TX_RC_MCS = BIT(3),
396 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
397 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
398 IEEE80211_TX_RC_DUP_DATA = BIT(6),
399 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800400};
401
Johannes Berge039fa42008-05-15 12:55:29 +0200402
Johannes Berge6a98542008-10-21 12:40:02 +0200403/* there are 40 bytes if you don't need the rateset to be kept */
404#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200405
Johannes Berge6a98542008-10-21 12:40:02 +0200406/* if you do need the rateset, then you have less space */
407#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
408
409/* maximum number of rate stages */
410#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200411
412/**
Johannes Berge6a98542008-10-21 12:40:02 +0200413 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200414 *
Johannes Berge6a98542008-10-21 12:40:02 +0200415 * @idx: rate index to attempt to send with
416 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200417 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200418 *
419 * A value of -1 for @idx indicates an invalid rate and, if used
420 * in an array of retry rates, that no more rates should be tried.
421 *
422 * When used for transmit status reporting, the driver should
423 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200424 *
425 * &struct ieee80211_tx_info contains an array of these structs
426 * in the control information, and it will be filled by the rate
427 * control algorithm according to what should be sent. For example,
428 * if this array contains, in the format { <idx>, <count> } the
429 * information
430 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
431 * then this means that the frame should be transmitted
432 * up to twice at rate 3, up to twice at rate 2, and up to four
433 * times at rate 1 if it doesn't get acknowledged. Say it gets
434 * acknowledged by the peer after the fifth attempt, the status
435 * information should then contain
436 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
437 * since it was transmitted twice at rate 3, twice at rate 2
438 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200439 */
Johannes Berge6a98542008-10-21 12:40:02 +0200440struct ieee80211_tx_rate {
441 s8 idx;
442 u8 count;
443 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000444} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200445
Johannes Berge039fa42008-05-15 12:55:29 +0200446/**
447 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200448 *
Johannes Berge039fa42008-05-15 12:55:29 +0200449 * This structure is placed in skb->cb for three uses:
450 * (1) mac80211 TX control - mac80211 tells the driver what to do
451 * (2) driver internal use (if applicable)
452 * (3) TX status information - driver tells mac80211 what happened
453 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200454 * The TX control's sta pointer is only valid during the ->tx call,
455 * it may be NULL.
456 *
Johannes Berge039fa42008-05-15 12:55:29 +0200457 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200458 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200459 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200460 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700461 * @control: union for control data
462 * @status: union for status data
463 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100464 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700465 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100466 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700467 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200468 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200469 */
Johannes Berge039fa42008-05-15 12:55:29 +0200470struct ieee80211_tx_info {
471 /* common information */
472 u32 flags;
473 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200474
Johannes Berge039fa42008-05-15 12:55:29 +0200475 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100476
Johannes Berge6a98542008-10-21 12:40:02 +0200477 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500478 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100479
Johannes Berge039fa42008-05-15 12:55:29 +0200480 union {
481 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200482 union {
483 /* rate control */
484 struct {
485 struct ieee80211_tx_rate rates[
486 IEEE80211_TX_MAX_RATES];
487 s8 rts_cts_rate_idx;
488 };
489 /* only needed before rate control */
490 unsigned long jiffies;
491 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200492 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200493 struct ieee80211_vif *vif;
494 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200495 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200496 } control;
497 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200498 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
499 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200500 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100501 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200502 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200503 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200504 struct {
505 struct ieee80211_tx_rate driver_rates[
506 IEEE80211_TX_MAX_RATES];
507 void *rate_driver_data[
508 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
509 };
510 void *driver_data[
511 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200512 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700513};
514
Johannes Berge039fa42008-05-15 12:55:29 +0200515static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
516{
517 return (struct ieee80211_tx_info *)skb->cb;
518}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400519
Johannes Bergf1d58c22009-06-17 13:13:00 +0200520static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
521{
522 return (struct ieee80211_rx_status *)skb->cb;
523}
524
Johannes Berge6a98542008-10-21 12:40:02 +0200525/**
526 * ieee80211_tx_info_clear_status - clear TX status
527 *
528 * @info: The &struct ieee80211_tx_info to be cleared.
529 *
530 * When the driver passes an skb back to mac80211, it must report
531 * a number of things in TX status. This function clears everything
532 * in the TX status but the rate control information (it does clear
533 * the count since you need to fill that in anyway).
534 *
535 * NOTE: You can only use this function if you do NOT use
536 * info->driver_data! Use info->rate_driver_data
537 * instead if you need only the less space that allows.
538 */
539static inline void
540ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
541{
542 int i;
543
544 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
545 offsetof(struct ieee80211_tx_info, control.rates));
546 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
547 offsetof(struct ieee80211_tx_info, driver_rates));
548 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
549 /* clear the rate counts */
550 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
551 info->status.rates[i].count = 0;
552
553 BUILD_BUG_ON(
554 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
555 memset(&info->status.ampdu_ack_len, 0,
556 sizeof(struct ieee80211_tx_info) -
557 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
558}
559
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400560
561/**
562 * enum mac80211_rx_flags - receive flags
563 *
564 * These flags are used with the @flag member of &struct ieee80211_rx_status.
565 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
566 * Use together with %RX_FLAG_MMIC_STRIPPED.
567 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400568 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
569 * verification has been done by the hardware.
570 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
571 * If this flag is set, the stack cannot do any replay detection
572 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400573 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
574 * the frame.
575 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
576 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100577 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900578 * is valid. This is useful in monitor mode and necessary for beacon frames
579 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200580 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200581 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
582 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
583 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400584 */
585enum mac80211_rx_flags {
586 RX_FLAG_MMIC_ERROR = 1<<0,
587 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400588 RX_FLAG_MMIC_STRIPPED = 1<<3,
589 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400590 RX_FLAG_FAILED_FCS_CRC = 1<<5,
591 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100592 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200593 RX_FLAG_SHORTPRE = 1<<8,
594 RX_FLAG_HT = 1<<9,
595 RX_FLAG_40MHZ = 1<<10,
596 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400597};
598
599/**
600 * struct ieee80211_rx_status - receive status
601 *
602 * The low-level driver should provide this information (the subset
603 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200604 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200605 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900606 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
607 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100608 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400609 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200610 * @signal: signal strength when receiving this frame, either in dBm, in dB or
611 * unspecified depending on the hardware capabilities flags
612 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400613 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200614 * @rate_idx: index of data rate into band's supported rates or MCS index if
615 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400616 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200617 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400618 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700619struct ieee80211_rx_status {
620 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100621 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400622 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400623 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700624 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100625 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700626 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200627 unsigned int rx_flags;
Jiri Bencf0706e822007-05-05 11:45:53 -0700628};
629
Johannes Berg6b301cd2007-09-18 17:29:20 -0400630/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400631 * enum ieee80211_conf_flags - configuration flags
632 *
633 * Flags to define PHY configuration options
634 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100635 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
636 * to determine for example whether to calculate timestamps for packets
637 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200638 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
639 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
640 * meaning that the hardware still wakes up for beacons, is able to
641 * transmit frames and receive the possible acknowledgment frames.
642 * Not to be confused with hardware specific wakeup/sleep states,
643 * driver is responsible for that. See the section "Powersave support"
644 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200645 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
646 * the driver should be prepared to handle configuration requests but
647 * may turn the device off as much as possible. Typically, this flag will
648 * be set when an interface is set UP but not associated or scanning, but
649 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200650 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
651 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400652 */
653enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100654 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200655 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200656 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200657 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400658};
Jiri Bencf0706e822007-05-05 11:45:53 -0700659
Johannes Berg7a5158e2008-10-08 10:59:33 +0200660
Jiri Bencf0706e822007-05-05 11:45:53 -0700661/**
Johannes Berge8975582008-10-09 12:18:51 +0200662 * enum ieee80211_conf_changed - denotes which configuration changed
663 *
Johannes Berge8975582008-10-09 12:18:51 +0200664 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100665 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200666 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200667 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100668 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200669 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200670 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100671 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200672 */
673enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100674 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200675 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100676 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200677 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200678 IEEE80211_CONF_CHANGE_POWER = BIT(5),
679 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
680 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200681 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200682};
683
684/**
Johannes Berg0f782312009-12-01 13:37:02 +0100685 * enum ieee80211_smps_mode - spatial multiplexing power save mode
686 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200687 * @IEEE80211_SMPS_AUTOMATIC: automatic
688 * @IEEE80211_SMPS_OFF: off
689 * @IEEE80211_SMPS_STATIC: static
690 * @IEEE80211_SMPS_DYNAMIC: dynamic
691 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100692 */
693enum ieee80211_smps_mode {
694 IEEE80211_SMPS_AUTOMATIC,
695 IEEE80211_SMPS_OFF,
696 IEEE80211_SMPS_STATIC,
697 IEEE80211_SMPS_DYNAMIC,
698
699 /* keep last */
700 IEEE80211_SMPS_NUM_MODES,
701};
702
703/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700704 * struct ieee80211_conf - configuration of the device
705 *
706 * This struct indicates how the driver shall configure the hardware.
707 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200708 * @flags: configuration flags defined above
709 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800710 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200711 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200712 * before checking the beacon for a TIM bit (managed mode only); this
713 * value will be only achievable between DTIM frames, the hardware
714 * needs to check for the multicast traffic bit in DTIM beacons.
715 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100716 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
717 * in power saving. Power saving will not be enabled until a beacon
718 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200719 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
720 * powersave documentation below. This variable is valid only when
721 * the CONF_PS flag is set.
722 *
Johannes Berg8318d782008-01-24 19:38:38 +0100723 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200724 *
Johannes Berg8318d782008-01-24 19:38:38 +0100725 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100726 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200727 *
Johannes Berg9124b072008-10-14 19:17:54 +0200728 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
729 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
730 * but actually means the number of transmissions not the number of retries
731 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
732 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
733 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100734 *
735 * @smps_mode: spatial multiplexing powersave mode; note that
736 * %IEEE80211_SMPS_STATIC is used when the device is not
737 * configured for an HT channel
Jiri Bencf0706e822007-05-05 11:45:53 -0700738 */
739struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400740 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300741 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200742 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200743
Johannes Berge8975582008-10-09 12:18:51 +0200744 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100745 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200746
Johannes Berg9124b072008-10-14 19:17:54 +0200747 u8 long_frame_max_tx_count, short_frame_max_tx_count;
748
Johannes Berg8318d782008-01-24 19:38:38 +0100749 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100750 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100751 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e822007-05-05 11:45:53 -0700752};
753
754/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200755 * struct ieee80211_channel_switch - holds the channel switch data
756 *
757 * The information provided in this structure is required for channel switch
758 * operation.
759 *
760 * @timestamp: value in microseconds of the 64-bit Time Synchronization
761 * Function (TSF) timer when the frame containing the channel switch
762 * announcement was received. This is simply the rx.mactime parameter
763 * the driver passed into mac80211.
764 * @block_tx: Indicates whether transmission must be blocked before the
765 * scheduled channel switch, as indicated by the AP.
766 * @channel: the new channel to switch to
767 * @count: the number of TBTT's until the channel switch event
768 */
769struct ieee80211_channel_switch {
770 u64 timestamp;
771 bool block_tx;
772 struct ieee80211_channel *channel;
773 u8 count;
774};
775
776/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100777 * struct ieee80211_vif - per-interface data
778 *
779 * Data in this structure is continually present for driver
780 * use during the life of a virtual interface.
781 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100782 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200783 * @bss_conf: BSS configuration for this interface, either our own
784 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100785 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200786 * @p2p: indicates whether this AP or STA interface is a p2p
787 * interface, i.e. a GO or p2p-sta respectively
Johannes Berg32bfd352007-12-19 01:31:26 +0100788 * @drv_priv: data area for driver use, will always be aligned to
789 * sizeof(void *).
790 */
791struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200792 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200793 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100794 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200795 bool p2p;
Johannes Berg32bfd352007-12-19 01:31:26 +0100796 /* must be last */
797 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
798};
799
Johannes Berg902acc72008-02-23 15:17:19 +0100800static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
801{
802#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200803 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100804#endif
805 return false;
806}
807
Johannes Berg32bfd352007-12-19 01:31:26 +0100808/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400809 * enum ieee80211_key_flags - key flags
810 *
811 * These flags are used for communication about keys between the driver
812 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
813 *
814 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
815 * that the STA this key will be used with could be using QoS.
816 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
817 * driver to indicate that it requires IV generation for this
818 * particular key.
819 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
820 * the driver for a TKIP key if it requires Michael MIC
821 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200822 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
823 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200824 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
825 * CCMP key if it requires CCMP encryption of management frames (MFP) to
826 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400827 */
828enum ieee80211_key_flags {
829 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
830 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
831 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200832 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200833 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400834};
835
836/**
837 * struct ieee80211_key_conf - key information
838 *
839 * This key information is given by mac80211 to the driver by
840 * the set_key() callback in &struct ieee80211_ops.
841 *
842 * @hw_key_idx: To be set by the driver, this is the key index the driver
843 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400844 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200845 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400846 * @flags: key flags, see &enum ieee80211_key_flags.
847 * @keyidx: the key index (0-3)
848 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400849 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
850 * data block:
851 * - Temporal Encryption Key (128 bits)
852 * - Temporal Authenticator Tx MIC Key (64 bits)
853 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100854 * @icv_len: The ICV length for this key type
855 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400856 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700857struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200858 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200859 u8 icv_len;
860 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400861 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400862 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400863 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400864 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700865 u8 key[0];
866};
867
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400868/**
869 * enum set_key_cmd - key command
870 *
871 * Used with the set_key() callback in &struct ieee80211_ops, this
872 * indicates whether a key is being removed or added.
873 *
874 * @SET_KEY: a key is set
875 * @DISABLE_KEY: a key must be disabled
876 */
Johannes Bergea49c352007-09-18 17:29:21 -0400877enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400878 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400879};
Jiri Bencf0706e822007-05-05 11:45:53 -0700880
Tomas Winkler478f8d22007-09-30 13:52:37 +0200881/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200882 * struct ieee80211_sta - station table entry
883 *
884 * A station table entry represents a station we are possibly
885 * communicating with. Since stations are RCU-managed in
886 * mac80211, any ieee80211_sta pointer you get access to must
887 * either be protected by rcu_read_lock() explicitly or implicitly,
888 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100889 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200890 *
891 * @addr: MAC address
892 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200893 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200894 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200895 * @drv_priv: data area for driver use, will always be aligned to
896 * sizeof(void *), size is determined in hw information.
897 */
898struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100899 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200900 u8 addr[ETH_ALEN];
901 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200902 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200903
904 /* must be last */
905 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
906};
907
908/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200909 * enum sta_notify_cmd - sta notify command
910 *
911 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +0530912 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200913 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100914 * @STA_NOTIFY_SLEEP: a station is now sleeping
915 * @STA_NOTIFY_AWAKE: a sleeping station woke up
916 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100917enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100918 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
919};
920
921/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200922 * enum ieee80211_tkip_key_type - get tkip key
923 *
924 * Used by drivers which need to get a tkip key for skb. Some drivers need a
925 * phase 1 key, others need a phase 2 key. A single function allows the driver
926 * to get the key, this enum indicates what type of key is required.
927 *
928 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
929 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
930 */
931enum ieee80211_tkip_key_type {
932 IEEE80211_TKIP_P1_KEY,
933 IEEE80211_TKIP_P2_KEY,
934};
935
936/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400937 * enum ieee80211_hw_flags - hardware flags
938 *
939 * These flags are used to indicate hardware capabilities to
940 * the stack. Generally, flags here should have their meaning
941 * done in a way that the simplest hardware doesn't need setting
942 * any particular flags. There are some exceptions to this rule,
943 * however, so you are advised to review these flags carefully.
944 *
Johannes Bergaf65cd92009-11-17 18:18:36 +0100945 * @IEEE80211_HW_HAS_RATE_CONTROL:
946 * The hardware or firmware includes rate control, and cannot be
947 * controlled by the stack. As such, no rate control algorithm
948 * should be instantiated, and the TX rate reported to userspace
949 * will be taken from the TX status instead of the rate control
950 * algorithm.
951 * Note that this requires that the driver implement a number of
952 * callbacks so it has the correct information, it needs to have
953 * the @set_rts_threshold callback and must look at the BSS config
954 * @use_cts_prot for G/N protection, @use_short_slot for slot
955 * timing in 2.4 GHz and @use_short_preamble for preambles for
956 * CCK frames.
957 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400958 * @IEEE80211_HW_RX_INCLUDES_FCS:
959 * Indicates that received frames passed to the stack include
960 * the FCS at the end.
961 *
962 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
963 * Some wireless LAN chipsets buffer broadcast/multicast frames
964 * for power saving stations in the hardware/firmware and others
965 * rely on the host system for such buffering. This option is used
966 * to configure the IEEE 802.11 upper layer to buffer broadcast and
967 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700968 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400969 *
Johannes Berg8318d782008-01-24 19:38:38 +0100970 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
971 * Hardware is not capable of short slot operation on the 2.4 GHz band.
972 *
973 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
974 * Hardware is not capable of receiving frames with short preamble on
975 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200976 *
977 * @IEEE80211_HW_SIGNAL_UNSPEC:
978 * Hardware can provide signal values but we don't know its units. We
979 * expect values between 0 and @max_signal.
980 * If possible please provide dB or dBm instead.
981 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200982 * @IEEE80211_HW_SIGNAL_DBM:
983 * Hardware gives signal values in dBm, decibel difference from
984 * one milliwatt. This is the preferred method since it is standardized
985 * between different devices. @max_signal does not need to be set.
986 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300987 * @IEEE80211_HW_SPECTRUM_MGMT:
988 * Hardware supports spectrum management defined in 802.11h
989 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530990 *
991 * @IEEE80211_HW_AMPDU_AGGREGATION:
992 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200993 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100994 * @IEEE80211_HW_SUPPORTS_PS:
995 * Hardware has power save support (i.e. can go to sleep).
996 *
997 * @IEEE80211_HW_PS_NULLFUNC_STACK:
998 * Hardware requires nullfunc frame handling in stack, implies
999 * stack support for dynamic PS.
1000 *
1001 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1002 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001003 *
1004 * @IEEE80211_HW_MFP_CAPABLE:
1005 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001006 *
1007 * @IEEE80211_HW_BEACON_FILTER:
1008 * Hardware supports dropping of irrelevant beacon frames to
1009 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +01001010 *
1011 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1012 * Hardware supports static spatial multiplexing powersave,
1013 * ie. can turn off all but one chain even on HT connections
1014 * that should be using more chains.
1015 *
1016 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1017 * Hardware supports dynamic spatial multiplexing powersave,
1018 * ie. can turn off all but one chain and then wake the rest
1019 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001020 *
1021 * @IEEE80211_HW_SUPPORTS_UAPSD:
1022 * Hardware supports Unscheduled Automatic Power Save Delivery
1023 * (U-APSD) in managed mode. The mode is configured with
1024 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301025 *
1026 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1027 * Hardware can provide ack status reports of Tx frames to
1028 * the stack.
1029 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001030 * @IEEE80211_HW_CONNECTION_MONITOR:
1031 * The hardware performs its own connection monitoring, including
1032 * periodic keep-alives to the AP and probing the AP on beacon loss.
1033 * When this flag is set, signaling beacon-loss will cause an immediate
1034 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001035 *
1036 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1037 * Hardware can do connection quality monitoring - i.e. it can monitor
1038 * connection quality related parameters, such as the RSSI level and
1039 * provide notifications if configured trigger levels are reached.
1040 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001041 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1042 * This device needs to know the DTIM period for the BSS before
1043 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001044 *
1045 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1046 * per-station GTKs as used by IBSS RSN or during fast transition. If
1047 * the device doesn't support per-station GTKs, but can be asked not
1048 * to decrypt group addressed frames, then IBSS RSN support is still
1049 * possible but software crypto will be used. Advertise the wiphy flag
1050 * only in that case.
Johannes Berg1bc08262007-09-18 17:29:15 -04001051 */
1052enum ieee80211_hw_flags {
Johannes Bergaf65cd92009-11-17 18:18:36 +01001053 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001054 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1055 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001056 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1057 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001058 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001059 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001060 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001061 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1062 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1063 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1064 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1065 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1066 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001067 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001068 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1069 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001070 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301071 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001072 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001073 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001074 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Johannes Berg1bc08262007-09-18 17:29:15 -04001075};
1076
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001077/**
1078 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001079 *
1080 * This structure contains the configuration and hardware
1081 * information for an 802.11 PHY.
1082 *
1083 * @wiphy: This points to the &struct wiphy allocated for this
1084 * 802.11 PHY. You must fill in the @perm_addr and @dev
1085 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001086 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1087 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001088 *
1089 * @conf: &struct ieee80211_conf, device configuration, don't use.
1090 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001091 * @priv: pointer to private area that was allocated for driver use
1092 * along with this structure.
1093 *
1094 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1095 *
1096 * @extra_tx_headroom: headroom to reserve in each transmit skb
1097 * for use by the driver (e.g. for transmit headers.)
1098 *
1099 * @channel_change_time: time (in microseconds) it takes to change channels.
1100 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001101 * @max_signal: Maximum value for signal (rssi) in RX information, used
1102 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001103 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001104 * @max_listen_interval: max listen interval in units of beacon interval
1105 * that HW supports
1106 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001107 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001108 * data packets. WMM/QoS requires at least four, these
1109 * queues need to have configurable access parameters.
1110 *
Johannes Berg830f9032007-10-28 14:51:05 +01001111 * @rate_control_algorithm: rate control algorithm for this hardware.
1112 * If unset (NULL), the default algorithm will be used. Must be
1113 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001114 *
1115 * @vif_data_size: size (in bytes) of the drv_priv data area
1116 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001117 * @sta_data_size: size (in bytes) of the drv_priv data area
1118 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001119 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001120 * @max_rates: maximum number of alternate rate retry stages the hw
1121 * can handle.
1122 * @max_report_rates: maximum number of alternate rate retry stages
1123 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001124 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001125 *
1126 * @napi_weight: weight used for NAPI polling. You must specify an
1127 * appropriate value here if a napi_poll operation is provided
1128 * by your driver.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001129 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001130struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -07001131 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001132 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001133 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -07001134 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001135 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -07001136 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -07001137 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001138 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001139 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001140 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001141 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001142 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -07001143 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001144 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001145 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001146 u8 max_rate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -07001147};
1148
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001149/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001150 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1151 *
1152 * @wiphy: the &struct wiphy which we want to query
1153 *
1154 * mac80211 drivers can use this to get to their respective
1155 * &struct ieee80211_hw. Drivers wishing to get to their own private
1156 * structure can then access it via hw->priv. Note that mac802111 drivers should
1157 * not use wiphy_priv() to try to get their private driver structure as this
1158 * is already used internally by mac80211.
1159 */
1160struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1161
1162/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001163 * SET_IEEE80211_DEV - set device for 802.11 hardware
1164 *
1165 * @hw: the &struct ieee80211_hw to set the device for
1166 * @dev: the &struct device of this 802.11 device
1167 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001168static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1169{
1170 set_wiphy_dev(hw->wiphy, dev);
1171}
1172
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001173/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001174 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001175 *
1176 * @hw: the &struct ieee80211_hw to set the MAC address for
1177 * @addr: the address to set
1178 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001179static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1180{
1181 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1182}
1183
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001184static inline struct ieee80211_rate *
1185ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001186 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001187{
Johannes Berge6a98542008-10-21 12:40:02 +02001188 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001189 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001190 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001191}
1192
1193static inline struct ieee80211_rate *
1194ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001195 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001196{
Johannes Berge039fa42008-05-15 12:55:29 +02001197 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001198 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001199 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001200}
1201
1202static inline struct ieee80211_rate *
1203ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001204 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001205{
Johannes Berge6a98542008-10-21 12:40:02 +02001206 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001207 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001208 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001209}
1210
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001211/**
1212 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001213 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001214 * mac80211 is capable of taking advantage of many hardware
1215 * acceleration designs for encryption and decryption operations.
1216 *
1217 * The set_key() callback in the &struct ieee80211_ops for a given
1218 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001219 * decryption. The callback takes a @sta parameter that will be NULL
1220 * for default keys or keys used for transmission only, or point to
1221 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001222 * Multiple transmission keys with the same key index may be used when
1223 * VLANs are configured for an access point.
1224 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001225 * When transmitting, the TX control data will use the @hw_key_idx
1226 * selected by the driver by modifying the &struct ieee80211_key_conf
1227 * pointed to by the @key parameter to the set_key() function.
1228 *
1229 * The set_key() call for the %SET_KEY command should return 0 if
1230 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1231 * added; if you return 0 then hw_key_idx must be assigned to the
1232 * hardware key index, you are free to use the full u8 range.
1233 *
1234 * When the cmd is %DISABLE_KEY then it must succeed.
1235 *
1236 * Note that it is permissible to not decrypt a frame even if a key
1237 * for it has been uploaded to hardware, the stack will not make any
1238 * decision based on whether a key has been uploaded or not but rather
1239 * based on the receive flags.
1240 *
1241 * The &struct ieee80211_key_conf structure pointed to by the @key
1242 * parameter is guaranteed to be valid until another call to set_key()
1243 * removes it, but it can only be used as a cookie to differentiate
1244 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001245 *
1246 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1247 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1248 * handler.
1249 * The update_tkip_key() call updates the driver with the new phase 1 key.
1250 * This happens everytime the iv16 wraps around (every 65536 packets). The
1251 * set_key() call will happen only once for each key (unless the AP did
1252 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001253 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001254 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001255 */
Johannes Berg4150c572007-09-17 01:29:23 -04001256
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001257/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001258 * DOC: Powersave support
1259 *
1260 * mac80211 has support for various powersave implementations.
1261 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001262 * First, it can support hardware that handles all powersaving by itself,
1263 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1264 * flag. In that case, it will be told about the desired powersave mode
1265 * with the %IEEE80211_CONF_PS flag depending on the association status.
1266 * The hardware must take care of sending nullfunc frames when necessary,
1267 * i.e. when entering and leaving powersave mode. The hardware is required
1268 * to look at the AID in beacons and signal to the AP that it woke up when
1269 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001270 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001271 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1272 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1273 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001274 * up the hardware before issuing commands to the hardware and putting it
1275 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001276 *
1277 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1278 * buffered multicast/broadcast frames after the beacon. Also it must be
1279 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001280 *
1281 * Other hardware designs cannot send nullfunc frames by themselves and also
1282 * need software support for parsing the TIM bitmap. This is also supported
1283 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1284 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001285 * required to pass up beacons. The hardware is still required to handle
1286 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001287 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001288 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001289 * Dynamic powersave is an extension to normal powersave in which the
1290 * hardware stays awake for a user-specified period of time after sending a
1291 * frame so that reply frames need not be buffered and therefore delayed to
1292 * the next wakeup. It's compromise of getting good enough latency when
1293 * there's data traffic and still saving significantly power in idle
1294 * periods.
1295 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001296 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001297 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1298 * flag and mac80211 will handle everything automatically. Additionally,
1299 * hardware having support for the dynamic PS feature may set the
1300 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1301 * dynamic PS mode itself. The driver needs to look at the
1302 * @dynamic_ps_timeout hardware configuration value and use it that value
1303 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1304 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1305 * enabled whenever user has enabled powersave.
1306 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001307 * Some hardware need to toggle a single shared antenna between WLAN and
1308 * Bluetooth to facilitate co-existence. These types of hardware set
1309 * limitations on the use of host controlled dynamic powersave whenever there
1310 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1311 * driver may request temporarily going into full power save, in order to
1312 * enable toggling the antenna between BT and WLAN. If the driver requests
1313 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1314 * temporarily set to zero until the driver re-enables dynamic powersave.
1315 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001316 * Driver informs U-APSD client support by enabling
1317 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1318 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1319 * Nullfunc frames and stay awake until the service period has ended. To
1320 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1321 * from that AC are transmitted with powersave enabled.
1322 *
1323 * Note: U-APSD client mode is not yet supported with
1324 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001325 */
1326
1327/**
Kalle Valo04de8382009-03-22 21:57:35 +02001328 * DOC: Beacon filter support
1329 *
1330 * Some hardware have beacon filter support to reduce host cpu wakeups
1331 * which will reduce system power consumption. It usuallly works so that
1332 * the firmware creates a checksum of the beacon but omits all constantly
1333 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1334 * beacon is forwarded to the host, otherwise it will be just dropped. That
1335 * way the host will only receive beacons where some relevant information
1336 * (for example ERP protection or WMM settings) have changed.
1337 *
Johannes Berg955394c2009-04-16 17:04:25 +02001338 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1339 * hardware capability. The driver needs to enable beacon filter support
1340 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1341 * power save is enabled, the stack will not check for beacon loss and the
1342 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1343 *
1344 * The time (or number of beacons missed) until the firmware notifies the
1345 * driver of a beacon loss event (which in turn causes the driver to call
1346 * ieee80211_beacon_loss()) should be configurable and will be controlled
1347 * by mac80211 and the roaming algorithm in the future.
1348 *
1349 * Since there may be constantly changing information elements that nothing
1350 * in the software stack cares about, we will, in the future, have mac80211
1351 * tell the driver which information elements are interesting in the sense
1352 * that we want to see changes in them. This will include
1353 * - a list of information element IDs
1354 * - a list of OUIs for the vendor information element
1355 *
1356 * Ideally, the hardware would filter out any beacons without changes in the
1357 * requested elements, but if it cannot support that it may, at the expense
1358 * of some efficiency, filter out only a subset. For example, if the device
1359 * doesn't support checking for OUIs it should pass up all changes in all
1360 * vendor information elements.
1361 *
1362 * Note that change, for the sake of simplification, also includes information
1363 * elements appearing or disappearing from the beacon.
1364 *
1365 * Some hardware supports an "ignore list" instead, just make sure nothing
1366 * that was requested is on the ignore list, and include commonly changing
1367 * information element IDs in the ignore list, for example 11 (BSS load) and
1368 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1369 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1370 * it could also include some currently unused IDs.
1371 *
1372 *
1373 * In addition to these capabilities, hardware should support notifying the
1374 * host of changes in the beacon RSSI. This is relevant to implement roaming
1375 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1376 * the received data packets). This can consist in notifying the host when
1377 * the RSSI changes significantly or when it drops below or rises above
1378 * configurable thresholds. In the future these thresholds will also be
1379 * configured by mac80211 (which gets them from userspace) to implement
1380 * them as the roaming algorithm requires.
1381 *
1382 * If the hardware cannot implement this, the driver should ask it to
1383 * periodically pass beacon frames to the host so that software can do the
1384 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001385 */
1386
1387/**
Johannes Berg0f782312009-12-01 13:37:02 +01001388 * DOC: Spatial multiplexing power save
1389 *
1390 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1391 * power in an 802.11n implementation. For details on the mechanism
1392 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1393 * "11.2.3 SM power save".
1394 *
1395 * The mac80211 implementation is capable of sending action frames
1396 * to update the AP about the station's SMPS mode, and will instruct
1397 * the driver to enter the specific mode. It will also announce the
1398 * requested SMPS mode during the association handshake. Hardware
1399 * support for this feature is required, and can be indicated by
1400 * hardware flags.
1401 *
1402 * The default mode will be "automatic", which nl80211/cfg80211
1403 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1404 * turned off otherwise.
1405 *
1406 * To support this feature, the driver must set the appropriate
1407 * hardware support flags, and handle the SMPS flag to the config()
1408 * operation. It will then with this mechanism be instructed to
1409 * enter the requested SMPS mode while associated to an HT AP.
1410 */
1411
1412/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001413 * DOC: Frame filtering
1414 *
1415 * mac80211 requires to see many management frames for proper
1416 * operation, and users may want to see many more frames when
1417 * in monitor mode. However, for best CPU usage and power consumption,
1418 * having as few frames as possible percolate through the stack is
1419 * desirable. Hence, the hardware should filter as much as possible.
1420 *
1421 * To achieve this, mac80211 uses filter flags (see below) to tell
1422 * the driver's configure_filter() function which frames should be
1423 * passed to mac80211 and which should be filtered out.
1424 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001425 * Before configure_filter() is invoked, the prepare_multicast()
1426 * callback is invoked with the parameters @mc_count and @mc_list
1427 * for the combined multicast address list of all virtual interfaces.
1428 * It's use is optional, and it returns a u64 that is passed to
1429 * configure_filter(). Additionally, configure_filter() has the
1430 * arguments @changed_flags telling which flags were changed and
1431 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001432 *
1433 * If your device has no multicast address filters your driver will
1434 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1435 * parameter to see whether multicast frames should be accepted
1436 * or dropped.
1437 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001438 * All unsupported flags in @total_flags must be cleared.
1439 * Hardware does not support a flag if it is incapable of _passing_
1440 * the frame to the stack. Otherwise the driver must ignore
1441 * the flag, but not clear it.
1442 * You must _only_ clear the flag (announce no support for the
1443 * flag to mac80211) if you are not able to pass the packet type
1444 * to the stack (so the hardware always filters it).
1445 * So for example, you should clear @FIF_CONTROL, if your hardware
1446 * always filters control frames. If your hardware always passes
1447 * control frames to the kernel and is incapable of filtering them,
1448 * you do _not_ clear the @FIF_CONTROL flag.
1449 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001450 */
1451
1452/**
1453 * enum ieee80211_filter_flags - hardware filter flags
1454 *
1455 * These flags determine what the filter in hardware should be
1456 * programmed to let through and what should not be passed to the
1457 * stack. It is always safe to pass more frames than requested,
1458 * but this has negative impact on power consumption.
1459 *
1460 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1461 * think of the BSS as your network segment and then this corresponds
1462 * to the regular ethernet device promiscuous mode.
1463 *
1464 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1465 * by the user or if the hardware is not capable of filtering by
1466 * multicast address.
1467 *
1468 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1469 * %RX_FLAG_FAILED_FCS_CRC for them)
1470 *
1471 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1472 * the %RX_FLAG_FAILED_PLCP_CRC for them
1473 *
1474 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1475 * to the hardware that it should not filter beacons or probe responses
1476 * by BSSID. Filtering them can greatly reduce the amount of processing
1477 * mac80211 needs to do and the amount of CPU wakeups, so you should
1478 * honour this flag if possible.
1479 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001480 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001481 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001482 *
1483 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001484 *
Johannes Berg7be50862010-10-13 12:06:24 +02001485 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1486 * those addressed to this station.
1487 *
1488 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001489 */
1490enum ieee80211_filter_flags {
1491 FIF_PROMISC_IN_BSS = 1<<0,
1492 FIF_ALLMULTI = 1<<1,
1493 FIF_FCSFAIL = 1<<2,
1494 FIF_PLCPFAIL = 1<<3,
1495 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1496 FIF_CONTROL = 1<<5,
1497 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001498 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001499 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001500};
1501
1502/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001503 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1504 *
1505 * These flags are used with the ampdu_action() callback in
1506 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001507 *
1508 * Note that drivers MUST be able to deal with a TX aggregation
1509 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001510 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001511 * might receive the addBA frame and send a delBA right away!
1512 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001513 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1514 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001515 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1516 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001517 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001518 */
1519enum ieee80211_ampdu_mlme_action {
1520 IEEE80211_AMPDU_RX_START,
1521 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001522 IEEE80211_AMPDU_TX_START,
1523 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001524 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001525};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001526
1527/**
1528 * struct ieee80211_ops - callbacks from mac80211 to the driver
1529 *
1530 * This structure contains various callbacks that the driver may
1531 * handle or, in some cases, must handle, for example to configure
1532 * the hardware to a new channel or to transmit a frame.
1533 *
1534 * @tx: Handler that 802.11 module calls for each transmitted frame.
1535 * skb contains the buffer starting from the IEEE 802.11 header.
1536 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001537 * configuration in the TX control data. This handler should,
1538 * preferably, never fail and stop queues appropriately, more
1539 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001540 * This function should return NETDEV_TX_OK except in very
1541 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001542 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001543 *
1544 * @start: Called before the first netdevice attached to the hardware
1545 * is enabled. This should turn on the hardware and must turn on
1546 * frame reception (for possibly enabled monitor interfaces.)
1547 * Returns negative error codes, these may be seen in userspace,
1548 * or zero.
1549 * When the device is started it should not have a MAC address
1550 * to avoid acknowledging frames before a non-monitor device
1551 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001552 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001553 *
1554 * @stop: Called after last netdevice attached to the hardware
1555 * is disabled. This should turn off the hardware (at least
1556 * it must turn off frame reception.)
1557 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001558 * an interface. If you added any work onto the mac80211 workqueue
1559 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001560 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001561 *
1562 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001563 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001564 * and @stop must be implemented.
1565 * The driver should perform any initialization it needs before
1566 * the device can be enabled. The initial configuration for the
1567 * interface is given in the conf parameter.
1568 * The callback may refuse to add an interface by returning a
1569 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001570 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001571 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001572 * @change_interface: Called when a netdevice changes type. This callback
1573 * is optional, but only if it is supported can interface types be
1574 * switched while the interface is UP. The callback may sleep.
1575 * Note that while an interface is being switched, it will not be
1576 * found by the interface iteration callbacks.
1577 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001578 * @remove_interface: Notifies a driver that an interface is going down.
1579 * The @stop callback is called after this if it is the last interface
1580 * and no monitor interfaces are present.
1581 * When all interfaces are removed, the MAC address in the hardware
1582 * must be cleared so the device no longer acknowledges packets,
1583 * the mac_addr member of the conf structure is, however, set to the
1584 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001585 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001586 *
1587 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1588 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001589 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001590 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001591 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001592 * @bss_info_changed: Handler for configuration requests related to BSS
1593 * parameters that may vary during BSS's lifespan, and may affect low
1594 * level driver (e.g. assoc/disassoc status, erp parameters).
1595 * This function should not be used if no BSS has been set, unless
1596 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001597 * of the bss parameters has changed when a call is made. The callback
1598 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001599 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001600 * @prepare_multicast: Prepare for multicast filter configuration.
1601 * This callback is optional, and its return value is passed
1602 * to configure_filter(). This callback must be atomic.
1603 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001604 * @configure_filter: Configure the device's RX filter.
1605 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001606 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001607 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001608 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001609 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001610 *
1611 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001612 * This callback is only called between add_interface and
1613 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001614 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001615 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001616 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001617 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001618 * @update_tkip_key: See the section "Hardware crypto acceleration"
1619 * This callback will be called in the context of Rx. Called for drivers
1620 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001621 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001622 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001623 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001624 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001625 * configuration done by the regulatory agent in the wiphy's
1626 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001627 * that power save is disabled.
1628 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1629 * entire IEs after the SSID, so that drivers need not look at these
1630 * at all but just send them after the SSID -- mac80211 includes the
1631 * (extended) supported rates and HT information (where applicable).
1632 * When the scan finishes, ieee80211_scan_completed() must be called;
1633 * note that it also must be called when the scan cannot finish due to
1634 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001635 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001636 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001637 * @sw_scan_start: Notifier function that is called just before a software scan
1638 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001639 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001640 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001641 * @sw_scan_complete: Notifier function that is called just after a
1642 * software scan finished. Can be NULL, if the driver doesn't need
1643 * this notification.
1644 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001645 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001646 * @get_stats: Return low-level statistics.
1647 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001648 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001649 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001650 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1651 * callback should be provided to read the TKIP transmit IVs (both IV32
1652 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001653 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001654 *
1655 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001656 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001657 *
Johannes Berg34e89502010-02-03 13:59:58 +01001658 * @sta_add: Notifies low level driver about addition of an associated station,
1659 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1660 *
1661 * @sta_remove: Notifies low level driver about removal of an associated
1662 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1663 *
1664 * @sta_notify: Notifies low level driver about power state transition of an
1665 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001666 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001667 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001668 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001669 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001670 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001671 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001672 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001673 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001674 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001675 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001676 *
1677 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1678 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001679 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001680 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001681 *
1682 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1683 * with other STAs in the IBSS. This is only used in IBSS mode. This
1684 * function is optional if the firmware/hardware takes full care of
1685 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001686 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001687 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001688 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1689 * This is needed only for IBSS mode and the result of this function is
1690 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001691 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001692 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001693 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001694 * @ampdu_action: Perform a certain A-MPDU action
1695 * The RA/TID combination determines the destination and TID we want
1696 * the ampdu action to be performed for. The action is defined through
1697 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001698 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001699 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001700 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02001701 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001702 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001703 * @get_survey: Return per-channel survey information
1704 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001705 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1706 * need to set wiphy->rfkill_poll to %true before registration,
1707 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001708 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001709 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001710 * @set_coverage_class: Set slot time for given coverage class as specified
1711 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1712 * accordingly. This callback is not required and may sleep.
1713 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001714 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001715 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001716 *
1717 * @flush: Flush all pending frames from the hardware queue, making sure
1718 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001719 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001720 *
1721 * @channel_switch: Drivers that need (or want) to offload the channel
1722 * switch operation for CSAs received from the AP may implement this
1723 * callback. They must then call ieee80211_chswitch_done() to indicate
1724 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001725 *
1726 * @napi_poll: Poll Rx queue for incoming data frames.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001727 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001728struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001729 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001730 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001731 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001732 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001733 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02001734 int (*change_interface)(struct ieee80211_hw *hw,
1735 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001736 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e822007-05-05 11:45:53 -07001737 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001738 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001739 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001740 void (*bss_info_changed)(struct ieee80211_hw *hw,
1741 struct ieee80211_vif *vif,
1742 struct ieee80211_bss_conf *info,
1743 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001744 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad2010-04-01 21:22:57 +00001745 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001746 void (*configure_filter)(struct ieee80211_hw *hw,
1747 unsigned int changed_flags,
1748 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001749 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001750 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1751 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001752 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001753 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001754 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001755 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001756 struct ieee80211_vif *vif,
1757 struct ieee80211_key_conf *conf,
1758 struct ieee80211_sta *sta,
1759 u32 iv32, u16 *phase1key);
Johannes Berga060bbf2010-04-27 11:59:34 +02001760 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001761 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001762 void (*sw_scan_start)(struct ieee80211_hw *hw);
1763 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001764 int (*get_stats)(struct ieee80211_hw *hw,
1765 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001766 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1767 u32 *iv32, u16 *iv16);
Jiri Bencf0706e822007-05-05 11:45:53 -07001768 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001769 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1770 struct ieee80211_sta *sta);
1771 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1772 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001773 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001774 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001775 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001776 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001777 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001778 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001779 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001780 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001781 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001782 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001783 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001784 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Holger Schurig12897232010-04-19 10:23:57 +02001785 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1786 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001787 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001788 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001789#ifdef CONFIG_NL80211_TESTMODE
1790 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1791#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001792 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02001793 void (*channel_switch)(struct ieee80211_hw *hw,
1794 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001795 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Jiri Bencf0706e822007-05-05 11:45:53 -07001796};
1797
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001798/**
1799 * ieee80211_alloc_hw - Allocate a new hardware device
1800 *
1801 * This must be called once for each hardware device. The returned pointer
1802 * must be used to refer to this device when calling other functions.
1803 * mac80211 allocates a private data area for the driver pointed to by
1804 * @priv in &struct ieee80211_hw, the size of this area is given as
1805 * @priv_data_len.
1806 *
1807 * @priv_data_len: length of private data
1808 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001809 */
1810struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1811 const struct ieee80211_ops *ops);
1812
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001813/**
1814 * ieee80211_register_hw - Register hardware device
1815 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001816 * You must call this function before any other functions in
1817 * mac80211. Note that before a hardware can be registered, you
1818 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001819 *
1820 * @hw: the device to register as returned by ieee80211_alloc_hw()
1821 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001822int ieee80211_register_hw(struct ieee80211_hw *hw);
1823
Jiri Bencf0706e822007-05-05 11:45:53 -07001824#ifdef CONFIG_MAC80211_LEDS
1825extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1826extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001827extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001828extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001829#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001830/**
1831 * ieee80211_get_tx_led_name - get name of TX LED
1832 *
1833 * mac80211 creates a transmit LED trigger for each wireless hardware
1834 * that can be used to drive LEDs if your driver registers a LED device.
1835 * This function returns the name (or %NULL if not configured for LEDs)
1836 * of the trigger so you can automatically link the LED device.
1837 *
1838 * @hw: the hardware to get the LED trigger name for
1839 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001840static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1841{
1842#ifdef CONFIG_MAC80211_LEDS
1843 return __ieee80211_get_tx_led_name(hw);
1844#else
1845 return NULL;
1846#endif
1847}
1848
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001849/**
1850 * ieee80211_get_rx_led_name - get name of RX LED
1851 *
1852 * mac80211 creates a receive LED trigger for each wireless hardware
1853 * that can be used to drive LEDs if your driver registers a LED device.
1854 * This function returns the name (or %NULL if not configured for LEDs)
1855 * of the trigger so you can automatically link the LED device.
1856 *
1857 * @hw: the hardware to get the LED trigger name for
1858 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001859static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1860{
1861#ifdef CONFIG_MAC80211_LEDS
1862 return __ieee80211_get_rx_led_name(hw);
1863#else
1864 return NULL;
1865#endif
1866}
1867
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001868/**
1869 * ieee80211_get_assoc_led_name - get name of association LED
1870 *
1871 * mac80211 creates a association LED trigger for each wireless hardware
1872 * that can be used to drive LEDs if your driver registers a LED device.
1873 * This function returns the name (or %NULL if not configured for LEDs)
1874 * of the trigger so you can automatically link the LED device.
1875 *
1876 * @hw: the hardware to get the LED trigger name for
1877 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001878static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1879{
1880#ifdef CONFIG_MAC80211_LEDS
1881 return __ieee80211_get_assoc_led_name(hw);
1882#else
1883 return NULL;
1884#endif
1885}
1886
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001887/**
1888 * ieee80211_get_radio_led_name - get name of radio LED
1889 *
1890 * mac80211 creates a radio change LED trigger for each wireless hardware
1891 * that can be used to drive LEDs if your driver registers a LED device.
1892 * This function returns the name (or %NULL if not configured for LEDs)
1893 * of the trigger so you can automatically link the LED device.
1894 *
1895 * @hw: the hardware to get the LED trigger name for
1896 */
1897static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1898{
1899#ifdef CONFIG_MAC80211_LEDS
1900 return __ieee80211_get_radio_led_name(hw);
1901#else
1902 return NULL;
1903#endif
1904}
Michael Buesch47f0c502007-09-27 15:10:44 +02001905
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001906/**
1907 * ieee80211_unregister_hw - Unregister a hardware device
1908 *
1909 * This function instructs mac80211 to free allocated resources
1910 * and unregister netdevices from the networking subsystem.
1911 *
1912 * @hw: the hardware to unregister
1913 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001914void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1915
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001916/**
1917 * ieee80211_free_hw - free hardware descriptor
1918 *
1919 * This function frees everything that was allocated, including the
1920 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001921 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001922 *
1923 * @hw: the hardware to free
1924 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001925void ieee80211_free_hw(struct ieee80211_hw *hw);
1926
Johannes Bergf2753dd2009-04-14 10:09:24 +02001927/**
1928 * ieee80211_restart_hw - restart hardware completely
1929 *
1930 * Call this function when the hardware was restarted for some reason
1931 * (hardware error, ...) and the driver is unable to restore its state
1932 * by itself. mac80211 assumes that at this point the driver/hardware
1933 * is completely uninitialised and stopped, it starts the process by
1934 * calling the ->start() operation. The driver will need to reset all
1935 * internal state that it has prior to calling this function.
1936 *
1937 * @hw: the hardware to restart
1938 */
1939void ieee80211_restart_hw(struct ieee80211_hw *hw);
1940
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001941/** ieee80211_napi_schedule - schedule NAPI poll
1942 *
1943 * Use this function to schedule NAPI polling on a device.
1944 *
1945 * @hw: the hardware to start polling
1946 */
1947void ieee80211_napi_schedule(struct ieee80211_hw *hw);
1948
1949/** ieee80211_napi_complete - complete NAPI polling
1950 *
1951 * Use this function to finish NAPI polling on a device.
1952 *
1953 * @hw: the hardware to stop polling
1954 */
1955void ieee80211_napi_complete(struct ieee80211_hw *hw);
1956
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001957/**
1958 * ieee80211_rx - receive frame
1959 *
1960 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08001961 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1962 * paged @skb is used, the driver is recommended to put the ieee80211
1963 * header of the frame on the linear part of the @skb to avoid memory
1964 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001965 *
Johannes Berg2485f712008-02-25 16:27:41 +01001966 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03001967 * for a single hardware must be synchronized against each other. Calls to
1968 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1969 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001970 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001971 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02001972 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001973 * @hw: the hardware this frame came in on
1974 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001975 */
John W. Linville103bf9f2009-08-20 16:34:15 -04001976void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001977
1978/**
1979 * ieee80211_rx_irqsafe - receive frame
1980 *
1981 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001982 * (internally defers to a tasklet.)
1983 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001984 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1985 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001986 *
1987 * @hw: the hardware this frame came in on
1988 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001989 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001990void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001991
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001992/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03001993 * ieee80211_rx_ni - receive frame (in process context)
1994 *
1995 * Like ieee80211_rx() but can be called in process context
1996 * (internally disables bottom halves).
1997 *
1998 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1999 * not be mixed for a single hardware.
2000 *
2001 * @hw: the hardware this frame came in on
2002 * @skb: the buffer to receive, owned by mac80211 after this call
2003 */
2004static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2005 struct sk_buff *skb)
2006{
2007 local_bh_disable();
2008 ieee80211_rx(hw, skb);
2009 local_bh_enable();
2010}
2011
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002012/*
2013 * The TX headroom reserved by mac80211 for its own tx_status functions.
2014 * This is enough for the radiotap header.
2015 */
2016#define IEEE80211_TX_STATUS_HEADROOM 13
2017
Kalle Valoe36e49f2009-10-13 20:33:13 +03002018/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002019 * ieee80211_tx_status - transmit status callback
2020 *
2021 * Call this function for all transmitted frames after they have been
2022 * transmitted. It is permissible to not call this function for
2023 * multicast frames but this can affect statistics.
2024 *
Johannes Berg2485f712008-02-25 16:27:41 +01002025 * This function may not be called in IRQ context. Calls to this function
2026 * for a single hardware must be synchronized against each other. Calls
2027 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
2028 * for a single hardware.
2029 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002030 * @hw: the hardware the frame was transmitted by
2031 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002032 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002033void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002034 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002035
2036/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002037 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002038 *
2039 * Like ieee80211_tx_status() but can be called in IRQ context
2040 * (internally defers to a tasklet.)
2041 *
2042 * Calls to this function and ieee80211_tx_status() may not be mixed for a
2043 * single hardware.
2044 *
2045 * @hw: the hardware the frame was transmitted by
2046 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002047 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002048void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002049 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07002050
2051/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01002052 * ieee80211_beacon_get_tim - beacon generation function
2053 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002054 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01002055 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2056 * Set to 0 if invalid (in non-AP modes).
2057 * @tim_length: pointer to variable that will receive the TIM IE length,
2058 * (including the ID and length bytes!).
2059 * Set to 0 if invalid (in non-AP modes).
2060 *
2061 * If the driver implements beaconing modes, it must use this function to
2062 * obtain the beacon frame/template.
2063 *
2064 * If the beacon frames are generated by the host system (i.e., not in
2065 * hardware/firmware), the driver uses this function to get each beacon
2066 * frame from mac80211 -- it is responsible for calling this function
2067 * before the beacon is needed (e.g. based on hardware interrupt).
2068 *
2069 * If the beacon frames are generated by the device, then the driver
2070 * must use the returned beacon as the template and change the TIM IE
2071 * according to the current DTIM parameters/TIM bitmap.
2072 *
2073 * The driver is responsible for freeing the returned skb.
2074 */
2075struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2076 struct ieee80211_vif *vif,
2077 u16 *tim_offset, u16 *tim_length);
2078
2079/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002080 * ieee80211_beacon_get - beacon generation function
2081 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002082 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002083 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002084 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e822007-05-05 11:45:53 -07002085 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002086static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2087 struct ieee80211_vif *vif)
2088{
2089 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2090}
Jiri Bencf0706e822007-05-05 11:45:53 -07002091
2092/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002093 * ieee80211_pspoll_get - retrieve a PS Poll template
2094 * @hw: pointer obtained from ieee80211_alloc_hw().
2095 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2096 *
2097 * Creates a PS Poll a template which can, for example, uploaded to
2098 * hardware. The template must be updated after association so that correct
2099 * AID, BSSID and MAC address is used.
2100 *
2101 * Note: Caller (or hardware) is responsible for setting the
2102 * &IEEE80211_FCTL_PM bit.
2103 */
2104struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2105 struct ieee80211_vif *vif);
2106
2107/**
2108 * ieee80211_nullfunc_get - retrieve a nullfunc template
2109 * @hw: pointer obtained from ieee80211_alloc_hw().
2110 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2111 *
2112 * Creates a Nullfunc template which can, for example, uploaded to
2113 * hardware. The template must be updated after association so that correct
2114 * BSSID and address is used.
2115 *
2116 * Note: Caller (or hardware) is responsible for setting the
2117 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2118 */
2119struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2120 struct ieee80211_vif *vif);
2121
2122/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002123 * ieee80211_probereq_get - retrieve a Probe Request template
2124 * @hw: pointer obtained from ieee80211_alloc_hw().
2125 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2126 * @ssid: SSID buffer
2127 * @ssid_len: length of SSID
2128 * @ie: buffer containing all IEs except SSID for the template
2129 * @ie_len: length of the IE buffer
2130 *
2131 * Creates a Probe Request template which can, for example, be uploaded to
2132 * hardware.
2133 */
2134struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2135 struct ieee80211_vif *vif,
2136 const u8 *ssid, size_t ssid_len,
2137 const u8 *ie, size_t ie_len);
2138
2139/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002140 * ieee80211_rts_get - RTS frame generation function
2141 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002142 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002143 * @frame: pointer to the frame that is going to be protected by the RTS.
2144 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002145 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002146 * @rts: The buffer where to store the RTS frame.
2147 *
2148 * If the RTS frames are generated by the host system (i.e., not in
2149 * hardware/firmware), the low-level driver uses this function to receive
2150 * the next RTS frame from the 802.11 code. The low-level is responsible
2151 * for calling this function before and RTS frame is needed.
2152 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002153void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002154 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002155 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002156 struct ieee80211_rts *rts);
2157
2158/**
2159 * ieee80211_rts_duration - Get the duration field for an RTS frame
2160 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002161 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002162 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002163 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002164 *
2165 * If the RTS is generated in firmware, but the host system must provide
2166 * the duration field, the low-level driver uses this function to receive
2167 * the duration field value in little-endian byteorder.
2168 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002169__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2170 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002171 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002172
2173/**
2174 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2175 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002176 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002177 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2178 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002179 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002180 * @cts: The buffer where to store the CTS-to-self frame.
2181 *
2182 * If the CTS-to-self frames are generated by the host system (i.e., not in
2183 * hardware/firmware), the low-level driver uses this function to receive
2184 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2185 * for calling this function before and CTS-to-self frame is needed.
2186 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002187void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2188 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002189 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002190 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002191 struct ieee80211_cts *cts);
2192
2193/**
2194 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2195 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002196 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002197 * @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 +02002198 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002199 *
2200 * If the CTS-to-self is generated in firmware, but the host system must provide
2201 * the duration field, the low-level driver uses this function to receive
2202 * the duration field value in little-endian byteorder.
2203 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002204__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2205 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002206 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002207 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002208
2209/**
2210 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2211 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002212 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002213 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002214 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07002215 *
2216 * Calculate the duration field of some generic frame, given its
2217 * length and transmission rate (in 100kbps).
2218 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002219__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2220 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002221 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002222 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07002223
2224/**
2225 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2226 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002227 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002228 *
2229 * Function for accessing buffered broadcast and multicast frames. If
2230 * hardware/firmware does not implement buffering of broadcast/multicast
2231 * frames when power saving is used, 802.11 code buffers them in the host
2232 * memory. The low-level driver uses this function to fetch next buffered
2233 * frame. In most cases, this is used when generating beacon frame. This
2234 * function returns a pointer to the next buffered skb or NULL if no more
2235 * buffered frames are available.
2236 *
2237 * Note: buffered frames are returned only after DTIM beacon frame was
2238 * generated with ieee80211_beacon_get() and the low-level driver must thus
2239 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2240 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2241 * does not need to check for DTIM beacons separately and should be able to
2242 * use common code for all beacons.
2243 */
2244struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002245ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07002246
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002247/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002248 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2249 *
2250 * This function computes a TKIP rc4 key for an skb. It computes
2251 * a phase 1 key if needed (iv16 wraps around). This function is to
2252 * be used by drivers which can do HW encryption but need to compute
2253 * to phase 1/2 key in SW.
2254 *
2255 * @keyconf: the parameter passed with the set key
2256 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002257 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002258 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002259 */
2260void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2261 struct sk_buff *skb,
2262 enum ieee80211_tkip_key_type type, u8 *key);
2263/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002264 * ieee80211_wake_queue - wake specific queue
2265 * @hw: pointer as obtained from ieee80211_alloc_hw().
2266 * @queue: queue number (counted from zero).
2267 *
2268 * Drivers should use this function instead of netif_wake_queue.
2269 */
2270void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2271
2272/**
2273 * ieee80211_stop_queue - stop specific queue
2274 * @hw: pointer as obtained from ieee80211_alloc_hw().
2275 * @queue: queue number (counted from zero).
2276 *
2277 * Drivers should use this function instead of netif_stop_queue.
2278 */
2279void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2280
2281/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002282 * ieee80211_queue_stopped - test status of the queue
2283 * @hw: pointer as obtained from ieee80211_alloc_hw().
2284 * @queue: queue number (counted from zero).
2285 *
2286 * Drivers should use this function instead of netif_stop_queue.
2287 */
2288
2289int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2290
2291/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002292 * ieee80211_stop_queues - stop all queues
2293 * @hw: pointer as obtained from ieee80211_alloc_hw().
2294 *
2295 * Drivers should use this function instead of netif_stop_queue.
2296 */
2297void ieee80211_stop_queues(struct ieee80211_hw *hw);
2298
2299/**
2300 * ieee80211_wake_queues - wake all queues
2301 * @hw: pointer as obtained from ieee80211_alloc_hw().
2302 *
2303 * Drivers should use this function instead of netif_wake_queue.
2304 */
2305void ieee80211_wake_queues(struct ieee80211_hw *hw);
2306
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002307/**
2308 * ieee80211_scan_completed - completed hardware scan
2309 *
2310 * When hardware scan offload is used (i.e. the hw_scan() callback is
2311 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02002312 * mac80211 that the scan finished. This function can be called from
2313 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002314 *
2315 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002316 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002317 */
Johannes Berg2a519312009-02-10 21:25:55 +01002318void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07002319
Johannes Bergdabeb342007-11-09 01:57:29 +01002320/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002321 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002322 *
2323 * This function iterates over the interfaces associated with a given
2324 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002325 * This function allows the iterator function to sleep, when the iterator
2326 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2327 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02002328 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01002329 *
2330 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002331 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002332 * @data: first argument of the iterator function
2333 */
2334void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2335 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002336 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002337 void *data);
2338
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002339/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002340 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2341 *
2342 * This function iterates over the interfaces associated with a given
2343 * hardware that are currently active and calls the callback for them.
2344 * This function requires the iterator callback function to be atomic,
2345 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02002346 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002347 *
2348 * @hw: the hardware struct of which the interfaces should be iterated over
2349 * @iterator: the iterator function to call, cannot sleep
2350 * @data: first argument of the iterator function
2351 */
2352void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2353 void (*iterator)(void *data,
2354 u8 *mac,
2355 struct ieee80211_vif *vif),
2356 void *data);
2357
2358/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002359 * ieee80211_queue_work - add work onto the mac80211 workqueue
2360 *
2361 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2362 * This helper ensures drivers are not queueing work when they should not be.
2363 *
2364 * @hw: the hardware struct for the interface we are adding work for
2365 * @work: the work we want to add onto the mac80211 workqueue
2366 */
2367void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2368
2369/**
2370 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2371 *
2372 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2373 * workqueue.
2374 *
2375 * @hw: the hardware struct for the interface we are adding work for
2376 * @dwork: delayable work to queue onto the mac80211 workqueue
2377 * @delay: number of jiffies to wait before queueing
2378 */
2379void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2380 struct delayed_work *dwork,
2381 unsigned long delay);
2382
2383/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002384 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002385 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002386 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002387 *
2388 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002389 *
2390 * Although mac80211/low level driver/user space application can estimate
2391 * the need to start aggregation on a certain RA/TID, the session level
2392 * will be managed by the mac80211.
2393 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002394int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002395
2396/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002397 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002398 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002399 * @ra: receiver address of the BA session recipient.
2400 * @tid: the TID to BA on.
2401 *
2402 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002403 * finished with preparations for the BA session. It can be called
2404 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002405 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002406void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002407 u16 tid);
2408
2409/**
2410 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002411 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002412 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002413 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02002414 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002415 *
2416 * Although mac80211/low level driver/user space application can estimate
2417 * the need to stop aggregation on a certain RA/TID, the session level
2418 * will be managed by the mac80211.
2419 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02002420int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002421
2422/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002423 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002424 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002425 * @ra: receiver address of the BA session recipient.
2426 * @tid: the desired TID to BA on.
2427 *
2428 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002429 * finished with preparations for the BA session tear down. It
2430 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002431 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002432void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002433 u16 tid);
2434
Mohamed Abbas84363e62008-04-04 16:59:58 -07002435/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002436 * ieee80211_find_sta - find a station
2437 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002438 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002439 * @addr: station's address
2440 *
2441 * This function must be called under RCU lock and the
2442 * resulting pointer is only valid under RCU lock as well.
2443 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002444struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002445 const u8 *addr);
2446
Kalle Valo04de8382009-03-22 21:57:35 +02002447/**
Ben Greear686b9cb2010-09-23 09:44:36 -07002448 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01002449 *
2450 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07002451 * @addr: remote station's address
2452 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002453 *
2454 * This function must be called under RCU lock and the
2455 * resulting pointer is only valid under RCU lock as well.
2456 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002457 * NOTE: You may pass NULL for localaddr, but then you will just get
2458 * the first STA that matches the remote address 'addr'.
2459 * We can have multiple STA associated with multiple
2460 * logical stations (e.g. consider a station connecting to another
2461 * BSSID on the same AP hardware without disconnecting first).
2462 * In this case, the result of this method with localaddr NULL
2463 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002464 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002465 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002466 */
Ben Greear686b9cb2010-09-23 09:44:36 -07002467struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2468 const u8 *addr,
2469 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01002470
2471/**
Johannes Bergaf818582009-11-06 11:35:50 +01002472 * ieee80211_sta_block_awake - block station from waking up
2473 * @hw: the hardware
2474 * @pubsta: the station
2475 * @block: whether to block or unblock
2476 *
2477 * Some devices require that all frames that are on the queues
2478 * for a specific station that went to sleep are flushed before
2479 * a poll response or frames after the station woke up can be
2480 * delivered to that it. Note that such frames must be rejected
2481 * by the driver as filtered, with the appropriate status flag.
2482 *
2483 * This function allows implementing this mode in a race-free
2484 * manner.
2485 *
2486 * To do this, a driver must keep track of the number of frames
2487 * still enqueued for a specific station. If this number is not
2488 * zero when the station goes to sleep, the driver must call
2489 * this function to force mac80211 to consider the station to
2490 * be asleep regardless of the station's actual state. Once the
2491 * number of outstanding frames reaches zero, the driver must
2492 * call this function again to unblock the station. That will
2493 * cause mac80211 to be able to send ps-poll responses, and if
2494 * the station queried in the meantime then frames will also
2495 * be sent out as a result of this. Additionally, the driver
2496 * will be notified that the station woke up some time after
2497 * it is unblocked, regardless of whether the station actually
2498 * woke up while blocked or not.
2499 */
2500void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2501 struct ieee80211_sta *pubsta, bool block);
2502
2503/**
Kalle Valo04de8382009-03-22 21:57:35 +02002504 * ieee80211_beacon_loss - inform hardware does not receive beacons
2505 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002506 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002507 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002508 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002509 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02002510 * hardware is not receiving beacons with this function.
2511 */
2512void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002513
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002514/**
2515 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2516 *
2517 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2518 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002519 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002520 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2521 * needs to inform if the connection to the AP has been lost.
2522 *
2523 * This function will cause immediate change to disassociated state,
2524 * without connection recovery attempts.
2525 */
2526void ieee80211_connection_loss(struct ieee80211_vif *vif);
2527
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002528/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03002529 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2530 *
2531 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2532 *
2533 * Some hardware require full power save to manage simultaneous BT traffic
2534 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2535 * burst of BT traffic. The hardware gets information of BT traffic via
2536 * hardware co-existence lines, and consequentially requests mac80211 to
2537 * (temporarily) enter full psm.
2538 * This function will only temporarily disable dynamic PS, not enable PSM if
2539 * it was not already enabled.
2540 * The driver must make sure to re-enable dynamic PS using
2541 * ieee80211_enable_dyn_ps() if the driver has disabled it.
2542 *
2543 */
2544void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2545
2546/**
2547 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2548 *
2549 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2550 *
2551 * This function restores dynamic PS after being temporarily disabled via
2552 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2553 * be coupled with an eventual call to this function.
2554 *
2555 */
2556void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2557
2558/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002559 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2560 * rssi threshold triggered
2561 *
2562 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2563 * @rssi_event: the RSSI trigger event type
2564 * @gfp: context flags
2565 *
2566 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2567 * monitoring is configured with an rssi threshold, the driver will inform
2568 * whenever the rssi level reaches the threshold.
2569 */
2570void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2571 enum nl80211_cqm_rssi_threshold_event rssi_event,
2572 gfp_t gfp);
2573
Johannes Berg5ce6e432010-05-11 16:20:57 +02002574/**
2575 * ieee80211_chswitch_done - Complete channel switch process
2576 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2577 * @success: make the channel switch successful or not
2578 *
2579 * Complete the channel switch post-process: set the new operational channel
2580 * and wake up the suspended queues.
2581 */
2582void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2583
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002584/**
2585 * ieee80211_request_smps - request SM PS transition
2586 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02002587 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002588 *
2589 * This allows the driver to request an SM PS transition in managed
2590 * mode. This is useful when the driver has more information than
2591 * the stack about possible interference, for example by bluetooth.
2592 */
2593void ieee80211_request_smps(struct ieee80211_vif *vif,
2594 enum ieee80211_smps_mode smps_mode);
2595
Johannes Berge31b8212010-10-05 19:39:30 +02002596/**
2597 * ieee80211_key_removed - disable hw acceleration for key
2598 * @key_conf: The key hw acceleration should be disabled for
2599 *
2600 * This allows drivers to indicate that the given key has been
2601 * removed from hardware acceleration, due to a new key that
2602 * was added. Don't use this if the key can continue to be used
2603 * for TX, if the key restriction is on RX only it is permitted
2604 * to keep the key for TX only and not call this function.
2605 *
2606 * Due to locking constraints, it may only be called during
2607 * @set_key. This function must be allowed to sleep, and the
2608 * key it tries to disable may still be used until it returns.
2609 */
2610void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
2611
Johannes Berg4b7679a2008-09-18 18:14:18 +02002612/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002613
Johannes Berg4b7679a2008-09-18 18:14:18 +02002614/**
Sujith81cb7622009-02-12 11:38:37 +05302615 * enum rate_control_changed - flags to indicate which parameter changed
2616 *
2617 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2618 * changed, rate control algorithm can update its internal state if needed.
2619 */
2620enum rate_control_changed {
2621 IEEE80211_RC_HT_CHANGED = BIT(0)
2622};
2623
2624/**
Johannes Berge6a98542008-10-21 12:40:02 +02002625 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002626 *
Johannes Berge6a98542008-10-21 12:40:02 +02002627 * @hw: The hardware the algorithm is invoked for.
2628 * @sband: The band this frame is being transmitted on.
2629 * @bss_conf: the current BSS configuration
2630 * @reported_rate: The rate control algorithm can fill this in to indicate
2631 * which rate should be reported to userspace as the current rate and
2632 * used for rate calculations in the mesh network.
2633 * @rts: whether RTS will be used for this frame because it is longer than the
2634 * RTS threshold
2635 * @short_preamble: whether mac80211 will request short-preamble transmission
2636 * if the selected rate supports it
2637 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002638 * (deprecated; this will be removed once drivers get updated to use
2639 * rate_idx_mask)
2640 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002641 * @skb: the skb that will be transmitted, the control information in it needs
2642 * to be filled in
Jouni Malinene00cfce2009-12-29 12:59:19 +02002643 * @ap: whether this frame is sent out in AP mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002644 */
Johannes Berge6a98542008-10-21 12:40:02 +02002645struct ieee80211_tx_rate_control {
2646 struct ieee80211_hw *hw;
2647 struct ieee80211_supported_band *sband;
2648 struct ieee80211_bss_conf *bss_conf;
2649 struct sk_buff *skb;
2650 struct ieee80211_tx_rate reported_rate;
2651 bool rts, short_preamble;
2652 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002653 u32 rate_idx_mask;
Jouni Malinene00cfce2009-12-29 12:59:19 +02002654 bool ap;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002655};
2656
2657struct rate_control_ops {
2658 struct module *module;
2659 const char *name;
2660 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002661 void (*free)(void *priv);
2662
2663 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2664 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2665 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302666 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2667 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302668 void *priv_sta, u32 changed,
2669 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002670 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2671 void *priv_sta);
2672
2673 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2674 struct ieee80211_sta *sta, void *priv_sta,
2675 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002676 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2677 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002678
2679 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2680 struct dentry *dir);
2681 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2682};
2683
2684static inline int rate_supported(struct ieee80211_sta *sta,
2685 enum ieee80211_band band,
2686 int index)
2687{
2688 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2689}
2690
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002691/**
2692 * rate_control_send_low - helper for drivers for management/no-ack frames
2693 *
2694 * Rate control algorithms that agree to use the lowest rate to
2695 * send management frames and NO_ACK data with the respective hw
2696 * retries should use this in the beginning of their mac80211 get_rate
2697 * callback. If true is returned the rate control can simply return.
2698 * If false is returned we guarantee that sta and sta and priv_sta is
2699 * not null.
2700 *
2701 * Rate control algorithms wishing to do more intelligent selection of
2702 * rate for multicast/broadcast frames may choose to not use this.
2703 *
2704 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2705 * that this may be null.
2706 * @priv_sta: private rate control structure. This may be null.
2707 * @txrc: rate control information we sholud populate for mac80211.
2708 */
2709bool rate_control_send_low(struct ieee80211_sta *sta,
2710 void *priv_sta,
2711 struct ieee80211_tx_rate_control *txrc);
2712
2713
Johannes Berg4b7679a2008-09-18 18:14:18 +02002714static inline s8
2715rate_lowest_index(struct ieee80211_supported_band *sband,
2716 struct ieee80211_sta *sta)
2717{
2718 int i;
2719
2720 for (i = 0; i < sband->n_bitrates; i++)
2721 if (rate_supported(sta, sband->band, i))
2722 return i;
2723
2724 /* warn when we cannot find a rate. */
2725 WARN_ON(1);
2726
2727 return 0;
2728}
2729
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002730static inline
2731bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2732 struct ieee80211_sta *sta)
2733{
2734 unsigned int i;
2735
2736 for (i = 0; i < sband->n_bitrates; i++)
2737 if (rate_supported(sta, sband->band, i))
2738 return true;
2739 return false;
2740}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002741
2742int ieee80211_rate_control_register(struct rate_control_ops *ops);
2743void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2744
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002745static inline bool
2746conf_is_ht20(struct ieee80211_conf *conf)
2747{
Johannes Berg47979382009-01-07 10:13:27 +01002748 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002749}
2750
2751static inline bool
2752conf_is_ht40_minus(struct ieee80211_conf *conf)
2753{
Johannes Berg47979382009-01-07 10:13:27 +01002754 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002755}
2756
2757static inline bool
2758conf_is_ht40_plus(struct ieee80211_conf *conf)
2759{
Johannes Berg47979382009-01-07 10:13:27 +01002760 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002761}
2762
2763static inline bool
2764conf_is_ht40(struct ieee80211_conf *conf)
2765{
2766 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2767}
2768
2769static inline bool
2770conf_is_ht(struct ieee80211_conf *conf)
2771{
Johannes Berg47979382009-01-07 10:13:27 +01002772 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002773}
2774
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002775static inline enum nl80211_iftype
2776ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
2777{
2778 if (p2p) {
2779 switch (type) {
2780 case NL80211_IFTYPE_STATION:
2781 return NL80211_IFTYPE_P2P_CLIENT;
2782 case NL80211_IFTYPE_AP:
2783 return NL80211_IFTYPE_P2P_GO;
2784 default:
2785 break;
2786 }
2787 }
2788 return type;
2789}
2790
2791static inline enum nl80211_iftype
2792ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
2793{
2794 return ieee80211_iftype_p2p(vif->type, vif->p2p);
2795}
2796
Jiri Bencf0706e822007-05-05 11:45:53 -07002797#endif /* MAC80211_H */