[deliverable/linux.git] / include / net / ieee80211softmac.h

/*
 * ieee80211softmac.h - public interface to the softmac
 *
 * Copyright (c) 2005 Johannes Berg <johannes@sipsolutions.net>
 *                    Joseph Jezak <josejx@gentoo.org>
 *                    Larry Finger <Larry.Finger@lwfinger.net>
 *                    Danny van Dyk <kugelfang@gentoo.org>
 *                    Michael Buesch <mbuesch@freenet.de>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called COPYING.
 */

#ifndef IEEE80211SOFTMAC_H_
#define IEEE80211SOFTMAC_H_

#include <linux/kernel.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/list.h>
#include <net/ieee80211.h>

/* Once the API is considered more or less stable,
 * this should be incremented on API incompatible changes.
 */
#define IEEE80211SOFTMAC_API	0

#define IEEE80211SOFTMAC_MAX_RATES_LEN		8
#define IEEE80211SOFTMAC_MAX_EX_RATES_LEN	255

struct ieee80211softmac_ratesinfo {
	u8 count;
	u8 rates[IEEE80211SOFTMAC_MAX_RATES_LEN + IEEE80211SOFTMAC_MAX_EX_RATES_LEN];
};

/* internal structures */
struct ieee80211softmac_network;
struct ieee80211softmac_scaninfo;

struct ieee80211softmac_essid {
	u8 len;
	char data[IW_ESSID_MAX_SIZE+1];
};

struct ieee80211softmac_wpa {
	char *IE;
	int IElen;
	int IEbuflen;
};

/*
 * Information about association
 */
struct ieee80211softmac_assoc_info {

	struct mutex mutex;

	/*
	 * This is the requested ESSID. It is written
	 * only by the WX handlers.
	 *
	 */
	struct ieee80211softmac_essid req_essid;
	/*
	 * the ESSID of the network we're currently
	 * associated (or trying) to. This is
	 * updated to the network's actual ESSID
	 * even if the requested ESSID was 'ANY'
	 */
	struct ieee80211softmac_essid associate_essid;
	
	/* BSSID we're trying to associate to */
	char bssid[ETH_ALEN];
	
	/* some flags.
	 * static_essid is valid if the essid is constant,
	 * this is for use by the wx handlers only.
	 *
	 * associating is true, if the network has been
	 * auth'ed on and we are in the process of associating.
	 *
	 * bssvalid is true if we found a matching network
	 * and saved it's BSSID into the bssid above.
	 *
	 * bssfixed is used for SIOCSIWAP.
	 */
	u8 static_essid;
	u8 short_preamble_available;
	u8 associating;
	u8 associated;
	u8 assoc_wait;
	u8 bssvalid;
	u8 bssfixed;

	/* Scan retries remaining */
	int scan_retry;

	struct delayed_work work;
	struct delayed_work timeout;
};

struct ieee80211softmac_bss_info {
	/* Rates supported by the network */
	struct ieee80211softmac_ratesinfo supported_rates;

	/* This indicates whether frames can currently be transmitted with
	 * short preamble (only use this variable during TX at CCK rates) */
	u8 short_preamble:1;

	/* This indicates whether protection (e.g. self-CTS) should be used
	 * when transmitting with OFDM modulation */
	u8 use_protection:1;
};

enum {
	IEEE80211SOFTMAC_AUTH_OPEN_REQUEST	= 1,
	IEEE80211SOFTMAC_AUTH_OPEN_RESPONSE	= 2,
};

enum {
	IEEE80211SOFTMAC_AUTH_SHARED_REQUEST	= 1,
	IEEE80211SOFTMAC_AUTH_SHARED_CHALLENGE = 2,
	IEEE80211SOFTMAC_AUTH_SHARED_RESPONSE	= 3,
	IEEE80211SOFTMAC_AUTH_SHARED_PASS	= 4,
};

/* We should make these tunable
 * AUTH_TIMEOUT seems really long, but that's what it is in BSD */
#define IEEE80211SOFTMAC_AUTH_TIMEOUT		(12 * HZ)
#define IEEE80211SOFTMAC_AUTH_RETRY_LIMIT	5
#define IEEE80211SOFTMAC_ASSOC_SCAN_RETRY_LIMIT	3

