[net-next-2.6.git] / net / ieee80211 / softmac / ieee80211softmac_priv.h

/*
 * Internal softmac API definitions.
 *
 * Copyright (c) 2005, 2006 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_PRIV_H_
#define IEEE80211SOFTMAC_PRIV_H_

#include <net/ieee80211softmac.h>
#include <net/ieee80211softmac_wx.h>
#include <linux/kernel.h>
#include <linux/stringify.h>


#define PFX				"SoftMAC: "

#ifdef assert
# undef assert
#endif
#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
#define assert(expr) \
	do {										\
		if (unlikely(!(expr))) {						\
		printkl(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n", #expr,	\
			__FILE__, __LINE__, __func__);				\
		}									\
	} while (0)
#else
#define assert(expr) do {} while (0)
#endif

/* rate limited printk(). */
#ifdef printkl
# undef printkl
#endif
#define printkl(f, x...)  do { if (printk_ratelimit()) printk(f ,##x); } while (0)
/* rate limited printk() for debugging */
#ifdef dprintkl
# undef dprintkl
#endif
#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
# define dprintkl		printkl
#else
# define dprintkl(f, x...)	do { /* nothing */ } while (0)
#endif

/* debugging printk() */
#ifdef dprintk
# undef dprintk
#endif
#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
# define dprintk(f, x...)  do { printk(f ,##x); } while (0)
#else
# define dprintk(f, x...)  do { /* nothing */ } while (0)
#endif

/* private definitions and prototypes */

/*** prototypes from _scan.c */
void ieee80211softmac_scan(struct work_struct *work);
/* for internal use if scanning is needed */
int ieee80211softmac_start_scan(struct ieee80211softmac_device *mac);
void ieee80211softmac_stop_scan(struct ieee80211softmac_device *mac);
void ieee80211softmac_wait_for_scan(struct ieee80211softmac_device *mac);

/* for use by _module.c to assign to the callbacks */
int ieee80211softmac_start_scan_implementation(struct net_device *dev);
void ieee80211softmac_stop_scan_implementation(struct net_device *dev);
void ieee80211softmac_wait_for_scan_implementation(struct net_device *dev);

/*** Network prototypes from _module.c */
struct ieee80211softmac_network * ieee80211softmac_create_network(
	struct ieee80211softmac_device *mac, struct ieee80211_network *net);
void ieee80211softmac_add_network_locked(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_network *net);
void ieee80211softmac_add_network(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_network *net);
void ieee80211softmac_del_network_locked(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_network *net);
void ieee80211softmac_del_network(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_network *net);
struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid_locked(
	struct ieee80211softmac_device *mac, u8 *ea);
struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid(
	struct ieee80211softmac_device *mac, u8 *ea);
struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid_locked(
	struct ieee80211softmac_device *mac, u8 *ssid, u8 ssid_len);
struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid(
	struct ieee80211softmac_device *mac, u8 *ssid, u8 ssid_len);
struct ieee80211softmac_network *
ieee80211softmac_get_network_by_essid_locked(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_essid *essid);
struct ieee80211softmac_network *
ieee80211softmac_get_network_by_essid(struct ieee80211softmac_device *mac,
	struct ieee80211softmac_essid *essid);

/* Rates related */
void ieee80211softmac_process_erp(struct ieee80211softmac_device *mac,
	u8 erp_value);
int ieee80211softmac_ratesinfo_rate_supported(struct ieee80211softmac_ratesinfo *ri, u8 rate);
u8 ieee80211softmac_lower_rate_delta(struct ieee80211softmac_device *mac, u8 rate, int delta);
void ieee80211softmac_init_bss(struct ieee80211softmac_device *mac);
void ieee80211softmac_recalc_txrates(struct ieee80211softmac_device *mac);
static inline u8 lower_rate(struct ieee80211softmac_device *mac, u8 rate) {
	return ieee80211softmac_lower_rate_delta(mac, rate, 1);
}

static inline u8 get_fallback_rate(struct ieee80211softmac_device *mac, u8 rate)
{
	return ieee80211softmac_lower_rate_delta(mac, rate, 2);
}


