Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / sys / dev / netif / awi / awivar.h
1 /* $NetBSD: awivar.h,v 1.12 2000/07/21 04:48:56 onoe Exp $ */
2 /* $FreeBSD: src/sys/dev/awi/awivar.h,v 1.6.2.1 2000/12/07 04:09:39 imp Exp $ */
3 /* $DragonFly: src/sys/dev/netif/awi/Attic/awivar.h,v 1.2 2003/06/17 04:28:22 dillon Exp $ */
4
5 /*-
6  * Copyright (c) 1999 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Bill Sommerfeld
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *        This product includes software developed by the NetBSD
23  *        Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40
41 /* timer values in msec */
42 #define AWI_SELFTEST_TIMEOUT    5000
43 #define AWI_CMD_TIMEOUT         2000
44 #define AWI_LOCKOUT_TIMEOUT     50
45 #define AWI_ASCAN_DURATION      100
46 #define AWI_ASCAN_WAIT          3000
47 #define AWI_PSCAN_DURATION      200
48 #define AWI_PSCAN_WAIT          5000
49 #define AWI_TRANS_TIMEOUT       2000
50
51 #define AWI_NTXBUFS             4
52 #define AWI_MAX_KEYLEN          16
53
54 enum awi_status {
55         AWI_ST_INIT,
56         AWI_ST_SCAN,
57         AWI_ST_SETSS,
58         AWI_ST_SYNC,
59         AWI_ST_AUTH,
60         AWI_ST_ASSOC,
61         AWI_ST_RUNNING
62 };
63
64 struct awi_bss 
65 {
66         TAILQ_ENTRY(awi_bss)    list;
67         u_int8_t        esrc[ETHER_ADDR_LEN];
68         u_int8_t        chanset;        /* channel set to use */
69         u_int8_t        pattern;        /* hop pattern to use */
70         u_int8_t        index;          /* index to use */
71         u_int8_t        rssi;           /* strength of this beacon */
72         u_int16_t       dwell_time;     /* dwell time */
73         u_int8_t        timestamp[8];   /* timestamp of this bss */
74         u_int8_t        bssid[ETHER_ADDR_LEN];
75         u_int16_t       capinfo;
76         u_int32_t       rxtime;         /* unit's local time */
77         u_int16_t       interval;       /* beacon interval */
78         u_int8_t        txrate;
79         u_int8_t        fails;
80         u_int8_t        essid[IEEE80211_NWID_LEN + 2];
81 };
82
83 struct awi_wep_algo {
84         char            *awa_name;
85         int             (*awa_ctxlen) __P((void));
86         void            (*awa_setkey) __P((void *, u_char *, int));
87         void            (*awa_encrypt) __P((void *, u_char *, u_char *, int));
88         void            (*awa_decrypt) __P((void *, u_char *, u_char *, int));
89 };
90
91 struct awi_softc 
92 {
93 #ifdef __NetBSD__
94         struct device           sc_dev;
95         struct ethercom         sc_ec;
96         void                    *sc_ih; /* interrupt handler */
97 #endif
98 #ifdef __FreeBSD__
99 #if __FreeBSD__ >= 4
100         struct {
101                 char    dv_xname[64];   /*XXX*/
102         }                       sc_dev;
103 #else
104         struct device           sc_dev;
105 #endif
106         struct arpcom           sc_ec;
107 #endif
108         struct am79c930_softc   sc_chip;
109         struct ifnet            *sc_ifp;
110         int                     (*sc_enable) __P((struct awi_softc *));
111         void                    (*sc_disable) __P((struct awi_softc *));
112
113         struct ifmedia          sc_media;
114         enum awi_status         sc_status;
115         unsigned int            sc_enabled:1,
116                                 sc_busy:1,
117                                 sc_cansleep:1,
118                                 sc_invalid:1,
119                                 sc_enab_intr:1,
120                                 sc_format_llc:1,
121                                 sc_start_bss:1,
122                                 sc_rawbpf:1,
123                                 sc_no_bssid:1,
124                                 sc_active_scan:1,
125                                 sc_attached:1;  /* attach has succeeded */
126         u_int8_t                sc_cmd_inprog;
127         int                     sc_sleep_cnt;
128
129         int                     sc_mgt_timer;
130
131         TAILQ_HEAD(, awi_bss)   sc_scan;
132         u_int8_t                sc_scan_cur;
133         u_int8_t                sc_scan_min;
134         u_int8_t                sc_scan_max;
135         u_int8_t                sc_scan_set;
136         struct awi_bss          sc_bss;
137         u_int8_t                sc_ownssid[IEEE80211_NWID_LEN + 2];
138         u_int8_t                sc_ownch;
139
140         int                     sc_rx_timer;
141         u_int32_t               sc_rxdoff;
142         u_int32_t               sc_rxmoff;
143         struct mbuf             *sc_rxpend;
144
145         int                     sc_tx_timer;
146         u_int8_t                sc_tx_rate;
147         struct ifqueue          sc_mgtq;
148         u_int32_t               sc_txbase;
149         u_int32_t               sc_txend;
150         u_int32_t               sc_txnext;
151         u_int32_t               sc_txdone;
152
153         int                     sc_wep_keylen[IEEE80211_WEP_NKID]; /* keylen */
154         u_int8_t                sc_wep_key[IEEE80211_WEP_NKID][AWI_MAX_KEYLEN];
155         int                     sc_wep_defkid;
156         void                    *sc_wep_ctx;    /* work area */
157         struct awi_wep_algo     *sc_wep_algo;
158
159         u_char                  sc_banner[AWI_BANNER_LEN];
160         struct awi_mib_local    sc_mib_local;
161         struct awi_mib_addr     sc_mib_addr;
162         struct awi_mib_mac      sc_mib_mac;
163         struct awi_mib_stat     sc_mib_stat;
164         struct awi_mib_mgt      sc_mib_mgt;
165         struct awi_mib_phy      sc_mib_phy;
166 };
167
168 #define awi_read_1(sc, off) ((sc)->sc_chip.sc_ops->read_1)(&sc->sc_chip, off)
169 #define awi_read_2(sc, off) ((sc)->sc_chip.sc_ops->read_2)(&sc->sc_chip, off)
170 #define awi_read_4(sc, off) ((sc)->sc_chip.sc_ops->read_4)(&sc->sc_chip, off)
171 #define awi_read_bytes(sc, off, ptr, len) ((sc)->sc_chip.sc_ops->read_bytes)(&sc->sc_chip, off, ptr, len)
172
173 #define awi_write_1(sc, off, val) \
174         ((sc)->sc_chip.sc_ops->write_1)(&sc->sc_chip, off, val)
175 #define awi_write_2(sc, off, val) \
176         ((sc)->sc_chip.sc_ops->write_2)(&sc->sc_chip, off, val)
177 #define awi_write_4(sc, off, val) \
178         ((sc)->sc_chip.sc_ops->write_4)(&sc->sc_chip, off, val)
179 #define awi_write_bytes(sc, off, ptr, len) \
180         ((sc)->sc_chip.sc_ops->write_bytes)(&sc->sc_chip, off, ptr, len)
181
182 #define awi_drvstate(sc, state) \
183         awi_write_1(sc, AWI_DRIVERSTATE, \
184             ((state) | AWI_DRV_AUTORXLED|AWI_DRV_AUTOTXLED))
185
186 /* unalligned little endian access */
187 #define LE_READ_2(p)                                                    \
188         (((u_int8_t *)(p))[0] | (((u_int8_t *)(p))[1] << 8))
189 #define LE_READ_4(p)                                                    \
190         (((u_int8_t *)(p))[0] | (((u_int8_t *)(p))[1] << 8) |           \
191          (((u_int8_t *)(p))[2] << 16) | (((u_int8_t *)(p))[3] << 24))
192 #define LE_WRITE_2(p, v)                                                \
193         ((((u_int8_t *)(p))[0] = ((u_int32_t)(v) & 0xff)),              \
194          (((u_int8_t *)(p))[1] = (((u_int32_t)(v) >> 8) & 0xff)))
195 #define LE_WRITE_4(p, v)                                                \
196         ((((u_int8_t *)(p))[0] = ((u_int32_t)(v) & 0xff)),              \
197          (((u_int8_t *)(p))[1] = (((u_int32_t)(v) >> 8) & 0xff)),       \
198          (((u_int8_t *)(p))[2] = (((u_int32_t)(v) >> 16) & 0xff)),      \
199          (((u_int8_t *)(p))[3] = (((u_int32_t)(v) >> 24) & 0xff)))
200
201 #define AWI_80211_RATE(rate)    (((rate) & 0x7f) * 5)
202
203 int     awi_attach __P((struct awi_softc *));
204 int     awi_intr __P((void *));
205 void    awi_reset __P((struct awi_softc *));
206 #ifdef __NetBSD__
207 int     awi_activate __P((struct device *, enum devact));
208 int     awi_detach __P((struct awi_softc *));
209 void    awi_power __P((struct awi_softc *, int));
210 #endif
211
212 void awi_stop __P((struct awi_softc *sc));
213 int awi_init __P((struct awi_softc *sc));
214 int awi_init_region __P((struct awi_softc *));
215 int awi_wicfg __P((struct ifnet *, u_long, caddr_t));
216
217 int awi_wep_setnwkey __P((struct awi_softc *, struct ieee80211_nwkey *));
218 int awi_wep_getnwkey __P((struct awi_softc *, struct ieee80211_nwkey *));
219 int awi_wep_getalgo __P((struct awi_softc *));
220 int awi_wep_setalgo __P((struct awi_softc *, int));
221 int awi_wep_setkey __P((struct awi_softc *, int, unsigned char *, int));
222 int awi_wep_getkey __P((struct awi_softc *, int, unsigned char *, int *));
223 struct mbuf *awi_wep_encrypt __P((struct awi_softc *, struct mbuf *, int));