blob: d67882dd3604cc4435dc6e2cca3afe7de04d73bb [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Johannes Berg3017b802007-08-28 17:01:53 -04006 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e82007-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>
22#include <net/wireless.h>
23#include <net/cfg80211.h>
24
Johannes Berg75a5f0c2007-09-18 17:29:20 -040025/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e82007-05-05 11:45:53 -070038 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010041 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070045 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070046 */
47
Johannes Berg75a5f0c2007-09-18 17:29:20 -040048/**
49 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070050 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040051 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
Jiri Bencf0706e82007-05-05 11:45:53 -070057 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040058 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
70 *
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e82007-05-05 11:45:53 -070074 */
75
Ron Rindjunsky10816d42007-11-26 16:14:30 +020076/**
Mohamed Abbas84363e62008-04-04 16:59:58 -070077 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
79 */
80enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
82};
83
84/**
Ron Rindjunsky10816d42007-11-26 16:14:30 +020085 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
86 *
87 * This structure describes most essential parameters needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -070088 * to describe 802.11n HT characteristics in a BSS.
Ron Rindjunsky10816d42007-11-26 16:14:30 +020089 *
90 * @primary_channel: channel number of primery channel
91 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
93 */
94struct ieee80211_ht_bss_info {
95 u8 primary_channel;
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
98};
99
100/**
Johannes Berge100bb62008-04-30 18:51:21 +0200101 * enum ieee80211_max_queues - maximum number of queues
102 *
103 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
104 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
105 * for A-MPDU operation.
106 */
107enum ieee80211_max_queues {
108 IEEE80211_MAX_QUEUES = 16,
109 IEEE80211_MAX_AMPDU_QUEUES = 16,
110};
111
112/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400113 * struct ieee80211_tx_queue_params - transmit queue configuration
114 *
115 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100116 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400117 *
Johannes Bergf434b2d2008-07-10 11:22:31 +0200118 * @aifs: arbitration interface space [0..255]
119 * @cw_min: minimum contention window [a value of the form
120 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100122 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400123 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700124struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200125 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100126 u16 cw_min;
127 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200128 u8 aifs;
Jiri Bencf0706e82007-05-05 11:45:53 -0700129};
130
Johannes Berg6b301cd2007-09-18 17:29:20 -0400131/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200132 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400133 *
134 * @len: number of packets in queue
135 * @limit: queue length limit
136 * @count: number of frames sent
137 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200138struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400139 unsigned int len;
140 unsigned int limit;
141 unsigned int count;
Jiri Bencf0706e82007-05-05 11:45:53 -0700142};
143
Jiri Bencf0706e82007-05-05 11:45:53 -0700144struct ieee80211_low_level_stats {
145 unsigned int dot11ACKFailureCount;
146 unsigned int dot11RTSFailureCount;
147 unsigned int dot11FCSErrorCount;
148 unsigned int dot11RTSSuccessCount;
149};
150
Johannes Berg471b3ef2007-12-28 14:32:58 +0100151/**
152 * enum ieee80211_bss_change - BSS change notification flags
153 *
154 * These flags are used with the bss_info_changed() callback
155 * to indicate which BSS parameter changed.
156 *
157 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
158 * also implies a change in the AID.
159 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
160 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300161 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700162 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg471b3ef2007-12-28 14:32:58 +0100163 */
164enum ieee80211_bss_change {
165 BSS_CHANGED_ASSOC = 1<<0,
166 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
167 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300168 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700169 BSS_CHANGED_HT = 1<<4,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100170};
171
172/**
173 * struct ieee80211_bss_conf - holds the BSS's changing parameters
174 *
175 * This structure keeps information about a BSS (and an association
176 * to that BSS) that can change during the lifetime of the BSS.
177 *
178 * @assoc: association status
179 * @aid: association ID number, valid only when @assoc is true
180 * @use_cts_prot: use CTS protection
181 * @use_short_preamble: use 802.11b short preamble
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300182 * @use_short_slot: use short slot time (only relevant for ERP)
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800183 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700184 * @timestamp: beacon timestamp
185 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800186 * @assoc_capability: capabilities taken from assoc resp
Tomas Winkler38668c02008-03-28 16:33:32 -0700187 * @assoc_ht: association in HT mode
188 * @ht_conf: ht capabilities
189 * @ht_bss_conf: ht extended capabilities
Johannes Berg471b3ef2007-12-28 14:32:58 +0100190 */
191struct ieee80211_bss_conf {
192 /* association related data */
193 bool assoc;
194 u16 aid;
195 /* erp related data */
196 bool use_cts_prot;
197 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300198 bool use_short_slot;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800199 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700200 u16 beacon_int;
201 u16 assoc_capability;
202 u64 timestamp;
Tomas Winkler38668c02008-03-28 16:33:32 -0700203 /* ht related data */
204 bool assoc_ht;
205 struct ieee80211_ht_info *ht_conf;
206 struct ieee80211_ht_bss_info *ht_bss_conf;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100207};
208
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800209/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700210 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800211 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700212 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800213 *
Johannes Berge039fa42008-05-15 12:55:29 +0200214 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge039fa42008-05-15 12:55:29 +0200215 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
216 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
217 * for combined 802.11g / 802.11b networks)
218 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700219 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200220 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
221 * station
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700222 * @IEEE80211_TX_CTL_REQUEUE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200223 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700224 * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200225 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
226 * through set_retry_limit configured long retry value
Johannes Berge039fa42008-05-15 12:55:29 +0200227 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
228 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
229 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
230 * of streams when this flag is on can be extracted from antenna_sel_tx,
231 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
232 * antennas marked use MIMO_n.
233 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
234 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
235 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
236 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700237 * @IEEE80211_TX_CTL_INJECTED: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode.
240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
Johannes Bergf591fa52008-07-10 11:21:26 +0200245 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
246 * number to this frame, taking care of not overwriting the fragment
247 * number and increasing the sequence number only when the
248 * IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
249 * assign sequence numbers to QoS-data frames but cannot do so correctly
250 * for non-QoS-data and management frames because beacons need them from
251 * that counter as well and mac80211 cannot guarantee proper sequencing.
252 * If this flag is set, the driver should instruct the hardware to
253 * assign a sequence number to the frame or assign one itself. Cf. IEEE
254 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
255 * beacons always be clear for frames without a sequence number field.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800256 */
257enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200258 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge039fa42008-05-15 12:55:29 +0200259 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
260 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
261 IEEE80211_TX_CTL_NO_ACK = BIT(4),
262 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
263 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
264 IEEE80211_TX_CTL_REQUEUE = BIT(7),
265 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
266 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
267 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
Johannes Berge039fa42008-05-15 12:55:29 +0200268 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
269 IEEE80211_TX_CTL_AMPDU = BIT(13),
270 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
271 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
272 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
273 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
274 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
275 IEEE80211_TX_CTL_INJECTED = BIT(19),
276 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
277 IEEE80211_TX_STAT_ACK = BIT(21),
278 IEEE80211_TX_STAT_AMPDU = BIT(22),
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300279 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
Johannes Bergf591fa52008-07-10 11:21:26 +0200280 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(24),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800281};
282
Johannes Berge039fa42008-05-15 12:55:29 +0200283
284#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
285 (sizeof(((struct sk_buff *)0)->cb) - 8)
286#define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
287 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
288
289/**
290 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200291 *
Johannes Berge039fa42008-05-15 12:55:29 +0200292 * This structure is placed in skb->cb for three uses:
293 * (1) mac80211 TX control - mac80211 tells the driver what to do
294 * (2) driver internal use (if applicable)
295 * (3) TX status information - driver tells mac80211 what happened
296 *
297 * @flags: transmit info flags, defined above
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700298 * @band: TBD
299 * @tx_rate_idx: TBD
300 * @antenna_sel_tx: TBD
301 * @control: union for control data
302 * @status: union for status data
303 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200304 * @retry_count: number of retries
305 * @excessive_retries: set to 1 if the frame was retried many times
306 * but not acknowledged
307 * @ampdu_ack_len: number of aggregated frames.
308 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
309 * @ampdu_ack_map: block ack bit map for the aggregation.
310 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
311 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200312 */
Johannes Berge039fa42008-05-15 12:55:29 +0200313struct ieee80211_tx_info {
314 /* common information */
315 u32 flags;
316 u8 band;
317 s8 tx_rate_idx;
318 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100319
Johannes Berge2530082008-05-17 00:57:14 +0200320 /* 1 byte hole */
Johannes Berg8318d782008-01-24 19:38:38 +0100321
Johannes Berge039fa42008-05-15 12:55:29 +0200322 union {
323 struct {
324 struct ieee80211_vif *vif;
325 struct ieee80211_key_conf *hw_key;
326 unsigned long jiffies;
Johannes Berge039fa42008-05-15 12:55:29 +0200327 u16 aid;
328 s8 rts_cts_rate_idx, alt_retry_rate_idx;
329 u8 retry_limit;
330 u8 icv_len;
331 u8 iv_len;
332 } control;
333 struct {
334 u64 ampdu_ack_map;
335 int ack_signal;
336 u8 retry_count;
337 bool excessive_retries;
338 u8 ampdu_ack_len;
339 } status;
340 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
341 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700342};
343
Johannes Berge039fa42008-05-15 12:55:29 +0200344static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
345{
346 return (struct ieee80211_tx_info *)skb->cb;
347}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400348
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400349
350/**
351 * enum mac80211_rx_flags - receive flags
352 *
353 * These flags are used with the @flag member of &struct ieee80211_rx_status.
354 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
355 * Use together with %RX_FLAG_MMIC_STRIPPED.
356 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
357 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
358 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
359 * verification has been done by the hardware.
360 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
361 * If this flag is set, the stack cannot do any replay detection
362 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400363 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
364 * the frame.
365 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
366 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100367 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900368 * is valid. This is useful in monitor mode and necessary for beacon frames
369 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200370 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400371 */
372enum mac80211_rx_flags {
373 RX_FLAG_MMIC_ERROR = 1<<0,
374 RX_FLAG_DECRYPTED = 1<<1,
375 RX_FLAG_RADIOTAP = 1<<2,
376 RX_FLAG_MMIC_STRIPPED = 1<<3,
377 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400378 RX_FLAG_FAILED_FCS_CRC = 1<<5,
379 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100380 RX_FLAG_TSFT = 1<<7,
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200381 RX_FLAG_SHORTPRE = 1<<8
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400382};
383
384/**
385 * struct ieee80211_rx_status - receive status
386 *
387 * The low-level driver should provide this information (the subset
388 * supported by hardware) to the 802.11 code with each received
389 * frame.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200390 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900391 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
392 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100393 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400394 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200395 * @signal: signal strength when receiving this frame, either in dBm, in dB or
396 * unspecified depending on the hardware capabilities flags
397 * @IEEE80211_HW_SIGNAL_*
398 * @noise: noise when receiving this frame, in dBm.
399 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400400 * @antenna: antenna used
Johannes Berg8318d782008-01-24 19:38:38 +0100401 * @rate_idx: index of data rate into band's supported rates
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400402 * @flag: %RX_FLAG_*
403 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700404struct ieee80211_rx_status {
405 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100406 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400407 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400408 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700409 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200410 int qual;
Jiri Bencf0706e82007-05-05 11:45:53 -0700411 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100412 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700413 int flag;
414};
415
Johannes Berg6b301cd2007-09-18 17:29:20 -0400416/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400417 * enum ieee80211_conf_flags - configuration flags
418 *
419 * Flags to define PHY configuration options
420 *
421 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
422 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200423 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
Samuel Ortiz49292d52008-07-04 10:49:31 +0200424 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
Johannes Berg6b301cd2007-09-18 17:29:20 -0400425 */
426enum ieee80211_conf_flags {
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300427 /*
428 * TODO: IEEE80211_CONF_SHORT_SLOT_TIME will be removed once drivers
429 * have been converted to use bss_info_changed() for slot time
430 * configuration
431 */
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200432 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
433 IEEE80211_CONF_RADIOTAP = (1<<1),
434 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
Samuel Ortiz49292d52008-07-04 10:49:31 +0200435 IEEE80211_CONF_PS = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400436};
Jiri Bencf0706e82007-05-05 11:45:53 -0700437
438/**
439 * struct ieee80211_conf - configuration of the device
440 *
441 * This struct indicates how the driver shall configure the hardware.
442 *
443 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400444 * TODO make a flag
Johannes Berg6b301cd2007-09-18 17:29:20 -0400445 * @beacon_int: beacon interval (TODO make interface config)
Tomas Winklerea95bba2008-07-18 13:53:00 +0800446 * @listen_interval: listen interval in units of beacon interval
Johannes Berg6b301cd2007-09-18 17:29:20 -0400447 * @flags: configuration flags defined above
Johannes Berg8318d782008-01-24 19:38:38 +0100448 * @power_level: requested transmit power (in dBm)
449 * @max_antenna_gain: maximum antenna gain (in dBi)
Johannes Berg6b301cd2007-09-18 17:29:20 -0400450 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
451 * 1/2: antenna 0/1
452 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200453 * @ht_conf: describes current self configuration of 802.11n HT capabilies
454 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
Johannes Berg8318d782008-01-24 19:38:38 +0100455 * @channel: the channel to tune to
Jiri Bencf0706e82007-05-05 11:45:53 -0700456 */
457struct ieee80211_conf {
Jiri Bencf0706e82007-05-05 11:45:53 -0700458 int radio_enabled;
459
460 int beacon_int;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800461 u16 listen_interval;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400462 u32 flags;
Johannes Berg8318d782008-01-24 19:38:38 +0100463 int power_level;
464 int max_antenna_gain;
Jiri Bencf0706e82007-05-05 11:45:53 -0700465 u8 antenna_sel_tx;
466 u8 antenna_sel_rx;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200467
Johannes Berg8318d782008-01-24 19:38:38 +0100468 struct ieee80211_channel *channel;
469
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200470 struct ieee80211_ht_info ht_conf;
471 struct ieee80211_ht_bss_info ht_bss_conf;
Jiri Bencf0706e82007-05-05 11:45:53 -0700472};
473
474/**
475 * enum ieee80211_if_types - types of 802.11 network interfaces
476 *
Johannes Berga2897552007-09-28 14:01:25 +0200477 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
478 * by mac80211 itself
Jiri Bencf0706e82007-05-05 11:45:53 -0700479 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
480 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
481 * daemon. Drivers should never see this type.
482 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
483 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
484 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
485 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400486 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
487 * will never see this type.
Johannes Bergdbbea672008-02-26 14:34:06 +0100488 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
Jiri Bencf0706e82007-05-05 11:45:53 -0700489 */
490enum ieee80211_if_types {
Johannes Berga2897552007-09-28 14:01:25 +0200491 IEEE80211_IF_TYPE_INVALID,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400492 IEEE80211_IF_TYPE_AP,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400493 IEEE80211_IF_TYPE_STA,
494 IEEE80211_IF_TYPE_IBSS,
Johannes Berg6032f932008-02-23 15:17:07 +0100495 IEEE80211_IF_TYPE_MESH_POINT,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400496 IEEE80211_IF_TYPE_MNTR,
497 IEEE80211_IF_TYPE_WDS,
498 IEEE80211_IF_TYPE_VLAN,
Jiri Bencf0706e82007-05-05 11:45:53 -0700499};
500
501/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100502 * struct ieee80211_vif - per-interface data
503 *
504 * Data in this structure is continually present for driver
505 * use during the life of a virtual interface.
506 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100507 * @type: type of this virtual interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100508 * @drv_priv: data area for driver use, will always be aligned to
509 * sizeof(void *).
510 */
511struct ieee80211_vif {
Johannes Berg51fb61e2007-12-19 01:31:27 +0100512 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100513 /* must be last */
514 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
515};
516
Johannes Berg902acc72008-02-23 15:17:19 +0100517static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
518{
519#ifdef CONFIG_MAC80211_MESH
520 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
521#endif
522 return false;
523}
524
Johannes Berg32bfd352007-12-19 01:31:26 +0100525/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700526 * struct ieee80211_if_init_conf - initial configuration of an interface
527 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100528 * @vif: pointer to a driver-use per-interface structure. The pointer
529 * itself is also used for various functions including
530 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Jiri Bencf0706e82007-05-05 11:45:53 -0700531 * @type: one of &enum ieee80211_if_types constants. Determines the type of
532 * added/removed interface.
533 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
534 * until the interface is removed (i.e. it cannot be used after
535 * remove_interface() callback was called for this interface).
536 *
537 * This structure is used in add_interface() and remove_interface()
538 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200539 *
540 * When you allow multiple interfaces to be added to your PHY, take care
541 * that the hardware can actually handle multiple MAC addresses. However,
542 * also take care that when there's no interface left with mac_addr != %NULL
543 * you remove the MAC address from the device to avoid acknowledging packets
544 * in pure monitor mode.
Jiri Bencf0706e82007-05-05 11:45:53 -0700545 */
546struct ieee80211_if_init_conf {
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400547 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100548 struct ieee80211_vif *vif;
Jiri Bencf0706e82007-05-05 11:45:53 -0700549 void *mac_addr;
550};
551
552/**
Johannes Berg9d139c82008-07-09 14:40:37 +0200553 * enum ieee80211_if_conf_change - interface config change flags
554 *
555 * @IEEE80211_IFCC_BSSID: The BSSID changed.
556 * @IEEE80211_IFCC_SSID: The SSID changed.
557 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
558 * (currently AP and MESH only), use ieee80211_beacon_get().
559 */
560enum ieee80211_if_conf_change {
561 IEEE80211_IFCC_BSSID = BIT(0),
562 IEEE80211_IFCC_SSID = BIT(1),
563 IEEE80211_IFCC_BEACON = BIT(2),
564};
565
566/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700567 * struct ieee80211_if_conf - configuration of an interface
568 *
Johannes Berg9d139c82008-07-09 14:40:37 +0200569 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
Jiri Bencf0706e82007-05-05 11:45:53 -0700570 * @bssid: BSSID of the network we are associated to/creating.
571 * @ssid: used (together with @ssid_len) by drivers for hardware that
572 * generate beacons independently. The pointer is valid only during the
573 * config_interface() call, so copy the value somewhere if you need
574 * it.
575 * @ssid_len: length of the @ssid field.
Jiri Bencf0706e82007-05-05 11:45:53 -0700576 *
577 * This structure is passed to the config_interface() callback of
578 * &struct ieee80211_hw.
579 */
580struct ieee80211_if_conf {
Johannes Berg9d139c82008-07-09 14:40:37 +0200581 u32 changed;
Jiri Bencf0706e82007-05-05 11:45:53 -0700582 u8 *bssid;
583 u8 *ssid;
584 size_t ssid_len;
Jiri Bencf0706e82007-05-05 11:45:53 -0700585};
586
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400587/**
588 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400589 * @ALG_WEP: WEP40 or WEP104
590 * @ALG_TKIP: TKIP
591 * @ALG_CCMP: CCMP (AES)
592 */
Johannes Bergea49c352007-09-18 17:29:21 -0400593enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400594 ALG_WEP,
595 ALG_TKIP,
596 ALG_CCMP,
Johannes Bergea49c352007-09-18 17:29:21 -0400597};
Jiri Bencf0706e82007-05-05 11:45:53 -0700598
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300599/**
600 * enum ieee80211_key_len - key length
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700601 * @LEN_WEP40: WEP 5-byte long key
602 * @LEN_WEP104: WEP 13-byte long key
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300603 */
604enum ieee80211_key_len {
605 LEN_WEP40 = 5,
606 LEN_WEP104 = 13,
607};
Johannes Berg11a843b2007-08-28 17:01:55 -0400608
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400609/**
610 * enum ieee80211_key_flags - key flags
611 *
612 * These flags are used for communication about keys between the driver
613 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
614 *
615 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
616 * that the STA this key will be used with could be using QoS.
617 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
618 * driver to indicate that it requires IV generation for this
619 * particular key.
620 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
621 * the driver for a TKIP key if it requires Michael MIC
622 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200623 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
624 * that the key is pairwise rather then a shared key.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400625 */
626enum ieee80211_key_flags {
627 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
628 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
629 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200630 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400631};
632
633/**
634 * struct ieee80211_key_conf - key information
635 *
636 * This key information is given by mac80211 to the driver by
637 * the set_key() callback in &struct ieee80211_ops.
638 *
639 * @hw_key_idx: To be set by the driver, this is the key index the driver
640 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400641 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400642 * @alg: The key algorithm.
643 * @flags: key flags, see &enum ieee80211_key_flags.
644 * @keyidx: the key index (0-3)
645 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400646 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
647 * data block:
648 * - Temporal Encryption Key (128 bits)
649 * - Temporal Authenticator Tx MIC Key (64 bits)
650 * - Temporal Authenticator Rx MIC Key (64 bits)
651 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400652 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700653struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400654 enum ieee80211_key_alg alg;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400655 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400656 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400657 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400658 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700659 u8 key[0];
660};
661
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400662/**
663 * enum set_key_cmd - key command
664 *
665 * Used with the set_key() callback in &struct ieee80211_ops, this
666 * indicates whether a key is being removed or added.
667 *
668 * @SET_KEY: a key is set
669 * @DISABLE_KEY: a key must be disabled
670 */
Johannes Bergea49c352007-09-18 17:29:21 -0400671enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400672 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400673};
Jiri Bencf0706e82007-05-05 11:45:53 -0700674
Tomas Winkler478f8d22007-09-30 13:52:37 +0200675/**
676 * enum sta_notify_cmd - sta notify command
677 *
678 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700679 * indicates addition and removal of a station to station table.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200680 *
681 * @STA_NOTIFY_ADD: a station was added to the station table
682 * @STA_NOTIFY_REMOVE: a station being removed from the station table
683 */
684enum sta_notify_cmd {
685 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
686};
Johannes Berg1bc08262007-09-18 17:29:15 -0400687
688/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200689 * enum ieee80211_tkip_key_type - get tkip key
690 *
691 * Used by drivers which need to get a tkip key for skb. Some drivers need a
692 * phase 1 key, others need a phase 2 key. A single function allows the driver
693 * to get the key, this enum indicates what type of key is required.
694 *
695 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
696 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
697 */
698enum ieee80211_tkip_key_type {
699 IEEE80211_TKIP_P1_KEY,
700 IEEE80211_TKIP_P2_KEY,
701};
702
703/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400704 * enum ieee80211_hw_flags - hardware flags
705 *
706 * These flags are used to indicate hardware capabilities to
707 * the stack. Generally, flags here should have their meaning
708 * done in a way that the simplest hardware doesn't need setting
709 * any particular flags. There are some exceptions to this rule,
710 * however, so you are advised to review these flags carefully.
711 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400712 * @IEEE80211_HW_RX_INCLUDES_FCS:
713 * Indicates that received frames passed to the stack include
714 * the FCS at the end.
715 *
716 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
717 * Some wireless LAN chipsets buffer broadcast/multicast frames
718 * for power saving stations in the hardware/firmware and others
719 * rely on the host system for such buffering. This option is used
720 * to configure the IEEE 802.11 upper layer to buffer broadcast and
721 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700722 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400723 *
Johannes Berg8318d782008-01-24 19:38:38 +0100724 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
725 * Hardware is not capable of short slot operation on the 2.4 GHz band.
726 *
727 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
728 * Hardware is not capable of receiving frames with short preamble on
729 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200730 *
731 * @IEEE80211_HW_SIGNAL_UNSPEC:
732 * Hardware can provide signal values but we don't know its units. We
733 * expect values between 0 and @max_signal.
734 * If possible please provide dB or dBm instead.
735 *
736 * @IEEE80211_HW_SIGNAL_DB:
737 * Hardware gives signal values in dB, decibel difference from an
738 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
739 * If possible please provide dBm instead.
740 *
741 * @IEEE80211_HW_SIGNAL_DBM:
742 * Hardware gives signal values in dBm, decibel difference from
743 * one milliwatt. This is the preferred method since it is standardized
744 * between different devices. @max_signal does not need to be set.
745 *
746 * @IEEE80211_HW_NOISE_DBM:
747 * Hardware can provide noise (radio interference) values in units dBm,
748 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300749 *
750 * @IEEE80211_HW_SPECTRUM_MGMT:
751 * Hardware supports spectrum management defined in 802.11h
752 * Measurement, Channel Switch, Quieting, TPC
Johannes Berg1bc08262007-09-18 17:29:15 -0400753 */
754enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400755 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
756 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100757 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
758 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200759 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
760 IEEE80211_HW_SIGNAL_DB = 1<<6,
761 IEEE80211_HW_SIGNAL_DBM = 1<<7,
762 IEEE80211_HW_NOISE_DBM = 1<<8,
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300763 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
Johannes Berg1bc08262007-09-18 17:29:15 -0400764};
765
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400766/**
767 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400768 *
769 * This structure contains the configuration and hardware
770 * information for an 802.11 PHY.
771 *
772 * @wiphy: This points to the &struct wiphy allocated for this
773 * 802.11 PHY. You must fill in the @perm_addr and @dev
774 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100775 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
776 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400777 *
778 * @conf: &struct ieee80211_conf, device configuration, don't use.
779 *
780 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200781 * allocated by mac80211 on registration and flushed when an
782 * interface is removed.
783 * NOTICE: All work performed on this workqueue should NEVER
784 * acquire the RTNL lock (i.e. Don't use the function
785 * ieee80211_iterate_active_interfaces())
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400786 *
787 * @priv: pointer to private area that was allocated for driver use
788 * along with this structure.
789 *
790 * @flags: hardware flags, see &enum ieee80211_hw_flags.
791 *
792 * @extra_tx_headroom: headroom to reserve in each transmit skb
793 * for use by the driver (e.g. for transmit headers.)
794 *
795 * @channel_change_time: time (in microseconds) it takes to change channels.
796 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200797 * @max_signal: Maximum value for signal (rssi) in RX information, used
798 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400799 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800800 * @max_listen_interval: max listen interval in units of beacon interval
801 * that HW supports
802 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400803 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200804 * data packets. WMM/QoS requires at least four, these
805 * queues need to have configurable access parameters.
806 *
807 * @ampdu_queues: number of available hardware transmit queues
808 * for A-MPDU packets, these have no access parameters
809 * because they're used only for A-MPDU frames. Note that
810 * mac80211 will not currently use any of the regular queues
811 * for aggregation.
Johannes Berg830f9032007-10-28 14:51:05 +0100812 *
813 * @rate_control_algorithm: rate control algorithm for this hardware.
814 * If unset (NULL), the default algorithm will be used. Must be
815 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100816 *
817 * @vif_data_size: size (in bytes) of the drv_priv data area
818 * within &struct ieee80211_vif.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400819 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700820struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -0700821 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400822 struct wiphy *wiphy;
Jiri Bencf0706e82007-05-05 11:45:53 -0700823 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100824 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -0700825 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400826 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700827 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -0700828 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100829 int vif_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800830 u16 queues;
831 u16 ampdu_queues;
832 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -0700833 s8 max_signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700834};
835
Luis R. Rodriguezb2e1b302008-09-09 23:19:48 -0700836struct ieee80211_hw *wiphy_to_hw(struct wiphy *wiphy);
837
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400838/**
839 * SET_IEEE80211_DEV - set device for 802.11 hardware
840 *
841 * @hw: the &struct ieee80211_hw to set the device for
842 * @dev: the &struct device of this 802.11 device
843 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700844static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
845{
846 set_wiphy_dev(hw->wiphy, dev);
847}
848
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400849/**
850 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
851 *
852 * @hw: the &struct ieee80211_hw to set the MAC address for
853 * @addr: the address to set
854 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700855static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
856{
857 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
858}
859
Johannes Berge2530082008-05-17 00:57:14 +0200860static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
861{
Johannes Berge2530082008-05-17 00:57:14 +0200862 return hw->queues;
Johannes Berge2530082008-05-17 00:57:14 +0200863}
864
865static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
866{
Johannes Berge2530082008-05-17 00:57:14 +0200867 return hw->queues + hw->ampdu_queues;
Johannes Berge2530082008-05-17 00:57:14 +0200868}
869
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200870static inline struct ieee80211_rate *
871ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200872 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200873{
874 if (WARN_ON(c->tx_rate_idx < 0))
875 return NULL;
876 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
877}
878
879static inline struct ieee80211_rate *
880ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200881 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200882{
Johannes Berge039fa42008-05-15 12:55:29 +0200883 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200884 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +0200885 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200886}
887
888static inline struct ieee80211_rate *
889ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200890 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200891{
Johannes Berge039fa42008-05-15 12:55:29 +0200892 if (c->control.alt_retry_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200893 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +0200894 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200895}
896
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400897/**
898 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -0400899 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400900 * mac80211 is capable of taking advantage of many hardware
901 * acceleration designs for encryption and decryption operations.
902 *
903 * The set_key() callback in the &struct ieee80211_ops for a given
904 * device is called to enable hardware acceleration of encryption and
905 * decryption. The callback takes an @address parameter that will be
906 * the broadcast address for default keys, the other station's hardware
907 * address for individual keys or the zero address for keys that will
908 * be used only for transmission.
909 * Multiple transmission keys with the same key index may be used when
910 * VLANs are configured for an access point.
911 *
912 * The @local_address parameter will always be set to our own address,
913 * this is only relevant if you support multiple local addresses.
914 *
915 * When transmitting, the TX control data will use the @hw_key_idx
916 * selected by the driver by modifying the &struct ieee80211_key_conf
917 * pointed to by the @key parameter to the set_key() function.
918 *
919 * The set_key() call for the %SET_KEY command should return 0 if
920 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
921 * added; if you return 0 then hw_key_idx must be assigned to the
922 * hardware key index, you are free to use the full u8 range.
923 *
924 * When the cmd is %DISABLE_KEY then it must succeed.
925 *
926 * Note that it is permissible to not decrypt a frame even if a key
927 * for it has been uploaded to hardware, the stack will not make any
928 * decision based on whether a key has been uploaded or not but rather
929 * based on the receive flags.
930 *
931 * The &struct ieee80211_key_conf structure pointed to by the @key
932 * parameter is guaranteed to be valid until another call to set_key()
933 * removes it, but it can only be used as a cookie to differentiate
934 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +0200935 *
936 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
937 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
938 * handler.
939 * The update_tkip_key() call updates the driver with the new phase 1 key.
940 * This happens everytime the iv16 wraps around (every 65536 packets). The
941 * set_key() call will happen only once for each key (unless the AP did
942 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
943 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
944 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -0400945 */
Johannes Berg4150c572007-09-17 01:29:23 -0400946
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400947/**
948 * DOC: Frame filtering
949 *
950 * mac80211 requires to see many management frames for proper
951 * operation, and users may want to see many more frames when
952 * in monitor mode. However, for best CPU usage and power consumption,
953 * having as few frames as possible percolate through the stack is
954 * desirable. Hence, the hardware should filter as much as possible.
955 *
956 * To achieve this, mac80211 uses filter flags (see below) to tell
957 * the driver's configure_filter() function which frames should be
958 * passed to mac80211 and which should be filtered out.
959 *
960 * The configure_filter() callback is invoked with the parameters
961 * @mc_count and @mc_list for the combined multicast address list
962 * of all virtual interfaces, @changed_flags telling which flags
963 * were changed and @total_flags with the new flag states.
964 *
965 * If your device has no multicast address filters your driver will
966 * need to check both the %FIF_ALLMULTI flag and the @mc_count
967 * parameter to see whether multicast frames should be accepted
968 * or dropped.
969 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +0100970 * All unsupported flags in @total_flags must be cleared.
971 * Hardware does not support a flag if it is incapable of _passing_
972 * the frame to the stack. Otherwise the driver must ignore
973 * the flag, but not clear it.
974 * You must _only_ clear the flag (announce no support for the
975 * flag to mac80211) if you are not able to pass the packet type
976 * to the stack (so the hardware always filters it).
977 * So for example, you should clear @FIF_CONTROL, if your hardware
978 * always filters control frames. If your hardware always passes
979 * control frames to the kernel and is incapable of filtering them,
980 * you do _not_ clear the @FIF_CONTROL flag.
981 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400982 */
983
984/**
985 * enum ieee80211_filter_flags - hardware filter flags
986 *
987 * These flags determine what the filter in hardware should be
988 * programmed to let through and what should not be passed to the
989 * stack. It is always safe to pass more frames than requested,
990 * but this has negative impact on power consumption.
991 *
992 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
993 * think of the BSS as your network segment and then this corresponds
994 * to the regular ethernet device promiscuous mode.
995 *
996 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
997 * by the user or if the hardware is not capable of filtering by
998 * multicast address.
999 *
1000 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1001 * %RX_FLAG_FAILED_FCS_CRC for them)
1002 *
1003 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1004 * the %RX_FLAG_FAILED_PLCP_CRC for them
1005 *
1006 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1007 * to the hardware that it should not filter beacons or probe responses
1008 * by BSSID. Filtering them can greatly reduce the amount of processing
1009 * mac80211 needs to do and the amount of CPU wakeups, so you should
1010 * honour this flag if possible.
1011 *
1012 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1013 * only those addressed to this station
1014 *
1015 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1016 */
1017enum ieee80211_filter_flags {
1018 FIF_PROMISC_IN_BSS = 1<<0,
1019 FIF_ALLMULTI = 1<<1,
1020 FIF_FCSFAIL = 1<<2,
1021 FIF_PLCPFAIL = 1<<3,
1022 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1023 FIF_CONTROL = 1<<5,
1024 FIF_OTHER_BSS = 1<<6,
1025};
1026
1027/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001028 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1029 *
1030 * These flags are used with the ampdu_action() callback in
1031 * &struct ieee80211_ops to indicate which action is needed.
1032 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1033 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001034 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1035 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001036 */
1037enum ieee80211_ampdu_mlme_action {
1038 IEEE80211_AMPDU_RX_START,
1039 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001040 IEEE80211_AMPDU_TX_START,
1041 IEEE80211_AMPDU_TX_STOP,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001042};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001043
1044/**
1045 * struct ieee80211_ops - callbacks from mac80211 to the driver
1046 *
1047 * This structure contains various callbacks that the driver may
1048 * handle or, in some cases, must handle, for example to configure
1049 * the hardware to a new channel or to transmit a frame.
1050 *
1051 * @tx: Handler that 802.11 module calls for each transmitted frame.
1052 * skb contains the buffer starting from the IEEE 802.11 header.
1053 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001054 * configuration in the TX control data. This handler should,
1055 * preferably, never fail and stop queues appropriately, more
1056 * importantly, however, it must never fail for A-MPDU-queues.
1057 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001058 *
1059 * @start: Called before the first netdevice attached to the hardware
1060 * is enabled. This should turn on the hardware and must turn on
1061 * frame reception (for possibly enabled monitor interfaces.)
1062 * Returns negative error codes, these may be seen in userspace,
1063 * or zero.
1064 * When the device is started it should not have a MAC address
1065 * to avoid acknowledging frames before a non-monitor device
1066 * is added.
1067 * Must be implemented.
1068 *
1069 * @stop: Called after last netdevice attached to the hardware
1070 * is disabled. This should turn off the hardware (at least
1071 * it must turn off frame reception.)
1072 * May be called right after add_interface if that rejects
1073 * an interface.
1074 * Must be implemented.
1075 *
1076 * @add_interface: Called when a netdevice attached to the hardware is
1077 * enabled. Because it is not called for monitor mode devices, @open
1078 * and @stop must be implemented.
1079 * The driver should perform any initialization it needs before
1080 * the device can be enabled. The initial configuration for the
1081 * interface is given in the conf parameter.
1082 * The callback may refuse to add an interface by returning a
1083 * negative error code (which will be seen in userspace.)
1084 * Must be implemented.
1085 *
1086 * @remove_interface: Notifies a driver that an interface is going down.
1087 * The @stop callback is called after this if it is the last interface
1088 * and no monitor interfaces are present.
1089 * When all interfaces are removed, the MAC address in the hardware
1090 * must be cleared so the device no longer acknowledges packets,
1091 * the mac_addr member of the conf structure is, however, set to the
1092 * MAC address of the device going away.
1093 * Hence, this callback must be implemented.
1094 *
1095 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1096 * function to change hardware configuration, e.g., channel.
1097 *
1098 * @config_interface: Handler for configuration requests related to interfaces
1099 * (e.g. BSSID changes.)
1100 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001101 * @bss_info_changed: Handler for configuration requests related to BSS
1102 * parameters that may vary during BSS's lifespan, and may affect low
1103 * level driver (e.g. assoc/disassoc status, erp parameters).
1104 * This function should not be used if no BSS has been set, unless
1105 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001106 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001107 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001108 * @configure_filter: Configure the device's RX filter.
1109 * See the section "Frame filtering" for more information.
1110 * This callback must be implemented and atomic.
1111 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001112 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1113 * must be set or cleared for a given AID. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001114 *
1115 * @set_key: See the section "Hardware crypto acceleration"
1116 * This callback can sleep, and is only called between add_interface
1117 * and remove_interface calls, i.e. while the interface with the
1118 * given local_address is enabled.
1119 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001120 * @update_tkip_key: See the section "Hardware crypto acceleration"
1121 * This callback will be called in the context of Rx. Called for drivers
1122 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1123 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001124 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001125 * the scan state machine in stack. The scan must honour the channel
1126 * configuration done by the regulatory agent in the wiphy's registered
Johannes Berg5bc75722008-09-11 00:01:51 +02001127 * bands. When the scan finishes, ieee80211_scan_completed() must be
1128 * called; note that it also must be called when the scan cannot finish
1129 * because the hardware is turned off! Anything else is a bug!
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001130 *
1131 * @get_stats: return low-level statistics
1132 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001133 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1134 * callback should be provided to read the TKIP transmit IVs (both IV32
1135 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001136 *
1137 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1138 *
1139 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1140 * the device does fragmentation by itself; if this method is assigned then
1141 * the stack will not do fragmentation.
1142 *
1143 * @set_retry_limit: Configuration of retry limits (if device needs it)
1144 *
Tomas Winkler478f8d22007-09-30 13:52:37 +02001145 * @sta_notify: Notifies low level driver about addition or removal
1146 * of assocaited station or AP.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001147 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001148 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001149 * bursting) for a hardware TX queue.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001150 *
1151 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1152 * to get number of currently queued packets (queue length), maximum queue
1153 * size (limit), and total number of packets sent using each TX queue
Johannes Berg57ffc582008-04-29 17:18:59 +02001154 * (count). The 'stats' pointer points to an array that has hw->queues +
1155 * hw->ampdu_queues items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001156 *
1157 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1158 * this is only used for IBSS mode debugging and, as such, is not a
1159 * required function. Must be atomic.
1160 *
1161 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1162 * with other STAs in the IBSS. This is only used in IBSS mode. This
1163 * function is optional if the firmware/hardware takes full care of
1164 * TSF synchronization.
1165 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001166 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1167 * This is needed only for IBSS mode and the result of this function is
1168 * used to determine whether to reply to Probe Requests.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001169 *
1170 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001171 *
1172 * @ampdu_action: Perform a certain A-MPDU action
1173 * The RA/TID combination determines the destination and TID we want
1174 * the ampdu action to be performed for. The action is defined through
1175 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001176 * is the first frame we expect to perform the action on. notice
1177 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001178 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001179struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001180 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001181 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001182 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001183 int (*add_interface)(struct ieee80211_hw *hw,
1184 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001185 void (*remove_interface)(struct ieee80211_hw *hw,
1186 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001187 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001188 int (*config_interface)(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001189 struct ieee80211_vif *vif,
1190 struct ieee80211_if_conf *conf);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001191 void (*bss_info_changed)(struct ieee80211_hw *hw,
1192 struct ieee80211_vif *vif,
1193 struct ieee80211_bss_conf *info,
1194 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001195 void (*configure_filter)(struct ieee80211_hw *hw,
1196 unsigned int changed_flags,
1197 unsigned int *total_flags,
1198 int mc_count, struct dev_addr_list *mc_list);
Jiri Bencf0706e82007-05-05 11:45:53 -07001199 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
Johannes Bergea49c352007-09-18 17:29:21 -04001200 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Berg11a843b2007-08-28 17:01:55 -04001201 const u8 *local_address, const u8 *address,
1202 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001203 void (*update_tkip_key)(struct ieee80211_hw *hw,
1204 struct ieee80211_key_conf *conf, const u8 *address,
1205 u32 iv32, u16 *phase1key);
Jiri Bencf0706e82007-05-05 11:45:53 -07001206 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
Jiri Bencf0706e82007-05-05 11:45:53 -07001207 int (*get_stats)(struct ieee80211_hw *hw,
1208 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001209 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1210 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001211 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001212 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001213 int (*set_retry_limit)(struct ieee80211_hw *hw,
1214 u32 short_retry, u32 long_retr);
Johannes Berg32bfd352007-12-19 01:31:26 +01001215 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Tomas Winkler478f8d22007-09-30 13:52:37 +02001216 enum sta_notify_cmd, const u8 *addr);
Johannes Berge100bb62008-04-30 18:51:21 +02001217 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001218 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001219 int (*get_tx_stats)(struct ieee80211_hw *hw,
1220 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e82007-05-05 11:45:53 -07001221 u64 (*get_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001222 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001223 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001224 int (*ampdu_action)(struct ieee80211_hw *hw,
1225 enum ieee80211_ampdu_mlme_action action,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001226 const u8 *addr, u16 tid, u16 *ssn);
Jiri Bencf0706e82007-05-05 11:45:53 -07001227};
1228
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001229/**
1230 * ieee80211_alloc_hw - Allocate a new hardware device
1231 *
1232 * This must be called once for each hardware device. The returned pointer
1233 * must be used to refer to this device when calling other functions.
1234 * mac80211 allocates a private data area for the driver pointed to by
1235 * @priv in &struct ieee80211_hw, the size of this area is given as
1236 * @priv_data_len.
1237 *
1238 * @priv_data_len: length of private data
1239 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001240 */
1241struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1242 const struct ieee80211_ops *ops);
1243
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001244/**
1245 * ieee80211_register_hw - Register hardware device
1246 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001247 * You must call this function before any other functions in
1248 * mac80211. Note that before a hardware can be registered, you
1249 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001250 *
1251 * @hw: the device to register as returned by ieee80211_alloc_hw()
1252 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001253int ieee80211_register_hw(struct ieee80211_hw *hw);
1254
Jiri Bencf0706e82007-05-05 11:45:53 -07001255#ifdef CONFIG_MAC80211_LEDS
1256extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1257extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001258extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001259extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001260#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001261/**
1262 * ieee80211_get_tx_led_name - get name of TX LED
1263 *
1264 * mac80211 creates a transmit LED trigger for each wireless hardware
1265 * that can be used to drive LEDs if your driver registers a LED device.
1266 * This function returns the name (or %NULL if not configured for LEDs)
1267 * of the trigger so you can automatically link the LED device.
1268 *
1269 * @hw: the hardware to get the LED trigger name for
1270 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001271static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1272{
1273#ifdef CONFIG_MAC80211_LEDS
1274 return __ieee80211_get_tx_led_name(hw);
1275#else
1276 return NULL;
1277#endif
1278}
1279
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001280/**
1281 * ieee80211_get_rx_led_name - get name of RX LED
1282 *
1283 * mac80211 creates a receive LED trigger for each wireless hardware
1284 * that can be used to drive LEDs if your driver registers a LED device.
1285 * This function returns the name (or %NULL if not configured for LEDs)
1286 * of the trigger so you can automatically link the LED device.
1287 *
1288 * @hw: the hardware to get the LED trigger name for
1289 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001290static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1291{
1292#ifdef CONFIG_MAC80211_LEDS
1293 return __ieee80211_get_rx_led_name(hw);
1294#else
1295 return NULL;
1296#endif
1297}
1298
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001299/**
1300 * ieee80211_get_assoc_led_name - get name of association LED
1301 *
1302 * mac80211 creates a association LED trigger for each wireless hardware
1303 * that can be used to drive LEDs if your driver registers a LED device.
1304 * This function returns the name (or %NULL if not configured for LEDs)
1305 * of the trigger so you can automatically link the LED device.
1306 *
1307 * @hw: the hardware to get the LED trigger name for
1308 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001309static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1310{
1311#ifdef CONFIG_MAC80211_LEDS
1312 return __ieee80211_get_assoc_led_name(hw);
1313#else
1314 return NULL;
1315#endif
1316}
1317
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001318/**
1319 * ieee80211_get_radio_led_name - get name of radio LED
1320 *
1321 * mac80211 creates a radio change LED trigger for each wireless hardware
1322 * that can be used to drive LEDs if your driver registers a LED device.
1323 * This function returns the name (or %NULL if not configured for LEDs)
1324 * of the trigger so you can automatically link the LED device.
1325 *
1326 * @hw: the hardware to get the LED trigger name for
1327 */
1328static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1329{
1330#ifdef CONFIG_MAC80211_LEDS
1331 return __ieee80211_get_radio_led_name(hw);
1332#else
1333 return NULL;
1334#endif
1335}
Michael Buesch47f0c502007-09-27 15:10:44 +02001336
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001337/**
1338 * ieee80211_unregister_hw - Unregister a hardware device
1339 *
1340 * This function instructs mac80211 to free allocated resources
1341 * and unregister netdevices from the networking subsystem.
1342 *
1343 * @hw: the hardware to unregister
1344 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001345void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1346
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001347/**
1348 * ieee80211_free_hw - free hardware descriptor
1349 *
1350 * This function frees everything that was allocated, including the
1351 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001352 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001353 *
1354 * @hw: the hardware to free
1355 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001356void ieee80211_free_hw(struct ieee80211_hw *hw);
1357
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001358/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e82007-05-05 11:45:53 -07001359void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1360 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001361
1362/**
1363 * ieee80211_rx - receive frame
1364 *
1365 * Use this function to hand received frames to mac80211. The receive
1366 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1367 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1368 *
Johannes Berg2485f712008-02-25 16:27:41 +01001369 * This function may not be called in IRQ context. Calls to this function
1370 * for a single hardware must be synchronized against each other. Calls
1371 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1372 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001373 *
1374 * @hw: the hardware this frame came in on
1375 * @skb: the buffer to receive, owned by mac80211 after this call
1376 * @status: status of this frame; the status pointer need not be valid
1377 * after this function returns
1378 */
1379static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1380 struct ieee80211_rx_status *status)
1381{
1382 __ieee80211_rx(hw, skb, status);
1383}
1384
1385/**
1386 * ieee80211_rx_irqsafe - receive frame
1387 *
1388 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001389 * (internally defers to a tasklet.)
1390 *
1391 * Calls to this function and ieee80211_rx() may not be mixed for a
1392 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001393 *
1394 * @hw: the hardware this frame came in on
1395 * @skb: the buffer to receive, owned by mac80211 after this call
1396 * @status: status of this frame; the status pointer need not be valid
1397 * after this function returns and is not freed by mac80211,
1398 * it is recommended that it points to a stack area
1399 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001400void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1401 struct sk_buff *skb,
1402 struct ieee80211_rx_status *status);
1403
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001404/**
1405 * ieee80211_tx_status - transmit status callback
1406 *
1407 * Call this function for all transmitted frames after they have been
1408 * transmitted. It is permissible to not call this function for
1409 * multicast frames but this can affect statistics.
1410 *
Johannes Berg2485f712008-02-25 16:27:41 +01001411 * This function may not be called in IRQ context. Calls to this function
1412 * for a single hardware must be synchronized against each other. Calls
1413 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1414 * for a single hardware.
1415 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001416 * @hw: the hardware the frame was transmitted by
1417 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001418 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001419void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001420 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001421
1422/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001423 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001424 *
1425 * Like ieee80211_tx_status() but can be called in IRQ context
1426 * (internally defers to a tasklet.)
1427 *
1428 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1429 * single hardware.
1430 *
1431 * @hw: the hardware the frame was transmitted by
1432 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001433 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001434void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001435 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001436
1437/**
1438 * ieee80211_beacon_get - beacon generation function
1439 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001440 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001441 * @control: will be filled with information needed to send this beacon.
1442 *
1443 * If the beacon frames are generated by the host system (i.e., not in
1444 * hardware/firmware), the low-level driver uses this function to receive
1445 * the next beacon frame from the 802.11 code. The low-level is responsible
1446 * for calling this function before beacon data is needed (e.g., based on
1447 * hardware interrupt). Returned skb is used only once and low-level driver
1448 * is responsible of freeing it.
1449 */
1450struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001451 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001452
1453/**
1454 * ieee80211_rts_get - RTS frame generation function
1455 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001456 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001457 * @frame: pointer to the frame that is going to be protected by the RTS.
1458 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001459 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001460 * @rts: The buffer where to store the RTS frame.
1461 *
1462 * If the RTS frames are generated by the host system (i.e., not in
1463 * hardware/firmware), the low-level driver uses this function to receive
1464 * the next RTS frame from the 802.11 code. The low-level is responsible
1465 * for calling this function before and RTS frame is needed.
1466 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001467void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001468 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001469 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001470 struct ieee80211_rts *rts);
1471
1472/**
1473 * ieee80211_rts_duration - Get the duration field for an RTS frame
1474 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001475 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001476 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001477 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001478 *
1479 * If the RTS is generated in firmware, but the host system must provide
1480 * the duration field, the low-level driver uses this function to receive
1481 * the duration field value in little-endian byteorder.
1482 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001483__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1484 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001485 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001486
1487/**
1488 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1489 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001490 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001491 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1492 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001493 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001494 * @cts: The buffer where to store the CTS-to-self frame.
1495 *
1496 * If the CTS-to-self frames are generated by the host system (i.e., not in
1497 * hardware/firmware), the low-level driver uses this function to receive
1498 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1499 * for calling this function before and CTS-to-self frame is needed.
1500 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001501void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1502 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001503 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001504 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001505 struct ieee80211_cts *cts);
1506
1507/**
1508 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1509 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001510 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001511 * @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 +02001512 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001513 *
1514 * If the CTS-to-self is generated in firmware, but the host system must provide
1515 * the duration field, the low-level driver uses this function to receive
1516 * the duration field value in little-endian byteorder.
1517 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001518__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1519 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001520 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001521 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001522
1523/**
1524 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1525 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001526 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001527 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001528 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07001529 *
1530 * Calculate the duration field of some generic frame, given its
1531 * length and transmission rate (in 100kbps).
1532 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001533__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1534 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001535 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001536 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07001537
1538/**
1539 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1540 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001541 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001542 * @control: will be filled with information needed to send returned frame.
1543 *
1544 * Function for accessing buffered broadcast and multicast frames. If
1545 * hardware/firmware does not implement buffering of broadcast/multicast
1546 * frames when power saving is used, 802.11 code buffers them in the host
1547 * memory. The low-level driver uses this function to fetch next buffered
1548 * frame. In most cases, this is used when generating beacon frame. This
1549 * function returns a pointer to the next buffered skb or NULL if no more
1550 * buffered frames are available.
1551 *
1552 * Note: buffered frames are returned only after DTIM beacon frame was
1553 * generated with ieee80211_beacon_get() and the low-level driver must thus
1554 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1555 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1556 * does not need to check for DTIM beacons separately and should be able to
1557 * use common code for all beacons.
1558 */
1559struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001560ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001561
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001562/**
1563 * ieee80211_get_hdrlen_from_skb - get header length from data
1564 *
1565 * Given an skb with a raw 802.11 header at the data pointer this function
Jiri Bencf0706e82007-05-05 11:45:53 -07001566 * returns the 802.11 header length in bytes (not including encryption
1567 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1568 * header the function returns 0.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001569 *
1570 * @skb: the frame
Jiri Bencf0706e82007-05-05 11:45:53 -07001571 */
Harvey Harrisonc9c69502008-06-11 14:21:57 -07001572unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001573
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001574/**
Harvey Harrison6693be72008-06-11 14:21:57 -07001575 * ieee80211_hdrlen - get header length in bytes from frame control
1576 * @fc: frame control field in little-endian format
1577 */
1578unsigned int ieee80211_hdrlen(__le16 fc);
1579
1580/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001581 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1582 *
1583 * This function computes a TKIP rc4 key for an skb. It computes
1584 * a phase 1 key if needed (iv16 wraps around). This function is to
1585 * be used by drivers which can do HW encryption but need to compute
1586 * to phase 1/2 key in SW.
1587 *
1588 * @keyconf: the parameter passed with the set key
1589 * @skb: the skb for which the key is needed
1590 * @rc4key: a buffer to which the key will be written
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001591 * @type: TBD
1592 * @key: TBD
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001593 */
1594void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1595 struct sk_buff *skb,
1596 enum ieee80211_tkip_key_type type, u8 *key);
1597/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001598 * ieee80211_wake_queue - wake specific queue
1599 * @hw: pointer as obtained from ieee80211_alloc_hw().
1600 * @queue: queue number (counted from zero).
1601 *
1602 * Drivers should use this function instead of netif_wake_queue.
1603 */
1604void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1605
1606/**
1607 * ieee80211_stop_queue - stop specific queue
1608 * @hw: pointer as obtained from ieee80211_alloc_hw().
1609 * @queue: queue number (counted from zero).
1610 *
1611 * Drivers should use this function instead of netif_stop_queue.
1612 */
1613void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1614
1615/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001616 * ieee80211_queue_stopped - test status of the queue
1617 * @hw: pointer as obtained from ieee80211_alloc_hw().
1618 * @queue: queue number (counted from zero).
1619 *
1620 * Drivers should use this function instead of netif_stop_queue.
1621 */
1622
1623int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1624
1625/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001626 * ieee80211_stop_queues - stop all queues
1627 * @hw: pointer as obtained from ieee80211_alloc_hw().
1628 *
1629 * Drivers should use this function instead of netif_stop_queue.
1630 */
1631void ieee80211_stop_queues(struct ieee80211_hw *hw);
1632
1633/**
1634 * ieee80211_wake_queues - wake all queues
1635 * @hw: pointer as obtained from ieee80211_alloc_hw().
1636 *
1637 * Drivers should use this function instead of netif_wake_queue.
1638 */
1639void ieee80211_wake_queues(struct ieee80211_hw *hw);
1640
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001641/**
1642 * ieee80211_scan_completed - completed hardware scan
1643 *
1644 * When hardware scan offload is used (i.e. the hw_scan() callback is
1645 * assigned) this function needs to be called by the driver to notify
1646 * mac80211 that the scan finished.
1647 *
1648 * @hw: the hardware that finished the scan
1649 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001650void ieee80211_scan_completed(struct ieee80211_hw *hw);
1651
Johannes Bergdabeb342007-11-09 01:57:29 +01001652/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001653 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001654 *
1655 * This function iterates over the interfaces associated with a given
1656 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001657 * This function allows the iterator function to sleep, when the iterator
1658 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1659 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001660 *
1661 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001662 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001663 * @data: first argument of the iterator function
1664 */
1665void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1666 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001667 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001668 void *data);
1669
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001670/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001671 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1672 *
1673 * This function iterates over the interfaces associated with a given
1674 * hardware that are currently active and calls the callback for them.
1675 * This function requires the iterator callback function to be atomic,
1676 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1677 *
1678 * @hw: the hardware struct of which the interfaces should be iterated over
1679 * @iterator: the iterator function to call, cannot sleep
1680 * @data: first argument of the iterator function
1681 */
1682void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1683 void (*iterator)(void *data,
1684 u8 *mac,
1685 struct ieee80211_vif *vif),
1686 void *data);
1687
1688/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001689 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1690 * @hw: pointer as obtained from ieee80211_alloc_hw().
1691 * @ra: receiver address of the BA session recipient
1692 * @tid: the TID to BA on.
1693 * @return: success if addBA request was sent, failure otherwise
1694 *
1695 * Although mac80211/low level driver/user space application can estimate
1696 * the need to start aggregation on a certain RA/TID, the session level
1697 * will be managed by the mac80211.
1698 */
1699int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1700
1701/**
1702 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1703 * @hw: pointer as obtained from ieee80211_alloc_hw().
1704 * @ra: receiver address of the BA session recipient.
1705 * @tid: the TID to BA on.
1706 *
1707 * This function must be called by low level driver once it has
1708 * finished with preparations for the BA session.
1709 */
1710void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1711
1712/**
1713 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1714 * @hw: pointer as obtained from ieee80211_alloc_hw().
1715 * @ra: receiver address of the BA session recipient.
1716 * @tid: the TID to BA on.
1717 *
1718 * This function must be called by low level driver once it has
1719 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001720 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001721 */
1722void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1723 u16 tid);
1724
1725/**
1726 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1727 * @hw: pointer as obtained from ieee80211_alloc_hw().
1728 * @ra: receiver address of the BA session recipient
1729 * @tid: the TID to stop BA.
1730 * @initiator: if indicates initiator DELBA frame will be sent.
1731 * @return: error if no sta with matching da found, success otherwise
1732 *
1733 * Although mac80211/low level driver/user space application can estimate
1734 * the need to stop aggregation on a certain RA/TID, the session level
1735 * will be managed by the mac80211.
1736 */
1737int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1738 u8 *ra, u16 tid,
1739 enum ieee80211_back_parties initiator);
1740
1741/**
1742 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1743 * @hw: pointer as obtained from ieee80211_alloc_hw().
1744 * @ra: receiver address of the BA session recipient.
1745 * @tid: the desired TID to BA on.
1746 *
1747 * This function must be called by low level driver once it has
1748 * finished with preparations for the BA session tear down.
1749 */
1750void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1751
1752/**
1753 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1754 * @hw: pointer as obtained from ieee80211_alloc_hw().
1755 * @ra: receiver address of the BA session recipient.
1756 * @tid: the desired TID to BA on.
1757 *
1758 * This function must be called by low level driver once it has
1759 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001760 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001761 */
1762void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1763 u16 tid);
1764
Mohamed Abbas84363e62008-04-04 16:59:58 -07001765/**
1766 * ieee80211_notify_mac - low level driver notification
1767 * @hw: pointer as obtained from ieee80211_alloc_hw().
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001768 * @notif_type: enum ieee80211_notification_types
Mohamed Abbas84363e62008-04-04 16:59:58 -07001769 *
1770 * This function must be called by low level driver to inform mac80211 of
1771 * low level driver status change or force mac80211 to re-assoc for low
1772 * level driver internal error that require re-assoc.
1773 */
1774void ieee80211_notify_mac(struct ieee80211_hw *hw,
1775 enum ieee80211_notification_types notif_type);
Jiri Bencf0706e82007-05-05 11:45:53 -07001776#endif /* MAC80211_H */