/*** prototypes from _io.c */
int ieee80211softmac_send_mgt_frame(struct ieee80211softmac_device *mac,
	void* ptrarg, u32 type, u32 arg);
int ieee80211softmac_handle_beacon(struct net_device *dev,
	struct ieee80211_beacon *beacon,
	struct ieee80211_network *network);

/*** prototypes from _auth.c */
/* do these have to go into the public header? */
int ieee80211softmac_auth_req(struct ieee80211softmac_device *mac, struct ieee80211softmac_network *net);
int ieee80211softmac_deauth_req(struct ieee80211softmac_device *mac, struct ieee80211softmac_network *net, int reason);

/* for use by _module.c to assign to the callbacks */
int ieee80211softmac_auth_resp(struct net_device *dev, struct ieee80211_auth *auth);
int ieee80211softmac_deauth_resp(struct net_device *dev, struct ieee80211_deauth *deauth);

/*** prototypes from _assoc.c */
void ieee80211softmac_assoc_work(struct work_struct *work);
int ieee80211softmac_handle_assoc_response(struct net_device * dev,
					   struct ieee80211_assoc_response * resp,
					   struct ieee80211_network * network);
int ieee80211softmac_handle_disassoc(struct net_device * dev,
				     struct ieee80211_disassoc * disassoc);
int ieee80211softmac_handle_reassoc_req(struct net_device * dev,
					struct ieee80211_reassoc_request * reassoc);
void ieee80211softmac_assoc_timeout(struct work_struct *work);
void ieee80211softmac_send_disassoc_req(struct ieee80211softmac_device *mac, u16 reason);
void ieee80211softmac_disassoc(struct ieee80211softmac_device *mac);

/* some helper functions */
static inline int ieee80211softmac_scan_handlers_check_self(struct ieee80211softmac_device *sm)
{
	return (sm->start_scan == ieee80211softmac_start_scan_implementation) &&
		(sm->stop_scan == ieee80211softmac_stop_scan_implementation) &&
		(sm->wait_for_scan == ieee80211softmac_wait_for_scan_implementation);
}

static inline int ieee80211softmac_scan_sanity_check(struct ieee80211softmac_device *sm)
{
	return ((sm->start_scan != ieee80211softmac_start_scan_implementation) &&
		(sm->stop_scan != ieee80211softmac_stop_scan_implementation) &&
		(sm->wait_for_scan != ieee80211softmac_wait_for_scan_implementation)
		) || ieee80211softmac_scan_handlers_check_self(sm);
}

#define IEEE80211SOFTMAC_PROBE_DELAY		HZ/50
#define IEEE80211SOFTMAC_WORKQUEUE_NAME_LEN	(17 + IFNAMSIZ)

struct ieee80211softmac_network {
	struct list_head		list;	/* List */
	/* Network information copied from ieee80211_network */
	u8 bssid[ETH_ALEN];
	u8 channel;
	struct ieee80211softmac_essid essid;

	struct ieee80211softmac_ratesinfo supported_rates;

	/* SoftMAC specific */
	u16 authenticating:1,			/* Status Flags */
	    authenticated:1,
	    auth_desynced_once:1;

	u8 erp_value;				/* Saved ERP value */
	u16 capabilities;			/* Capabilities bitfield */
	u8 challenge_len;			/* Auth Challenge length */
	char *challenge;			/* Challenge Text */
};

/* structure used to keep track of networks we're auth'ing to */
struct ieee80211softmac_auth_queue_item {
	struct list_head		list;	/* List head */
	struct ieee80211softmac_network	*net;	/* Network to auth */
	struct ieee80211softmac_device	*mac;	/* SoftMAC device */
	u8 retry;				/* Retry limit */
	u8 state;				/* Auth State */
	struct delayed_work		work;	/* Work queue */
};

/* scanning information */
struct ieee80211softmac_scaninfo {
	u8 current_channel_idx,
	   number_channels;
	struct ieee80211_channel *channels;
	u8 started:1,
	   stop:1;
	u8 skip_flags;
	struct completion finished;
	struct delayed_work softmac_scan;
	struct ieee80211softmac_device *mac;
};