struct ieee80211softmac_txrates {
	/* The Bit-Rate to be used for multicast frames. */
	u8 mcast_rate;

	/* The Bit-Rate to be used for multicast management frames. */
	u8 mgt_mcast_rate;

	/* The Bit-Rate to be used for any other (normal) data packet. */
	u8 default_rate;
	/* The Bit-Rate to be used for default fallback
	 * (If the device supports fallback and hardware-retry)
	 */
	u8 default_fallback;

	/* This is the rate that the user asked for */
	u8 user_rate;
};

/* Bits for txrates_change callback. */
#define IEEE80211SOFTMAC_TXRATECHG_DEFAULT		(1 << 0) /* default_rate */
#define IEEE80211SOFTMAC_TXRATECHG_DEFAULT_FBACK	(1 << 1) /* default_fallback */
#define IEEE80211SOFTMAC_TXRATECHG_MCAST		(1 << 2) /* mcast_rate */
#define IEEE80211SOFTMAC_TXRATECHG_MGT_MCAST		(1 << 3) /* mgt_mcast_rate */

#define IEEE80211SOFTMAC_BSSINFOCHG_RATES		(1 << 0) /* supported_rates */
#define IEEE80211SOFTMAC_BSSINFOCHG_SHORT_PREAMBLE	(1 << 1) /* short_preamble */
#define IEEE80211SOFTMAC_BSSINFOCHG_PROTECTION		(1 << 2) /* use_protection */

struct ieee80211softmac_device {
	/* 802.11 structure for data stuff */
	struct ieee80211_device *ieee;
	struct net_device *dev;

	/* only valid if associated, then holds the Association ID */
	u16 association_id;
	
	/* the following methods are callbacks that the driver
	 * using this framework has to assign
	 */

	/* always assign these */
	void (*set_bssid_filter)(struct net_device *dev, const u8 *bssid);
	void (*set_channel)(struct net_device *dev, u8 channel);

	/* assign if you need it, informational only */
	void (*link_change)(struct net_device *dev);

	/* If the hardware can do scanning, assign _all_ three of these callbacks.
	 * When the scan finishes, call ieee80211softmac_scan_finished().
	 */
	
	/* when called, start_scan is guaranteed to not be called again
	 * until you call ieee80211softmac_scan_finished.
	 * Return 0 if scanning could start, error otherwise.
	 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_start_scan */
	int (*start_scan)(struct net_device *dev);
	/* this should block until after ieee80211softmac_scan_finished was called
	 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_wait_for_scan */
	void (*wait_for_scan)(struct net_device *dev);
	/* stop_scan aborts a scan, but is asynchronous.
	 * if you want to wait for it too, use wait_for_scan
	 * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_stop_scan */
	void (*stop_scan)(struct net_device *dev);

	/* we'll need something about beacons here too, for AP or ad-hoc modes */

	/* Transmission rates to be used by the driver.
	 * The SoftMAC figures out the best possible rates.
	 * The driver just needs to read them.
	 */
	struct ieee80211softmac_txrates txrates;

	/* If the driver needs to do stuff on TX rate changes, assign this
	 * callback. See IEEE80211SOFTMAC_TXRATECHG for change flags. */
	void (*txrates_change)(struct net_device *dev,
			       u32 changes);

	/* If the driver needs to do stuff when BSS properties change, assign
	 * this callback. see IEEE80211SOFTMAC_BSSINFOCHG for change flags. */
	void (*bssinfo_change)(struct net_device *dev,
			       u32 changes);

	/* private stuff follows */
	/* this lock protects this structure */
	spinlock_t lock;

	u8 running; /* SoftMAC started? */
	u8 scanning;

	struct ieee80211softmac_scaninfo *scaninfo;
	struct ieee80211softmac_assoc_info associnfo;
	struct ieee80211softmac_bss_info bssinfo;

	struct list_head auth_queue;
	struct list_head events;

 	struct ieee80211softmac_ratesinfo ratesinfo;
	int txrate_badness;
	
	/* WPA stuff */
	struct ieee80211softmac_wpa wpa;

