Merge branch 'topic/usb-mixer-cache' into next/usb-audio
[linux-2.6] / drivers / staging / wlan-ng / p80211netdev.h
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>
58
59 /*================================================================*/
60 /* Constants */
61
62 #define WLAN_DEVICE_CLOSED      0
63 #define WLAN_DEVICE_OPEN        1
64
65 #define WLAN_MACMODE_NONE       0
66 #define WLAN_MACMODE_IBSS_STA   1
67 #define WLAN_MACMODE_ESS_STA    2
68 #define WLAN_MACMODE_ESS_AP     3
69
70 /* MSD States */
71 #define WLAN_MSD_START                  -1
72 #define WLAN_MSD_DRIVERLOADED           0
73 #define WLAN_MSD_HWPRESENT_PENDING      1
74 #define WLAN_MSD_HWFAIL                 2
75 #define WLAN_MSD_HWPRESENT              3
76 #define WLAN_MSD_FWLOAD_PENDING         4
77 #define WLAN_MSD_FWLOAD                 5
78 #define WLAN_MSD_RUNNING_PENDING        6
79 #define WLAN_MSD_RUNNING                7
80
81 #ifndef ETH_P_ECONET
82 #define ETH_P_ECONET   0x0018    /* needed for 2.2.x kernels */
83 #endif
84
85 #define ETH_P_80211_RAW        (ETH_P_ECONET + 1)
86
87 #ifndef ARPHRD_IEEE80211
88 #define ARPHRD_IEEE80211 801     /* kernel 2.4.6 */
89 #endif
90
91 #ifndef ARPHRD_IEEE80211_PRISM  /* kernel 2.4.18 */
92 #define ARPHRD_IEEE80211_PRISM 802
93 #endif
94
95 /*--- NSD Capabilities Flags ------------------------------*/
96 #define P80211_NSDCAP_HARDWAREWEP           0x01  /* hardware wep engine */
97 #define P80211_NSDCAP_TIEDWEP               0x02  /* can't decouple en/de */
98 #define P80211_NSDCAP_NOHOSTWEP             0x04  /* must use hardware wep */
99 #define P80211_NSDCAP_PBCC                  0x08  /* hardware supports PBCC */
100 #define P80211_NSDCAP_SHORT_PREAMBLE        0x10  /* hardware supports */
101 #define P80211_NSDCAP_AGILITY               0x20  /* hardware supports */
102 #define P80211_NSDCAP_AP_RETRANSMIT         0x40  /* nsd handles retransmits */
103 #define P80211_NSDCAP_HWFRAGMENT            0x80  /* nsd handles frag/defrag */
104 #define P80211_NSDCAP_AUTOJOIN              0x100  /* nsd does autojoin */
105 #define P80211_NSDCAP_NOSCAN                0x200  /* nsd can scan */
106
107 /*================================================================*/
108 /* Macros */
109
110 /*================================================================*/
111 /* Types */
112
113 /* Received frame statistics */
114 typedef struct p80211_frmrx_t
115 {
116         u32     mgmt;
117         u32     assocreq;
118         u32     assocresp;
119         u32     reassocreq;
120         u32     reassocresp;
121         u32     probereq;
122         u32     proberesp;
123         u32     beacon;
124         u32     atim;
125         u32     disassoc;
126         u32     authen;
127         u32     deauthen;
128         u32     mgmt_unknown;
129         u32     ctl;
130         u32     pspoll;
131         u32     rts;
132         u32     cts;
133         u32     ack;
134         u32     cfend;
135         u32     cfendcfack;
136         u32     ctl_unknown;
137         u32     data;
138         u32     dataonly;
139         u32     data_cfack;
140         u32     data_cfpoll;
141         u32     data__cfack_cfpoll;
142         u32     null;
143         u32     cfack;
144         u32     cfpoll;
145         u32     cfack_cfpoll;
146         u32     data_unknown;
147         u32  decrypt;
148         u32  decrypt_err;
149 } p80211_frmrx_t;
150
151 /* called by /proc/net/wireless */
152 struct iw_statistics* p80211wext_get_wireless_stats(netdevice_t *dev);
153 /* wireless extensions' ioctls */
154 int p80211wext_support_ioctl(netdevice_t *dev, struct ifreq *ifr, int cmd);
155 extern struct iw_handler_def p80211wext_handler_def;
156 int p80211wext_event_associated(struct wlandevice *wlandev, int assoc);
157
158 /* WEP stuff */
159 #define NUM_WEPKEYS 4
160 #define MAX_KEYLEN 32
161
162 #define HOSTWEP_DEFAULTKEY_MASK (BIT1|BIT0)
163 #define HOSTWEP_DECRYPT  BIT4
164 #define HOSTWEP_ENCRYPT  BIT5
165 #define HOSTWEP_PRIVACYINVOKED BIT6
166 #define HOSTWEP_EXCLUDEUNENCRYPTED BIT7
167
168 extern int wlan_watchdog;
169 extern int wlan_wext_write;
170
171 /* WLAN device type */
172 typedef struct wlandevice
173 {
174         struct wlandevice       *next;          /* link for list of devices */
175         void                    *priv;          /* private data for MSD */
176
177         /* Subsystem State */
178         char            name[WLAN_DEVNAMELEN_MAX]; /* Dev name, from register_wlandev()*/
179         char            *nsdname;
180
181         u32          state;          /* Device I/F state (open/closed) */
182         u32             msdstate;       /* state of underlying driver */
183         u32             hwremoved;      /* Has the hw been yanked out? */
184
185         /* Hardware config */
186         unsigned int            irq;
187         unsigned int            iobase;
188         unsigned int            membase;
189         u32          nsdcaps;  /* NSD Capabilities flags */
190
191         /* Config vars */
192         unsigned int            ethconv;
193
194         /* device methods (init by MSD, used by p80211 */
195         int             (*open)(struct wlandevice *wlandev);
196         int             (*close)(struct wlandevice *wlandev);
197         void            (*reset)(struct wlandevice *wlandev );
198         int             (*txframe)(struct wlandevice *wlandev, struct sk_buff *skb, p80211_hdr_t *p80211_hdr, p80211_metawep_t *p80211_wep);
199         int             (*mlmerequest)(struct wlandevice *wlandev, p80211msg_t *msg);
200         int             (*set_multicast_list)(struct wlandevice *wlandev,
201                                               netdevice_t *dev);
202         void            (*tx_timeout)(struct wlandevice *wlandev);
203
204         /* 802.11 State */
205         u8              bssid[WLAN_BSSID_LEN];
206         p80211pstr32_t  ssid;
207         u32             macmode;
208         int             linkstatus;
209
210         /* WEP State */
211         u8 wep_keys[NUM_WEPKEYS][MAX_KEYLEN];
212         u8 wep_keylens[NUM_WEPKEYS];
213         int   hostwep;
214
215         /* Request/Confirm i/f state (used by p80211) */
216         unsigned long           request_pending; /* flag, access atomically */
217
218         /* netlink socket */
219         /* queue for indications waiting for cmd completion */
220         /* Linux netdevice and support */
221         netdevice_t             *netdev;        /* ptr to linux netdevice */
222         struct net_device_stats linux_stats;
223
224         /* Rx bottom half */
225         struct tasklet_struct   rx_bh;
226
227         struct sk_buff_head     nsd_rxq;
228
229         /* 802.11 device statistics */
230         struct p80211_frmrx_t   rx;
231
232         struct iw_statistics    wstats;
233
234         /* jkriegl: iwspy fields */
235         u8                      spy_number;
236         char                    spy_address[IW_MAX_SPY][ETH_ALEN];
237         struct iw_quality       spy_stat[IW_MAX_SPY];
238 } wlandevice_t;
239
240 /* WEP stuff */
241 int wep_change_key(wlandevice_t *wlandev, int keynum, u8* key, int keylen);
242 int wep_decrypt(wlandevice_t *wlandev, u8 *buf, u32 len, int key_override, u8 *iv, u8 *icv);
243 int wep_encrypt(wlandevice_t *wlandev, u8 *buf, u8 *dst, u32 len, int keynum, u8 *iv, u8 *icv);
244
245 void    p80211netdev_startup(void);
246 void    p80211netdev_shutdown(void);
247 int     wlan_setup(wlandevice_t *wlandev);
248 int     wlan_unsetup(wlandevice_t *wlandev);
249 int     register_wlandev(wlandevice_t *wlandev);
250 int     unregister_wlandev(wlandevice_t *wlandev);
251 void    p80211netdev_rx(wlandevice_t *wlandev, struct sk_buff *skb);
252 void    p80211netdev_hwremoved(wlandevice_t *wlandev);
253
254 #endif