Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / dev / netif / wi / if_wivar.h
1 /*
2  * Copyright (c) 2002
3  *      M Warner Losh <imp@freebsd.org>.  All rights reserved.
4  * Copyright (c) 1997, 1998, 1999
5  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: src/sys/dev/wi/if_wivar.h,v 1.8.2.3 2002/08/02 07:11:34 imp Exp $
35  */
36
37 #define WICACHE                 /* turn on signal strength cache code */  
38 #define MAXWICACHE      10
39
40 struct wi_counters {
41         u_int32_t               wi_tx_unicast_frames;
42         u_int32_t               wi_tx_multicast_frames;
43         u_int32_t               wi_tx_fragments;
44         u_int32_t               wi_tx_unicast_octets;
45         u_int32_t               wi_tx_multicast_octets;
46         u_int32_t               wi_tx_deferred_xmits;
47         u_int32_t               wi_tx_single_retries;
48         u_int32_t               wi_tx_multi_retries;
49         u_int32_t               wi_tx_retry_limit;
50         u_int32_t               wi_tx_discards;
51         u_int32_t               wi_rx_unicast_frames;
52         u_int32_t               wi_rx_multicast_frames;
53         u_int32_t               wi_rx_fragments;
54         u_int32_t               wi_rx_unicast_octets;
55         u_int32_t               wi_rx_multicast_octets;
56         u_int32_t               wi_rx_fcs_errors;
57         u_int32_t               wi_rx_discards_nobuf;
58         u_int32_t               wi_tx_discards_wrong_sa;
59         u_int32_t               wi_rx_WEP_cant_decrypt;
60         u_int32_t               wi_rx_msg_in_msg_frags;
61         u_int32_t               wi_rx_msg_in_bad_msg_frags;
62 };
63
64 /*
65  * Encryption controls. We can enable or disable encryption as
66  * well as specify up to 4 encryption keys. We can also specify
67  * which of the four keys will be used for transmit encryption.
68  */
69 #define WI_RID_ENCRYPTION       0xFC20
70 #define WI_RID_AUTHTYPE         0xFC21
71 #define WI_RID_DEFLT_CRYPT_KEYS 0xFCB0
72 #define WI_RID_TX_CRYPT_KEY     0xFCB1
73 #define WI_RID_WEP_AVAIL        0xFD4F
74 #define WI_RID_P2_TX_CRYPT_KEY  0xFC23
75 #define WI_RID_P2_CRYPT_KEY0    0xFC24
76 #define WI_RID_P2_CRYPT_KEY1    0xFC25
77 #define WI_RID_MICROWAVE_OVEN   0xFC25
78 #define WI_RID_P2_CRYPT_KEY2    0xFC26
79 #define WI_RID_P2_CRYPT_KEY3    0xFC27
80 #define WI_RID_P2_ENCRYPTION    0xFC28
81 #define WI_RID_ROAMING_MODE     0xFC2D
82 #define WI_RID_CUR_TX_RATE      0xFD44 /* current TX rate */
83 struct wi_key {
84         u_int16_t               wi_keylen;
85         u_int8_t                wi_keydat[14];
86 };
87
88 struct wi_ltv_keys {
89         u_int16_t               wi_len;
90         u_int16_t               wi_type;
91         struct wi_key           wi_keys[4];
92 };
93
94 struct wi_softc {
95         struct arpcom           arpcom;
96         struct ifmedia          ifmedia;
97         device_t                dev;
98         int                     wi_unit;
99         struct resource *       local;
100         int                                     local_rid;
101         struct resource *       iobase;
102         int                                     iobase_rid;
103         struct resource *       irq;
104         int                                     irq_rid;
105         struct resource *       mem;
106         int                                     mem_rid;
107         bus_space_handle_t      wi_localhandle;
108         bus_space_tag_t         wi_localtag;
109         bus_space_handle_t      wi_bhandle;
110         bus_space_tag_t         wi_btag;
111         bus_space_handle_t      wi_bmemhandle;
112         bus_space_tag_t         wi_bmemtag;
113         void *                  wi_intrhand;
114         int                     sc_firmware_type;
115 #define WI_NOTYPE       0
116 #define WI_LUCENT       1
117 #define WI_INTERSIL     2
118 #define WI_SYMBOL       3
119         int                     sc_pri_firmware_ver;    /* Primary firmware */
120         int                     sc_sta_firmware_ver;    /* Station firmware */
121         int                     sc_enabled;
122         int                     wi_io_addr;
123         int                     wi_tx_data_id;
124         int                     wi_tx_mgmt_id;
125         int                     wi_gone;
126         int                     wi_flags;
127 #define WI_FLAGS_ATTACHED               0x01
128 #define WI_FLAGS_INITIALIZED            0x02
129 #define WI_FLAGS_HAS_WEP                0x04
130 #define WI_FLAGS_HAS_IBSS               0x08
131 #define WI_FLAGS_HAS_CREATE_IBSS        0x10
132 #define WI_FLAGS_HAS_MOR                0x20
133 #define WI_FLAGS_HAS_ROAMING            0x30
134 #define WI_FLAGS_HAS_DIVERSITY          0x40
135 #define WI_FLAGS_HAS_HOSTAP             0x80
136         int                     wi_if_flags;
137         u_int16_t               wi_procframe;
138         u_int16_t               wi_ptype;
139         u_int16_t               wi_portnum;
140         u_int16_t               wi_max_data_len;
141         u_int16_t               wi_rts_thresh;
142         u_int16_t               wi_ap_density;
143         u_int16_t               wi_tx_rate;
144         u_int16_t               wi_create_ibss;
145         u_int16_t               wi_channel;
146         u_int16_t               wi_pm_enabled;
147         u_int16_t               wi_mor_enabled;
148         u_int16_t               wi_max_sleep;
149         u_int16_t               wi_supprates;
150         u_int16_t               wi_authtype;
151         u_int16_t               wi_roaming;
152         char                    wi_node_name[32];
153         char                    wi_net_name[32];
154         char                    wi_ibss_name[32];
155         u_int8_t                wi_txbuf[1596];
156         u_int8_t                wi_scanbuf[1596];
157         int                     wi_scanbuf_len;
158         struct wi_counters      wi_stats;
159         int                     wi_has_wep;
160         int                     wi_use_wep;
161         int                     wi_authmode;
162         int                     wi_tx_key;
163         struct wi_ltv_keys      wi_keys;
164 #ifdef WICACHE
165         int                     wi_sigitems;
166         struct wi_sigcache      wi_sigcache[MAXWICACHE];
167         int                     wi_nextitem;
168 #endif
169         struct wihap_info       wi_hostap_info;
170         u_int32_t               wi_icv;
171         int                     wi_icv_flag;
172         int                     wi_ibss_port;
173         struct callout_handle   wi_stat_ch;
174 #if __FreeBSD_version >= 500000
175         struct mtx              wi_mtx;
176 #endif
177         int                     wi_nic_type;
178         int                     wi_bus_type;    /* Bus attachment type */
179         struct {
180                 u_int16_t               wi_sleep;
181                 u_int16_t               wi_delaysupp;
182                 u_int16_t               wi_txsupp;
183                 u_int16_t               wi_monitor;
184                 u_int16_t               wi_ledtest;
185                 u_int16_t               wi_ledtest_param0;
186                 u_int16_t               wi_ledtest_param1;
187                 u_int16_t               wi_conttx;
188                 u_int16_t               wi_conttx_param0;
189                 u_int16_t               wi_contrx;
190                 u_int16_t               wi_sigstate;
191                 u_int16_t               wi_sigstate_param0;
192                 u_int16_t               wi_confbits;
193                 u_int16_t               wi_confbits_param0;
194         } wi_debug;
195
196 };
197
198 struct wi_card_ident {
199         u_int16_t       card_id;
200         char            *card_name;
201         u_int8_t        firm_type;
202 };
203
204 #if __FreeBSD_version < 500000
205 /*
206  * Various compat hacks/kludges
207  */
208 #define le16toh(x) (x)
209 #define htole16(x) (x)
210 #define ifaddr_byindex(idx) ifnet_addrs[(idx) - 1];
211 #define WI_LOCK(_sc, _s)        s = splimp()
212 #define WI_UNLOCK(_sc, _s)      splx(s)
213 #else
214 #define WI_LOCK(_sc, _s) _s = 1
215 #define WI_UNLOCK(_sc, _s)
216 #endif
217
218 int wi_generic_attach(device_t);
219 int wi_generic_detach(device_t);
220 void wi_shutdown(device_t);
221 int wi_alloc(device_t, int);
222 void wi_free(device_t);
223 extern devclass_t wi_devclass;
224 int wi_mgmt_xmit(struct wi_softc *, caddr_t, int);