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