GNU Linux-libre 4.9.318-gnu1
[releases.git] / 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 #include <linux/netdevice.h>
59
60 #define WLAN_RELEASE    "0.3.0-staging"
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_HWPRESENT_PENDING      1
72 #define WLAN_MSD_HWFAIL                 2
73 #define WLAN_MSD_HWPRESENT              3
74 #define WLAN_MSD_FWLOAD_PENDING         4
75 #define WLAN_MSD_FWLOAD                 5
76 #define WLAN_MSD_RUNNING_PENDING        6
77 #define WLAN_MSD_RUNNING                7
78
79 #ifndef ETH_P_ECONET
80 #define ETH_P_ECONET   0x0018   /* needed for 2.2.x kernels */
81 #endif
82
83 #define ETH_P_80211_RAW        (ETH_P_ECONET + 1)
84
85 #ifndef ARPHRD_IEEE80211
86 #define ARPHRD_IEEE80211 801    /* kernel 2.4.6 */
87 #endif
88
89 #ifndef ARPHRD_IEEE80211_PRISM  /* kernel 2.4.18 */
90 #define ARPHRD_IEEE80211_PRISM 802
91 #endif
92
93 /*--- NSD Capabilities Flags ------------------------------*/
94 #define P80211_NSDCAP_HARDWAREWEP           0x01  /* hardware wep engine */
95 #define P80211_NSDCAP_SHORT_PREAMBLE        0x10  /* hardware supports */
96 #define P80211_NSDCAP_HWFRAGMENT            0x80  /* nsd handles frag/defrag */
97 #define P80211_NSDCAP_AUTOJOIN              0x100 /* nsd does autojoin */
98 #define P80211_NSDCAP_NOSCAN                0x200 /* nsd can scan */
99
100 /* Received frame statistics */
101 struct p80211_frmrx {
102         u32 mgmt;
103         u32 assocreq;
104         u32 assocresp;
105         u32 reassocreq;
106         u32 reassocresp;
107         u32 probereq;
108         u32 proberesp;
109         u32 beacon;
110         u32 atim;
111         u32 disassoc;
112         u32 authen;
113         u32 deauthen;
114         u32 mgmt_unknown;
115         u32 ctl;
116         u32 pspoll;
117         u32 rts;
118         u32 cts;
119         u32 ack;
120         u32 cfend;
121         u32 cfendcfack;
122         u32 ctl_unknown;
123         u32 data;
124         u32 dataonly;
125         u32 data_cfack;
126         u32 data_cfpoll;
127         u32 data__cfack_cfpoll;
128         u32 null;
129         u32 cfack;
130         u32 cfpoll;
131         u32 cfack_cfpoll;
132         u32 data_unknown;
133         u32 decrypt;
134         u32 decrypt_err;
135 };
136
137 /* called by /proc/net/wireless */
138 struct iw_statistics *p80211wext_get_wireless_stats(struct net_device *dev);
139 /* wireless extensions' ioctls */
140 extern struct iw_handler_def p80211wext_handler_def;
141
142 /* WEP stuff */
143 #define NUM_WEPKEYS 4
144 #define MAX_KEYLEN 32
145
146 #define HOSTWEP_DEFAULTKEY_MASK (BIT(1)|BIT(0))
147 #define HOSTWEP_SHAREDKEY BIT(3)
148 #define HOSTWEP_DECRYPT  BIT(4)
149 #define HOSTWEP_ENCRYPT  BIT(5)
150 #define HOSTWEP_PRIVACYINVOKED BIT(6)
151 #define HOSTWEP_EXCLUDEUNENCRYPTED BIT(7)
152
153 extern int wlan_watchdog;
154 extern int wlan_wext_write;
155
156 /* WLAN device type */
157 struct wlandevice {
158         void *priv;             /* private data for MSD */
159
160         /* Subsystem State */
161         char name[WLAN_DEVNAMELEN_MAX]; /* Dev name, from register_wlandev() */
162         char *nsdname;
163
164         u32 state;              /* Device I/F state (open/closed) */
165         u32 msdstate;           /* state of underlying driver */
166         u32 hwremoved;          /* Has the hw been yanked out? */
167
168         /* Hardware config */
169         unsigned int irq;
170         unsigned int iobase;
171         unsigned int membase;
172         u32 nsdcaps;            /* NSD Capabilities flags */
173
174         /* Config vars */
175         unsigned int ethconv;
176
177         /* device methods (init by MSD, used by p80211 */
178         int (*open)(struct wlandevice *wlandev);
179         int (*close)(struct wlandevice *wlandev);
180         void (*reset)(struct wlandevice *wlandev);
181         int (*txframe)(struct wlandevice *wlandev, struct sk_buff *skb,
182                         union p80211_hdr *p80211_hdr,
183                         struct p80211_metawep *p80211_wep);
184         int (*mlmerequest)(struct wlandevice *wlandev, struct p80211msg *msg);
185         int (*set_multicast_list)(struct wlandevice *wlandev,
186                                    struct net_device *dev);
187         void (*tx_timeout)(struct wlandevice *wlandev);
188
189         /* 802.11 State */
190         u8 bssid[WLAN_BSSID_LEN];
191         struct p80211pstr32 ssid;
192         u32 macmode;
193         int linkstatus;
194
195         /* WEP State */
196         u8 wep_keys[NUM_WEPKEYS][MAX_KEYLEN];
197         u8 wep_keylens[NUM_WEPKEYS];
198         int hostwep;
199
200         /* Request/Confirm i/f state (used by p80211) */
201         unsigned long request_pending;  /* flag, access atomically */
202
203         /* netlink socket */
204         /* queue for indications waiting for cmd completion */
205         /* Linux netdevice and support */
206         struct net_device *netdev;      /* ptr to linux netdevice */
207
208         /* Rx bottom half */
209         struct tasklet_struct rx_bh;
210
211         struct sk_buff_head nsd_rxq;
212
213         /* 802.11 device statistics */
214         struct p80211_frmrx rx;
215
216         struct iw_statistics wstats;
217
218         /* jkriegl: iwspy fields */
219         u8 spy_number;
220         char spy_address[IW_MAX_SPY][ETH_ALEN];
221         struct iw_quality spy_stat[IW_MAX_SPY];
222 };
223
224 /* WEP stuff */
225 int wep_change_key(struct wlandevice *wlandev, int keynum, u8 *key, int keylen);
226 int wep_decrypt(struct wlandevice *wlandev, u8 *buf, u32 len, int key_override,
227                 u8 *iv, u8 *icv);
228 int wep_encrypt(struct wlandevice *wlandev, u8 *buf, u8 *dst, u32 len,
229                 int keynum, u8 *iv, u8 *icv);
230
231 int wlan_setup(struct wlandevice *wlandev, struct device *physdev);
232 void wlan_unsetup(struct wlandevice *wlandev);
233 int register_wlandev(struct wlandevice *wlandev);
234 int unregister_wlandev(struct wlandevice *wlandev);
235 void p80211netdev_rx(struct wlandevice *wlandev, struct sk_buff *skb);
236 void p80211netdev_hwremoved(struct wlandevice *wlandev);
237 #endif