if_wivar.h revision 165087
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 165087 2006-12-11 00:35:51Z 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
62#define	WI_MAX_AID		256	/* max stations for ap operation */
63
64struct wi_softc	{
65	struct ifnet		*sc_ifp;
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	device_t		sc_dev;
73	struct mtx		sc_mtx;
74	int			sc_unit;
75	int			wi_gone;
76	int			sc_enabled;
77	int			sc_reset;
78	int			sc_firmware_type;
79#define WI_NOTYPE	0
80#define	WI_LUCENT	1
81#define	WI_INTERSIL	2
82#define	WI_SYMBOL	3
83	int			sc_pri_firmware_ver;	/* Primary firmware */
84	int			sc_sta_firmware_ver;	/* Station firmware */
85
86	int			wi_bus_type;	/* Bus attachment type */
87	struct resource *	local;
88	int			local_rid;
89	struct resource *	iobase;
90	int			iobase_rid;
91	struct resource *	irq;
92	int			irq_rid;
93	struct resource *	mem;
94	int			mem_rid;
95	bus_space_handle_t	wi_localhandle;
96	bus_space_tag_t		wi_localtag;
97	bus_space_handle_t	wi_bhandle;
98	bus_space_tag_t		wi_btag;
99	bus_space_handle_t	wi_bmemhandle;
100	bus_space_tag_t		wi_bmemtag;
101	void *			wi_intrhand;
102	int			wi_io_addr;
103	int			wi_cmd_count;
104
105	struct bpf_if		*sc_drvbpf;
106	int			sc_flags;
107	int			sc_if_flags;
108	int			sc_bap_id;
109	int			sc_bap_off;
110
111	u_int16_t		sc_procframe;
112	u_int16_t		sc_portnum;
113
114	/* RSSI interpretation */
115	u_int16_t		sc_min_rssi;	/* clamp sc_min_rssi < RSSI */
116	u_int16_t		sc_max_rssi;	/* clamp RSSI < sc_max_rssi */
117	u_int16_t		sc_dbm_offset;	/* dBm ~ RSSI - sc_dbm_offset */
118
119	u_int16_t		sc_max_datalen;
120	u_int16_t		sc_system_scale;
121	u_int16_t		sc_cnfauthmode;
122	u_int16_t		sc_roaming_mode;
123	u_int16_t		sc_microwave_oven;
124	u_int16_t		sc_authtype;
125	u_int16_t		sc_encryption;
126
127	int			sc_nodelen;
128	char			sc_nodename[IEEE80211_NWID_LEN];
129	char			sc_net_name[IEEE80211_NWID_LEN];
130	uint8_t			sc_hintmacaddr[IEEE80211_ADDR_LEN];
131
132	int			sc_buflen;		/* TX buffer size */
133	int			sc_ntxbuf;
134#define	WI_NTXBUF	3
135	struct {
136		int		d_fid;
137		int		d_len;
138	}			sc_txd[WI_NTXBUF];	/* TX buffers */
139	int			sc_txnext;		/* index of next TX */
140	int			sc_txcur;		/* index of current TX*/
141	int			sc_tx_timer;
142	int			sc_scan_timer;
143
144	struct wi_counters	sc_stats;
145	u_int16_t		sc_ibss_port;
146
147#define WI_MAXAPINFO		30
148	struct wi_apinfo	sc_aps[WI_MAXAPINFO];
149	int			sc_naps;
150
151	struct {
152		u_int16_t               wi_sleep;
153		u_int16_t               wi_delaysupp;
154		u_int16_t               wi_txsupp;
155		u_int16_t               wi_monitor;
156		u_int16_t               wi_ledtest;
157		u_int16_t               wi_ledtest_param0;
158		u_int16_t               wi_ledtest_param1;
159		u_int16_t               wi_conttx;
160		u_int16_t               wi_conttx_param0;
161		u_int16_t               wi_contrx;
162		u_int16_t               wi_sigstate;
163		u_int16_t               wi_sigstate_param0;
164		u_int16_t               wi_confbits;
165		u_int16_t               wi_confbits_param0;
166	} wi_debug;
167
168	struct timeval		sc_last_syn;
169	int			sc_false_syns;
170
171	u_int16_t		sc_txbuf[IEEE80211_MAX_LEN/2];
172
173	union {
174		struct wi_tx_radiotap_header th;
175		u_int8_t	pad[64];
176	} u_tx_rt;
177	int			sc_tx_th_len;
178	union {
179		struct wi_rx_radiotap_header th;
180		u_int8_t	pad[64];
181	} u_rx_rt;
182	int			sc_rx_th_len;
183};
184#define	sc_tx_th		u_tx_rt.th
185#define	sc_rx_th		u_rx_rt.th
186
187/* maximum consecutive false change-of-BSSID indications */
188#define	WI_MAX_FALSE_SYNS		10
189
190#define	WI_SCAN_INQWAIT			3	/* wait sec before inquire */
191#define	WI_SCAN_WAIT			5	/* maximum scan wait */
192
193#define	WI_FLAGS_ATTACHED		0x0001
194#define	WI_FLAGS_INITIALIZED		0x0002
195#define	WI_FLAGS_OUTRANGE		0x0004
196#define	WI_FLAGS_HAS_MOR		0x0010
197#define	WI_FLAGS_HAS_ROAMING		0x0020
198#define	WI_FLAGS_HAS_DIVERSITY		0x0040
199#define	WI_FLAGS_HAS_SYSSCALE		0x0080
200#define	WI_FLAGS_BUG_AUTOINC		0x0100
201#define	WI_FLAGS_HAS_FRAGTHR		0x0200
202#define	WI_FLAGS_HAS_DBMADJUST		0x0400
203
204struct wi_card_ident {
205	u_int16_t	card_id;
206	char		*card_name;
207	u_int8_t	firm_type;
208};
209
210#define	WI_PRISM_MIN_RSSI	0x1b
211#define	WI_PRISM_MAX_RSSI	0x9a
212#define	WI_PRISM_DBM_OFFSET	100 /* XXX */
213
214#define	WI_LUCENT_MIN_RSSI	47
215#define	WI_LUCENT_MAX_RSSI	138
216#define	WI_LUCENT_DBM_OFFSET	149
217
218#define	WI_RSSI_TO_DBM(sc, rssi) (MIN((sc)->sc_max_rssi, \
219    MAX((sc)->sc_min_rssi, (rssi))) - (sc)->sc_dbm_offset)
220
221#define	WI_LOCK(_sc) 		mtx_lock(&(_sc)->sc_mtx)
222#define	WI_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
223#define	WI_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
224
225int	wi_attach(device_t);
226int	wi_detach(device_t);
227void	wi_shutdown(device_t);
228int	wi_alloc(device_t, int);
229void	wi_free(device_t);
230extern devclass_t wi_devclass;
231void	wi_init(void *);
232void	wi_intr(void *);
233int	wi_mgmt_xmit(struct wi_softc *, caddr_t, int);
234void	wi_stop(struct ifnet *, int);
235int	wi_symbol_load_firm(struct wi_softc *, const void *, int, const void *, int);
236