[deliverable/linux.git] / drivers / staging / wlan-ng / p80211netdev.h

/* p80211netdev.h
*
* WLAN net device structure and functions
*
* Copyright (C) 1999 AbsoluteValue Systems, Inc.  All Rights Reserved.
* --------------------------------------------------------------------
*
* linux-wlan
*
*   The contents of this file are subject to the Mozilla Public
*   License Version 1.1 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.mozilla.org/MPL/
*
*   Software distributed under the License is distributed on an "AS
*   IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
*   implied. See the License for the specific language governing
*   rights and limitations under the License.
*
*   Alternatively, the contents of this file may be used under the
*   terms of the GNU Public License version 2 (the "GPL"), in which
*   case the provisions of the GPL are applicable instead of the
*   above.  If you wish to allow the use of your version of this file
*   only under the terms of the GPL and not to allow others to use
*   your version of this file under the MPL, indicate your decision
*   by deleting the provisions above and replace them with the notice
*   and other provisions required by the GPL.  If you do not delete
*   the provisions above, a recipient may use your version of this
*   file under either the MPL or the GPL.
*
* --------------------------------------------------------------------
*
* Inquiries regarding the linux-wlan Open Source project can be
* made directly to:
*
* AbsoluteValue Systems Inc.
* info@linux-wlan.com
* http://www.linux-wlan.com
*
* --------------------------------------------------------------------
*
* Portions of the development of this software were funded by
* Intersil Corporation as part of PRISM(R) chipset product development.
*
* --------------------------------------------------------------------
*
* This file declares the structure type that represents each wlan
* interface.
*
* --------------------------------------------------------------------
*/

#ifndef _LINUX_P80211NETDEV_H
#define _LINUX_P80211NETDEV_H

#include <linux/interrupt.h>
#include <linux/wireless.h>
#include <linux/netdevice.h>

#undef netdevice_t
typedef struct net_device netdevice_t;

#define WLAN_RELEASE	"0.3.0-staging"

#define WLAN_DEVICE_CLOSED	0
#define WLAN_DEVICE_OPEN	1

#define WLAN_MACMODE_NONE	0
#define WLAN_MACMODE_IBSS_STA	1
#define WLAN_MACMODE_ESS_STA	2
#define WLAN_MACMODE_ESS_AP	3

/* MSD States */
#define WLAN_MSD_HWPRESENT_PENDING	1
#define WLAN_MSD_HWFAIL			2
#define WLAN_MSD_HWPRESENT		3
#define WLAN_MSD_FWLOAD_PENDING		4
#define WLAN_MSD_FWLOAD			5
#define WLAN_MSD_RUNNING_PENDING	6
#define WLAN_MSD_RUNNING		7

#ifndef ETH_P_ECONET
#define ETH_P_ECONET   0x0018	/* needed for 2.2.x kernels */
#endif

#define ETH_P_80211_RAW        (ETH_P_ECONET + 1)

#ifndef ARPHRD_IEEE80211
#define ARPHRD_IEEE80211 801	/* kernel 2.4.6 */
#endif

#ifndef ARPHRD_IEEE80211_PRISM	/* kernel 2.4.18 */
#define ARPHRD_IEEE80211_PRISM 802
#endif

/*--- NSD Capabilities Flags ------------------------------*/
#define P80211_NSDCAP_HARDWAREWEP           0x01	/* hardware wep engine */
#define P80211_NSDCAP_SHORT_PREAMBLE        0x10	/* hardware supports */
#define P80211_NSDCAP_HWFRAGMENT            0x80	/* nsd handles frag/defrag */
#define P80211_NSDCAP_AUTOJOIN              0x100	/* nsd does autojoin */
#define P80211_NSDCAP_NOSCAN                0x200	/* nsd can scan */