	/* we need to keep a list of network structs we copied */
	struct list_head network_list;

	/* This must be the last item so that it points to the data
	 * allocated beyond this structure by alloc_ieee80211 */
	u8 priv[0];
};

extern void ieee80211softmac_scan_finished(struct ieee80211softmac_device *sm);

static inline void * ieee80211softmac_priv(struct net_device *dev)
{
	return ((struct ieee80211softmac_device *)ieee80211_priv(dev))->priv;
}

extern struct net_device * alloc_ieee80211softmac(int sizeof_priv);
extern void free_ieee80211softmac(struct net_device *dev);

/* Call this function if you detect a lost TX fragment.
 * (If the device indicates failure of ACK RX, for example.)
 * It is wise to call this function if you are able to detect lost packets,
 * because it contributes to the TX Rates auto adjustment.
 */
extern void ieee80211softmac_fragment_lost(struct net_device *dev,
					   u16 wireless_sequence_number);
/* Call this function before _start to tell the softmac what rates
 * the hw supports. The rates parameter is copied, so you can
 * free it right after calling this function. 
 * Note that the rates need to be sorted. */
extern void ieee80211softmac_set_rates(struct net_device *dev, u8 count, u8 *rates);

/* Finds the highest rate which is:
 *  1. Present in ri (optionally a basic rate)
 *  2. Supported by the device
 *  3. Less than or equal to the user-defined rate
 */
extern u8 ieee80211softmac_highest_supported_rate(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_ratesinfo *ri, int basic_only);

/* Helper function which advises you the rate at which a frame should be
 * transmitted at. */
static inline u8 ieee80211softmac_suggest_txrate(struct ieee80211softmac_device *mac,
						 int is_multicast,
						 int is_mgt)
{
	struct ieee80211softmac_txrates *txrates = &mac->txrates;

	if (!mac->associnfo.associated)
		return txrates->mgt_mcast_rate;

	/* We are associated, sending unicast frame */
	if (!is_multicast)
		return txrates->default_rate;

	/* We are associated, sending multicast frame */
	if (is_mgt)
		return txrates->mgt_mcast_rate;
	else
		return txrates->mcast_rate;
}

/* Helper function which advises you when it is safe to transmit with short
 * preamble.
 * You should only call this function when transmitting at CCK rates. */
static inline int ieee80211softmac_short_preamble_ok(struct ieee80211softmac_device *mac,
						    int is_multicast,
						    int is_mgt)
{
	return (is_multicast && is_mgt) ? 0 : mac->bssinfo.short_preamble;
}

/* Helper function which advises you whether protection (e.g. self-CTS) is
 * needed. 1 = protection needed, 0 = no protection needed
 * Only use this function when transmitting with OFDM modulation. */
static inline int ieee80211softmac_protection_needed(struct ieee80211softmac_device *mac)
{
	return mac->bssinfo.use_protection;
}

/* Start the SoftMAC. Call this after you initialized the device
 * and it is ready to run.
 */
extern void ieee80211softmac_start(struct net_device *dev);
/* Stop the SoftMAC. Call this before you shutdown the device. */
extern void ieee80211softmac_stop(struct net_device *dev);

/*
 * Event system
 */

/* valid event types */
#define IEEE80211SOFTMAC_EVENT_ANY			-1 /*private use only*/
#define IEEE80211SOFTMAC_EVENT_SCAN_FINISHED		0
#define IEEE80211SOFTMAC_EVENT_ASSOCIATED		1
#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_FAILED		2
#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_TIMEOUT	3
#define IEEE80211SOFTMAC_EVENT_AUTHENTICATED		4
#define IEEE80211SOFTMAC_EVENT_AUTH_FAILED		5
#define IEEE80211SOFTMAC_EVENT_AUTH_TIMEOUT		6
#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_NET_NOT_FOUND	7
#define IEEE80211SOFTMAC_EVENT_DISASSOCIATED		8
/* keep this updated! */
#define IEEE80211SOFTMAC_EVENT_LAST			8
/*
 * If you want to be notified of certain events, you can call
 * ieee80211softmac_notify[_atomic] with
 * 	- event set to one of the constants below
 * 	- fun set to a function pointer of the appropriate type
 *	- context set to the context data you want passed
 * The return value is 0, or an error.
 */
