if_wivar.h revision 180919 
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 180919 2008-07-28 17:00:37Z imp $
35 */
36
37/*
38 * Encryption controls. We can enable or disable encryption as
39 * well as specify up to 4 encryption keys. We can also specify
40 * which of the four keys will be used for transmit encryption.
41 */
42#define WI_RID_ENCRYPTION	0xFC20
43#define WI_RID_AUTHTYPE		0xFC21
44#define WI_RID_DEFLT_CRYPT_KEYS	0xFCB0
45#define WI_RID_TX_CRYPT_KEY	0xFCB1
46#define WI_RID_WEP_AVAIL	0xFD4F
47#define WI_RID_P2_TX_CRYPT_KEY	0xFC23
48#define WI_RID_P2_CRYPT_KEY0	0xFC24
49#define WI_RID_P2_CRYPT_KEY1	0xFC25
50#define WI_RID_MICROWAVE_OVEN	0xFC25
51#define WI_RID_P2_CRYPT_KEY2	0xFC26
52#define WI_RID_P2_CRYPT_KEY3	0xFC27
53#define WI_RID_P2_ENCRYPTION	0xFC28
54#define WI_RID_ROAMING_MODE	0xFC2D
55#define WI_RID_CUR_TX_RATE	0xFD44 /* current TX rate */
56
57#define	WI_MAX_AID		256	/* max stations for ap operation */
58
59struct wi_vap {
60	struct ieee80211vap	wv_vap;
61	struct ieee80211_beacon_offsets	wv_bo;
62	struct task		wv_connected_task;
63	struct task		wv_disconnected_task;
64	struct task		wv_assoc_failed_task;
65
66	void		(*wv_recv_mgmt)(struct ieee80211_node *,
67			    struct mbuf *, int, int, int, u_int32_t);
68	int		(*wv_newstate)(struct ieee80211vap *,
69			    enum ieee80211_state, int);
70};
71#define	WI_VAP(vap)		((struct wi_vap *)(vap))
72
73struct wi_softc	{
74	struct ifnet		*sc_ifp;
75	device_t		sc_dev;
76	struct mtx		sc_mtx;
77	struct callout		sc_watchdog;
78	struct task		sc_oor_task;
79	int			sc_unit;
80	int			wi_gone;
81	int			sc_enabled;
82	int			sc_reset;
83	int			sc_firmware_type;
84#define WI_NOTYPE	0
85#define	WI_LUCENT	1
86#define	WI_INTERSIL	2
87#define	WI_SYMBOL	3
88	int			sc_pri_firmware_ver;	/* Primary firmware */
89	int			sc_sta_firmware_ver;	/* Station firmware */
90	unsigned int		sc_nic_id;		/* Type of NIC */
91	char *			sc_nic_name;
92
93	int			wi_bus_type;	/* Bus attachment type */
94	struct resource *	local;
95	int			local_rid;
96	struct resource *	iobase;
97	int			iobase_rid;
98	struct resource *	irq;
99	int			irq_rid;
100	struct resource *	mem;
101	int			mem_rid;
102	bus_space_handle_t	wi_localhandle;
103	bus_space_tag_t		wi_localtag;
104	bus_space_handle_t	wi_bhandle;
105	bus_space_tag_t		wi_btag;
106	bus_space_handle_t	wi_bmemhandle;
107	bus_space_tag_t		wi_bmemtag;
108	void *			wi_intrhand;
109	struct ieee80211_channel *wi_channel;
110	int			wi_io_addr;
111	int			wi_cmd_count;
112
113	int			sc_flags;
114	int			sc_if_flags;
115	int			sc_bap_id;
116	int			sc_bap_off;
117
118	int			sc_porttype;
119	u_int16_t		sc_portnum;
120	u_int16_t		sc_encryption;
121	u_int16_t		sc_monitor_port;
122
123	/* RSSI interpretation */
124	u_int16_t		sc_min_rssi;	/* clamp sc_min_rssi < RSSI */
125	u_int16_t		sc_max_rssi;	/* clamp RSSI < sc_max_rssi */
126	u_int16_t		sc_dbm_offset;	/* dBm ~ RSSI - sc_dbm_offset */
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
139	struct wi_counters	sc_stats;
140	u_int16_t		sc_ibss_port;
141
142	struct timeval		sc_last_syn;
143	int			sc_false_syns;
144
145	u_int16_t		sc_txbuf[IEEE80211_MAX_LEN/2];
146
147	struct wi_tx_radiotap_header sc_tx_th;
148	int			sc_tx_th_len;
149	struct wi_rx_radiotap_header sc_rx_th;
150	int			sc_rx_th_len;
151};
152
153/* maximum consecutive false change-of-BSSID indications */
154#define	WI_MAX_FALSE_SYNS		10
155
156#define	WI_FLAGS_HAS_ENHSECURITY	0x0001
157#define	WI_FLAGS_HAS_WPASUPPORT		0x0002
158#define	WI_FLAGS_HAS_ROAMING		0x0020
159#define	WI_FLAGS_HAS_FRAGTHR		0x0200
160#define	WI_FLAGS_HAS_DBMADJUST		0x0400
161
162struct wi_card_ident {
163	u_int16_t	card_id;
164	char		*card_name;
165	u_int8_t	firm_type;
166};
167
168#define	WI_PRISM_MIN_RSSI	0x1b
169#define	WI_PRISM_MAX_RSSI	0x9a
170#define	WI_PRISM_DBM_OFFSET	100 /* XXX */
171
172#define	WI_LUCENT_MIN_RSSI	47
173#define	WI_LUCENT_MAX_RSSI	138
174#define	WI_LUCENT_DBM_OFFSET	149
175
176#define	WI_RSSI_TO_DBM(sc, rssi) (MIN((sc)->sc_max_rssi, \
177    MAX((sc)->sc_min_rssi, (rssi))) - (sc)->sc_dbm_offset)
178
179#define	WI_LOCK(_sc) 		mtx_lock(&(_sc)->sc_mtx)
180#define	WI_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
181#define	WI_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
182
183int	wi_attach(device_t);
184int	wi_detach(device_t);
185void	wi_shutdown(device_t);
186int	wi_alloc(device_t, int);
187void	wi_free(device_t);
188extern devclass_t wi_devclass;
189void	wi_init(void *);
190void	wi_intr(void *);
191int	wi_mgmt_xmit(struct wi_softc *, caddr_t, int);
192void	wi_stop(struct wi_softc *, int);
193