/* private event struct */
struct ieee80211softmac_event {
	struct list_head list;
	int event_type;
	void *event_context;
	struct delayed_work work;
	notify_function_ptr fun;
	void *context;
	struct ieee80211softmac_device *mac;
};

void ieee80211softmac_call_events(struct ieee80211softmac_device *mac, int event, void *event_context);
void ieee80211softmac_call_events_locked(struct ieee80211softmac_device *mac, int event, void *event_context);
int ieee80211softmac_notify_internal(struct ieee80211softmac_device *mac,
	int event, void *event_context, notify_function_ptr fun, void *context, gfp_t gfp_mask);

void ieee80211softmac_try_reassoc(struct ieee80211softmac_device *mac);

#endif /* IEEE80211SOFTMAC_PRIV_H_ */
Commit	Line	Data
4855d25b JB	1	/*
	2	* Internal softmac API definitions.
	3	*
79859051 JB	4	* Copyright (c) 2005, 2006 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>
4855d25b JB	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_PRIV_H_
	28	#define IEEE80211SOFTMAC_PRIV_H_
	29
	30	#include <net/ieee80211softmac.h>
	31	#include <net/ieee80211softmac_wx.h>
	32	#include <linux/kernel.h>
	33	#include <linux/stringify.h>
	34
	35
	36	#define PFX "SoftMAC: "
	37
	38	#ifdef assert
	39	# undef assert
	40	#endif
	41	#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
	42	#define assert(expr) \
	43	do { \
	44	if (unlikely(!(expr))) { \
	45	printkl(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n", #expr, \
0dc47877	46	__FILE__, __LINE__, __func__); \
370121e5 JB	47	} \
	48	} while (0)
	49	#else
	50	#define assert(expr) do {} while (0)
	51	#endif
	52
	53	/* rate limited printk(). */
	54	#ifdef printkl
	55	# undef printkl
	56	#endif
	57	#define printkl(f, x...) do { if (printk_ratelimit()) printk(f ,##x); } while (0)
	58	/* rate limited printk() for debugging */
	59	#ifdef dprintkl
	60	# undef dprintkl
	61	#endif
	62	#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
	63	# define dprintkl printkl
	64	#else
	65	# define dprintkl(f, x...) do { /* nothing */ } while (0)
	66	#endif
	67
	68	/* debugging printk() */
	69	#ifdef dprintk
	70	# undef dprintk
	71	#endif
	72	#ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
	73	# define dprintk(f, x...) do { printk(f ,##x); } while (0)
	74	#else
	75	# define dprintk(f, x...) do { /* nothing */ } while (0)
	76	#endif
	77
370121e5 JB	78	/* private definitions and prototypes */
	79
	80	/*** prototypes from _scan.c */
c4028958	81	void ieee80211softmac_scan(struct work_struct *work);
370121e5 JB	82	/* for internal use if scanning is needed */
	83	int ieee80211softmac_start_scan(struct ieee80211softmac_device *mac);
	84	void ieee80211softmac_stop_scan(struct ieee80211softmac_device *mac);
	85	void ieee80211softmac_wait_for_scan(struct ieee80211softmac_device *mac);
	86
	87	/* for use by _module.c to assign to the callbacks */
	88	int ieee80211softmac_start_scan_implementation(struct net_device *dev);
	89	void ieee80211softmac_stop_scan_implementation(struct net_device *dev);
	90	void ieee80211softmac_wait_for_scan_implementation(struct net_device *dev);
	91
	92	/*** Network prototypes from _module.c */
	93	struct ieee80211softmac_network * ieee80211softmac_create_network(
	94	struct ieee80211softmac_device mac, struct ieee80211_network net);
	95	void ieee80211softmac_add_network_locked(struct ieee80211softmac_device *mac,
	96	struct ieee80211softmac_network *net);
	97	void ieee80211softmac_add_network(struct ieee80211softmac_device *mac,
	98	struct ieee80211softmac_network *net);
	99	void ieee80211softmac_del_network_locked(struct ieee80211softmac_device *mac,
	100	struct ieee80211softmac_network *net);
	101	void ieee80211softmac_del_network(struct ieee80211softmac_device *mac,
	102	struct ieee80211softmac_network *net);
	103	struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid_locked(
	104	struct ieee80211softmac_device mac, u8 ea);
	105	struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid(
	106	struct ieee80211softmac_device mac, u8 ea);
	107	struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid_locked(
	108	struct ieee80211softmac_device mac, u8 ssid, u8 ssid_len);
	109	struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid(
	110	struct ieee80211softmac_device mac, u8 ssid, u8 ssid_len);
