xref: /dragonfly/sys/dev/netif/wi/if_wivar.h (revision 0cfebe3d)
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.25.2.1 2005/10/05 13:13:46 avatar Exp $
35  * $DragonFly: src/sys/dev/netif/wi/if_wivar.h,v 1.10 2006/05/18 13:51:45 sephe Exp $
36  */
37 
38 #if 0
39 #define WICACHE			/* turn on signal strength cache code */
40 #define	MAXWICACHE	10
41 #endif
42 
43 /*
44  * Encryption controls. We can enable or disable encryption as
45  * well as specify up to 4 encryption keys. We can also specify
46  * which of the four keys will be used for transmit encryption.
47  */
48 #define WI_RID_ENCRYPTION	0xFC20
49 #define WI_RID_AUTHTYPE		0xFC21
50 #define WI_RID_DEFLT_CRYPT_KEYS	0xFCB0
51 #define WI_RID_TX_CRYPT_KEY	0xFCB1
52 #define WI_RID_WEP_AVAIL	0xFD4F
53 #define WI_RID_P2_TX_CRYPT_KEY	0xFC23
54 #define WI_RID_P2_CRYPT_KEY0	0xFC24
55 #define WI_RID_P2_CRYPT_KEY1	0xFC25
56 #define WI_RID_MICROWAVE_OVEN	0xFC25
57 #define WI_RID_P2_CRYPT_KEY2	0xFC26
58 #define WI_RID_P2_CRYPT_KEY3	0xFC27
59 #define WI_RID_P2_ENCRYPTION	0xFC28
60 #define WI_RID_ROAMING_MODE	0xFC2D
61 #define WI_RID_CUR_TX_RATE	0xFD44 /* current TX rate */
62 
63 #define WI_MAX_AID		256	/* max stations for ap operation */
64 
65 struct wi_softc	{
66 	struct ieee80211com	sc_ic;
67 	int			(*sc_newstate)(struct ieee80211com *,
68 					enum ieee80211_state, int);
69 	int			(*sc_key_alloc)(struct ieee80211com *,
70 					const struct ieee80211_key *,
71 					ieee80211_keyix *, ieee80211_keyix *);
72 	int			wi_gone;
73 	int			sc_enabled;
74 	int			sc_reset;
75 	int			sc_firmware_type;
76 #define WI_NOTYPE	0
77 #define	WI_LUCENT	1
78 #define	WI_INTERSIL	2
79 #define	WI_SYMBOL	3
80 	int			sc_pri_firmware_ver;	/* Primary firmware */
81 	int			sc_sta_firmware_ver;	/* Station firmware */
82 
83 	int			wi_bus_type;	/* Bus attachment type */
84 	struct resource *	local;
85 	int			local_rid;
86 	struct resource *	iobase;
87 	int			iobase_rid;
88 	struct resource *	irq;
89 	int			irq_rid;
90 	struct resource *	mem;
91 	int			mem_rid;
92 	bus_space_handle_t	wi_localhandle;
93 	bus_space_tag_t		wi_localtag;
94 	bus_space_handle_t	wi_bhandle;
95 	bus_space_tag_t		wi_btag;
96 	bus_space_handle_t	wi_bmemhandle;
97 	bus_space_tag_t		wi_bmemtag;
98 	void *			wi_intrhand;
99 	int			wi_io_addr;
100 	int			wi_cmd_count;
101 
102 	struct bpf_if		*sc_drvbpf;
103 	int			sc_flags;
104 	int			sc_if_flags;
105 	int			sc_bap_id;
106 	int			sc_bap_off;
107 
108 	u_int16_t		sc_procframe;
109 	u_int16_t		sc_portnum;
110 
111 	/* RSSI interpretation */
112 	u_int16_t		sc_min_rssi;	/* clamp sc_min_rssi < RSSI */
113 	u_int16_t		sc_max_rssi;	/* clamp RSSI < sc_max_rssi */
114 	u_int16_t		sc_dbm_offset;	/* dBm ~ RSSI - sc_dbm_offset */
115 
116 	u_int16_t		sc_max_datalen;
117 	u_int16_t		sc_system_scale;
118 	u_int16_t		sc_cnfauthmode;
119 	u_int16_t		sc_roaming_mode;
120 	u_int16_t		sc_microwave_oven;
121 	u_int16_t		sc_authtype;
122 	u_int16_t		sc_encryption;
123 
124 	int			sc_nodelen;
125 	char			sc_nodename[IEEE80211_NWID_LEN];
126 	char			sc_net_name[IEEE80211_NWID_LEN];
127 
128 	int			sc_buflen;		/* TX buffer size */
129 	int			sc_ntxbuf;
130 #define	WI_NTXBUF	3
131 	struct {
132 		int		d_fid;
133 		int		d_len;
134 	}			sc_txd[WI_NTXBUF];	/* TX buffers */
135 	int			sc_txnext;		/* index of next TX */
136 	int			sc_txcur;		/* index of current TX*/
137 	int			sc_tx_timer;
138 	int			sc_scan_timer;
139 
140 	struct wi_counters	sc_stats;
141 	u_int16_t		sc_ibss_port;
142 
143 #define WI_MAXAPINFO		30
144 	struct wi_apinfo	sc_aps[WI_MAXAPINFO];
145 	int			sc_naps;
146 
147 	struct {
148 		u_int16_t               wi_sleep;
149 		u_int16_t               wi_delaysupp;
150 		u_int16_t               wi_txsupp;
151 		u_int16_t               wi_monitor;
152 		u_int16_t               wi_ledtest;
153 		u_int16_t               wi_ledtest_param0;
154 		u_int16_t               wi_ledtest_param1;
155 		u_int16_t               wi_conttx;
156 		u_int16_t               wi_conttx_param0;
157 		u_int16_t               wi_contrx;
158 		u_int16_t               wi_sigstate;
159 		u_int16_t               wi_sigstate_param0;
160 		u_int16_t               wi_confbits;
161 		u_int16_t               wi_confbits_param0;
162 	} wi_debug;
163 
164 	struct timeval		sc_last_syn;
165 	int			sc_false_syns;
166 
167 	u_int16_t		sc_txbuf[IEEE80211_MAX_LEN/2];
168 
169 	union {
170 		struct wi_tx_radiotap_header th;
171 		u_int8_t	pad[64];
172 	} u_tx_rt;
173 	int			sc_tx_th_len;
174 	union {
175 		struct wi_rx_radiotap_header th;
176 		u_int8_t	pad[64];
177 	} u_rx_rt;
178 	int			sc_rx_th_len;
179 };
180 #define	sc_if			sc_ic.ic_if
181 #define	sc_tx_th		u_tx_rt.th
182 #define	sc_rx_th		u_rx_rt.th
183 
184 /* maximum consecutive false change-of-BSSID indications */
185 #define	WI_MAX_FALSE_SYNS		10
186 
187 #define	WI_SCAN_INQWAIT			3	/* wait sec before inquire */
188 #define	WI_SCAN_WAIT			5	/* maximum scan wait */
189 
190 #define	WI_FLAGS_ATTACHED		0x0001
191 #define	WI_FLAGS_INITIALIZED		0x0002
192 #define	WI_FLAGS_OUTRANGE		0x0004
193 #define	WI_FLAGS_HAS_MOR		0x0010
194 #define	WI_FLAGS_HAS_ROAMING		0x0020
195 #define	WI_FLAGS_HAS_DIVERSITY		0x0040
196 #define	WI_FLAGS_HAS_SYSSCALE		0x0080
197 #define	WI_FLAGS_BUG_AUTOINC		0x0100
198 #define	WI_FLAGS_HAS_FRAGTHR		0x0200
199 #define	WI_FLAGS_HAS_DBMADJUST		0x0400
200 
201 struct wi_card_ident {
202 	u_int16_t	card_id;
203 	char		*card_name;
204 	u_int8_t	firm_type;
205 };
206 
207 #define	WI_PRISM_MIN_RSSI	0x1b
208 #define	WI_PRISM_MAX_RSSI	0x9a
209 #define	WI_PRISM_DBM_OFFSET	100 /* XXX */
210 
211 #define	WI_LUCENT_MIN_RSSI	47
212 #define	WI_LUCENT_MAX_RSSI	138
213 #define	WI_LUCENT_DBM_OFFSET	149
214 
215 #define	WI_RSSI_TO_DBM(sc, rssi) (MIN((sc)->sc_max_rssi, \
216     MAX((sc)->sc_min_rssi, (rssi))) - (sc)->sc_dbm_offset)
217 
218 int	wi_attach(device_t);
219 int	wi_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 void	wi_init(void *);
225 void	wi_intr(void *);
226 void	wi_stop(struct ifnet *, int);
227 int	wi_symbol_load_firm(struct wi_softc *, const void *, int, const void *, int);
228