[mirror_ubuntu-artful-kernel.git] / drivers / net / wireless / orinoco / 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/interrupt.h>
#include <linux/suspend.h>
#include <linux/netdevice.h>
#include <linux/wireless.h>
#include <net/iw_handler.h>
#include <net/cfg80211.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_SEQ_LEN		8
#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));

#define TKIP_KEYLEN	16
#define MIC_KEYLEN	8

struct orinoco_tkip_key {
	u8 tkip[TKIP_KEYLEN];
	u8 tx_mic[MIC_KEYLEN];
	u8 rx_mic[MIC_KEYLEN];
};

enum orinoco_alg {
	ORINOCO_ALG_NONE,
	ORINOCO_ALG_WEP,
	ORINOCO_ALG_TKIP
};

typedef enum {
	FIRMWARE_TYPE_AGERE,
	FIRMWARE_TYPE_INTERSIL,
	FIRMWARE_TYPE_SYMBOL
} fwtype_t;

struct firmware;

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

	struct ieee80211_supported_band band;
	struct ieee80211_channel channels[14];
	u32 cipher_suites[3];

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

	/* Interrupt tasklets */
	struct tasklet_struct rx_tasklet;
	struct list_head rx_list;

	/* 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;
	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 has_wpa:1;
	unsigned int do_fw_download:1;
	unsigned int broken_disableport:1;
	unsigned int broken_monitor:1;
	unsigned int prefer_port3:1;

	/* Configuration paramaters */
	enum nl80211_iftype iw_mode;
	enum orinoco_alg encode_alg;
	u16 wep_restrict, tx_key;
	struct key_params 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;
	u16 short_retry_limit, long_retry_limit;
	u16 retry_lifetime;
#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 cfg80211_scan_request *scan_request;
	struct work_struct process_scan;
	struct list_head scan_list;
	spinlock_t scan_lock; /* protects the scan list */

	/* WPA support */
	u8 *wpa_ie;
	int wpa_ie_len;

	struct crypto_hash *rx_tfm_mic;
	struct crypto_hash *tx_tfm_mic;

	unsigned int wpa_enabled:1;
	unsigned int tkip_cm_active:1;
	unsigned int key_mgmt:3;

#if defined(CONFIG_HERMES_CACHE_FW_ON_INIT) || defined(CONFIG_PM_SLEEP)
	/* Cached in memory firmware to use during ->resume. */
	const struct firmware *cached_pri_fw;
	const struct firmware *cached_fw;
#endif

	struct notifier_block pm_notifier;
};

#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 orinoco_private *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 orinoco_private *priv);
extern int orinoco_init(struct orinoco_private *priv);
extern int orinoco_if_add(struct orinoco_private *priv,
			  unsigned long base_addr,
			  unsigned int irq,
			  const struct net_device_ops *ops);
extern void orinoco_if_del(struct orinoco_private *priv);
extern int orinoco_up(struct orinoco_private *priv);
extern void orinoco_down(struct orinoco_private *priv);
extern irqreturn_t orinoco_interrupt(int irq, void *dev_id);

/* Common ndo functions exported for reuse by orinoco_usb */
int orinoco_open(struct net_device *dev);
int orinoco_stop(struct net_device *dev);
struct net_device_stats *orinoco_get_stats(struct net_device *dev);
void orinoco_set_multicast_list(struct net_device *dev);
int orinoco_change_mtu(struct net_device *dev, int new_mtu);
void orinoco_tx_timeout(struct net_device *dev);

/********************************************************************/
/* 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);
}

/*** Navigate from net_device to orinoco_private ***/
static inline struct orinoco_private *ndev_priv(struct net_device *dev)
{
	struct wireless_dev *wdev = netdev_priv(dev);
	return wdev_priv(wdev);
}
#endif /* _ORINOCO_H */
Commit	Line	Data
1da177e4	1	/* orinoco.h
d14c7c1d	2	*
1da177e4 LT	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
31afcef3	12	#include <linux/interrupt.h>
39d1ffee	13	#include <linux/suspend.h>
1da177e4 LT	14	#include <linux/netdevice.h>
1da177e4 LT	15	#include <linux/wireless.h>
343c686c	16	#include <net/iw_handler.h>
ea60a6aa	17	#include <net/cfg80211.h>
1da177e4 LT	18
	19	#include "hermes.h"
	20
	21	/* To enable debug messages */
d14c7c1d	22	/#define ORINOCO_DEBUG 3/
1da177e4	23
d14c7c1d	24	#define WIRELESS_SPY /* enable iwspy support */
1da177e4	25
16739b06 CH	26	#define MAX_SCAN_LEN 4096
16739b06 CH	27
5c9f41e2	28	#define ORINOCO_SEQ_LEN 8
1da177e4 LT	29	#define ORINOCO_MAX_KEY_SIZE 14
	30	#define ORINOCO_MAX_KEYS 4
	31
	32	struct orinoco_key {
d133ae4c	33	__le16 len; /* always stored as little-endian */
1da177e4 LT	34	char data[ORINOCO_MAX_KEY_SIZE];
	35	} __attribute__ ((packed));
	36
