[deliverable/linux.git] / drivers / net / wireless / orinoco.h

/* orinoco.h
 * 
 * Common definitions to all pieces of the various orinoco
 * drivers
 */

#ifndef _ORINOCO_H
#define _ORINOCO_H

#define DRIVER_VERSION "0.15"

#include <linux/netdevice.h>
#include <linux/wireless.h>
#include <net/iw_handler.h>

#include "hermes.h"

/* To enable debug messages */
//#define ORINOCO_DEBUG		3

#define WIRELESS_SPY		// enable iwspy support

#define MAX_SCAN_LEN		4096

#define ORINOCO_MAX_KEY_SIZE	14
#define ORINOCO_MAX_KEYS	4

struct orinoco_key {
	__le16 len;	/* always stored as little-endian */
	char data[ORINOCO_MAX_KEY_SIZE];
} __attribute__ ((packed));

typedef enum {
	FIRMWARE_TYPE_AGERE,
	FIRMWARE_TYPE_INTERSIL,
	FIRMWARE_TYPE_SYMBOL
} fwtype_t;

struct bss_element {
	union hermes_scan_info bss;
	unsigned long last_scanned;
	struct list_head list;
};

struct xbss_element {
	struct agere_ext_scan_info bss;
	unsigned long last_scanned;
	struct list_head list;
};

struct orinoco_private {
	void *card;	/* Pointer to card dependent structure */
	struct device *dev;
	int (*hard_reset)(struct orinoco_private *);
	int (*stop_fw)(struct orinoco_private *, int);

	/* Synchronisation stuff */
	spinlock_t lock;
	int hw_unavailable;
	struct work_struct reset_work;

	/* driver state */
	int open;
	u16 last_linkstatus;
	struct work_struct join_work;
	struct work_struct wevent_work;

	/* Net device stuff */
	struct net_device *ndev;
	struct net_device_stats stats;
	struct iw_statistics wstats;

	/* Hardware control variables */
	hermes_t hw;
	u16 txfid;

	/* Capabilities of the hardware/firmware */
	fwtype_t firmware_type;
	char fw_name[32];
	int ibss_port;
	int nicbuf_size;
	u16 channel_mask;

	/* Boolean capabilities */
	unsigned int has_ibss:1;
	unsigned int has_port3:1;
	unsigned int has_wep:1;
	unsigned int has_big_wep:1;
	unsigned int has_mwo:1;
	unsigned int has_pm:1;
	unsigned int has_preamble:1;
	unsigned int has_sensitivity:1;
	unsigned int has_hostscan:1;
	unsigned int has_alt_txcntl:1;
	unsigned int has_ext_scan:1;
	unsigned int do_fw_download:1;
	unsigned int broken_disableport:1;
	unsigned int broken_monitor:1;

	/* Configuration paramaters */
	u32 iw_mode;
	int prefer_port3;
	u16 wep_on, wep_restrict, tx_key;
	struct orinoco_key keys[ORINOCO_MAX_KEYS];
	int bitratemode;
 	char nick[IW_ESSID_MAX_SIZE+1];
	char desired_essid[IW_ESSID_MAX_SIZE+1];
	char desired_bssid[ETH_ALEN];
	int bssid_fixed;
	u16 frag_thresh, mwo_robust;
	u16 channel;
	u16 ap_density, rts_thresh;
	u16 pm_on, pm_mcast, pm_period, pm_timeout;
	u16 preamble;
#ifdef WIRELESS_SPY
 	struct iw_spy_data spy_data; /* iwspy support */
	struct iw_public_data	wireless_data;
#endif

	/* Configuration dependent variables */
	int port_type, createibss;
	int promiscuous, mc_count;

	/* Scanning support */
	struct list_head bss_list;
	struct list_head bss_free_list;
	void *bss_xbss_data;

	int	scan_inprogress;	/* Scan pending... */
	u32	scan_mode;		/* Type of scan done */
};

#ifdef ORINOCO_DEBUG
extern int orinoco_debug;
#define DEBUG(n, args...) do { if (orinoco_debug>(n)) printk(KERN_DEBUG args); } while(0)
#else
#define DEBUG(n, args...) do { } while (0)
#endif	/* ORINOCO_DEBUG */

/********************************************************************/
/* Exported prototypes                                              */
/********************************************************************/

