[PATCH] uml: add -ffreestanding to CFLAGS
[linux/fpc-iii.git] / include / net / ieee80211softmac.h
blob052ed596a4e487de798d0513f472ce842b66ba21
1 /*
2 * ieee80211softmac.h - public interface to the softmac
4 * Copyright (c) 2005 Johannes Berg <johannes@sipsolutions.net>
5 * Joseph Jezak <josejx@gentoo.org>
6 * Larry Finger <Larry.Finger@lwfinger.net>
7 * Danny van Dyk <kugelfang@gentoo.org>
8 * Michael Buesch <mbuesch@freenet.de>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 * The full GNU General Public License is included in this distribution in the
24 * file called COPYING.
27 #ifndef IEEE80211SOFTMAC_H_
28 #define IEEE80211SOFTMAC_H_
30 #include <linux/kernel.h>
31 #include <linux/spinlock.h>
32 #include <linux/workqueue.h>
33 #include <linux/list.h>
34 #include <net/ieee80211.h>
36 /* Once the API is considered more or less stable,
37 * this should be incremented on API incompatible changes.
39 #define IEEE80211SOFTMAC_API 0
41 #define IEEE80211SOFTMAC_MAX_RATES_LEN 8
42 #define IEEE80211SOFTMAC_MAX_EX_RATES_LEN 255
44 struct ieee80211softmac_ratesinfo {
45 u8 count;
46 u8 rates[IEEE80211SOFTMAC_MAX_RATES_LEN + IEEE80211SOFTMAC_MAX_EX_RATES_LEN];
49 /* internal structures */
50 struct ieee80211softmac_network;
51 struct ieee80211softmac_scaninfo;
53 struct ieee80211softmac_essid {
54 u8 len;
55 char data[IW_ESSID_MAX_SIZE+1];
58 struct ieee80211softmac_wpa {
59 char *IE;
60 int IElen;
61 int IEbuflen;
65 * Information about association
67 * Do we need a lock for this?
68 * We only ever use this structure inlined
69 * into our global struct. I've used its lock,
70 * but maybe we need a local one here?
72 struct ieee80211softmac_assoc_info {
74 * This is the requested ESSID. It is written
75 * only by the WX handlers.
78 struct ieee80211softmac_essid req_essid;
80 * the ESSID of the network we're currently
81 * associated (or trying) to. This is
82 * updated to the network's actual ESSID
83 * even if the requested ESSID was 'ANY'
85 struct ieee80211softmac_essid associate_essid;
87 /* BSSID we're trying to associate to */
88 char bssid[ETH_ALEN];
90 /* some flags.
91 * static_essid is valid if the essid is constant,
92 * this is for use by the wx handlers only.
94 * associating is true, if the network has been
95 * auth'ed on and we are in the process of associating.
97 * bssvalid is true if we found a matching network
98 * and saved it's BSSID into the bssid above.
100 * bssfixed is used for SIOCSIWAP.
102 u8 static_essid:1,
103 associating:1,
104 bssvalid:1,
105 bssfixed:1;
107 /* Scan retries remaining */
108 int scan_retry;
110 struct work_struct work;
111 struct work_struct timeout;
114 enum {
115 IEEE80211SOFTMAC_AUTH_OPEN_REQUEST = 1,
116 IEEE80211SOFTMAC_AUTH_OPEN_RESPONSE = 2,
119 enum {
120 IEEE80211SOFTMAC_AUTH_SHARED_REQUEST = 1,
121 IEEE80211SOFTMAC_AUTH_SHARED_CHALLENGE = 2,
122 IEEE80211SOFTMAC_AUTH_SHARED_RESPONSE = 3,
123 IEEE80211SOFTMAC_AUTH_SHARED_PASS = 4,
126 /* We should make these tunable
127 * AUTH_TIMEOUT seems really long, but that's what it is in BSD */
128 #define IEEE80211SOFTMAC_AUTH_TIMEOUT (12 * HZ)
129 #define IEEE80211SOFTMAC_AUTH_RETRY_LIMIT 5
130 #define IEEE80211SOFTMAC_ASSOC_SCAN_RETRY_LIMIT 3
132 struct ieee80211softmac_txrates {
133 /* The Bit-Rate to be used for multicast frames. */
134 u8 mcast_rate;
135 /* The Bit-Rate to be used for multicast fallback
136 * (If the device supports fallback and hardware-retry)
138 u8 mcast_fallback;
139 /* The Bit-Rate to be used for any other (normal) data packet. */
140 u8 default_rate;
141 /* The Bit-Rate to be used for default fallback
142 * (If the device supports fallback and hardware-retry)
144 u8 default_fallback;
147 /* Bits for txrates_change callback. */
148 #define IEEE80211SOFTMAC_TXRATECHG_DEFAULT (1 << 0) /* default_rate */
149 #define IEEE80211SOFTMAC_TXRATECHG_DEFAULT_FBACK (1 << 1) /* default_fallback */
150 #define IEEE80211SOFTMAC_TXRATECHG_MCAST (1 << 2) /* mcast_rate */
151 #define IEEE80211SOFTMAC_TXRATECHG_MCAST_FBACK (1 << 3) /* mcast_fallback */
153 struct ieee80211softmac_device {
154 /* 802.11 structure for data stuff */
155 struct ieee80211_device *ieee;
156 struct net_device *dev;
158 /* only valid if associated, then holds the Association ID */
159 u16 association_id;
161 /* the following methods are callbacks that the driver
162 * using this framework has to assign
165 /* always assign these */
166 void (*set_bssid_filter)(struct net_device *dev, const u8 *bssid);
167 void (*set_channel)(struct net_device *dev, u8 channel);
169 /* assign if you need it, informational only */
170 void (*link_change)(struct net_device *dev);
172 /* If the hardware can do scanning, assign _all_ three of these callbacks.
173 * When the scan finishes, call ieee80211softmac_scan_finished().
176 /* when called, start_scan is guaranteed to not be called again
177 * until you call ieee80211softmac_scan_finished.
178 * Return 0 if scanning could start, error otherwise.
179 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_start_scan */
180 int (*start_scan)(struct net_device *dev);
181 /* this should block until after ieee80211softmac_scan_finished was called
182 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_wait_for_scan */
183 void (*wait_for_scan)(struct net_device *dev);
184 /* stop_scan aborts a scan, but is asynchronous.
185 * if you want to wait for it too, use wait_for_scan
186 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_stop_scan */
187 void (*stop_scan)(struct net_device *dev);
189 /* we'll need something about beacons here too, for AP or ad-hoc modes */
191 /* Transmission rates to be used by the driver.
192 * The SoftMAC figures out the best possible rates.
193 * The driver just needs to read them.
195 struct ieee80211softmac_txrates txrates;
196 /* If the driver needs to do stuff on TX rate changes, assign this callback. */
197 void (*txrates_change)(struct net_device *dev,
198 u32 changes, /* see IEEE80211SOFTMAC_TXRATECHG flags */
199 const struct ieee80211softmac_txrates *rates_before_change);
201 /* private stuff follows */
202 /* this lock protects this structure */
203 spinlock_t lock;
205 /* couple of flags */
206 u8 scanning:1, /* protects scanning from being done multiple times at once */
207 associated:1,
208 running:1;
210 struct ieee80211softmac_scaninfo *scaninfo;
211 struct ieee80211softmac_assoc_info associnfo;
213 struct list_head auth_queue;
214 struct list_head events;
216 struct ieee80211softmac_ratesinfo ratesinfo;
217 int txrate_badness;
219 /* WPA stuff */
220 struct ieee80211softmac_wpa wpa;
222 /* we need to keep a list of network structs we copied */
223 struct list_head network_list;
225 /* This must be the last item so that it points to the data
226 * allocated beyond this structure by alloc_ieee80211 */
227 u8 priv[0];
230 extern void ieee80211softmac_scan_finished(struct ieee80211softmac_device *sm);
232 static inline void * ieee80211softmac_priv(struct net_device *dev)
234 return ((struct ieee80211softmac_device *)ieee80211_priv(dev))->priv;
237 extern struct net_device * alloc_ieee80211softmac(int sizeof_priv);
238 extern void free_ieee80211softmac(struct net_device *dev);
240 /* Call this function if you detect a lost TX fragment.
241 * (If the device indicates failure of ACK RX, for example.)
242 * It is wise to call this function if you are able to detect lost packets,
243 * because it contributes to the TX Rates auto adjustment.
245 extern void ieee80211softmac_fragment_lost(struct net_device *dev,
246 u16 wireless_sequence_number);
247 /* Call this function before _start to tell the softmac what rates
248 * the hw supports. The rates parameter is copied, so you can
249 * free it right after calling this function.
250 * Note that the rates need to be sorted. */
251 extern void ieee80211softmac_set_rates(struct net_device *dev, u8 count, u8 *rates);
253 /* Start the SoftMAC. Call this after you initialized the device
254 * and it is ready to run.
256 extern void ieee80211softmac_start(struct net_device *dev);
257 /* Stop the SoftMAC. Call this before you shutdown the device. */
258 extern void ieee80211softmac_stop(struct net_device *dev);
261 * Event system
264 /* valid event types */
265 #define IEEE80211SOFTMAC_EVENT_ANY -1 /*private use only*/
266 #define IEEE80211SOFTMAC_EVENT_SCAN_FINISHED 0
267 #define IEEE80211SOFTMAC_EVENT_ASSOCIATED 1
268 #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_FAILED 2
269 #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_TIMEOUT 3
270 #define IEEE80211SOFTMAC_EVENT_AUTHENTICATED 4
271 #define IEEE80211SOFTMAC_EVENT_AUTH_FAILED 5
272 #define IEEE80211SOFTMAC_EVENT_AUTH_TIMEOUT 6
273 #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_NET_NOT_FOUND 7
274 #define IEEE80211SOFTMAC_EVENT_DISASSOCIATED 8
275 /* keep this updated! */
276 #define IEEE80211SOFTMAC_EVENT_LAST 8
278 * If you want to be notified of certain events, you can call
279 * ieee80211softmac_notify[_atomic] with
280 * - event set to one of the constants below
281 * - fun set to a function pointer of the appropriate type
282 * - context set to the context data you want passed
283 * The return value is 0, or an error.
285 typedef void (*notify_function_ptr)(struct net_device *dev, void *context);
287 #define ieee80211softmac_notify(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_KERNEL);
288 #define ieee80211softmac_notify_atomic(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_ATOMIC);
290 extern int ieee80211softmac_notify_gfp(struct net_device *dev,
291 int event, notify_function_ptr fun, void *context, gfp_t gfp_mask);
293 /* To clear pending work (for ifconfig down, etc.) */
294 extern void
295 ieee80211softmac_clear_pending_work(struct ieee80211softmac_device *sm);
297 #endif /* IEEE80211SOFTMAC_H_ */