d03032af DK	37	#define TKIP_KEYLEN 16
	38	#define MIC_KEYLEN 8
	39
	40	struct orinoco_tkip_key {
	41	u8 tkip[TKIP_KEYLEN];
	42	u8 tx_mic[MIC_KEYLEN];
	43	u8 rx_mic[MIC_KEYLEN];
	44	};
	45
5c9f41e2 DK	46	enum orinoco_alg {
	47	ORINOCO_ALG_NONE,
	48	ORINOCO_ALG_WEP,
	49	ORINOCO_ALG_TKIP
	50	};
	51
1da177e4 LT	52	typedef enum {
	53	FIRMWARE_TYPE_AGERE,
	54	FIRMWARE_TYPE_INTERSIL,
	55	FIRMWARE_TYPE_SYMBOL
	56	} fwtype_t;
	57
4fb30784 AB	58	struct firmware;
4fb30784 AB	59
1da177e4 LT	60	struct orinoco_private {
1da177e4 LT	61	void card; / Pointer to card dependent structure */
3994d502	62	struct device *dev;
1da177e4	63	int (hard_reset)(struct orinoco_private );
3994d502	64	int (stop_fw)(struct orinoco_private , int);
1da177e4	65
ea60a6aa DK	66	struct ieee80211_supported_band band;
	67	struct ieee80211_channel channels[14];
	68	u32 cipher_suites[3];
	69
1da177e4 LT	70	/* Synchronisation stuff */
	71	spinlock_t lock;
	72	int hw_unavailable;
	73	struct work_struct reset_work;
	74
31afcef3 DK	75	/* Interrupt tasklets */
	76	struct tasklet_struct rx_tasklet;
	77	struct list_head rx_list;
31afcef3	78
1da177e4 LT	79	/* driver state */
	80	int open;
	81	u16 last_linkstatus;
16739b06	82	struct work_struct join_work;
95dd91fb	83	struct work_struct wevent_work;
1da177e4 LT	84
	85	/* Net device stuff */
	86	struct net_device *ndev;
	87	struct net_device_stats stats;
	88	struct iw_statistics wstats;
	89
	90	/* Hardware control variables */
	91	hermes_t hw;
	92	u16 txfid;
	93
	94	/* Capabilities of the hardware/firmware */
	95	fwtype_t firmware_type;
1da177e4 LT	96	int ibss_port;
	97	int nicbuf_size;
	98	u16 channel_mask;
	99
	100	/* Boolean capabilities */
	101	unsigned int has_ibss:1;
	102	unsigned int has_port3:1;
	103	unsigned int has_wep:1;
	104	unsigned int has_big_wep:1;
	105	unsigned int has_mwo:1;
	106	unsigned int has_pm:1;
	107	unsigned int has_preamble:1;
	108	unsigned int has_sensitivity:1;
95dd91fb	109	unsigned int has_hostscan:1;
6eecad77	110	unsigned int has_alt_txcntl:1;
01632fa4	111	unsigned int has_ext_scan:1;
d03032af	112	unsigned int has_wpa:1;
3994d502	113	unsigned int do_fw_download:1;
1da177e4	114	unsigned int broken_disableport:1;
98c4cae1	115	unsigned int broken_monitor:1;
bb7e43c0	116	unsigned int prefer_port3:1;
1da177e4 LT	117
1da177e4 LT	118	/* Configuration paramaters */
5217c571	119	enum nl80211_iftype iw_mode;
5c9f41e2 DK	120	enum orinoco_alg encode_alg;
5c9f41e2 DK	121	u16 wep_restrict, tx_key;
4af198fb DK	122	struct key_params keys[ORINOCO_MAX_KEYS];
4af198fb DK	123
1da177e4	124	int bitratemode;
d14c7c1d	125	char nick[IW_ESSID_MAX_SIZE+1];
1da177e4	126	char desired_essid[IW_ESSID_MAX_SIZE+1];
16739b06 CH	127	char desired_bssid[ETH_ALEN];
16739b06 CH	128	int bssid_fixed;
1da177e4 LT	129	u16 frag_thresh, mwo_robust;
	130	u16 channel;
	131	u16 ap_density, rts_thresh;
	132	u16 pm_on, pm_mcast, pm_period, pm_timeout;
	133	u16 preamble;
c3d41503 DK	134	u16 short_retry_limit, long_retry_limit;
c3d41503 DK	135	u16 retry_lifetime;
1da177e4	136	#ifdef WIRELESS_SPY
d14c7c1d	137	struct iw_spy_data spy_data; /* iwspy support */
343c686c	138	struct iw_public_data wireless_data;
1da177e4 LT	139	#endif
	140
	141	/* Configuration dependent variables */
	142	int port_type, createibss;
	143	int promiscuous, mc_count;
95dd91fb CH	144
95dd91fb CH	145	/* Scanning support */
c63cdbe8 DK	146	struct cfg80211_scan_request *scan_request;
	147	struct work_struct process_scan;
	148	struct list_head scan_list;
	149	spinlock_t scan_lock; /* protects the scan list */
d03032af DK	150
	151	/* WPA support */
	152	u8 *wpa_ie;
	153	int wpa_ie_len;
	154
23edcc41 DK	155	struct crypto_hash *rx_tfm_mic;
23edcc41 DK	156	struct crypto_hash *tx_tfm_mic;
d03032af DK	157
	158	unsigned int wpa_enabled:1;
	159	unsigned int tkip_cm_active:1;
	160	unsigned int key_mgmt:3;
4fb30784	161
2bfc5cb5	162	#if defined(CONFIG_HERMES_CACHE_FW_ON_INIT) \|\| defined(CONFIG_PM_SLEEP)
2cea7b26 DK	163	/* Cached in memory firmware to use during ->resume. */
2cea7b26 DK	164	const struct firmware *cached_pri_fw;
4fb30784	165	const struct firmware *cached_fw;
2bfc5cb5	166	#endif
39d1ffee DK	167
39d1ffee DK	168	struct notifier_block pm_notifier;
1da177e4 LT	169	};
	170
	171	#ifdef ORINOCO_DEBUG
	172	extern int orinoco_debug;
