[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;

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

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

	/* 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 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;
	bss_element *bss_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,
					   int (*hard_reset)(struct orinoco_private *));
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
1e3428e9 DW	39	typedef struct {
	40	union hermes_scan_info bss;
	41	unsigned long last_scanned;
	42	struct list_head list;
	43	} bss_element;
	44
1da177e4 LT	45	struct orinoco_private {
	46	void card; / Pointer to card dependent structure */
	47	int (hard_reset)(struct orinoco_private );
	48
	49	/* Synchronisation stuff */
	50	spinlock_t lock;
	51	int hw_unavailable;
	52	struct work_struct reset_work;
	53
	54	/* driver state */
	55	int open;
	56	u16 last_linkstatus;
16739b06	57	struct work_struct join_work;
95dd91fb	58	struct work_struct wevent_work;
1da177e4 LT	59
	60	/* Net device stuff */
	61	struct net_device *ndev;
	62	struct net_device_stats stats;
	63	struct iw_statistics wstats;
	64
	65	/* Hardware control variables */
	66	hermes_t hw;
	67	u16 txfid;
	68
	69	/* Capabilities of the hardware/firmware */
	70	fwtype_t firmware_type;
	71	char fw_name[32];
	72	int ibss_port;
	73	int nicbuf_size;
	74	u16 channel_mask;
	75
	76	/* Boolean capabilities */
	77	unsigned int has_ibss:1;
	78	unsigned int has_port3:1;
	79	unsigned int has_wep:1;
	80	unsigned int has_big_wep:1;
	81	unsigned int has_mwo:1;
	82	unsigned int has_pm:1;
	83	unsigned int has_preamble:1;
	84	unsigned int has_sensitivity:1;
95dd91fb	85	unsigned int has_hostscan:1;
1da177e4	86	unsigned int broken_disableport:1;
98c4cae1	87	unsigned int broken_monitor:1;
1da177e4 LT	88
	89	/* Configuration paramaters */
	90	u32 iw_mode;
	91	int prefer_port3;
	92	u16 wep_on, wep_restrict, tx_key;
	93	struct orinoco_key keys[ORINOCO_MAX_KEYS];
	94	int bitratemode;
	95	char nick[IW_ESSID_MAX_SIZE+1];
	96	char desired_essid[IW_ESSID_MAX_SIZE+1];
16739b06 CH	97	char desired_bssid[ETH_ALEN];
16739b06 CH	98	int bssid_fixed;
1da177e4 LT	99	u16 frag_thresh, mwo_robust;
	100	u16 channel;
	101	u16 ap_density, rts_thresh;
	102	u16 pm_on, pm_mcast, pm_period, pm_timeout;
	103	u16 preamble;
	104	#ifdef WIRELESS_SPY
343c686c PR	105	struct iw_spy_data spy_data; /* iwspy support */
343c686c PR	106	struct iw_public_data wireless_data;
1da177e4 LT	107	#endif
	108
	109	/* Configuration dependent variables */
	110	int port_type, createibss;
	111	int promiscuous, mc_count;
95dd91fb CH	112
95dd91fb CH	113	/* Scanning support */
1e3428e9 DW	114	struct list_head bss_list;
	115	struct list_head bss_free_list;
	116	bss_element *bss_data;
	117
95dd91fb CH	118	int scan_inprogress; /* Scan pending... */
95dd91fb CH	119	u32 scan_mode; /* Type of scan done */
1da177e4 LT	120	};
	121
	122	#ifdef ORINOCO_DEBUG
	123	extern int orinoco_debug;
	124	#define DEBUG(n, args...) do { if (orinoco_debug>(n)) printk(KERN_DEBUG args); } while(0)
	125	#else
	126	#define DEBUG(n, args...) do { } while (0)
	127	#endif /* ORINOCO_DEBUG */
	128
1da177e4 LT	129	/********************************************************************/
	130	/* Exported prototypes */
	131	/********************************************************************/
	132
	133	extern struct net_device *alloc_orinocodev(int sizeof_card,
	134	int (hard_reset)(struct orinoco_private ));
	135	extern void free_orinocodev(struct net_device *dev);
	136	extern int __orinoco_up(struct net_device *dev);
	137	extern int __orinoco_down(struct net_device *dev);
1da177e4	138	extern int orinoco_reinit_firmware(struct net_device *dev);
7d12e780	139	extern irqreturn_t orinoco_interrupt(int irq, void * dev_id);
1da177e4 LT	140
	141	/********************************************************************/
	142	/* Locking and synchronization functions */
	143	/********************************************************************/
	144
821fe683	145	static inline int orinoco_lock(struct orinoco_private *priv,
1da177e4 LT	146	unsigned long *flags)
	147	{
	148	spin_lock_irqsave(&priv->lock, *flags);
	149	if (priv->hw_unavailable) {
	150	DEBUG(1, "orinoco_lock() called with hw_unavailable (dev=%p)\n",
	151	priv->ndev);
	152	spin_unlock_irqrestore(&priv->lock, *flags);
	153	return -EBUSY;
	154	}
	155	return 0;
	156	}
	157
821fe683	158	static inline void orinoco_unlock(struct orinoco_private *priv,
1da177e4 LT	159	unsigned long *flags)
	160	{
	161	spin_unlock_irqrestore(&priv->lock, *flags);
	162	}
	163
	164	#endif /* _ORINOCO_H */