/* Received frame statistics */
typedef struct p80211_frmrx_t {
	u32 mgmt;
	u32 assocreq;
	u32 assocresp;
	u32 reassocreq;
	u32 reassocresp;
	u32 probereq;
	u32 proberesp;
	u32 beacon;
	u32 atim;
	u32 disassoc;
	u32 authen;
	u32 deauthen;
	u32 mgmt_unknown;
	u32 ctl;
	u32 pspoll;
	u32 rts;
	u32 cts;
	u32 ack;
	u32 cfend;
	u32 cfendcfack;
	u32 ctl_unknown;
	u32 data;
	u32 dataonly;
	u32 data_cfack;
	u32 data_cfpoll;
	u32 data__cfack_cfpoll;
	u32 null;
	u32 cfack;
	u32 cfpoll;
	u32 cfack_cfpoll;
	u32 data_unknown;
	u32 decrypt;
	u32 decrypt_err;
} p80211_frmrx_t;

/* called by /proc/net/wireless */
struct iw_statistics *p80211wext_get_wireless_stats(netdevice_t * dev);
/* wireless extensions' ioctls */
extern struct iw_handler_def p80211wext_handler_def;
int p80211wext_event_associated(struct wlandevice *wlandev, int assoc);

/* WEP stuff */
#define NUM_WEPKEYS 4
#define MAX_KEYLEN 32

#define HOSTWEP_DEFAULTKEY_MASK (BIT(1)|BIT(0))
#define HOSTWEP_DECRYPT  BIT(4)
#define HOSTWEP_ENCRYPT  BIT(5)
#define HOSTWEP_PRIVACYINVOKED BIT(6)
#define HOSTWEP_EXCLUDEUNENCRYPTED BIT(7)

extern int wlan_watchdog;
extern int wlan_wext_write;

/* WLAN device type */
typedef struct wlandevice {
	struct wlandevice *next;	/* link for list of devices */
	void *priv;		/* private data for MSD */

	/* Subsystem State */
	char name[WLAN_DEVNAMELEN_MAX];	/* Dev name, from register_wlandev() */
	char *nsdname;

	u32 state;		/* Device I/F state (open/closed) */
	u32 msdstate;		/* state of underlying driver */
	u32 hwremoved;		/* Has the hw been yanked out? */

	/* Hardware config */
	unsigned int irq;
	unsigned int iobase;
	unsigned int membase;
	u32 nsdcaps;		/* NSD Capabilities flags */

	/* Config vars */
	unsigned int ethconv;

	/* device methods (init by MSD, used by p80211 */
	int (*open) (struct wlandevice * wlandev);
	int (*close) (struct wlandevice * wlandev);
	void (*reset) (struct wlandevice * wlandev);
	int (*txframe) (struct wlandevice * wlandev, struct sk_buff * skb,
			p80211_hdr_t * p80211_hdr,
			p80211_metawep_t * p80211_wep);
	int (*mlmerequest) (struct wlandevice * wlandev, p80211msg_t * msg);
	int (*set_multicast_list) (struct wlandevice * wlandev,
				   netdevice_t * dev);
	void (*tx_timeout) (struct wlandevice * wlandev);

	/* 802.11 State */
	u8 bssid[WLAN_BSSID_LEN];
	p80211pstr32_t ssid;
	u32 macmode;
	int linkstatus;

	/* WEP State */
	u8 wep_keys[NUM_WEPKEYS][MAX_KEYLEN];
	u8 wep_keylens[NUM_WEPKEYS];
	int hostwep;

	/* Request/Confirm i/f state (used by p80211) */
	unsigned long request_pending;	/* flag, access atomically */

	/* netlink socket */
	/* queue for indications waiting for cmd completion */
	/* Linux netdevice and support */
	netdevice_t *netdev;	/* ptr to linux netdevice */
	struct net_device_stats linux_stats;

	/* Rx bottom half */
	struct tasklet_struct rx_bh;

	struct sk_buff_head nsd_rxq;

	/* 802.11 device statistics */
	struct p80211_frmrx_t rx;

	struct iw_statistics wstats;

	/* jkriegl: iwspy fields */
	u8 spy_number;
	char spy_address[IW_MAX_SPY][ETH_ALEN];
	struct iw_quality spy_stat[IW_MAX_SPY];
} wlandevice_t;

/* WEP stuff */
int wep_change_key(wlandevice_t * wlandev, int keynum, u8 * key, int keylen);
int wep_decrypt(wlandevice_t * wlandev, u8 * buf, u32 len, int key_override,
		u8 * iv, u8 * icv);
