blob: fe80771d95f1fd81628bccf1fcf164bde027d9af [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>
Johannes Bergae5eb022008-10-14 16:58:37 +02006 * Copyright 2007-2008 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/**
Johannes Berge100bb62008-04-30 18:51:21 +020076 * enum ieee80211_max_queues - maximum number of queues
77 *
78 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020079 */
80enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010081 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020082};
83
84/**
Johannes Berg6b301cd2007-09-18 17:29:20 -040085 * struct ieee80211_tx_queue_params - transmit queue configuration
86 *
87 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +010088 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -040089 *
Bob Copelande37d4df2008-10-20 21:20:27 -040090 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +020091 * @cw_min: minimum contention window [a value of the form
92 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -040093 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +010094 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -040095 */
Jiri Bencf0706e822007-05-05 11:45:53 -070096struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +020097 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +010098 u16 cw_min;
99 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200100 u8 aifs;
Jiri Bencf0706e822007-05-05 11:45:53 -0700101};
102
Johannes Berg6b301cd2007-09-18 17:29:20 -0400103/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200104 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400105 *
106 * @len: number of packets in queue
107 * @limit: queue length limit
108 * @count: number of frames sent
109 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200110struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111 unsigned int len;
112 unsigned int limit;
113 unsigned int count;
Jiri Bencf0706e822007-05-05 11:45:53 -0700114};
115
Jiri Bencf0706e822007-05-05 11:45:53 -0700116struct ieee80211_low_level_stats {
117 unsigned int dot11ACKFailureCount;
118 unsigned int dot11RTSFailureCount;
119 unsigned int dot11FCSErrorCount;
120 unsigned int dot11RTSSuccessCount;
121};
122
Johannes Berg471b3ef2007-12-28 14:32:58 +0100123/**
124 * enum ieee80211_bss_change - BSS change notification flags
125 *
126 * These flags are used with the bss_info_changed() callback
127 * to indicate which BSS parameter changed.
128 *
129 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
130 * also implies a change in the AID.
131 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
132 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300133 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700134 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200135 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200136 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200137 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
138 * reason (IBSS and managed mode)
139 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
140 * new beacon (beaconing modes)
141 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
142 * enabled/disabled (beaconing modes)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100143 */
144enum ieee80211_bss_change {
145 BSS_CHANGED_ASSOC = 1<<0,
146 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
147 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300148 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700149 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200150 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200151 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200152 BSS_CHANGED_BSSID = 1<<7,
153 BSS_CHANGED_BEACON = 1<<8,
154 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100155};
156
157/**
158 * struct ieee80211_bss_conf - holds the BSS's changing parameters
159 *
160 * This structure keeps information about a BSS (and an association
161 * to that BSS) that can change during the lifetime of the BSS.
162 *
163 * @assoc: association status
164 * @aid: association ID number, valid only when @assoc is true
165 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200166 * @use_short_preamble: use 802.11b short preamble;
167 * if the hardware cannot handle this it must set the
168 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
169 * @use_short_slot: use short slot time (only relevant for ERP);
170 * if the hardware cannot handle this it must set the
171 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800172 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700173 * @timestamp: beacon timestamp
174 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800175 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200176 * @basic_rates: bitmap of basic rates, each bit stands for an
177 * index into the rate table configured by the driver in
178 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200179 * @bssid: The BSSID for this BSS
180 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200181 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
182 * This field is only valid when the channel type is one of the HT types.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100183 */
184struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200185 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100186 /* association related data */
187 bool assoc;
188 u16 aid;
189 /* erp related data */
190 bool use_cts_prot;
191 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300192 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200193 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800194 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700195 u16 beacon_int;
196 u16 assoc_capability;
197 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100198 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200199 u16 ht_operation_mode;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100200};
201
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800202/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700203 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800204 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700205 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800206 *
Johannes Berge039fa42008-05-15 12:55:29 +0200207 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200208 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
209 * number to this frame, taking care of not overwriting the fragment
210 * number and increasing the sequence number only when the
211 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
212 * assign sequence numbers to QoS-data frames but cannot do so correctly
213 * for non-QoS-data and management frames because beacons need them from
214 * that counter as well and mac80211 cannot guarantee proper sequencing.
215 * If this flag is set, the driver should instruct the hardware to
216 * assign a sequence number to the frame or assign one itself. Cf. IEEE
217 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
218 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200219 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200220 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
221 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200222 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200225 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200226 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
227 * because the destination STA was in powersave mode.
228 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
229 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
230 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300231 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
232 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200233 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
234 * set by rate control algorithms to indicate probe rate, will
235 * be cleared for fragmented frames (except on the last fragment)
Johannes Berg2b874e82009-03-23 14:10:22 +0100236 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
237 * set this flag in the driver; indicates that the rate control
238 * algorithm was used and should be notified of TX status
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100239 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
240 * used to indicate that a pending frame requires TX processing before
241 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200242 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
243 * used to indicate that a frame was already retried due to PS
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800244 */
245enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200246 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200247 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
248 IEEE80211_TX_CTL_NO_ACK = BIT(2),
249 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
250 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
251 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
252 IEEE80211_TX_CTL_AMPDU = BIT(6),
253 IEEE80211_TX_CTL_INJECTED = BIT(7),
254 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
255 IEEE80211_TX_STAT_ACK = BIT(9),
256 IEEE80211_TX_STAT_AMPDU = BIT(10),
257 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
258 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Berg2b874e82009-03-23 14:10:22 +0100259 IEEE80211_TX_INTFL_RCALGO = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100260 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200261 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berge6a98542008-10-21 12:40:02 +0200262};
263
Sujith2134e7e2009-01-22 09:00:52 +0530264/**
265 * enum mac80211_rate_control_flags - per-rate flags set by the
266 * Rate Control algorithm.
267 *
268 * These flags are set by the Rate control algorithm for each rate during tx,
269 * in the @flags member of struct ieee80211_tx_rate.
270 *
271 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
272 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
273 * This is set if the current BSS requires ERP protection.
274 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
275 * @IEEE80211_TX_RC_MCS: HT rate.
276 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
277 * Greenfield mode.
278 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
279 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
280 * adjacent 20 MHz channels, if the current channel type is
281 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
282 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
283 */
Johannes Berge6a98542008-10-21 12:40:02 +0200284enum mac80211_rate_control_flags {
285 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
286 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
287 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
288
289 /* rate index is an MCS rate number instead of an index */
290 IEEE80211_TX_RC_MCS = BIT(3),
291 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
292 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
293 IEEE80211_TX_RC_DUP_DATA = BIT(6),
294 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800295};
296
Johannes Berge039fa42008-05-15 12:55:29 +0200297
Johannes Berge6a98542008-10-21 12:40:02 +0200298/* there are 40 bytes if you don't need the rateset to be kept */
299#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200300
Johannes Berge6a98542008-10-21 12:40:02 +0200301/* if you do need the rateset, then you have less space */
302#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
303
304/* maximum number of rate stages */
305#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200306
307/**
Johannes Berge6a98542008-10-21 12:40:02 +0200308 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200309 *
Johannes Berge6a98542008-10-21 12:40:02 +0200310 * @idx: rate index to attempt to send with
311 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200312 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200313 *
314 * A value of -1 for @idx indicates an invalid rate and, if used
315 * in an array of retry rates, that no more rates should be tried.
316 *
317 * When used for transmit status reporting, the driver should
318 * always report the rate along with the flags it used.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200319 */
Johannes Berge6a98542008-10-21 12:40:02 +0200320struct ieee80211_tx_rate {
321 s8 idx;
322 u8 count;
323 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100324} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200325
Johannes Berge039fa42008-05-15 12:55:29 +0200326/**
327 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200328 *
Johannes Berge039fa42008-05-15 12:55:29 +0200329 * This structure is placed in skb->cb for three uses:
330 * (1) mac80211 TX control - mac80211 tells the driver what to do
331 * (2) driver internal use (if applicable)
332 * (3) TX status information - driver tells mac80211 what happened
333 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200334 * The TX control's sta pointer is only valid during the ->tx call,
335 * it may be NULL.
336 *
Johannes Berge039fa42008-05-15 12:55:29 +0200337 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200338 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200339 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200340 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700341 * @control: union for control data
342 * @status: union for status data
343 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200344 * @ampdu_ack_len: number of aggregated frames.
345 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
346 * @ampdu_ack_map: block ack bit map for the aggregation.
347 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
348 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200349 */
Johannes Berge039fa42008-05-15 12:55:29 +0200350struct ieee80211_tx_info {
351 /* common information */
352 u32 flags;
353 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200354
Johannes Berge039fa42008-05-15 12:55:29 +0200355 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100356
Johannes Berge6a98542008-10-21 12:40:02 +0200357 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500358 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100359
Johannes Berge039fa42008-05-15 12:55:29 +0200360 union {
361 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200362 union {
363 /* rate control */
364 struct {
365 struct ieee80211_tx_rate rates[
366 IEEE80211_TX_MAX_RATES];
367 s8 rts_cts_rate_idx;
368 };
369 /* only needed before rate control */
370 unsigned long jiffies;
371 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200372 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200373 struct ieee80211_vif *vif;
374 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200375 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200376 } control;
377 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200378 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
379 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200380 u64 ampdu_ack_map;
381 int ack_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200382 /* 8 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200383 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200384 struct {
385 struct ieee80211_tx_rate driver_rates[
386 IEEE80211_TX_MAX_RATES];
387 void *rate_driver_data[
388 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
389 };
390 void *driver_data[
391 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200392 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700393};
394
Johannes Berge039fa42008-05-15 12:55:29 +0200395static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
396{
397 return (struct ieee80211_tx_info *)skb->cb;
398}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400399
Johannes Bergf1d58c22009-06-17 13:13:00 +0200400static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
401{
402 return (struct ieee80211_rx_status *)skb->cb;
403}
404
Johannes Berge6a98542008-10-21 12:40:02 +0200405/**
406 * ieee80211_tx_info_clear_status - clear TX status
407 *
408 * @info: The &struct ieee80211_tx_info to be cleared.
409 *
410 * When the driver passes an skb back to mac80211, it must report
411 * a number of things in TX status. This function clears everything
412 * in the TX status but the rate control information (it does clear
413 * the count since you need to fill that in anyway).
414 *
415 * NOTE: You can only use this function if you do NOT use
416 * info->driver_data! Use info->rate_driver_data
417 * instead if you need only the less space that allows.
418 */
419static inline void
420ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
421{
422 int i;
423
424 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
425 offsetof(struct ieee80211_tx_info, control.rates));
426 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
427 offsetof(struct ieee80211_tx_info, driver_rates));
428 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
429 /* clear the rate counts */
430 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
431 info->status.rates[i].count = 0;
432
433 BUILD_BUG_ON(
434 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
435 memset(&info->status.ampdu_ack_len, 0,
436 sizeof(struct ieee80211_tx_info) -
437 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
438}
439
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400440
441/**
442 * enum mac80211_rx_flags - receive flags
443 *
444 * These flags are used with the @flag member of &struct ieee80211_rx_status.
445 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
446 * Use together with %RX_FLAG_MMIC_STRIPPED.
447 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
448 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
449 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
450 * verification has been done by the hardware.
451 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
452 * If this flag is set, the stack cannot do any replay detection
453 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400454 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
455 * the frame.
456 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
457 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100458 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900459 * is valid. This is useful in monitor mode and necessary for beacon frames
460 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200461 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200462 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
463 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
464 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400465 */
466enum mac80211_rx_flags {
467 RX_FLAG_MMIC_ERROR = 1<<0,
468 RX_FLAG_DECRYPTED = 1<<1,
469 RX_FLAG_RADIOTAP = 1<<2,
470 RX_FLAG_MMIC_STRIPPED = 1<<3,
471 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400472 RX_FLAG_FAILED_FCS_CRC = 1<<5,
473 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100474 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200475 RX_FLAG_SHORTPRE = 1<<8,
476 RX_FLAG_HT = 1<<9,
477 RX_FLAG_40MHZ = 1<<10,
478 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400479};
480
481/**
482 * struct ieee80211_rx_status - receive status
483 *
484 * The low-level driver should provide this information (the subset
485 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200486 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200487 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900488 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
489 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100490 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400491 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200492 * @signal: signal strength when receiving this frame, either in dBm, in dB or
493 * unspecified depending on the hardware capabilities flags
494 * @IEEE80211_HW_SIGNAL_*
495 * @noise: noise when receiving this frame, in dBm.
496 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400497 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200498 * @rate_idx: index of data rate into band's supported rates or MCS index if
499 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400500 * @flag: %RX_FLAG_*
501 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700502struct ieee80211_rx_status {
503 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100504 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400505 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400506 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700507 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200508 int qual;
Jiri Bencf0706e822007-05-05 11:45:53 -0700509 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100510 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700511 int flag;
512};
513
Johannes Berg6b301cd2007-09-18 17:29:20 -0400514/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400515 * enum ieee80211_conf_flags - configuration flags
516 *
517 * Flags to define PHY configuration options
518 *
Johannes Berg6b301cd2007-09-18 17:29:20 -0400519 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Johannes Berg04fe2032009-04-22 18:44:37 +0200520 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
Johannes Berg5cff20e2009-04-29 12:26:17 +0200521 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
522 * the driver should be prepared to handle configuration requests but
523 * may turn the device off as much as possible. Typically, this flag will
524 * be set when an interface is set UP but not associated or scanning, but
525 * it can also be unset in that case when monitor interfaces are active.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400526 */
527enum ieee80211_conf_flags {
Johannes Berg7a5158e2008-10-08 10:59:33 +0200528 IEEE80211_CONF_RADIOTAP = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200529 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200530 IEEE80211_CONF_IDLE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400531};
Jiri Bencf0706e822007-05-05 11:45:53 -0700532
Johannes Berg7a5158e2008-10-08 10:59:33 +0200533
Jiri Bencf0706e822007-05-05 11:45:53 -0700534/**
Johannes Berge8975582008-10-09 12:18:51 +0200535 * enum ieee80211_conf_changed - denotes which configuration changed
536 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200537 * @_IEEE80211_CONF_CHANGE_RADIO_ENABLED: DEPRECATED
Johannes Berge8975582008-10-09 12:18:51 +0200538 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
539 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200540 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200541 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100542 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200543 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200544 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berge8975582008-10-09 12:18:51 +0200545 */
546enum ieee80211_conf_changed {
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200547 _IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
Johannes Berge8975582008-10-09 12:18:51 +0200548 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
549 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
550 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200551 IEEE80211_CONF_CHANGE_POWER = BIT(5),
552 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
553 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200554 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200555};
556
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200557static inline __deprecated enum ieee80211_conf_changed
558__IEEE80211_CONF_CHANGE_RADIO_ENABLED(void)
559{
560 return _IEEE80211_CONF_CHANGE_RADIO_ENABLED;
561}
562#define IEEE80211_CONF_CHANGE_RADIO_ENABLED \
563 __IEEE80211_CONF_CHANGE_RADIO_ENABLED()
564
Johannes Berge8975582008-10-09 12:18:51 +0200565/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700566 * struct ieee80211_conf - configuration of the device
567 *
568 * This struct indicates how the driver shall configure the hardware.
569 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200570 * @flags: configuration flags defined above
571 *
Jiri Bencf0706e822007-05-05 11:45:53 -0700572 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berge535c752009-05-23 11:18:45 +0200573 * @beacon_int: DEPRECATED, DO NOT USE
Johannes Berg04fe2032009-04-22 18:44:37 +0200574 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800575 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200576 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200577 * before checking the beacon for a TIM bit (managed mode only); this
578 * value will be only achievable between DTIM frames, the hardware
579 * needs to check for the multicast traffic bit in DTIM beacons.
580 * This variable is valid only when the CONF_PS flag is set.
581 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
582 * powersave documentation below. This variable is valid only when
583 * the CONF_PS flag is set.
584 *
Johannes Berg8318d782008-01-24 19:38:38 +0100585 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200586 *
Johannes Berg8318d782008-01-24 19:38:38 +0100587 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100588 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200589 *
Johannes Berg9124b072008-10-14 19:17:54 +0200590 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
591 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
592 * but actually means the number of transmissions not the number of retries
593 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
594 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
595 * number of transmissions not the number of retries
Jiri Bencf0706e822007-05-05 11:45:53 -0700596 */
597struct ieee80211_conf {
Johannes Berge535c752009-05-23 11:18:45 +0200598 int __deprecated beacon_int;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400599 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100600 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200601 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200602
Johannes Berge8975582008-10-09 12:18:51 +0200603 u16 listen_interval;
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200604 bool __deprecated radio_enabled;
Johannes Berge8975582008-10-09 12:18:51 +0200605
Johannes Berg9124b072008-10-14 19:17:54 +0200606 u8 long_frame_max_tx_count, short_frame_max_tx_count;
607
Johannes Berg8318d782008-01-24 19:38:38 +0100608 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100609 enum nl80211_channel_type channel_type;
Jiri Bencf0706e822007-05-05 11:45:53 -0700610};
611
612/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100613 * struct ieee80211_vif - per-interface data
614 *
615 * Data in this structure is continually present for driver
616 * use during the life of a virtual interface.
617 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100618 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200619 * @bss_conf: BSS configuration for this interface, either our own
620 * or the BSS we're associated to
Johannes Berg32bfd352007-12-19 01:31:26 +0100621 * @drv_priv: data area for driver use, will always be aligned to
622 * sizeof(void *).
623 */
624struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200625 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200626 struct ieee80211_bss_conf bss_conf;
Johannes Berg32bfd352007-12-19 01:31:26 +0100627 /* must be last */
628 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
629};
630
Johannes Berg902acc72008-02-23 15:17:19 +0100631static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
632{
633#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200634 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100635#endif
636 return false;
637}
638
Johannes Berg32bfd352007-12-19 01:31:26 +0100639/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700640 * struct ieee80211_if_init_conf - initial configuration of an interface
641 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100642 * @vif: pointer to a driver-use per-interface structure. The pointer
643 * itself is also used for various functions including
644 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Johannes Berg05c914f2008-09-11 00:01:58 +0200645 * @type: one of &enum nl80211_iftype constants. Determines the type of
Jiri Bencf0706e822007-05-05 11:45:53 -0700646 * added/removed interface.
647 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
648 * until the interface is removed (i.e. it cannot be used after
649 * remove_interface() callback was called for this interface).
650 *
651 * This structure is used in add_interface() and remove_interface()
652 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200653 *
654 * When you allow multiple interfaces to be added to your PHY, take care
655 * that the hardware can actually handle multiple MAC addresses. However,
656 * also take care that when there's no interface left with mac_addr != %NULL
657 * you remove the MAC address from the device to avoid acknowledging packets
658 * in pure monitor mode.
Jiri Bencf0706e822007-05-05 11:45:53 -0700659 */
660struct ieee80211_if_init_conf {
Johannes Berg05c914f2008-09-11 00:01:58 +0200661 enum nl80211_iftype type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100662 struct ieee80211_vif *vif;
Jiri Bencf0706e822007-05-05 11:45:53 -0700663 void *mac_addr;
664};
665
666/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400667 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400668 * @ALG_WEP: WEP40 or WEP104
669 * @ALG_TKIP: TKIP
670 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200671 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400672 */
Johannes Bergea49c352007-09-18 17:29:21 -0400673enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400674 ALG_WEP,
675 ALG_TKIP,
676 ALG_CCMP,
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200677 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400678};
Jiri Bencf0706e822007-05-05 11:45:53 -0700679
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300680/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400681 * enum ieee80211_key_flags - key flags
682 *
683 * These flags are used for communication about keys between the driver
684 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
685 *
686 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
687 * that the STA this key will be used with could be using QoS.
688 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
689 * driver to indicate that it requires IV generation for this
690 * particular key.
691 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
692 * the driver for a TKIP key if it requires Michael MIC
693 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200694 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
695 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200696 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
697 * CCMP key if it requires CCMP encryption of management frames (MFP) to
698 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400699 */
700enum ieee80211_key_flags {
701 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
702 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
703 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200704 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200705 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400706};
707
708/**
709 * struct ieee80211_key_conf - key information
710 *
711 * This key information is given by mac80211 to the driver by
712 * the set_key() callback in &struct ieee80211_ops.
713 *
714 * @hw_key_idx: To be set by the driver, this is the key index the driver
715 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400716 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400717 * @alg: The key algorithm.
718 * @flags: key flags, see &enum ieee80211_key_flags.
719 * @keyidx: the key index (0-3)
720 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400721 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
722 * data block:
723 * - Temporal Encryption Key (128 bits)
724 * - Temporal Authenticator Tx MIC Key (64 bits)
725 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100726 * @icv_len: The ICV length for this key type
727 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400728 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700729struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400730 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200731 u8 icv_len;
732 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400733 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400734 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400735 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400736 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700737 u8 key[0];
738};
739
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400740/**
741 * enum set_key_cmd - key command
742 *
743 * Used with the set_key() callback in &struct ieee80211_ops, this
744 * indicates whether a key is being removed or added.
745 *
746 * @SET_KEY: a key is set
747 * @DISABLE_KEY: a key must be disabled
748 */
Johannes Bergea49c352007-09-18 17:29:21 -0400749enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400750 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400751};
Jiri Bencf0706e822007-05-05 11:45:53 -0700752
Tomas Winkler478f8d22007-09-30 13:52:37 +0200753/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200754 * struct ieee80211_sta - station table entry
755 *
756 * A station table entry represents a station we are possibly
757 * communicating with. Since stations are RCU-managed in
758 * mac80211, any ieee80211_sta pointer you get access to must
759 * either be protected by rcu_read_lock() explicitly or implicitly,
760 * or you must take good care to not use such a pointer after a
761 * call to your sta_notify callback that removed it.
762 *
763 * @addr: MAC address
764 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200765 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200766 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200767 * @drv_priv: data area for driver use, will always be aligned to
768 * sizeof(void *), size is determined in hw information.
769 */
770struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100771 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200772 u8 addr[ETH_ALEN];
773 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200774 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200775
776 /* must be last */
777 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
778};
779
780/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200781 * enum sta_notify_cmd - sta notify command
782 *
783 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100784 * indicates addition and removal of a station to station table,
785 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200786 *
787 * @STA_NOTIFY_ADD: a station was added to the station table
788 * @STA_NOTIFY_REMOVE: a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100789 * @STA_NOTIFY_SLEEP: a station is now sleeping
790 * @STA_NOTIFY_AWAKE: a sleeping station woke up
791 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100792enum sta_notify_cmd {
793 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100794 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
795};
796
797/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200798 * enum ieee80211_tkip_key_type - get tkip key
799 *
800 * Used by drivers which need to get a tkip key for skb. Some drivers need a
801 * phase 1 key, others need a phase 2 key. A single function allows the driver
802 * to get the key, this enum indicates what type of key is required.
803 *
804 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
805 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
806 */
807enum ieee80211_tkip_key_type {
808 IEEE80211_TKIP_P1_KEY,
809 IEEE80211_TKIP_P2_KEY,
810};
811
812/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400813 * enum ieee80211_hw_flags - hardware flags
814 *
815 * These flags are used to indicate hardware capabilities to
816 * the stack. Generally, flags here should have their meaning
817 * done in a way that the simplest hardware doesn't need setting
818 * any particular flags. There are some exceptions to this rule,
819 * however, so you are advised to review these flags carefully.
820 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400821 * @IEEE80211_HW_RX_INCLUDES_FCS:
822 * Indicates that received frames passed to the stack include
823 * the FCS at the end.
824 *
825 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
826 * Some wireless LAN chipsets buffer broadcast/multicast frames
827 * for power saving stations in the hardware/firmware and others
828 * rely on the host system for such buffering. This option is used
829 * to configure the IEEE 802.11 upper layer to buffer broadcast and
830 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700831 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400832 *
Johannes Berg8318d782008-01-24 19:38:38 +0100833 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
834 * Hardware is not capable of short slot operation on the 2.4 GHz band.
835 *
836 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
837 * Hardware is not capable of receiving frames with short preamble on
838 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200839 *
840 * @IEEE80211_HW_SIGNAL_UNSPEC:
841 * Hardware can provide signal values but we don't know its units. We
842 * expect values between 0 and @max_signal.
843 * If possible please provide dB or dBm instead.
844 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200845 * @IEEE80211_HW_SIGNAL_DBM:
846 * Hardware gives signal values in dBm, decibel difference from
847 * one milliwatt. This is the preferred method since it is standardized
848 * between different devices. @max_signal does not need to be set.
849 *
850 * @IEEE80211_HW_NOISE_DBM:
851 * Hardware can provide noise (radio interference) values in units dBm,
852 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300853 *
854 * @IEEE80211_HW_SPECTRUM_MGMT:
855 * Hardware supports spectrum management defined in 802.11h
856 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530857 *
858 * @IEEE80211_HW_AMPDU_AGGREGATION:
859 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200860 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100861 * @IEEE80211_HW_SUPPORTS_PS:
862 * Hardware has power save support (i.e. can go to sleep).
863 *
864 * @IEEE80211_HW_PS_NULLFUNC_STACK:
865 * Hardware requires nullfunc frame handling in stack, implies
866 * stack support for dynamic PS.
867 *
868 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
869 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200870 *
871 * @IEEE80211_HW_MFP_CAPABLE:
872 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200873 *
874 * @IEEE80211_HW_BEACON_FILTER:
875 * Hardware supports dropping of irrelevant beacon frames to
876 * avoid waking up cpu.
Johannes Berg1bc08262007-09-18 17:29:15 -0400877 */
878enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400879 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
880 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100881 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
882 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200883 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100884 IEEE80211_HW_SIGNAL_DBM = 1<<6,
885 IEEE80211_HW_NOISE_DBM = 1<<7,
886 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
887 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
888 IEEE80211_HW_SUPPORTS_PS = 1<<10,
889 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
890 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
891 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200892 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg1bc08262007-09-18 17:29:15 -0400893};
894
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400895/**
896 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400897 *
898 * This structure contains the configuration and hardware
899 * information for an 802.11 PHY.
900 *
901 * @wiphy: This points to the &struct wiphy allocated for this
902 * 802.11 PHY. You must fill in the @perm_addr and @dev
903 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100904 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
905 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400906 *
907 * @conf: &struct ieee80211_conf, device configuration, don't use.
908 *
909 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200910 * allocated by mac80211 on registration and flushed when an
911 * interface is removed.
Johannes Bergc771c9d2009-01-23 22:54:03 +0100912 * NOTICE: All work performed on this workqueue must not
913 * acquire the RTNL lock.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400914 *
915 * @priv: pointer to private area that was allocated for driver use
916 * along with this structure.
917 *
918 * @flags: hardware flags, see &enum ieee80211_hw_flags.
919 *
920 * @extra_tx_headroom: headroom to reserve in each transmit skb
921 * for use by the driver (e.g. for transmit headers.)
922 *
923 * @channel_change_time: time (in microseconds) it takes to change channels.
924 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200925 * @max_signal: Maximum value for signal (rssi) in RX information, used
926 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400927 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800928 * @max_listen_interval: max listen interval in units of beacon interval
929 * that HW supports
930 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400931 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200932 * data packets. WMM/QoS requires at least four, these
933 * queues need to have configurable access parameters.
934 *
Johannes Berg830f9032007-10-28 14:51:05 +0100935 * @rate_control_algorithm: rate control algorithm for this hardware.
936 * If unset (NULL), the default algorithm will be used. Must be
937 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100938 *
939 * @vif_data_size: size (in bytes) of the drv_priv data area
940 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200941 * @sta_data_size: size (in bytes) of the drv_priv data area
942 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200943 *
Johannes Berge6a98542008-10-21 12:40:02 +0200944 * @max_rates: maximum number of alternate rate retry stages
945 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400946 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700947struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -0700948 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400949 struct wiphy *wiphy;
Jiri Bencf0706e822007-05-05 11:45:53 -0700950 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100951 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -0700952 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400953 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -0700954 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -0700955 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100956 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +0200957 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800958 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800959 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -0700960 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200961 u8 max_rates;
962 u8 max_rate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -0700963};
964
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400965/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -0800966 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
967 *
968 * @wiphy: the &struct wiphy which we want to query
969 *
970 * mac80211 drivers can use this to get to their respective
971 * &struct ieee80211_hw. Drivers wishing to get to their own private
972 * structure can then access it via hw->priv. Note that mac802111 drivers should
973 * not use wiphy_priv() to try to get their private driver structure as this
974 * is already used internally by mac80211.
975 */
976struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
977
978/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400979 * SET_IEEE80211_DEV - set device for 802.11 hardware
980 *
981 * @hw: the &struct ieee80211_hw to set the device for
982 * @dev: the &struct device of this 802.11 device
983 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700984static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
985{
986 set_wiphy_dev(hw->wiphy, dev);
987}
988
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400989/**
Bob Copelande37d4df2008-10-20 21:20:27 -0400990 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400991 *
992 * @hw: the &struct ieee80211_hw to set the MAC address for
993 * @addr: the address to set
994 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700995static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
996{
997 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
998}
999
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001000static inline struct ieee80211_rate *
1001ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001002 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001003{
Johannes Berge6a98542008-10-21 12:40:02 +02001004 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001005 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001006 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001007}
1008
1009static inline struct ieee80211_rate *
1010ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001011 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001012{
Johannes Berge039fa42008-05-15 12:55:29 +02001013 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001014 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001015 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001016}
1017
1018static inline struct ieee80211_rate *
1019ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001020 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001021{
Johannes Berge6a98542008-10-21 12:40:02 +02001022 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001023 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001024 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001025}
1026
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001027/**
1028 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001029 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001030 * mac80211 is capable of taking advantage of many hardware
1031 * acceleration designs for encryption and decryption operations.
1032 *
1033 * The set_key() callback in the &struct ieee80211_ops for a given
1034 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001035 * decryption. The callback takes a @sta parameter that will be NULL
1036 * for default keys or keys used for transmission only, or point to
1037 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001038 * Multiple transmission keys with the same key index may be used when
1039 * VLANs are configured for an access point.
1040 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001041 * When transmitting, the TX control data will use the @hw_key_idx
1042 * selected by the driver by modifying the &struct ieee80211_key_conf
1043 * pointed to by the @key parameter to the set_key() function.
1044 *
1045 * The set_key() call for the %SET_KEY command should return 0 if
1046 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1047 * added; if you return 0 then hw_key_idx must be assigned to the
1048 * hardware key index, you are free to use the full u8 range.
1049 *
1050 * When the cmd is %DISABLE_KEY then it must succeed.
1051 *
1052 * Note that it is permissible to not decrypt a frame even if a key
1053 * for it has been uploaded to hardware, the stack will not make any
1054 * decision based on whether a key has been uploaded or not but rather
1055 * based on the receive flags.
1056 *
1057 * The &struct ieee80211_key_conf structure pointed to by the @key
1058 * parameter is guaranteed to be valid until another call to set_key()
1059 * removes it, but it can only be used as a cookie to differentiate
1060 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001061 *
1062 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1063 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1064 * handler.
1065 * The update_tkip_key() call updates the driver with the new phase 1 key.
1066 * This happens everytime the iv16 wraps around (every 65536 packets). The
1067 * set_key() call will happen only once for each key (unless the AP did
1068 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001069 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001070 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001071 */
Johannes Berg4150c572007-09-17 01:29:23 -04001072
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001073/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001074 * DOC: Powersave support
1075 *
1076 * mac80211 has support for various powersave implementations.
1077 *
1078 * First, it can support hardware that handles all powersaving by
1079 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1080 * hardware flag. In that case, it will be told about the desired
1081 * powersave mode depending on the association status, and the driver
1082 * must take care of sending nullfunc frames when necessary, i.e. when
1083 * entering and leaving powersave mode. The driver is required to look at
1084 * the AID in beacons and signal to the AP that it woke up when it finds
1085 * traffic directed to it. This mode supports dynamic PS by simply
1086 * enabling/disabling PS.
1087 *
1088 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1089 * flag to indicate that it can support dynamic PS mode itself (see below).
1090 *
1091 * Other hardware designs cannot send nullfunc frames by themselves and also
1092 * need software support for parsing the TIM bitmap. This is also supported
1093 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1094 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001095 * required to pass up beacons. The hardware is still required to handle
1096 * waking up for multicast traffic; if it cannot the driver must handle that
1097 * as best as it can, mac80211 is too slow.
Johannes Berg4be8c382009-01-07 18:28:20 +01001098 *
1099 * Dynamic powersave mode is an extension to normal powersave mode in which
1100 * the hardware stays awake for a user-specified period of time after sending
1101 * a frame so that reply frames need not be buffered and therefore delayed
1102 * to the next wakeup. This can either be supported by hardware, in which case
1103 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1104 * value, or by the stack if all nullfunc handling is in the stack.
1105 */
1106
1107/**
Kalle Valo04de8382009-03-22 21:57:35 +02001108 * DOC: Beacon filter support
1109 *
1110 * Some hardware have beacon filter support to reduce host cpu wakeups
1111 * which will reduce system power consumption. It usuallly works so that
1112 * the firmware creates a checksum of the beacon but omits all constantly
1113 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1114 * beacon is forwarded to the host, otherwise it will be just dropped. That
1115 * way the host will only receive beacons where some relevant information
1116 * (for example ERP protection or WMM settings) have changed.
1117 *
Johannes Berg955394c2009-04-16 17:04:25 +02001118 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1119 * hardware capability. The driver needs to enable beacon filter support
1120 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1121 * power save is enabled, the stack will not check for beacon loss and the
1122 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1123 *
1124 * The time (or number of beacons missed) until the firmware notifies the
1125 * driver of a beacon loss event (which in turn causes the driver to call
1126 * ieee80211_beacon_loss()) should be configurable and will be controlled
1127 * by mac80211 and the roaming algorithm in the future.
1128 *
1129 * Since there may be constantly changing information elements that nothing
1130 * in the software stack cares about, we will, in the future, have mac80211
1131 * tell the driver which information elements are interesting in the sense
1132 * that we want to see changes in them. This will include
1133 * - a list of information element IDs
1134 * - a list of OUIs for the vendor information element
1135 *
1136 * Ideally, the hardware would filter out any beacons without changes in the
1137 * requested elements, but if it cannot support that it may, at the expense
1138 * of some efficiency, filter out only a subset. For example, if the device
1139 * doesn't support checking for OUIs it should pass up all changes in all
1140 * vendor information elements.
1141 *
1142 * Note that change, for the sake of simplification, also includes information
1143 * elements appearing or disappearing from the beacon.
1144 *
1145 * Some hardware supports an "ignore list" instead, just make sure nothing
1146 * that was requested is on the ignore list, and include commonly changing
1147 * information element IDs in the ignore list, for example 11 (BSS load) and
1148 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1149 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1150 * it could also include some currently unused IDs.
1151 *
1152 *
1153 * In addition to these capabilities, hardware should support notifying the
1154 * host of changes in the beacon RSSI. This is relevant to implement roaming
1155 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1156 * the received data packets). This can consist in notifying the host when
1157 * the RSSI changes significantly or when it drops below or rises above
1158 * configurable thresholds. In the future these thresholds will also be
1159 * configured by mac80211 (which gets them from userspace) to implement
1160 * them as the roaming algorithm requires.
1161 *
1162 * If the hardware cannot implement this, the driver should ask it to
1163 * periodically pass beacon frames to the host so that software can do the
1164 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001165 */
1166
1167/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001168 * DOC: Frame filtering
1169 *
1170 * mac80211 requires to see many management frames for proper
1171 * operation, and users may want to see many more frames when
1172 * in monitor mode. However, for best CPU usage and power consumption,
1173 * having as few frames as possible percolate through the stack is
1174 * desirable. Hence, the hardware should filter as much as possible.
1175 *
1176 * To achieve this, mac80211 uses filter flags (see below) to tell
1177 * the driver's configure_filter() function which frames should be
1178 * passed to mac80211 and which should be filtered out.
1179 *
1180 * The configure_filter() callback is invoked with the parameters
1181 * @mc_count and @mc_list for the combined multicast address list
1182 * of all virtual interfaces, @changed_flags telling which flags
1183 * were changed and @total_flags with the new flag states.
1184 *
1185 * If your device has no multicast address filters your driver will
1186 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1187 * parameter to see whether multicast frames should be accepted
1188 * or dropped.
1189 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001190 * All unsupported flags in @total_flags must be cleared.
1191 * Hardware does not support a flag if it is incapable of _passing_
1192 * the frame to the stack. Otherwise the driver must ignore
1193 * the flag, but not clear it.
1194 * You must _only_ clear the flag (announce no support for the
1195 * flag to mac80211) if you are not able to pass the packet type
1196 * to the stack (so the hardware always filters it).
1197 * So for example, you should clear @FIF_CONTROL, if your hardware
1198 * always filters control frames. If your hardware always passes
1199 * control frames to the kernel and is incapable of filtering them,
1200 * you do _not_ clear the @FIF_CONTROL flag.
1201 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001202 */
1203
1204/**
1205 * enum ieee80211_filter_flags - hardware filter flags
1206 *
1207 * These flags determine what the filter in hardware should be
1208 * programmed to let through and what should not be passed to the
1209 * stack. It is always safe to pass more frames than requested,
1210 * but this has negative impact on power consumption.
1211 *
1212 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1213 * think of the BSS as your network segment and then this corresponds
1214 * to the regular ethernet device promiscuous mode.
1215 *
1216 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1217 * by the user or if the hardware is not capable of filtering by
1218 * multicast address.
1219 *
1220 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1221 * %RX_FLAG_FAILED_FCS_CRC for them)
1222 *
1223 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1224 * the %RX_FLAG_FAILED_PLCP_CRC for them
1225 *
1226 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1227 * to the hardware that it should not filter beacons or probe responses
1228 * by BSSID. Filtering them can greatly reduce the amount of processing
1229 * mac80211 needs to do and the amount of CPU wakeups, so you should
1230 * honour this flag if possible.
1231 *
1232 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1233 * only those addressed to this station
1234 *
1235 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1236 */
1237enum ieee80211_filter_flags {
1238 FIF_PROMISC_IN_BSS = 1<<0,
1239 FIF_ALLMULTI = 1<<1,
1240 FIF_FCSFAIL = 1<<2,
1241 FIF_PLCPFAIL = 1<<3,
1242 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1243 FIF_CONTROL = 1<<5,
1244 FIF_OTHER_BSS = 1<<6,
1245};
1246
1247/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001248 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1249 *
1250 * These flags are used with the ampdu_action() callback in
1251 * &struct ieee80211_ops to indicate which action is needed.
1252 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1253 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001254 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1255 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001256 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001257 */
1258enum ieee80211_ampdu_mlme_action {
1259 IEEE80211_AMPDU_RX_START,
1260 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001261 IEEE80211_AMPDU_TX_START,
1262 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001263 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001264};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001265
1266/**
1267 * struct ieee80211_ops - callbacks from mac80211 to the driver
1268 *
1269 * This structure contains various callbacks that the driver may
1270 * handle or, in some cases, must handle, for example to configure
1271 * the hardware to a new channel or to transmit a frame.
1272 *
1273 * @tx: Handler that 802.11 module calls for each transmitted frame.
1274 * skb contains the buffer starting from the IEEE 802.11 header.
1275 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001276 * configuration in the TX control data. This handler should,
1277 * preferably, never fail and stop queues appropriately, more
1278 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001279 * This function should return NETDEV_TX_OK except in very
1280 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001281 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001282 *
1283 * @start: Called before the first netdevice attached to the hardware
1284 * is enabled. This should turn on the hardware and must turn on
1285 * frame reception (for possibly enabled monitor interfaces.)
1286 * Returns negative error codes, these may be seen in userspace,
1287 * or zero.
1288 * When the device is started it should not have a MAC address
1289 * to avoid acknowledging frames before a non-monitor device
1290 * is added.
1291 * Must be implemented.
1292 *
1293 * @stop: Called after last netdevice attached to the hardware
1294 * is disabled. This should turn off the hardware (at least
1295 * it must turn off frame reception.)
1296 * May be called right after add_interface if that rejects
1297 * an interface.
1298 * Must be implemented.
1299 *
1300 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001301 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001302 * and @stop must be implemented.
1303 * The driver should perform any initialization it needs before
1304 * the device can be enabled. The initial configuration for the
1305 * interface is given in the conf parameter.
1306 * The callback may refuse to add an interface by returning a
1307 * negative error code (which will be seen in userspace.)
1308 * Must be implemented.
1309 *
1310 * @remove_interface: Notifies a driver that an interface is going down.
1311 * The @stop callback is called after this if it is the last interface
1312 * and no monitor interfaces are present.
1313 * When all interfaces are removed, the MAC address in the hardware
1314 * must be cleared so the device no longer acknowledges packets,
1315 * the mac_addr member of the conf structure is, however, set to the
1316 * MAC address of the device going away.
1317 * Hence, this callback must be implemented.
1318 *
1319 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1320 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001321 * This function should never fail but returns a negative error code
1322 * if it does.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001323 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001324 * @bss_info_changed: Handler for configuration requests related to BSS
1325 * parameters that may vary during BSS's lifespan, and may affect low
1326 * level driver (e.g. assoc/disassoc status, erp parameters).
1327 * This function should not be used if no BSS has been set, unless
1328 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001329 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001330 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001331 * @configure_filter: Configure the device's RX filter.
1332 * See the section "Frame filtering" for more information.
1333 * This callback must be implemented and atomic.
1334 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001335 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001336 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001337 *
1338 * @set_key: See the section "Hardware crypto acceleration"
1339 * This callback can sleep, and is only called between add_interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001340 * and remove_interface calls, i.e. while the given virtual interface
1341 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001342 * Returns a negative error code if the key can't be added.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001343 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001344 * @update_tkip_key: See the section "Hardware crypto acceleration"
1345 * This callback will be called in the context of Rx. Called for drivers
1346 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1347 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001348 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001349 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001350 * configuration done by the regulatory agent in the wiphy's
1351 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001352 * that power save is disabled.
1353 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1354 * entire IEs after the SSID, so that drivers need not look at these
1355 * at all but just send them after the SSID -- mac80211 includes the
1356 * (extended) supported rates and HT information (where applicable).
1357 * When the scan finishes, ieee80211_scan_completed() must be called;
1358 * note that it also must be called when the scan cannot finish due to
1359 * any error unless this callback returned a negative error code.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001360 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001361 * @sw_scan_start: Notifier function that is called just before a software scan
1362 * is started. Can be NULL, if the driver doesn't need this notification.
1363 *
1364 * @sw_scan_complete: Notifier function that is called just after a software scan
1365 * finished. Can be NULL, if the driver doesn't need this notification.
1366 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001367 * @get_stats: Return low-level statistics.
1368 * Returns zero if statistics are available.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001369 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001370 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1371 * callback should be provided to read the TKIP transmit IVs (both IV32
1372 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001373 *
1374 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1375 *
Christian Lamparter89fad572008-12-09 16:28:06 +01001376 * @sta_notify: Notifies low level driver about addition, removal or power
1377 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1378 * Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001379 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001380 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001381 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001382 * Returns a negative error code on failure.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001383 *
1384 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1385 * to get number of currently queued packets (queue length), maximum queue
1386 * size (limit), and total number of packets sent using each TX queue
Johannes Berge4e72fb2009-03-23 17:28:42 +01001387 * (count). The 'stats' pointer points to an array that has hw->queues
1388 * items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001389 *
1390 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001391 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001392 * required function.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001393 *
1394 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1395 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001396 * required function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001397 *
1398 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1399 * with other STAs in the IBSS. This is only used in IBSS mode. This
1400 * function is optional if the firmware/hardware takes full care of
1401 * TSF synchronization.
1402 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001403 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1404 * This is needed only for IBSS mode and the result of this function is
1405 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001406 * Returns non-zero if this device sent the last beacon.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001407 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001408 * @ampdu_action: Perform a certain A-MPDU action
1409 * The RA/TID combination determines the destination and TID we want
1410 * the ampdu action to be performed for. The action is defined through
1411 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001412 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001413 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001414 * Returns a negative error code on failure.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001415 *
1416 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1417 * need to set wiphy->rfkill_poll to %true before registration,
1418 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001419 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001420struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001421 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001422 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001423 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001424 int (*add_interface)(struct ieee80211_hw *hw,
1425 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001426 void (*remove_interface)(struct ieee80211_hw *hw,
1427 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +02001428 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001429 void (*bss_info_changed)(struct ieee80211_hw *hw,
1430 struct ieee80211_vif *vif,
1431 struct ieee80211_bss_conf *info,
1432 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001433 void (*configure_filter)(struct ieee80211_hw *hw,
1434 unsigned int changed_flags,
1435 unsigned int *total_flags,
1436 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg17741cd2008-09-11 00:02:02 +02001437 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1438 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001439 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001440 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001441 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001442 void (*update_tkip_key)(struct ieee80211_hw *hw,
1443 struct ieee80211_key_conf *conf, const u8 *address,
1444 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001445 int (*hw_scan)(struct ieee80211_hw *hw,
1446 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001447 void (*sw_scan_start)(struct ieee80211_hw *hw);
1448 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001449 int (*get_stats)(struct ieee80211_hw *hw,
1450 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001451 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1452 u32 *iv32, u16 *iv16);
Jiri Bencf0706e822007-05-05 11:45:53 -07001453 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001454 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001455 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001456 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001457 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001458 int (*get_tx_stats)(struct ieee80211_hw *hw,
1459 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e822007-05-05 11:45:53 -07001460 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001461 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001462 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001463 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001464 int (*ampdu_action)(struct ieee80211_hw *hw,
1465 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001466 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001467
1468 void (*rfkill_poll)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001469};
1470
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001471/**
1472 * ieee80211_alloc_hw - Allocate a new hardware device
1473 *
1474 * This must be called once for each hardware device. The returned pointer
1475 * must be used to refer to this device when calling other functions.
1476 * mac80211 allocates a private data area for the driver pointed to by
1477 * @priv in &struct ieee80211_hw, the size of this area is given as
1478 * @priv_data_len.
1479 *
1480 * @priv_data_len: length of private data
1481 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001482 */
1483struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1484 const struct ieee80211_ops *ops);
1485
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001486/**
1487 * ieee80211_register_hw - Register hardware device
1488 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001489 * You must call this function before any other functions in
1490 * mac80211. Note that before a hardware can be registered, you
1491 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001492 *
1493 * @hw: the device to register as returned by ieee80211_alloc_hw()
1494 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001495int ieee80211_register_hw(struct ieee80211_hw *hw);
1496
Jiri Bencf0706e822007-05-05 11:45:53 -07001497#ifdef CONFIG_MAC80211_LEDS
1498extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1499extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001500extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001501extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001502#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001503/**
1504 * ieee80211_get_tx_led_name - get name of TX LED
1505 *
1506 * mac80211 creates a transmit LED trigger for each wireless hardware
1507 * that can be used to drive LEDs if your driver registers a LED device.
1508 * This function returns the name (or %NULL if not configured for LEDs)
1509 * of the trigger so you can automatically link the LED device.
1510 *
1511 * @hw: the hardware to get the LED trigger name for
1512 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001513static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1514{
1515#ifdef CONFIG_MAC80211_LEDS
1516 return __ieee80211_get_tx_led_name(hw);
1517#else
1518 return NULL;
1519#endif
1520}
1521
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001522/**
1523 * ieee80211_get_rx_led_name - get name of RX LED
1524 *
1525 * mac80211 creates a receive LED trigger for each wireless hardware
1526 * that can be used to drive LEDs if your driver registers a LED device.
1527 * This function returns the name (or %NULL if not configured for LEDs)
1528 * of the trigger so you can automatically link the LED device.
1529 *
1530 * @hw: the hardware to get the LED trigger name for
1531 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001532static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1533{
1534#ifdef CONFIG_MAC80211_LEDS
1535 return __ieee80211_get_rx_led_name(hw);
1536#else
1537 return NULL;
1538#endif
1539}
1540
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001541/**
1542 * ieee80211_get_assoc_led_name - get name of association LED
1543 *
1544 * mac80211 creates a association LED trigger for each wireless hardware
1545 * that can be used to drive LEDs if your driver registers a LED device.
1546 * This function returns the name (or %NULL if not configured for LEDs)
1547 * of the trigger so you can automatically link the LED device.
1548 *
1549 * @hw: the hardware to get the LED trigger name for
1550 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001551static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1552{
1553#ifdef CONFIG_MAC80211_LEDS
1554 return __ieee80211_get_assoc_led_name(hw);
1555#else
1556 return NULL;
1557#endif
1558}
1559
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001560/**
1561 * ieee80211_get_radio_led_name - get name of radio LED
1562 *
1563 * mac80211 creates a radio change LED trigger for each wireless hardware
1564 * that can be used to drive LEDs if your driver registers a LED device.
1565 * This function returns the name (or %NULL if not configured for LEDs)
1566 * of the trigger so you can automatically link the LED device.
1567 *
1568 * @hw: the hardware to get the LED trigger name for
1569 */
1570static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1571{
1572#ifdef CONFIG_MAC80211_LEDS
1573 return __ieee80211_get_radio_led_name(hw);
1574#else
1575 return NULL;
1576#endif
1577}
Michael Buesch47f0c502007-09-27 15:10:44 +02001578
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001579/**
1580 * ieee80211_unregister_hw - Unregister a hardware device
1581 *
1582 * This function instructs mac80211 to free allocated resources
1583 * and unregister netdevices from the networking subsystem.
1584 *
1585 * @hw: the hardware to unregister
1586 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001587void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1588
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001589/**
1590 * ieee80211_free_hw - free hardware descriptor
1591 *
1592 * This function frees everything that was allocated, including the
1593 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001594 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001595 *
1596 * @hw: the hardware to free
1597 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001598void ieee80211_free_hw(struct ieee80211_hw *hw);
1599
Johannes Bergf2753dd2009-04-14 10:09:24 +02001600/**
1601 * ieee80211_restart_hw - restart hardware completely
1602 *
1603 * Call this function when the hardware was restarted for some reason
1604 * (hardware error, ...) and the driver is unable to restore its state
1605 * by itself. mac80211 assumes that at this point the driver/hardware
1606 * is completely uninitialised and stopped, it starts the process by
1607 * calling the ->start() operation. The driver will need to reset all
1608 * internal state that it has prior to calling this function.
1609 *
1610 * @hw: the hardware to restart
1611 */
1612void ieee80211_restart_hw(struct ieee80211_hw *hw);
1613
Johannes Bergf1d58c22009-06-17 13:13:00 +02001614/*
1615 * trick to avoid symbol clashes with the ieee80211 subsystem,
1616 * use the inline below instead
1617 */
1618void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001619
1620/**
1621 * ieee80211_rx - receive frame
1622 *
1623 * Use this function to hand received frames to mac80211. The receive
1624 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1625 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1626 *
Johannes Berg2485f712008-02-25 16:27:41 +01001627 * This function may not be called in IRQ context. Calls to this function
1628 * for a single hardware must be synchronized against each other. Calls
1629 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1630 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001631 *
1632 * @hw: the hardware this frame came in on
1633 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001634 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001635static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001636{
Johannes Bergf1d58c22009-06-17 13:13:00 +02001637 __ieee80211_rx(hw, skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001638}
1639
1640/**
1641 * ieee80211_rx_irqsafe - receive frame
1642 *
1643 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001644 * (internally defers to a tasklet.)
1645 *
1646 * Calls to this function and ieee80211_rx() may not be mixed for a
1647 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001648 *
1649 * @hw: the hardware this frame came in on
1650 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001651 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001652void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001653
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001654/**
1655 * ieee80211_tx_status - transmit status callback
1656 *
1657 * Call this function for all transmitted frames after they have been
1658 * transmitted. It is permissible to not call this function for
1659 * multicast frames but this can affect statistics.
1660 *
Johannes Berg2485f712008-02-25 16:27:41 +01001661 * This function may not be called in IRQ context. Calls to this function
1662 * for a single hardware must be synchronized against each other. Calls
1663 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1664 * for a single hardware.
1665 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001666 * @hw: the hardware the frame was transmitted by
1667 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001668 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001669void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001670 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001671
1672/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001673 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001674 *
1675 * Like ieee80211_tx_status() but can be called in IRQ context
1676 * (internally defers to a tasklet.)
1677 *
1678 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1679 * single hardware.
1680 *
1681 * @hw: the hardware the frame was transmitted by
1682 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001683 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001684void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001685 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001686
1687/**
1688 * ieee80211_beacon_get - beacon generation function
1689 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001690 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001691 *
1692 * If the beacon frames are generated by the host system (i.e., not in
1693 * hardware/firmware), the low-level driver uses this function to receive
1694 * the next beacon frame from the 802.11 code. The low-level is responsible
1695 * for calling this function before beacon data is needed (e.g., based on
1696 * hardware interrupt). Returned skb is used only once and low-level driver
Bob Copelande37d4df2008-10-20 21:20:27 -04001697 * is responsible for freeing it.
Jiri Bencf0706e822007-05-05 11:45:53 -07001698 */
1699struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001700 struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001701
1702/**
1703 * ieee80211_rts_get - RTS frame generation function
1704 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001705 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001706 * @frame: pointer to the frame that is going to be protected by the RTS.
1707 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001708 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001709 * @rts: The buffer where to store the RTS frame.
1710 *
1711 * If the RTS frames are generated by the host system (i.e., not in
1712 * hardware/firmware), the low-level driver uses this function to receive
1713 * the next RTS frame from the 802.11 code. The low-level is responsible
1714 * for calling this function before and RTS frame is needed.
1715 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001716void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001717 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001718 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001719 struct ieee80211_rts *rts);
1720
1721/**
1722 * ieee80211_rts_duration - Get the duration field for an RTS frame
1723 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001724 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001725 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001726 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001727 *
1728 * If the RTS is generated in firmware, but the host system must provide
1729 * the duration field, the low-level driver uses this function to receive
1730 * the duration field value in little-endian byteorder.
1731 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001732__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1733 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001734 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001735
1736/**
1737 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1738 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001739 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001740 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1741 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001742 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001743 * @cts: The buffer where to store the CTS-to-self frame.
1744 *
1745 * If the CTS-to-self frames are generated by the host system (i.e., not in
1746 * hardware/firmware), the low-level driver uses this function to receive
1747 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1748 * for calling this function before and CTS-to-self frame is needed.
1749 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001750void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1751 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001752 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001753 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001754 struct ieee80211_cts *cts);
1755
1756/**
1757 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1758 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001759 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001760 * @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 +02001761 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001762 *
1763 * If the CTS-to-self is generated in firmware, but the host system must provide
1764 * the duration field, the low-level driver uses this function to receive
1765 * the duration field value in little-endian byteorder.
1766 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001767__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1768 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001769 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001770 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001771
1772/**
1773 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1774 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001775 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001776 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001777 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07001778 *
1779 * Calculate the duration field of some generic frame, given its
1780 * length and transmission rate (in 100kbps).
1781 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001782__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1783 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001784 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001785 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07001786
1787/**
1788 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1789 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001790 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001791 *
1792 * Function for accessing buffered broadcast and multicast frames. If
1793 * hardware/firmware does not implement buffering of broadcast/multicast
1794 * frames when power saving is used, 802.11 code buffers them in the host
1795 * memory. The low-level driver uses this function to fetch next buffered
1796 * frame. In most cases, this is used when generating beacon frame. This
1797 * function returns a pointer to the next buffered skb or NULL if no more
1798 * buffered frames are available.
1799 *
1800 * Note: buffered frames are returned only after DTIM beacon frame was
1801 * generated with ieee80211_beacon_get() and the low-level driver must thus
1802 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1803 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1804 * does not need to check for DTIM beacons separately and should be able to
1805 * use common code for all beacons.
1806 */
1807struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001808ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001809
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001810/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001811 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1812 *
1813 * This function computes a TKIP rc4 key for an skb. It computes
1814 * a phase 1 key if needed (iv16 wraps around). This function is to
1815 * be used by drivers which can do HW encryption but need to compute
1816 * to phase 1/2 key in SW.
1817 *
1818 * @keyconf: the parameter passed with the set key
1819 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001820 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001821 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001822 */
1823void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1824 struct sk_buff *skb,
1825 enum ieee80211_tkip_key_type type, u8 *key);
1826/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001827 * ieee80211_wake_queue - wake specific queue
1828 * @hw: pointer as obtained from ieee80211_alloc_hw().
1829 * @queue: queue number (counted from zero).
1830 *
1831 * Drivers should use this function instead of netif_wake_queue.
1832 */
1833void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1834
1835/**
1836 * ieee80211_stop_queue - stop specific queue
1837 * @hw: pointer as obtained from ieee80211_alloc_hw().
1838 * @queue: queue number (counted from zero).
1839 *
1840 * Drivers should use this function instead of netif_stop_queue.
1841 */
1842void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1843
1844/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001845 * ieee80211_queue_stopped - test status of the queue
1846 * @hw: pointer as obtained from ieee80211_alloc_hw().
1847 * @queue: queue number (counted from zero).
1848 *
1849 * Drivers should use this function instead of netif_stop_queue.
1850 */
1851
1852int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1853
1854/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001855 * ieee80211_stop_queues - stop all queues
1856 * @hw: pointer as obtained from ieee80211_alloc_hw().
1857 *
1858 * Drivers should use this function instead of netif_stop_queue.
1859 */
1860void ieee80211_stop_queues(struct ieee80211_hw *hw);
1861
1862/**
1863 * ieee80211_wake_queues - wake all queues
1864 * @hw: pointer as obtained from ieee80211_alloc_hw().
1865 *
1866 * Drivers should use this function instead of netif_wake_queue.
1867 */
1868void ieee80211_wake_queues(struct ieee80211_hw *hw);
1869
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001870/**
1871 * ieee80211_scan_completed - completed hardware scan
1872 *
1873 * When hardware scan offload is used (i.e. the hw_scan() callback is
1874 * assigned) this function needs to be called by the driver to notify
1875 * mac80211 that the scan finished.
1876 *
1877 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01001878 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001879 */
Johannes Berg2a519312009-02-10 21:25:55 +01001880void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07001881
Johannes Bergdabeb342007-11-09 01:57:29 +01001882/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001883 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001884 *
1885 * This function iterates over the interfaces associated with a given
1886 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001887 * This function allows the iterator function to sleep, when the iterator
1888 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1889 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001890 *
1891 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001892 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001893 * @data: first argument of the iterator function
1894 */
1895void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1896 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001897 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001898 void *data);
1899
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001900/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001901 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1902 *
1903 * This function iterates over the interfaces associated with a given
1904 * hardware that are currently active and calls the callback for them.
1905 * This function requires the iterator callback function to be atomic,
1906 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1907 *
1908 * @hw: the hardware struct of which the interfaces should be iterated over
1909 * @iterator: the iterator function to call, cannot sleep
1910 * @data: first argument of the iterator function
1911 */
1912void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1913 void (*iterator)(void *data,
1914 u8 *mac,
1915 struct ieee80211_vif *vif),
1916 void *data);
1917
1918/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001919 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1920 * @hw: pointer as obtained from ieee80211_alloc_hw().
1921 * @ra: receiver address of the BA session recipient
1922 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001923 *
1924 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001925 *
1926 * Although mac80211/low level driver/user space application can estimate
1927 * the need to start aggregation on a certain RA/TID, the session level
1928 * will be managed by the mac80211.
1929 */
1930int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1931
1932/**
1933 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1934 * @hw: pointer as obtained from ieee80211_alloc_hw().
1935 * @ra: receiver address of the BA session recipient.
1936 * @tid: the TID to BA on.
1937 *
1938 * This function must be called by low level driver once it has
1939 * finished with preparations for the BA session.
1940 */
1941void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1942
1943/**
1944 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1945 * @hw: pointer as obtained from ieee80211_alloc_hw().
1946 * @ra: receiver address of the BA session recipient.
1947 * @tid: the TID to BA on.
1948 *
1949 * This function must be called by low level driver once it has
1950 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001951 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001952 */
1953void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1954 u16 tid);
1955
1956/**
1957 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1958 * @hw: pointer as obtained from ieee80211_alloc_hw().
1959 * @ra: receiver address of the BA session recipient
1960 * @tid: the TID to stop BA.
1961 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001962 *
1963 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001964 *
1965 * Although mac80211/low level driver/user space application can estimate
1966 * the need to stop aggregation on a certain RA/TID, the session level
1967 * will be managed by the mac80211.
1968 */
1969int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1970 u8 *ra, u16 tid,
1971 enum ieee80211_back_parties initiator);
1972
1973/**
1974 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1975 * @hw: pointer as obtained from ieee80211_alloc_hw().
1976 * @ra: receiver address of the BA session recipient.
1977 * @tid: the desired TID to BA on.
1978 *
1979 * This function must be called by low level driver once it has
1980 * finished with preparations for the BA session tear down.
1981 */
1982void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1983
1984/**
1985 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1986 * @hw: pointer as obtained from ieee80211_alloc_hw().
1987 * @ra: receiver address of the BA session recipient.
1988 * @tid: the desired TID to BA on.
1989 *
1990 * This function must be called by low level driver once it has
1991 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001992 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001993 */
1994void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1995 u16 tid);
1996
Mohamed Abbas84363e62008-04-04 16:59:58 -07001997/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001998 * ieee80211_find_sta - find a station
1999 *
2000 * @hw: pointer as obtained from ieee80211_alloc_hw()
2001 * @addr: station's address
2002 *
2003 * This function must be called under RCU lock and the
2004 * resulting pointer is only valid under RCU lock as well.
2005 */
2006struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
2007 const u8 *addr);
2008
Kalle Valo04de8382009-03-22 21:57:35 +02002009/**
2010 * ieee80211_beacon_loss - inform hardware does not receive beacons
2011 *
2012 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2013 *
2014 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2015 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2016 * hardware is not receiving beacons with this function.
2017 */
2018void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002019
2020/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002021
Johannes Berg4b7679a2008-09-18 18:14:18 +02002022/**
Sujith81cb7622009-02-12 11:38:37 +05302023 * enum rate_control_changed - flags to indicate which parameter changed
2024 *
2025 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2026 * changed, rate control algorithm can update its internal state if needed.
2027 */
2028enum rate_control_changed {
2029 IEEE80211_RC_HT_CHANGED = BIT(0)
2030};
2031
2032/**
Johannes Berge6a98542008-10-21 12:40:02 +02002033 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002034 *
Johannes Berge6a98542008-10-21 12:40:02 +02002035 * @hw: The hardware the algorithm is invoked for.
2036 * @sband: The band this frame is being transmitted on.
2037 * @bss_conf: the current BSS configuration
2038 * @reported_rate: The rate control algorithm can fill this in to indicate
2039 * which rate should be reported to userspace as the current rate and
2040 * used for rate calculations in the mesh network.
2041 * @rts: whether RTS will be used for this frame because it is longer than the
2042 * RTS threshold
2043 * @short_preamble: whether mac80211 will request short-preamble transmission
2044 * if the selected rate supports it
2045 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002046 * @skb: the skb that will be transmitted, the control information in it needs
2047 * to be filled in
Johannes Berg4b7679a2008-09-18 18:14:18 +02002048 */
Johannes Berge6a98542008-10-21 12:40:02 +02002049struct ieee80211_tx_rate_control {
2050 struct ieee80211_hw *hw;
2051 struct ieee80211_supported_band *sband;
2052 struct ieee80211_bss_conf *bss_conf;
2053 struct sk_buff *skb;
2054 struct ieee80211_tx_rate reported_rate;
2055 bool rts, short_preamble;
2056 u8 max_rate_idx;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002057};
2058
2059struct rate_control_ops {
2060 struct module *module;
2061 const char *name;
2062 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002063 void (*free)(void *priv);
2064
2065 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2066 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2067 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302068 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2069 struct ieee80211_sta *sta,
2070 void *priv_sta, u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002071 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2072 void *priv_sta);
2073
2074 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2075 struct ieee80211_sta *sta, void *priv_sta,
2076 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002077 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2078 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002079
2080 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2081 struct dentry *dir);
2082 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2083};
2084
2085static inline int rate_supported(struct ieee80211_sta *sta,
2086 enum ieee80211_band band,
2087 int index)
2088{
2089 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2090}
2091
2092static inline s8
2093rate_lowest_index(struct ieee80211_supported_band *sband,
2094 struct ieee80211_sta *sta)
2095{
2096 int i;
2097
2098 for (i = 0; i < sband->n_bitrates; i++)
2099 if (rate_supported(sta, sband->band, i))
2100 return i;
2101
2102 /* warn when we cannot find a rate. */
2103 WARN_ON(1);
2104
2105 return 0;
2106}
2107
2108
2109int ieee80211_rate_control_register(struct rate_control_ops *ops);
2110void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2111
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002112static inline bool
2113conf_is_ht20(struct ieee80211_conf *conf)
2114{
Johannes Berg47979382009-01-07 10:13:27 +01002115 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002116}
2117
2118static inline bool
2119conf_is_ht40_minus(struct ieee80211_conf *conf)
2120{
Johannes Berg47979382009-01-07 10:13:27 +01002121 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002122}
2123
2124static inline bool
2125conf_is_ht40_plus(struct ieee80211_conf *conf)
2126{
Johannes Berg47979382009-01-07 10:13:27 +01002127 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002128}
2129
2130static inline bool
2131conf_is_ht40(struct ieee80211_conf *conf)
2132{
2133 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2134}
2135
2136static inline bool
2137conf_is_ht(struct ieee80211_conf *conf)
2138{
Johannes Berg47979382009-01-07 10:13:27 +01002139 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002140}
2141
Jiri Bencf0706e822007-05-05 11:45:53 -07002142#endif /* MAC80211_H */