typedef void (*notify_function_ptr)(struct net_device *dev, int event_type, void *context);

#define ieee80211softmac_notify(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_KERNEL);
#define ieee80211softmac_notify_atomic(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_ATOMIC);

extern int ieee80211softmac_notify_gfp(struct net_device *dev,
	int event, notify_function_ptr fun, void *context, gfp_t gfp_mask);

/* To clear pending work (for ifconfig down, etc.) */
extern void
ieee80211softmac_clear_pending_work(struct ieee80211softmac_device *sm);

#endif /* IEEE80211SOFTMAC_H_ */
Commit	Line	Data
4855d25b JB	1	/*
	2	* ieee80211softmac.h - public interface to the softmac
	3	*
	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>
	9	*
	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.
	13	*
	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.
	18	*
	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
	22	*
	23	* The full GNU General Public License is included in this distribution in the
	24	* file called COPYING.
	25	*/
	26
370121e5 JB	27	#ifndef IEEE80211SOFTMAC_H_
	28	#define IEEE80211SOFTMAC_H_
	29
	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>
	35
	36	/* Once the API is considered more or less stable,
	37	* this should be incremented on API incompatible changes.
	38	*/
	39	#define IEEE80211SOFTMAC_API 0
	40
	41	#define IEEE80211SOFTMAC_MAX_RATES_LEN 8
	42	#define IEEE80211SOFTMAC_MAX_EX_RATES_LEN 255
	43
	44	struct ieee80211softmac_ratesinfo {
	45	u8 count;
	46	u8 rates[IEEE80211SOFTMAC_MAX_RATES_LEN + IEEE80211SOFTMAC_MAX_EX_RATES_LEN];
	47	};
	48
	49	/* internal structures */
	50	struct ieee80211softmac_network;
	51	struct ieee80211softmac_scaninfo;
	52
	53	struct ieee80211softmac_essid {
	54	u8 len;
	55	char data[IW_ESSID_MAX_SIZE+1];
	56	};
	57
	58	struct ieee80211softmac_wpa {
	59	char *IE;
	60	int IElen;
	61	int IEbuflen;
	62	};
	63
	64	/*
	65	* Information about association
370121e5 JB	66	*/
370121e5 JB	67	struct ieee80211softmac_assoc_info {
7c28ad2d MB	68
	69	struct mutex mutex;
	70
370121e5 JB	71	/*
	72	* This is the requested ESSID. It is written
	73	* only by the WX handlers.
	74	*
	75	*/
	76	struct ieee80211softmac_essid req_essid;
	77	/*
	78	* the ESSID of the network we're currently
	79	* associated (or trying) to. This is
	80	* updated to the network's actual ESSID
	81	* even if the requested ESSID was 'ANY'
	82	*/
	83	struct ieee80211softmac_essid associate_essid;
	84
	85	/* BSSID we're trying to associate to */
	86	char bssid[ETH_ALEN];
	87
	88	/* some flags.
	89	* static_essid is valid if the essid is constant,
	90	* this is for use by the wx handlers only.
	91	*
	92	* associating is true, if the network has been
	93	* auth'ed on and we are in the process of associating.
	94	*
	95	* bssvalid is true if we found a matching network
	96	* and saved it's BSSID into the bssid above.
818667f7 JB	97	*
818667f7 JB	98	* bssfixed is used for SIOCSIWAP.
370121e5	99	*/
7c28ad2d MB	100	u8 static_essid;
	101	u8 short_preamble_available;
	102	u8 associating;
	103	u8 associated;
	104	u8 assoc_wait;
	105	u8 bssvalid;
	106	u8 bssfixed;
370121e5 JB	107
	108	/* Scan retries remaining */
	109	int scan_retry;
	110
c4028958 DH	111	struct delayed_work work;
c4028958 DH	112	struct delayed_work timeout;
370121e5 JB	113	};
370121e5 JB	114
5acd0c41 DD	115	struct ieee80211softmac_bss_info {
	116	/* Rates supported by the network */
	117	struct ieee80211softmac_ratesinfo supported_rates;
	118
	119	/* This indicates whether frames can currently be transmitted with
	120	* short preamble (only use this variable during TX at CCK rates) */
	121	u8 short_preamble:1;
	122
	123	/* This indicates whether protection (e.g. self-CTS) should be used
	124	* when transmitting with OFDM modulation */
	125	u8 use_protection:1;
	126	};
	127