d14c7c1d AB	173	#define DEBUG(n, args...) do { \
	174	if (orinoco_debug > (n)) \
	175	printk(KERN_DEBUG args); \
	176	} while (0)
1da177e4 LT	177	#else
	178	#define DEBUG(n, args...) do { } while (0)
	179	#endif /* ORINOCO_DEBUG */
	180
1da177e4 LT	181	/********************************************************************/
	182	/* Exported prototypes */
	183	/********************************************************************/
	184
a2608362	185	extern struct orinoco_private *alloc_orinocodev(
3994d502 DK	186	int sizeof_card, struct device *device,
	187	int (hard_reset)(struct orinoco_private ),
	188	int (stop_fw)(struct orinoco_private , int));
a2608362	189	extern void free_orinocodev(struct orinoco_private *priv);
8e638267	190	extern int orinoco_init(struct orinoco_private *priv);
5381956b DK	191	extern int orinoco_if_add(struct orinoco_private *priv,
5381956b DK	192	unsigned long base_addr,
593ef09c DK	193	unsigned int irq,
593ef09c DK	194	const struct net_device_ops *ops);
5381956b	195	extern void orinoco_if_del(struct orinoco_private *priv);
6415f7df DK	196	extern int orinoco_up(struct orinoco_private *priv);
6415f7df DK	197	extern void orinoco_down(struct orinoco_private *priv);
d14c7c1d	198	extern irqreturn_t orinoco_interrupt(int irq, void *dev_id);
1da177e4	199
593ef09c DK	200	/* Common ndo functions exported for reuse by orinoco_usb */
	201	int orinoco_open(struct net_device *dev);
	202	int orinoco_stop(struct net_device *dev);
	203	struct net_device_stats orinoco_get_stats(struct net_device dev);
	204	void orinoco_set_multicast_list(struct net_device *dev);
	205	int orinoco_change_mtu(struct net_device *dev, int new_mtu);
	206	void orinoco_tx_timeout(struct net_device *dev);
	207
1da177e4 LT	208	/********************************************************************/
	209	/* Locking and synchronization functions */
	210	/********************************************************************/
	211
821fe683	212	static inline int orinoco_lock(struct orinoco_private *priv,
1da177e4 LT	213	unsigned long *flags)
	214	{
	215	spin_lock_irqsave(&priv->lock, *flags);
	216	if (priv->hw_unavailable) {
	217	DEBUG(1, "orinoco_lock() called with hw_unavailable (dev=%p)\n",
	218	priv->ndev);
	219	spin_unlock_irqrestore(&priv->lock, *flags);
	220	return -EBUSY;
	221	}
	222	return 0;
	223	}
	224
821fe683	225	static inline void orinoco_unlock(struct orinoco_private *priv,
1da177e4 LT	226	unsigned long *flags)
	227	{
	228	spin_unlock_irqrestore(&priv->lock, *flags);
	229	}
	230
ea60a6aa DK	231	/* Navigate from net_device to orinoco_private */
	232	static inline struct orinoco_private ndev_priv(struct net_device dev)
	233	{
	234	struct wireless_dev *wdev = netdev_priv(dev);
	235	return wdev_priv(wdev);
	236	}
1da177e4	237	#endif /* _ORINOCO_H */