Merge branch 'fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/djbw/async_tx
[linux-2.6] / drivers / net / wireless / orinoco / orinoco.h
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
10 #define DRIVER_VERSION "0.15"
11
12 #include <linux/interrupt.h>
13 #include <linux/suspend.h>
14 #include <linux/netdevice.h>
15 #include <linux/wireless.h>
16 #include <net/iw_handler.h>
17
18 #include "hermes.h"
19
20 /* To enable debug messages */
21 //#define ORINOCO_DEBUG         3
22
23 #define WIRELESS_SPY            // enable iwspy support
24
25 #define MAX_SCAN_LEN            4096
26
27 #define ORINOCO_MAX_KEY_SIZE    14
28 #define ORINOCO_MAX_KEYS        4
29
30 struct orinoco_key {
31         __le16 len;     /* always stored as little-endian */
32         char data[ORINOCO_MAX_KEY_SIZE];
33 } __attribute__ ((packed));
34
35 #define TKIP_KEYLEN     16
36 #define MIC_KEYLEN      8
37
38 struct orinoco_tkip_key {
39         u8 tkip[TKIP_KEYLEN];
40         u8 tx_mic[MIC_KEYLEN];
41         u8 rx_mic[MIC_KEYLEN];
42 };
43
44 typedef enum {
45         FIRMWARE_TYPE_AGERE,
46         FIRMWARE_TYPE_INTERSIL,
47         FIRMWARE_TYPE_SYMBOL
48 } fwtype_t;
49
50 struct bss_element {
51         union hermes_scan_info bss;
52         unsigned long last_scanned;
53         struct list_head list;
54 };
55
56 struct xbss_element {
57         struct agere_ext_scan_info bss;
58         unsigned long last_scanned;
59         struct list_head list;
60 };
61
62 struct hermes_rx_descriptor;
63
64 struct orinoco_rx_data {
65         struct hermes_rx_descriptor *desc;
66         struct sk_buff *skb;
67         struct list_head list;
68 };
69
70 struct firmware;
71
72 struct orinoco_private {
73         void *card;     /* Pointer to card dependent structure */
74         struct device *dev;
75         int (*hard_reset)(struct orinoco_private *);
76         int (*stop_fw)(struct orinoco_private *, int);
77
78         /* Synchronisation stuff */
79         spinlock_t lock;
80         int hw_unavailable;
81         struct work_struct reset_work;
82
83         /* Interrupt tasklets */
84         struct tasklet_struct rx_tasklet;
85         struct list_head rx_list;
86         struct orinoco_rx_data *rx_data;
87
88         /* driver state */
89         int open;
90         u16 last_linkstatus;
91         struct work_struct join_work;
92         struct work_struct wevent_work;
93
94         /* Net device stuff */
95         struct net_device *ndev;
96         struct net_device_stats stats;
97         struct iw_statistics wstats;
98
99         /* Hardware control variables */
100         hermes_t hw;
101         u16 txfid;
102
103         /* Capabilities of the hardware/firmware */
104         fwtype_t firmware_type;
105         char fw_name[32];
106         int ibss_port;
107         int nicbuf_size;
108         u16 channel_mask;
109
110         /* Boolean capabilities */
111         unsigned int has_ibss:1;
112         unsigned int has_port3:1;
113         unsigned int has_wep:1;
114         unsigned int has_big_wep:1;
115         unsigned int has_mwo:1;
116         unsigned int has_pm:1;
117         unsigned int has_preamble:1;
118         unsigned int has_sensitivity:1;
119         unsigned int has_hostscan:1;
120         unsigned int has_alt_txcntl:1;
121         unsigned int has_ext_scan:1;
122         unsigned int has_wpa:1;
123         unsigned int do_fw_download:1;
124         unsigned int broken_disableport:1;
125         unsigned int broken_monitor:1;
126
127         /* Configuration paramaters */
128         u32 iw_mode;
129         int prefer_port3;
130         u16 encode_alg, wep_restrict, tx_key;
131         struct orinoco_key keys[ORINOCO_MAX_KEYS];
132         int bitratemode;
133         char nick[IW_ESSID_MAX_SIZE+1];
134         char desired_essid[IW_ESSID_MAX_SIZE+1];
135         char desired_bssid[ETH_ALEN];
136         int bssid_fixed;
137         u16 frag_thresh, mwo_robust;
138         u16 channel;
139         u16 ap_density, rts_thresh;
140         u16 pm_on, pm_mcast, pm_period, pm_timeout;
141         u16 preamble;
142 #ifdef WIRELESS_SPY
143         struct iw_spy_data spy_data; /* iwspy support */
144         struct iw_public_data   wireless_data;
145 #endif
146
147         /* Configuration dependent variables */
148         int port_type, createibss;
149         int promiscuous, mc_count;
150
151         /* Scanning support */
152         struct list_head bss_list;
153         struct list_head bss_free_list;
154         void *bss_xbss_data;
155
156         int     scan_inprogress;        /* Scan pending... */
157         u32     scan_mode;              /* Type of scan done */
158
159         /* WPA support */
160         u8 *wpa_ie;
161         int wpa_ie_len;
162
163         struct orinoco_tkip_key tkip_key[ORINOCO_MAX_KEYS];
164         struct crypto_hash *rx_tfm_mic;
165         struct crypto_hash *tx_tfm_mic;
166
167         unsigned int wpa_enabled:1;
168         unsigned int tkip_cm_active:1;
169         unsigned int key_mgmt:3;
170
171         /* Cached in memory firmware to use during ->resume. */
172         const struct firmware *cached_pri_fw;
173         const struct firmware *cached_fw;
174
175         struct notifier_block pm_notifier;
176 };
177
178 #ifdef ORINOCO_DEBUG
179 extern int orinoco_debug;
180 #define DEBUG(n, args...) do { if (orinoco_debug>(n)) printk(KERN_DEBUG args); } while(0)
181 #else
182 #define DEBUG(n, args...) do { } while (0)
183 #endif  /* ORINOCO_DEBUG */
184
185 /********************************************************************/
186 /* Exported prototypes                                              */
187 /********************************************************************/
188
189 extern struct net_device *alloc_orinocodev(
190         int sizeof_card, struct device *device,
191         int (*hard_reset)(struct orinoco_private *),
192         int (*stop_fw)(struct orinoco_private *, int));
193 extern void free_orinocodev(struct net_device *dev);
194 extern int __orinoco_up(struct net_device *dev);
195 extern int __orinoco_down(struct net_device *dev);
196 extern int orinoco_reinit_firmware(struct net_device *dev);
197 extern irqreturn_t orinoco_interrupt(int irq, void * dev_id);
198
199 /********************************************************************/
200 /* Locking and synchronization functions                            */
201 /********************************************************************/
202
203 static inline int orinoco_lock(struct orinoco_private *priv,
204                                unsigned long *flags)
205 {
206         spin_lock_irqsave(&priv->lock, *flags);
207         if (priv->hw_unavailable) {
208                 DEBUG(1, "orinoco_lock() called with hw_unavailable (dev=%p)\n",
209                        priv->ndev);
210                 spin_unlock_irqrestore(&priv->lock, *flags);
211                 return -EBUSY;
212         }
213         return 0;
214 }
215
216 static inline void orinoco_unlock(struct orinoco_private *priv,
217                                   unsigned long *flags)
218 {
219         spin_unlock_irqrestore(&priv->lock, *flags);
220 }
221
222 #endif /* _ORINOCO_H */