714e1a51 JB	111	struct ieee80211softmac_network *
	112	ieee80211softmac_get_network_by_essid_locked(struct ieee80211softmac_device *mac,
	113	struct ieee80211softmac_essid *essid);
	114	struct ieee80211softmac_network *
	115	ieee80211softmac_get_network_by_essid(struct ieee80211softmac_device *mac,
	116	struct ieee80211softmac_essid *essid);
370121e5 JB	117
370121e5 JB	118	/* Rates related */
5acd0c41 DD	119	void ieee80211softmac_process_erp(struct ieee80211softmac_device *mac,
5acd0c41 DD	120	u8 erp_value);
8462fe3c	121	int ieee80211softmac_ratesinfo_rate_supported(struct ieee80211softmac_ratesinfo *ri, u8 rate);
370121e5	122	u8 ieee80211softmac_lower_rate_delta(struct ieee80211softmac_device *mac, u8 rate, int delta);
5acd0c41	123	void ieee80211softmac_init_bss(struct ieee80211softmac_device *mac);
8462fe3c	124	void ieee80211softmac_recalc_txrates(struct ieee80211softmac_device *mac);
370121e5 JB	125	static inline u8 lower_rate(struct ieee80211softmac_device *mac, u8 rate) {
	126	return ieee80211softmac_lower_rate_delta(mac, rate, 1);
	127	}
	128
	129	static inline u8 get_fallback_rate(struct ieee80211softmac_device *mac, u8 rate)
	130	{
	131	return ieee80211softmac_lower_rate_delta(mac, rate, 2);
	132	}
64265651	133
370121e5 JB	134
	135	/*** prototypes from _io.c */
	136	int ieee80211softmac_send_mgt_frame(struct ieee80211softmac_device *mac,
	137	void* ptrarg, u32 type, u32 arg);
5acd0c41 DD	138	int ieee80211softmac_handle_beacon(struct net_device *dev,
	139	struct ieee80211_beacon *beacon,
	140	struct ieee80211_network *network);
370121e5 JB	141
	142	/*** prototypes from _auth.c */
	143	/* do these have to go into the public header? */
	144	int ieee80211softmac_auth_req(struct ieee80211softmac_device mac, struct ieee80211softmac_network net);
	145	int ieee80211softmac_deauth_req(struct ieee80211softmac_device mac, struct ieee80211softmac_network net, int reason);
	146
	147	/* for use by _module.c to assign to the callbacks */
	148	int ieee80211softmac_auth_resp(struct net_device dev, struct ieee80211_auth auth);
b10c991f	149	int ieee80211softmac_deauth_resp(struct net_device dev, struct ieee80211_deauth deauth);
370121e5 JB	150
370121e5 JB	151	/*** prototypes from _assoc.c */
c4028958	152	void ieee80211softmac_assoc_work(struct work_struct *work);
370121e5 JB	153	int ieee80211softmac_handle_assoc_response(struct net_device * dev,
	154	struct ieee80211_assoc_response * resp,
	155	struct ieee80211_network * network);
	156	int ieee80211softmac_handle_disassoc(struct net_device * dev,
	157	struct ieee80211_disassoc * disassoc);