int wep_encrypt(wlandevice_t * wlandev, u8 * buf, u8 * dst, u32 len, int keynum,
		u8 * iv, u8 * icv);

int wlan_setup(wlandevice_t * wlandev);
int wlan_unsetup(wlandevice_t * wlandev);
int register_wlandev(wlandevice_t * wlandev);
int unregister_wlandev(wlandevice_t * wlandev);
void p80211netdev_rx(wlandevice_t * wlandev, struct sk_buff *skb);
void p80211netdev_hwremoved(wlandevice_t * wlandev);
#endif
Commit	Line	Data
00b3ed16 GKH	1	/* p80211netdev.h
	2	*
	3	* WLAN net device structure and functions
	4	*
	5	* Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved.
	6	* --------------------------------------------------------------------
	7	*
	8	* linux-wlan
	9	*
	10	* The contents of this file are subject to the Mozilla Public
	11	* License Version 1.1 (the "License"); you may not use this file
	12	* except in compliance with the License. You may obtain a copy of
	13	* the License at http://www.mozilla.org/MPL/
	14	*
	15	* Software distributed under the License is distributed on an "AS
	16	* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
	17	* implied. See the License for the specific language governing
	18	* rights and limitations under the License.
	19	*
	20	* Alternatively, the contents of this file may be used under the
	21	* terms of the GNU Public License version 2 (the "GPL"), in which
	22	* case the provisions of the GPL are applicable instead of the
	23	* above. If you wish to allow the use of your version of this file
	24	* only under the terms of the GPL and not to allow others to use
	25	* your version of this file under the MPL, indicate your decision
	26	* by deleting the provisions above and replace them with the notice
	27	* and other provisions required by the GPL. If you do not delete
	28	* the provisions above, a recipient may use your version of this
	29	* file under either the MPL or the GPL.
	30	*
	31	* --------------------------------------------------------------------
	32	*
	33	* Inquiries regarding the linux-wlan Open Source project can be
	34	* made directly to:
	35	*
	36	* AbsoluteValue Systems Inc.
	37	* info@linux-wlan.com
	38	* http://www.linux-wlan.com
	39	*
	40	* --------------------------------------------------------------------
	41	*
	42	* Portions of the development of this software were funded by
	43	* Intersil Corporation as part of PRISM(R) chipset product development.
	44	*
	45	* --------------------------------------------------------------------
	46	*
	47	* This file declares the structure type that represents each wlan
	48	* interface.
	49	*
	50	* --------------------------------------------------------------------
	51	*/
	52
	53	#ifndef _LINUX_P80211NETDEV_H
	54	#define _LINUX_P80211NETDEV_H
	55
	56	#include <linux/interrupt.h>
	57	#include <linux/wireless.h>
96c5abd7	58	#include <linux/netdevice.h>
00b3ed16	59
96c5abd7 MM	60	#undef netdevice_t
	61	typedef struct net_device netdevice_t;
	62
1f61379e MM	63	#define WLAN_RELEASE "0.3.0-staging"
1f61379e MM	64
00b3ed16 GKH	65	#define WLAN_DEVICE_CLOSED 0
	66	#define WLAN_DEVICE_OPEN 1
	67
	68	#define WLAN_MACMODE_NONE 0
	69	#define WLAN_MACMODE_IBSS_STA 1
	70	#define WLAN_MACMODE_ESS_STA 2
	71	#define WLAN_MACMODE_ESS_AP 3
	72
	73	/* MSD States */
00b3ed16 GKH	74	#define WLAN_MSD_HWPRESENT_PENDING 1
	75	#define WLAN_MSD_HWFAIL 2
	76	#define WLAN_MSD_HWPRESENT 3
	77	#define WLAN_MSD_FWLOAD_PENDING 4
	78	#define WLAN_MSD_FWLOAD 5
	79	#define WLAN_MSD_RUNNING_PENDING 6
	80	#define WLAN_MSD_RUNNING 7
	81
	82	#ifndef ETH_P_ECONET
a32fb5f7	83	#define ETH_P_ECONET 0x0018 /* needed for 2.2.x kernels */
00b3ed16 GKH	84	#endif
	85
	86	#define ETH_P_80211_RAW (ETH_P_ECONET + 1)
	87
	88	#ifndef ARPHRD_IEEE80211
