xref: /netbsd-src/sys/dev/ic/wivar.h (revision 1ffa7b76c40339c17a0fb2a09fac93f287cfc046)
1 /*	$NetBSD: wivar.h,v 1.30 2003/03/27 04:53:52 dyoung Exp $	*/
2 
3 /*
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 
35 /*
36  * FreeBSD driver ported to NetBSD by Bill Sommerfeld in the back of the
37  * Oslo IETF plenary meeting.
38  */
39 struct wi_softc	{
40 	struct device		sc_dev;
41 	struct ieee80211com	sc_ic;
42 	void			*sc_ih;		/* interrupt handler */
43 	int			(*sc_enable)(struct wi_softc *);
44 	void			(*sc_disable)(struct wi_softc *);
45 	void			(*sc_reset)(struct wi_softc *);
46 
47 	int			sc_attached;
48 	int			sc_enabled;
49 	int			sc_firmware_type;
50 #define	WI_NOTYPE	0
51 #define	WI_LUCENT	1
52 #define	WI_INTERSIL	2
53 #define	WI_SYMBOL	3
54 	int			sc_pri_firmware_ver;	/* Primary firm vers */
55 	int			sc_sta_firmware_ver;	/* Station firm vers */
56 	int			sc_pci;			/* attach to PCI-Bus */
57 
58 	bus_space_tag_t		sc_iot;			/* bus cookie */
59 	bus_space_handle_t	sc_ioh;			/* bus i/o handle */
60 
61 	struct ifmedia		sc_media;
62 	caddr_t			sc_drvbpf;
63 	int			sc_flags;
64 	int			sc_bap_id;
65 	int			sc_bap_off;
66 
67 	u_int16_t		sc_dbm_adjust;
68 	u_int16_t		sc_max_datalen;
69 	u_int16_t		sc_frag_thresh;
70 	u_int16_t		sc_rts_thresh;
71 	u_int16_t		sc_system_scale;
72 	u_int16_t		sc_tx_rate;
73 	u_int16_t		sc_cnfauthmode;
74 	u_int16_t		sc_roaming_mode;
75 	u_int16_t		sc_microwave_oven;
76 
77 	int			sc_nodelen;
78 	char			sc_nodename[IEEE80211_NWID_LEN];
79 
80 	int			sc_buflen;
81 #define	WI_NTXBUF	3
82 	struct sc_txdesc {
83 		int		d_fid;
84 		int		d_len;
85 	}			sc_txd[WI_NTXBUF];
86 	int			sc_txnext;
87 	int			sc_txcur;
88 	int			sc_tx_timer;
89 	int			sc_scan_timer;
90 	int			sc_syn_timer;
91 
92 	struct wi_counters	sc_stats;
93 	u_int16_t		sc_ibss_port;
94 
95 	struct wi_apinfo	sc_aps[MAXAPINFO];
96 	int 			sc_naps;
97 
98 	int			sc_false_syns;
99 
100 	u_int16_t		sc_txbuf[IEEE80211_MAX_LEN/2];
101 };
102 
103 #define	sc_if			sc_ic.ic_if
104 
105 /* maximum consecutive false change-of-BSSID indications */
106 #define	WI_MAX_FALSE_SYNS		10
107 
108 #define	WI_SCAN_INQWAIT			3	/* wait sec before inquire */
109 #define	WI_SCAN_WAIT			5	/* maximum scan wait */
110 
111 /* Values for wi_flags. */
112 #define	WI_FLAGS_ATTACHED		0x0001
113 #define	WI_FLAGS_INITIALIZED		0x0002
114 #define	WI_FLAGS_OUTRANGE		0x0004
115 #define	WI_FLAGS_HAS_MOR		0x0010
116 #define	WI_FLAGS_HAS_ROAMING		0x0020
117 #define	WI_FLAGS_HAS_DIVERSITY		0x0040
118 #define	WI_FLAGS_HAS_SYSSCALE		0x0080
119 #define	WI_FLAGS_BUG_AUTOINC		0x0100
120 #define	WI_FLAGS_HAS_FRAGTHR		0x0200
121 #define	WI_FLAGS_HAS_DBMADJUST		0x0400
122 
123 struct wi_card_ident {
124 	u_int16_t	card_id;
125 	char		*card_name;
126 	u_int8_t	firm_type;
127 };
128 
129 /*
130  * register space access macros
131  */
132 #ifdef WI_AT_BIGENDIAN_BUS_HACK
133 	/*
134 	 * XXX - ugly hack for sparc bus_space_* macro deficiencies:
135 	 *       assume the bus we are accessing is big endian.
136 	 */
137 
138 #define CSR_WRITE_4(sc, reg, val)	\
139 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,	\
140 			(sc->sc_pci? reg * 2: reg) , htole32(val))
141 #define CSR_WRITE_2(sc, reg, val)	\
142 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,	\
143 			(sc->sc_pci? reg * 2: reg), htole16(val))
144 #define CSR_WRITE_1(sc, reg, val)	\
145 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,	\
146 			(sc->sc_pci? reg * 2: reg), val)
147 
148 #define CSR_READ_4(sc, reg)		\
149 	le32toh(bus_space_read_4(sc->sc_iot, sc->sc_ioh,	\
150 			(sc->sc_pci? reg * 2: reg)))
151 #define CSR_READ_2(sc, reg)		\
152 	le16toh(bus_space_read_2(sc->sc_iot, sc->sc_ioh,	\
153 			(sc->sc_pci? reg * 2: reg)))
154 #define CSR_READ_1(sc, reg)		\
155 	bus_space_read_1(sc->sc_iot, sc->sc_ioh,	\
156 			(sc->sc_pci? reg * 2: reg))
157 
158 #else
159 
160 #define CSR_WRITE_4(sc, reg, val)	\
161 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,	\
162 			(sc->sc_pci? reg * 2: reg) , val)
163 #define CSR_WRITE_2(sc, reg, val)	\
164 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,	\
165 			(sc->sc_pci? reg * 2: reg), val)
166 #define CSR_WRITE_1(sc, reg, val)	\
167 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,	\
168 			(sc->sc_pci? reg * 2: reg), val)
169 
170 #define CSR_READ_4(sc, reg)		\
171 	bus_space_read_4(sc->sc_iot, sc->sc_ioh,	\
172 			(sc->sc_pci? reg * 2: reg))
173 #define CSR_READ_2(sc, reg)		\
174 	bus_space_read_2(sc->sc_iot, sc->sc_ioh,	\
175 			(sc->sc_pci? reg * 2: reg))
176 #define CSR_READ_1(sc, reg)		\
177 	bus_space_read_1(sc->sc_iot, sc->sc_ioh,	\
178 			(sc->sc_pci? reg * 2: reg))
179 #endif
180 
181 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
182 #define bus_space_write_stream_2	bus_space_write_2
183 #define bus_space_write_multi_stream_2	bus_space_write_multi_2
184 #define bus_space_read_stream_2		bus_space_read_2
185 #define bus_space_read_multi_stream_2		bus_space_read_multi_2
186 #endif
187 
188 #define CSR_WRITE_STREAM_2(sc, reg, val)	\
189 	bus_space_write_stream_2(sc->sc_iot, sc->sc_ioh,	\
190 			(sc->sc_pci? reg * 2: reg), val)
191 #define CSR_WRITE_MULTI_STREAM_2(sc, reg, val, count)	\
192 	bus_space_write_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
193 			(sc->sc_pci? reg * 2: reg), val, count)
194 #define CSR_READ_STREAM_2(sc, reg)		\
195 	bus_space_read_stream_2(sc->sc_iot, sc->sc_ioh,	\
196 			(sc->sc_pci? reg * 2: reg))
197 #define CSR_READ_MULTI_STREAM_2(sc, reg, buf, count)		\
198 	bus_space_read_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
199 			(sc->sc_pci? reg * 2: reg), buf, count)
200 
201 
202 int	wi_attach(struct wi_softc *);
203 int	wi_detach(struct wi_softc *);
204 int	wi_activate(struct device *, enum devact);
205 int	wi_intr(void *arg);
206 void	wi_power(struct wi_softc *, int);
207 void	wi_shutdown(struct wi_softc *);
208