b6c7658e	158	int ieee80211softmac_handle_reassoc_req(struct net_device * dev,
64265651	159	struct ieee80211_reassoc_request * reassoc);
c4028958	160	void ieee80211softmac_assoc_timeout(struct work_struct *work);
6d92f83f DD	161	void ieee80211softmac_send_disassoc_req(struct ieee80211softmac_device *mac, u16 reason);
6d92f83f DD	162	void ieee80211softmac_disassoc(struct ieee80211softmac_device *mac);
370121e5 JB	163
	164	/* some helper functions */
	165	static inline int ieee80211softmac_scan_handlers_check_self(struct ieee80211softmac_device *sm)
	166	{
64265651 YH	167	return (sm->start_scan == ieee80211softmac_start_scan_implementation) &&
64265651 YH	168	(sm->stop_scan == ieee80211softmac_stop_scan_implementation) &&
370121e5 JB	169	(sm->wait_for_scan == ieee80211softmac_wait_for_scan_implementation);
	170	}
	171
	172	static inline int ieee80211softmac_scan_sanity_check(struct ieee80211softmac_device *sm)
	173	{
64265651 YH	174	return ((sm->start_scan != ieee80211softmac_start_scan_implementation) &&
64265651 YH	175	(sm->stop_scan != ieee80211softmac_stop_scan_implementation) &&
370121e5 JB	176	(sm->wait_for_scan != ieee80211softmac_wait_for_scan_implementation)
	177	) \|\| ieee80211softmac_scan_handlers_check_self(sm);
	178	}
	179
16f43527	180	#define IEEE80211SOFTMAC_PROBE_DELAY HZ/50
370121e5 JB	181	#define IEEE80211SOFTMAC_WORKQUEUE_NAME_LEN (17 + IFNAMSIZ)
	182
	183	struct ieee80211softmac_network {
	184	struct list_head list; /* List */
	185	/* Network information copied from ieee80211_network */
	186	u8 bssid[ETH_ALEN];
	187	u8 channel;
	188	struct ieee80211softmac_essid essid;
	189
	190	struct ieee80211softmac_ratesinfo supported_rates;
	191
	192	/* SoftMAC specific */
	193	u16 authenticating:1, /* Status Flags */
	194	authenticated:1,
	195	auth_desynced_once:1;
	196
5acd0c41	197	u8 erp_value; /* Saved ERP value */
370121e5 JB	198	u16 capabilities; /* Capabilities bitfield */
	199	u8 challenge_len; /* Auth Challenge length */
	200	char challenge; / Challenge Text */
	201	};
	202
	203	/* structure used to keep track of networks we're auth'ing to */
	204	struct ieee80211softmac_auth_queue_item {
	205	struct list_head list; /* List head */
	206	struct ieee80211softmac_network net; / Network to auth */
	207	struct ieee80211softmac_device mac; / SoftMAC device */
	208	u8 retry; /* Retry limit */
	209	u8 state; /* Auth State */
c4028958	210	struct delayed_work work; /* Work queue */
370121e5 JB	211	};
	212
	213	/* scanning information */
	214	struct ieee80211softmac_scaninfo {
	215	u8 current_channel_idx,
	216	number_channels;
	217	struct ieee80211_channel *channels;
	218	u8 started:1,
	219	stop:1;
	220	u8 skip_flags;
	221	struct completion finished;
c4028958 DH	222	struct delayed_work softmac_scan;
c4028958 DH	223	struct ieee80211softmac_device *mac;
370121e5 JB	224	};
	225
	226	/* private event struct */
	227	struct ieee80211softmac_event {
	228	struct list_head list;
	229	int event_type;
	230	void *event_context;
c4028958	231	struct delayed_work work;
370121e5 JB	232	notify_function_ptr fun;
	233	void *context;
	234	struct ieee80211softmac_device *mac;
	235	};
	236
	237	void ieee80211softmac_call_events(struct ieee80211softmac_device mac, int event, void event_context);
	238	void ieee80211softmac_call_events_locked(struct ieee80211softmac_device mac, int event, void event_context);
	239	int ieee80211softmac_notify_internal(struct ieee80211softmac_device *mac,
	240	int event, void event_context, notify_function_ptr fun, void context, gfp_t gfp_mask);
	241
2b50c245 UK	242	void ieee80211softmac_try_reassoc(struct ieee80211softmac_device *mac);
2b50c245 UK	243
370121e5	244	#endif /* IEEE80211SOFTMAC_PRIV_H_ */