extern struct net_device *alloc_orinocodev(
	int sizeof_card, struct device *device,
	int (*hard_reset)(struct orinoco_private *),
	int (*stop_fw)(struct orinoco_private *, int));
extern void free_orinocodev(struct net_device *dev);
extern int __orinoco_up(struct net_device *dev);
extern int __orinoco_down(struct net_device *dev);
extern int orinoco_reinit_firmware(struct net_device *dev);
extern irqreturn_t orinoco_interrupt(int irq, void * dev_id);

/********************************************************************/
/* Locking and synchronization functions                            */
/********************************************************************/

static inline int orinoco_lock(struct orinoco_private *priv,
			       unsigned long *flags)
{
	spin_lock_irqsave(&priv->lock, *flags);
	if (priv->hw_unavailable) {
		DEBUG(1, "orinoco_lock() called with hw_unavailable (dev=%p)\n",
		       priv->ndev);
		spin_unlock_irqrestore(&priv->lock, *flags);
		return -EBUSY;
	}
	return 0;
}

static inline void orinoco_unlock(struct orinoco_private *priv,
				  unsigned long *flags)
{
	spin_unlock_irqrestore(&priv->lock, *flags);
}

#endif /* _ORINOCO_H */
Commit	Line	Data
1da177e4 LT	1	/* orinoco.h
	2	*
	3	* Common definitions to all pieces of the various orinoco
	4	* drivers
	5	*/
	6
	7	#ifndef _ORINOCO_H
	8	#define _ORINOCO_H
	9
f298a2ec	10	#define DRIVER_VERSION "0.15"
1da177e4	11
1da177e4 LT	12	#include <linux/netdevice.h>
1da177e4 LT	13	#include <linux/wireless.h>
343c686c	14	#include <net/iw_handler.h>
1da177e4 LT	15
	16	#include "hermes.h"
	17
	18	/* To enable debug messages */
	19	//#define ORINOCO_DEBUG 3
	20
	21	#define WIRELESS_SPY // enable iwspy support
	22
16739b06 CH	23	#define MAX_SCAN_LEN 4096
16739b06 CH	24
1da177e4 LT	25	#define ORINOCO_MAX_KEY_SIZE 14
	26	#define ORINOCO_MAX_KEYS 4
	27
	28	struct orinoco_key {
d133ae4c	29	__le16 len; /* always stored as little-endian */
1da177e4 LT	30	char data[ORINOCO_MAX_KEY_SIZE];
	31	} __attribute__ ((packed));
	32
	33	typedef enum {
	34	FIRMWARE_TYPE_AGERE,
	35	FIRMWARE_TYPE_INTERSIL,
	36	FIRMWARE_TYPE_SYMBOL
	37	} fwtype_t;
	38
3056c404	39	struct bss_element {
1e3428e9 DW	40	union hermes_scan_info bss;
	41	unsigned long last_scanned;
	42	struct list_head list;
3056c404	43	};
1e3428e9	44
01632fa4 DK	45	struct xbss_element {
	46	struct agere_ext_scan_info bss;
	47	unsigned long last_scanned;
	48	struct list_head list;
	49	};
	50