a32fb5f7	89	#define ARPHRD_IEEE80211 801 /* kernel 2.4.6 */
00b3ed16 GKH	90	#endif
00b3ed16 GKH	91
a32fb5f7	92	#ifndef ARPHRD_IEEE80211_PRISM /* kernel 2.4.18 */
00b3ed16 GKH	93	#define ARPHRD_IEEE80211_PRISM 802
	94	#endif
	95
	96	/--- NSD Capabilities Flags ------------------------------/
a32fb5f7 MM	97	#define P80211_NSDCAP_HARDWAREWEP 0x01 /* hardware wep engine */
	98	#define P80211_NSDCAP_SHORT_PREAMBLE 0x10 /* hardware supports */
	99	#define P80211_NSDCAP_HWFRAGMENT 0x80 /* nsd handles frag/defrag */
	100	#define P80211_NSDCAP_AUTOJOIN 0x100 /* nsd does autojoin */
	101	#define P80211_NSDCAP_NOSCAN 0x200 /* nsd can scan */
00b3ed16 GKH	102
00b3ed16 GKH	103	/* Received frame statistics */
a32fb5f7 MM	104	typedef struct p80211_frmrx_t {
	105	u32 mgmt;
	106	u32 assocreq;
	107	u32 assocresp;
	108	u32 reassocreq;
	109	u32 reassocresp;
	110	u32 probereq;
	111	u32 proberesp;
	112	u32 beacon;
	113	u32 atim;
	114	u32 disassoc;
	115	u32 authen;
	116	u32 deauthen;
	117	u32 mgmt_unknown;
	118	u32 ctl;
	119	u32 pspoll;
	120	u32 rts;
	121	u32 cts;
	122	u32 ack;
	123	u32 cfend;
	124	u32 cfendcfack;
	125	u32 ctl_unknown;
	126	u32 data;
	127	u32 dataonly;
	128	u32 data_cfack;
	129	u32 data_cfpoll;
	130	u32 data__cfack_cfpoll;
	131	u32 null;
	132	u32 cfack;
	133	u32 cfpoll;
	134	u32 cfack_cfpoll;
	135	u32 data_unknown;
	136	u32 decrypt;
	137	u32 decrypt_err;
00b3ed16 GKH	138	} p80211_frmrx_t;
00b3ed16 GKH	139
00b3ed16	140	/* called by /proc/net/wireless */
a32fb5f7	141	struct iw_statistics p80211wext_get_wireless_stats(netdevice_t dev);
00b3ed16	142	/* wireless extensions' ioctls */
00b3ed16	143	extern struct iw_handler_def p80211wext_handler_def;
00b3ed16	144	int p80211wext_event_associated(struct wlandevice *wlandev, int assoc);
00b3ed16 GKH	145
	146	/* WEP stuff */
	147	#define NUM_WEPKEYS 4
	148	#define MAX_KEYLEN 32
	149
7f6e0e44 MM	150	#define HOSTWEP_DEFAULTKEY_MASK (BIT(1)\|BIT(0))
	151	#define HOSTWEP_DECRYPT BIT(4)
	152	#define HOSTWEP_ENCRYPT BIT(5)
	153	#define HOSTWEP_PRIVACYINVOKED BIT(6)
	154	#define HOSTWEP_EXCLUDEUNENCRYPTED BIT(7)
00b3ed16 GKH	155
	156	extern int wlan_watchdog;
	157	extern int wlan_wext_write;
	158
	159	/* WLAN device type */