370121e5 JB	128	enum {
	129	IEEE80211SOFTMAC_AUTH_OPEN_REQUEST = 1,
	130	IEEE80211SOFTMAC_AUTH_OPEN_RESPONSE = 2,
	131	};
	132
	133	enum {
	134	IEEE80211SOFTMAC_AUTH_SHARED_REQUEST = 1,
	135	IEEE80211SOFTMAC_AUTH_SHARED_CHALLENGE = 2,
	136	IEEE80211SOFTMAC_AUTH_SHARED_RESPONSE = 3,
	137	IEEE80211SOFTMAC_AUTH_SHARED_PASS = 4,
	138	};
	139
	140	/* We should make these tunable
	141	* AUTH_TIMEOUT seems really long, but that's what it is in BSD */
	142	#define IEEE80211SOFTMAC_AUTH_TIMEOUT (12 * HZ)
	143	#define IEEE80211SOFTMAC_AUTH_RETRY_LIMIT 5
	144	#define IEEE80211SOFTMAC_ASSOC_SCAN_RETRY_LIMIT 3
	145
	146	struct ieee80211softmac_txrates {
	147	/* The Bit-Rate to be used for multicast frames. */
	148	u8 mcast_rate;
8462fe3c DD	149
	150	/* The Bit-Rate to be used for multicast management frames. */
	151	u8 mgt_mcast_rate;
	152
370121e5 JB	153	/* The Bit-Rate to be used for any other (normal) data packet. */
	154	u8 default_rate;
	155	/* The Bit-Rate to be used for default fallback
	156	* (If the device supports fallback and hardware-retry)
	157	*/
	158	u8 default_fallback;
8462fe3c DD	159
	160	/* This is the rate that the user asked for */
	161	u8 user_rate;
370121e5 JB	162	};
	163
	164	/* Bits for txrates_change callback. */
	165	#define IEEE80211SOFTMAC_TXRATECHG_DEFAULT (1 << 0) /* default_rate */
	166	#define IEEE80211SOFTMAC_TXRATECHG_DEFAULT_FBACK (1 << 1) /* default_fallback */
	167	#define IEEE80211SOFTMAC_TXRATECHG_MCAST (1 << 2) /* mcast_rate */
8462fe3c	168	#define IEEE80211SOFTMAC_TXRATECHG_MGT_MCAST (1 << 3) /* mgt_mcast_rate */
370121e5	169
5acd0c41 DD	170	#define IEEE80211SOFTMAC_BSSINFOCHG_RATES (1 << 0) /* supported_rates */
	171	#define IEEE80211SOFTMAC_BSSINFOCHG_SHORT_PREAMBLE (1 << 1) /* short_preamble */
	172	#define IEEE80211SOFTMAC_BSSINFOCHG_PROTECTION (1 << 2) /* use_protection */
	173