1da177e4 LT	51	struct orinoco_private {
1da177e4 LT	52	void card; / Pointer to card dependent structure */
3994d502	53	struct device *dev;
1da177e4	54	int (hard_reset)(struct orinoco_private );
3994d502	55	int (stop_fw)(struct orinoco_private , int);
1da177e4 LT	56
	57	/* Synchronisation stuff */
	58	spinlock_t lock;
	59	int hw_unavailable;
	60	struct work_struct reset_work;
	61
	62	/* driver state */
	63	int open;
	64	u16 last_linkstatus;
16739b06	65	struct work_struct join_work;
95dd91fb	66	struct work_struct wevent_work;
1da177e4 LT	67
	68	/* Net device stuff */
	69	struct net_device *ndev;
	70	struct net_device_stats stats;
	71	struct iw_statistics wstats;
	72
	73	/* Hardware control variables */
	74	hermes_t hw;
	75	u16 txfid;
	76
	77	/* Capabilities of the hardware/firmware */
	78	fwtype_t firmware_type;
	79	char fw_name[32];
	80	int ibss_port;
	81	int nicbuf_size;
	82	u16 channel_mask;
	83
	84	/* Boolean capabilities */
	85	unsigned int has_ibss:1;
	86	unsigned int has_port3:1;
	87	unsigned int has_wep:1;
	88	unsigned int has_big_wep:1;
	89	unsigned int has_mwo:1;
	90	unsigned int has_pm:1;
	91	unsigned int has_preamble:1;
	92	unsigned int has_sensitivity:1;
95dd91fb	93	unsigned int has_hostscan:1;
6eecad77	94	unsigned int has_alt_txcntl:1;
01632fa4	95	unsigned int has_ext_scan:1;
3994d502	96	unsigned int do_fw_download:1;
1da177e4	97	unsigned int broken_disableport:1;
98c4cae1	98	unsigned int broken_monitor:1;
1da177e4 LT	99
	100	/* Configuration paramaters */
	101	u32 iw_mode;
	102	int prefer_port3;
	103	u16 wep_on, wep_restrict, tx_key;
	104	struct orinoco_key keys[ORINOCO_MAX_KEYS];
	105	int bitratemode;
	106	char nick[IW_ESSID_MAX_SIZE+1];
	107	char desired_essid[IW_ESSID_MAX_SIZE+1];
16739b06 CH	108	char desired_bssid[ETH_ALEN];
16739b06 CH	109	int bssid_fixed;
1da177e4 LT	110	u16 frag_thresh, mwo_robust;
	111	u16 channel;
	112	u16 ap_density, rts_thresh;
	113	u16 pm_on, pm_mcast, pm_period, pm_timeout;
	114	u16 preamble;
	115	#ifdef WIRELESS_SPY
343c686c PR	116	struct iw_spy_data spy_data; /* iwspy support */
343c686c PR	117	struct iw_public_data wireless_data;
1da177e4 LT	118	#endif
	119
	120	/* Configuration dependent variables */
	121	int port_type, createibss;
	122	int promiscuous, mc_count;
95dd91fb CH	123
95dd91fb CH	124	/* Scanning support */
1e3428e9 DW	125	struct list_head bss_list;
1e3428e9 DW	126	struct list_head bss_free_list;
01632fa4	127	void *bss_xbss_data;
1e3428e9	128
95dd91fb CH	129	int scan_inprogress; /* Scan pending... */
95dd91fb CH	130	u32 scan_mode; /* Type of scan done */
1da177e4 LT	131	};
	132
	133	#ifdef ORINOCO_DEBUG
	134	extern int orinoco_debug;
	135	#define DEBUG(n, args...) do { if (orinoco_debug>(n)) printk(KERN_DEBUG args); } while(0)
	136	#else
	137	#define DEBUG(n, args...) do { } while (0)
	138	#endif /* ORINOCO_DEBUG */
	139
1da177e4 LT	140	/********************************************************************/
	141	/* Exported prototypes */
	142	/********************************************************************/
	143
3994d502 DK	144	extern struct net_device *alloc_orinocodev(
	145	int sizeof_card, struct device *device,
	146	int (hard_reset)(struct orinoco_private ),
	147	int (stop_fw)(struct orinoco_private , int));
1da177e4 LT	148	extern void free_orinocodev(struct net_device *dev);
	149	extern int __orinoco_up(struct net_device *dev);
	150	extern int __orinoco_down(struct net_device *dev);
1da177e4	151	extern int orinoco_reinit_firmware(struct net_device *dev);
7d12e780	152	extern irqreturn_t orinoco_interrupt(int irq, void * dev_id);
1da177e4 LT	153
	154	/********************************************************************/
	155	/* Locking and synchronization functions */
	156	/********************************************************************/
	157
821fe683	158	static inline int orinoco_lock(struct orinoco_private *priv,
1da177e4 LT	159	unsigned long *flags)
	160	{
	161	spin_lock_irqsave(&priv->lock, *flags);
	162	if (priv->hw_unavailable) {
	163	DEBUG(1, "orinoco_lock() called with hw_unavailable (dev=%p)\n",
	164	priv->ndev);
	165	spin_unlock_irqrestore(&priv->lock, *flags);
	166	return -EBUSY;
	167	}
	168	return 0;
	169	}
	170
821fe683	171	static inline void orinoco_unlock(struct orinoco_private *priv,
1da177e4 LT	172	unsigned long *flags)
	173	{
	174	spin_unlock_irqrestore(&priv->lock, *flags);
	175	}
	176
	177	#endif /* _ORINOCO_H */