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