370121e5 JB	174	struct ieee80211softmac_device {
	175	/* 802.11 structure for data stuff */
	176	struct ieee80211_device *ieee;
	177	struct net_device *dev;
	178
	179	/* only valid if associated, then holds the Association ID */
	180	u16 association_id;
	181
	182	/* the following methods are callbacks that the driver
	183	* using this framework has to assign
	184	*/
	185
	186	/* always assign these */
	187	void (set_bssid_filter)(struct net_device dev, const u8 *bssid);
	188	void (set_channel)(struct net_device dev, u8 channel);
	189
	190	/* assign if you need it, informational only */
	191	void (link_change)(struct net_device dev);
	192
	193	/* If the hardware can do scanning, assign _all_ three of these callbacks.
	194	* When the scan finishes, call ieee80211softmac_scan_finished().
	195	*/
	196
	197	/* when called, start_scan is guaranteed to not be called again
	198	* until you call ieee80211softmac_scan_finished.
	199	* Return 0 if scanning could start, error otherwise.
	200	* SOFTMAC AUTHORS: don't call this, use ieee80211softmac_start_scan */
	201	int (start_scan)(struct net_device dev);
	202	/* this should block until after ieee80211softmac_scan_finished was called
	203	* SOFTMAC AUTHORS: don't call this, use ieee80211softmac_wait_for_scan */
	204	void (wait_for_scan)(struct net_device dev);
	205	/* stop_scan aborts a scan, but is asynchronous.
	206	* if you want to wait for it too, use wait_for_scan
	207	* SOFTMAC AUTHORS: don't call this, use ieee80211softmac_stop_scan */
	208	void (stop_scan)(struct net_device dev);
	209
	210	/* we'll need something about beacons here too, for AP or ad-hoc modes */
	211
	212	/* Transmission rates to be used by the driver.
	213	* The SoftMAC figures out the best possible rates.
	214	* The driver just needs to read them.
	215	*/
	216	struct ieee80211softmac_txrates txrates;
5acd0c41 DD	217
	218	/* If the driver needs to do stuff on TX rate changes, assign this
	219	* callback. See IEEE80211SOFTMAC_TXRATECHG for change flags. */
370121e5	220	void (txrates_change)(struct net_device dev,
5acd0c41 DD	221	u32 changes);
	222
	223	/* If the driver needs to do stuff when BSS properties change, assign
	224	* this callback. see IEEE80211SOFTMAC_BSSINFOCHG for change flags. */
	225	void (bssinfo_change)(struct net_device dev,
	226	u32 changes);
370121e5 JB	227
	228	/* private stuff follows */
	229	/* this lock protects this structure */
	230	spinlock_t lock;
7c28ad2d MB	231
	232	u8 running; /* SoftMAC started? */
	233	u8 scanning;
	234
370121e5 JB	235	struct ieee80211softmac_scaninfo *scaninfo;
370121e5 JB	236	struct ieee80211softmac_assoc_info associnfo;
5acd0c41	237	struct ieee80211softmac_bss_info bssinfo;
370121e5 JB	238
	239	struct list_head auth_queue;
	240	struct list_head events;
	241
	242	struct ieee80211softmac_ratesinfo ratesinfo;
	243	int txrate_badness;
	244
	245	/* WPA stuff */
	246	struct ieee80211softmac_wpa wpa;
	247
	248	/* we need to keep a list of network structs we copied */
	249	struct list_head network_list;
7c28ad2d	250
370121e5 JB	251	/* This must be the last item so that it points to the data
	252	* allocated beyond this structure by alloc_ieee80211 */
	253	u8 priv[0];
	254	};
	255
	256	extern void ieee80211softmac_scan_finished(struct ieee80211softmac_device *sm);
	257
	258	static inline void * ieee80211softmac_priv(struct net_device *dev)
	259	{
	260	return ((struct ieee80211softmac_device *)ieee80211_priv(dev))->priv;
	261	}
	262
	263	extern struct net_device * alloc_ieee80211softmac(int sizeof_priv);
	264	extern void free_ieee80211softmac(struct net_device *dev);
	265
	266	/* Call this function if you detect a lost TX fragment.
	267	* (If the device indicates failure of ACK RX, for example.)
	268	* It is wise to call this function if you are able to detect lost packets,
	269	* because it contributes to the TX Rates auto adjustment.
	270	*/
	271	extern void ieee80211softmac_fragment_lost(struct net_device *dev,
	272	u16 wireless_sequence_number);
	273	/* Call this function before _start to tell the softmac what rates
	274	* the hw supports. The rates parameter is copied, so you can
	275	* free it right after calling this function.
	276	* Note that the rates need to be sorted. */
	277	extern void ieee80211softmac_set_rates(struct net_device dev, u8 count, u8 rates);
	278
d7712ac2 DD	279	/* Finds the highest rate which is:
	280	* 1. Present in ri (optionally a basic rate)
	281	* 2. Supported by the device
	282	* 3. Less than or equal to the user-defined rate
	283	*/
	284	extern u8 ieee80211softmac_highest_supported_rate(struct ieee80211softmac_device *mac,
	285	struct ieee80211softmac_ratesinfo *ri, int basic_only);
	286