a32fb5f7 MM	160	typedef struct wlandevice {
	161	struct wlandevice next; / link for list of devices */
	162	void priv; / private data for MSD */
00b3ed16 GKH	163
00b3ed16 GKH	164	/* Subsystem State */
a32fb5f7 MM	165	char name[WLAN_DEVNAMELEN_MAX]; /* Dev name, from register_wlandev() */
a32fb5f7 MM	166	char *nsdname;
00b3ed16	167
a32fb5f7 MM	168	u32 state; /* Device I/F state (open/closed) */
	169	u32 msdstate; /* state of underlying driver */
	170	u32 hwremoved; /* Has the hw been yanked out? */
00b3ed16 GKH	171
00b3ed16 GKH	172	/* Hardware config */
a32fb5f7 MM	173	unsigned int irq;
	174	unsigned int iobase;
	175	unsigned int membase;
	176	u32 nsdcaps; /* NSD Capabilities flags */
00b3ed16 GKH	177
00b3ed16 GKH	178	/* Config vars */
a32fb5f7	179	unsigned int ethconv;
00b3ed16 GKH	180
00b3ed16 GKH	181	/* device methods (init by MSD, used by p80211 */
75f49e07 MT	182	int (open) (struct wlandevice wlandev);
	183	int (close) (struct wlandevice wlandev);
	184	void (reset) (struct wlandevice wlandev);
	185	int (txframe) (struct wlandevice wlandev, struct sk_buff * skb,
	186	p80211_hdr_t * p80211_hdr,
	187	p80211_metawep_t * p80211_wep);
	188	int (mlmerequest) (struct wlandevice wlandev, p80211msg_t * msg);
	189	int (set_multicast_list) (struct wlandevice wlandev,
	190	netdevice_t * dev);
	191	void (tx_timeout) (struct wlandevice wlandev);
00b3ed16	192
00b3ed16	193	/* 802.11 State */
a32fb5f7 MM	194	u8 bssid[WLAN_BSSID_LEN];
	195	p80211pstr32_t ssid;
	196	u32 macmode;
	197	int linkstatus;
00b3ed16 GKH	198
00b3ed16 GKH	199	/* WEP State */
aaad4303 SP	200	u8 wep_keys[NUM_WEPKEYS][MAX_KEYLEN];
aaad4303 SP	201	u8 wep_keylens[NUM_WEPKEYS];
a32fb5f7	202	int hostwep;
00b3ed16 GKH	203
00b3ed16 GKH	204	/* Request/Confirm i/f state (used by p80211) */
a32fb5f7	205	unsigned long request_pending; /* flag, access atomically */
00b3ed16 GKH	206
	207	/* netlink socket */
	208	/* queue for indications waiting for cmd completion */
	209	/* Linux netdevice and support */
a32fb5f7	210	netdevice_t netdev; / ptr to linux netdevice */
00b3ed16 GKH	211	struct net_device_stats linux_stats;
00b3ed16 GKH	212
00b3ed16	213	/* Rx bottom half */
a32fb5f7	214	struct tasklet_struct rx_bh;
00b3ed16	215
a32fb5f7	216	struct sk_buff_head nsd_rxq;
00b3ed16 GKH	217
00b3ed16 GKH	218	/* 802.11 device statistics */
a32fb5f7	219	struct p80211_frmrx_t rx;
00b3ed16	220
a32fb5f7	221	struct iw_statistics wstats;
00b3ed16 GKH	222
00b3ed16 GKH	223	/* jkriegl: iwspy fields */
a32fb5f7 MM	224	u8 spy_number;
	225	char spy_address[IW_MAX_SPY][ETH_ALEN];
	226	struct iw_quality spy_stat[IW_MAX_SPY];
00b3ed16 GKH	227	} wlandevice_t;
	228
	229	/* WEP stuff */
75f49e07 MT	230	int wep_change_key(wlandevice_t * wlandev, int keynum, u8 * key, int keylen);
	231	int wep_decrypt(wlandevice_t * wlandev, u8 * buf, u32 len, int key_override,
	232	u8 * iv, u8 * icv);
	233	int wep_encrypt(wlandevice_t * wlandev, u8 * buf, u8 * dst, u32 len, int keynum,
	234	u8 * iv, u8 * icv);
	235
	236	int wlan_setup(wlandevice_t * wlandev);
	237	int wlan_unsetup(wlandevice_t * wlandev);
	238	int register_wlandev(wlandevice_t * wlandev);
	239	int unregister_wlandev(wlandevice_t * wlandev);
	240	void p80211netdev_rx(wlandevice_t * wlandev, struct sk_buff *skb);
	241	void p80211netdev_hwremoved(wlandevice_t * wlandev);
00b3ed16	242	#endif