8462fe3c DD	287	/* Helper function which advises you the rate at which a frame should be
	288	* transmitted at. */
	289	static inline u8 ieee80211softmac_suggest_txrate(struct ieee80211softmac_device *mac,
	290	int is_multicast,
	291	int is_mgt)
	292	{
	293	struct ieee80211softmac_txrates *txrates = &mac->txrates;
	294
7c28ad2d	295	if (!mac->associnfo.associated)
8462fe3c DD	296	return txrates->mgt_mcast_rate;
	297
	298	/* We are associated, sending unicast frame */
	299	if (!is_multicast)
	300	return txrates->default_rate;
	301
	302	/* We are associated, sending multicast frame */
	303	if (is_mgt)
	304	return txrates->mgt_mcast_rate;
	305	else
	306	return txrates->mcast_rate;
	307	}
	308
5acd0c41 DD	309	/* Helper function which advises you when it is safe to transmit with short
	310	* preamble.
	311	* You should only call this function when transmitting at CCK rates. */
	312	static inline int ieee80211softmac_short_preamble_ok(struct ieee80211softmac_device *mac,
	313	int is_multicast,
	314	int is_mgt)
	315	{
	316	return (is_multicast && is_mgt) ? 0 : mac->bssinfo.short_preamble;
	317	}
	318
	319	/* Helper function which advises you whether protection (e.g. self-CTS) is
	320	* needed. 1 = protection needed, 0 = no protection needed
	321	* Only use this function when transmitting with OFDM modulation. */
	322	static inline int ieee80211softmac_protection_needed(struct ieee80211softmac_device *mac)
	323	{
	324	return mac->bssinfo.use_protection;
	325	}
	326
370121e5 JB	327	/* Start the SoftMAC. Call this after you initialized the device
	328	* and it is ready to run.
	329	*/
	330	extern void ieee80211softmac_start(struct net_device *dev);
	331	/* Stop the SoftMAC. Call this before you shutdown the device. */
	332	extern void ieee80211softmac_stop(struct net_device *dev);
	333
	334	/*
	335	* Event system
	336	*/
	337
	338	/* valid event types */
	339	#define IEEE80211SOFTMAC_EVENT_ANY -1 /private use only/
	340	#define IEEE80211SOFTMAC_EVENT_SCAN_FINISHED 0
	341	#define IEEE80211SOFTMAC_EVENT_ASSOCIATED 1
	342	#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_FAILED 2
	343	#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_TIMEOUT 3
	344	#define IEEE80211SOFTMAC_EVENT_AUTHENTICATED 4
	345	#define IEEE80211SOFTMAC_EVENT_AUTH_FAILED 5
	346	#define IEEE80211SOFTMAC_EVENT_AUTH_TIMEOUT 6
	347	#define IEEE80211SOFTMAC_EVENT_ASSOCIATE_NET_NOT_FOUND 7
feeeaa87	348	#define IEEE80211SOFTMAC_EVENT_DISASSOCIATED 8
370121e5	349	/* keep this updated! */
feeeaa87	350	#define IEEE80211SOFTMAC_EVENT_LAST 8
370121e5 JB	351	/*
	352	* If you want to be notified of certain events, you can call
	353	* ieee80211softmac_notify[_atomic] with
	354	* - event set to one of the constants below
	355	* - fun set to a function pointer of the appropriate type
	356	* - context set to the context data you want passed
	357	* The return value is 0, or an error.
	358	*/
6ae15df1	359	typedef void (notify_function_ptr)(struct net_device dev, int event_type, void *context);
370121e5 JB	360
	361	#define ieee80211softmac_notify(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_KERNEL);
	362	#define ieee80211softmac_notify_atomic(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_ATOMIC);
	363
	364	extern int ieee80211softmac_notify_gfp(struct net_device *dev,
	365	int event, notify_function_ptr fun, void *context, gfp_t gfp_mask);
	366
	367	/* To clear pending work (for ifconfig down, etc.) */
	368	extern void
	369	ieee80211softmac_clear_pending_work(struct ieee80211softmac_device *sm);
	370
	371	#endif /* IEEE80211SOFTMAC_H_ */