1/*-
2 * Copyright (c) 1997, 1998, 1999
3 *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $FreeBSD: stable/11/sys/dev/wi/if_wireg.h 345636 2019-03-28 09:50:25Z avos $
33 */
34
35#define WI_DELAY	5
36#define WI_TIMEOUT	(500000/WI_DELAY)	/* 500 ms */
37
38#define WI_PORT0	(0 << 8)
39#define WI_PORT1	(1 << 8)
40#define WI_PORT2	(2 << 8)
41#define WI_PORT3	(3 << 8)
42#define WI_PORT4	(4 << 8)
43#define WI_PORT5	(5 << 8)
44
45#define WI_PCI_LMEMRES	0x10	/* PCI Memory (native PCI implementations) */
46#define WI_PCI_LOCALRES	0x14	/* The PLX chip's local registers */
47#define WI_PCI_MEMRES	0x18	/* The PCCard's attribute memory */
48#define WI_PCI_IORES	0x1C	/* The PCCard's I/O space */
49
50#define WI_LOCAL_INTCSR		0x4c
51#define WI_LOCAL_INTEN		0x40
52#define WI_HFA384X_SWSUPPORT0_OFF	0x28
53#define WI_PRISM2STA_MAGIC		0x4A2D
54#define WI_PCICOR_OFF		0x26
55#define WI_PCICOR_RESET		0x0080
56
57/* Default port: 0 (only 0 exists on stations) */
58#define WI_DEFAULT_PORT	WI_PORT0
59
60/* Default network name: ANY */
61/*
62 * [sommerfeld 1999/07/15] Changed from "ANY" to ""; according to Bill Fenner,
63 * ANY is used in MS driver user interfaces, while "" is used over the
64 * wire..
65 */
66#define WI_DEFAULT_NETNAME	""
67
68#define WI_DEFAULT_AP_DENSITY	1
69
70#define WI_DEFAULT_RTS_THRESH	2347
71
72#define WI_DEFAULT_DATALEN	2304
73
74#define WI_DEFAULT_CREATE_IBSS	0
75
76#define WI_DEFAULT_PM_ENABLED	0
77
78#define WI_DEFAULT_MAX_SLEEP	100
79
80#define WI_DEFAULT_ROAMING	1
81
82#define WI_DEFAULT_AUTHTYPE	1
83
84#ifdef __NetBSD__
85#define OS_STRING_NAME	"NetBSD"
86#endif
87#ifdef __FreeBSD__
88#define OS_STRING_NAME	"FreeBSD"
89#endif
90#ifdef __OpenBSD__
91#define OS_STRING_NAME	"OpenBSD"
92#endif
93
94#define WI_DEFAULT_NODENAME	OS_STRING_NAME " WaveLAN/IEEE node"
95
96#define WI_DEFAULT_IBSS		OS_STRING_NAME " IBSS"
97
98#define WI_BUS_PCCARD		0	/* pccard device */
99#define WI_BUS_PCI_PLX		1	/* PCI card w/ PLX PCI/PCMICA bridge */
100#define WI_BUS_PCI_NATIVE	2	/* native PCI device (Prism 2.5) */
101
102/*
103 * register space access macros
104 */
105#define CSR_WRITE_4(sc, reg, val)				\
106	bus_space_write_4((sc)->wi_btag, (sc)->wi_bhandle, 	\
107	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
108#define CSR_WRITE_2(sc, reg, val)				\
109	bus_space_write_2((sc)->wi_btag, (sc)->wi_bhandle,	\
110 	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
111#define CSR_WRITE_1(sc, reg, val)				\
112	bus_space_write_1((sc)->wi_btag, (sc)->wi_bhandle,	\
113 	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
114
115#define CSR_READ_4(sc, reg)					\
116	bus_space_read_4((sc)->wi_btag, (sc)->wi_bhandle,	\
117 	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
118#define CSR_READ_2(sc, reg)					\
119	bus_space_read_2((sc)->wi_btag, (sc)->wi_bhandle,	\
120 	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
121#define CSR_READ_1(sc, reg)					\
122	bus_space_read_1((sc)->wi_btag, (sc)->wi_bhandle,	\
123 	    (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
124
125#define CSM_WRITE_1(sc, off, val)	\
126	bus_space_write_1((sc)->wi_bmemtag, (sc)->wi_bmemhandle, off, val)
127
128#define CSM_READ_1(sc, off)		\
129	bus_space_read_1((sc)->wi_bmemtag, (sc)->wi_bmemhandle, off)
130
131#define CSR_WRITE_STREAM_2(sc, reg, val)	\
132	bus_space_write_stream_2(sc->wi_btag, sc->wi_bhandle,	\
133	    (sc->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg) * 2 : (reg)), val)
134#define CSR_WRITE_MULTI_STREAM_2(sc, reg, val, count)	\
135	bus_space_write_multi_stream_2(sc->wi_btag, sc->wi_bhandle,	\
136	    (sc->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg) * 2 : (reg)), val, count)
137#define CSR_READ_STREAM_2(sc, reg)		\
138	bus_space_read_stream_2(sc->wi_btag, sc->wi_bhandle,	\
139	    (sc->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg) * 2 : (reg)))
140#define CSR_READ_MULTI_STREAM_2(sc, reg, buf, count)		\
141	bus_space_read_multi_stream_2(sc->wi_btag, sc->wi_bhandle,	\
142	    (sc->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg) * 2 : (reg)), buf, count)
143
144/*
145 * The WaveLAN/IEEE cards contain an 802.11 MAC controller which Lucent
146 * calls 'Hermes.' In typical fashion, getting documentation about this
147 * controller is about as easy as squeezing blood from a stone. Here
148 * is more or less what I know:
149 *
150 * - The Hermes controller is firmware driven, and the host interacts
151 *   with the Hermes via a firmware interface, which can change.
152 *
153 * - The Hermes is described in a document called: "Hermes Firmware
154 *   WaveLAN/IEEE Station Functions," document #010245, which of course
155 *   Lucent will not release without an NDA.
156 *
157 * - Lucent has created a library called HCF (Hardware Control Functions)
158 *   though which it wants developers to interact with the card. The HCF
159 *   is needlessly complex, ill conceived and badly documented. Actually,
160 *   the comments in the HCP code itself aren't bad, but the publicly
161 *   available manual that comes with it is awful, probably due largely to
162 *   the fact that it has been emasculated in order to hide information
163 *   that Lucent wants to keep proprietary. The purpose of the HCF seems
164 *   to be to insulate the driver programmer from the Hermes itself so that
165 *   Lucent has an excuse not to release programming in for it.
166 *
167 * - Lucent only makes available documentation and code for 'HCF Light'
168 *   which is a stripped down version of HCF with certain features not
169 *   implemented, most notably support for 802.11 frames.
170 *
171 * - The HCF code which I have seen blows goats. Whoever decided to
172 *   use a 132 column format should be shot.
173 *
174 * Rather than actually use the Lucent HCF library, I have stripped all
175 * the useful information from it and used it to create a driver in the
176 * usual BSD form. Note: I don't want to hear anybody whining about the
177 * fact that the Lucent code is GPLed and mine isn't. I did not actually
178 * put any of Lucent's code in this driver: I only used it as a reference
179 * to obtain information about the underlying hardware. The Hermes
180 * programming interface is not GPLed, so bite me.
181 */
182
183/*
184 * Size of Hermes & Prism2 I/O space.
185 */
186#define WI_IOSIZ		0x40
187
188/*
189 * Hermes & Prism2 register definitions
190 */
191
192/* Hermes command/status registers. */
193#define WI_COMMAND		0x00
194#define WI_PARAM0		0x02
195#define WI_PARAM1		0x04
196#define WI_PARAM2		0x06
197#define WI_STATUS		0x08
198#define WI_RESP0		0x0A
199#define WI_RESP1		0x0C
200#define WI_RESP2		0x0E
201
202/* Command register values. */
203#define WI_CMD_BUSY		0x8000 /* busy bit */
204#define WI_CMD_INI		0x0000 /* initialize */
205#define WI_CMD_ENABLE		0x0001 /* enable */
206#define WI_CMD_DISABLE		0x0002 /* disable */
207#define WI_CMD_DIAG		0x0003
208#define WI_CMD_ALLOC_MEM	0x000A /* allocate NIC memory */
209#define WI_CMD_TX		0x000B /* transmit */
210#define WI_CMD_NOTIFY		0x0010
211#define WI_CMD_INQUIRE		0x0011
212#define WI_CMD_ACCESS		0x0021
213#define WI_CMD_ACCESS_WRITE	0x0121
214#define WI_CMD_PROGRAM		0x0022
215#define WI_CMD_READEE		0x0030	/* symbol only */
216#define WI_CMD_READMIF		0x0030	/* prism2 */
217#define WI_CMD_WRITEMIF		0x0031	/* prism2 */
218#define WI_CMD_DEBUG		0x0038	/* Various test commands */
219
220#define WI_CMD_CODE_MASK	0x003F
221
222/*
223 * Various cmd test stuff.
224 */
225#define WI_TEST_MONITOR		0x0B
226#define WI_TEST_STOP		0x0F
227#define WI_TEST_CFG_BITS	0x15
228#define WI_TEST_CFG_BIT_ALC	0x08
229
230/*
231 * Reclaim qualifier bit, applicable to the
232 * TX and INQUIRE commands.
233 */
234#define WI_RECLAIM		0x0100 /* reclaim NIC memory */
235
236/*
237 * ACCESS command qualifier bits.
238 */
239#define WI_ACCESS_READ		0x0000
240#define WI_ACCESS_WRITE		0x0100
241
242/*
243 * PROGRAM command qualifier bits.
244 */
245#define WI_PROGRAM_DISABLE	0x0000
246#define WI_PROGRAM_ENABLE_RAM	0x0100
247#define WI_PROGRAM_ENABLE_NVRAM	0x0200
248#define WI_PROGRAM_NVRAM	0x0300
249
250/* Status register values */
251#define WI_STAT_CMD_CODE	0x003F
252#define WI_STAT_DIAG_ERR	0x0100
253#define WI_STAT_INQ_ERR		0x0500
254#define WI_STAT_CMD_RESULT	0x7F00
255
256/* memory handle management registers */
257#define WI_INFO_FID		0x10
258#define WI_RX_FID		0x20
259#define WI_ALLOC_FID		0x22
260#define WI_TX_CMP_FID		0x24
261
262/*
263 * Buffer Access Path (BAP) registers.
264 * These are I/O channels. I believe you can use each one for
265 * any desired purpose independently of the other. In general
266 * though, we use BAP1 for reading and writing LTV records and
267 * reading received data frames, and BAP0 for writing transmit
268 * frames. This is a convention though, not a rule.
269 */
270#define WI_SEL0			0x18
271#define WI_SEL1			0x1A
272#define WI_OFF0			0x1C
273#define WI_OFF1			0x1E
274#define WI_DATA0		0x36
275#define WI_DATA1		0x38
276#define WI_BAP0			WI_DATA0
277#define WI_BAP1			WI_DATA1
278
279#define WI_OFF_BUSY		0x8000
280#define WI_OFF_ERR		0x4000
281#define WI_OFF_DATAOFF		0x0FFF
282
283/* Event registers */
284#define WI_EVENT_STAT		0x30	/* Event status */
285#define WI_INT_EN		0x32	/* Interrupt enable/disable */
286#define WI_EVENT_ACK		0x34	/* Ack event */
287
288/* Events */
289#define WI_EV_TICK		0x8000	/* aux timer tick */
290#define WI_EV_RES		0x4000	/* controller h/w error (time out) */
291#define WI_EV_INFO_DROP		0x2000	/* no RAM to build unsolicited frame */
292#define WI_EV_NO_CARD		0x0800	/* card removed (hunh?) */
293#define WI_EV_DUIF_RX		0x0400	/* wavelan management packet received */
294#define WI_EV_INFO		0x0080	/* async info frame */
295#define WI_EV_CMD		0x0010	/* command completed */
296#define WI_EV_ALLOC		0x0008	/* async alloc/reclaim completed */
297#define WI_EV_TX_EXC		0x0004	/* async xmit completed with failure */
298#define	WI_EV_TX		0x0002	/* async xmit completed successfully */
299#define WI_EV_RX		0x0001	/* async rx completed */
300
301/* Host software registers */
302#define WI_SW0			0x28
303#define WI_SW1			0x2A
304#define WI_SW2			0x2C
305#define WI_SW3			0x2E 	/* does not appear in Prism2 */
306
307#define WI_CNTL			0x14
308
309#define WI_CNTL_AUX_ENA		0xC000
310#define WI_CNTL_AUX_ENA_STAT	0xC000
311#define WI_CNTL_AUX_DIS_STAT	0x0000
312#define WI_CNTL_AUX_ENA_CNTL	0x8000
313#define WI_CNTL_AUX_DIS_CNTL	0x4000
314
315#define WI_AUX_PAGE		0x3A
316#define WI_AUX_OFFSET		0x3C
317#define WI_AUX_DATA		0x3E
318
319#define WI_AUX_PGSZ		128
320#define WI_AUX_KEY0		0xfe01
321#define WI_AUX_KEY1		0xdc23
322#define WI_AUX_KEY2		0xba45
323
324#define WI_COR			0x40	/* only for Symbol */
325#define WI_COR_RESET		0x0080
326#define WI_COR_IOMODE		0x0041
327
328#define WI_HCR			0x42	/* only for Symbol */
329#define WI_HCR_4WIRE		0x0010
330#define WI_HCR_RUN		0x0007
331#define WI_HCR_HOLD		0x000f
332#define WI_HCR_EEHOLD		0x00ce
333
334#define WI_COR_OFFSET	0x3e0	/* OK for PCI, default COR for Prism PC Card */
335#define WI_COR_VALUE	0x41
336
337/*
338 * One form of communication with the Hermes is with what Lucent calls
339 * LTV records, where LTV stands for Length, Type and Value. The length
340 * and type are 16 bits and are in native byte order. The value is in
341 * multiples of 16 bits and is in little endian byte order.
342 */
343struct wi_lt_hdr {
344	u_int16_t		wi_len;
345	u_int16_t		wi_type;
346	/* value is vary depends on resource id */
347};
348
349/*
350 * Download buffer location and length (0xFD01).
351 */
352struct wi_dnld_buf {
353	u_int16_t		wi_buf_pg; /* page addr of intermediate dl buf*/
354	u_int16_t		wi_buf_off; /* offset of idb */
355	u_int16_t		wi_buf_len; /* len of idb */
356};
357
358/*
359 * Mem sizes (0xFD02).
360 */
361struct wi_memsz {
362	u_int16_t		wi_mem_ram;
363	u_int16_t		wi_mem_nvram;
364};
365
366/*
367 * NIC Identification (0xFD0B, 0xFD20)
368 */
369struct wi_ver {
370	u_int16_t		wi_ver[4];
371};
372
373/* define card ident */
374#define	WI_NIC_LUCENT_ID	0x0001
375#define	WI_NIC_LUCENT_STR	"Lucent Technologies, WaveLAN/IEEE"
376
377#define	WI_NIC_SONY_ID		0x0002
378#define	WI_NIC_SONY_STR		"Sony WaveLAN/IEEE"
379
380#define	WI_NIC_LUCENT_EMB_ID	0x0005
381#define	WI_NIC_LUCENT_EMB_STR	"Lucent Embedded WaveLAN/IEEE"
382
383#define	WI_NIC_EVB2_ID		0x8000
384#define	WI_NIC_EVB2_STR		"RF:PRISM2 MAC:HFA3841"
385
386#define	WI_NIC_HWB3763_ID	0x8001
387#define	WI_NIC_HWB3763_STR	"RF:PRISM2 MAC:HFA3841 CARD:HWB3763 rev.B"
388
389#define	WI_NIC_HWB3163_ID	0x8002
390#define	WI_NIC_HWB3163_STR	"RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.A"
391
392#define	WI_NIC_HWB3163B_ID	0x8003
393#define	WI_NIC_HWB3163B_STR	"RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.B"
394
395#define	WI_NIC_EVB3_ID		0x8004
396#define	WI_NIC_EVB3_STR		"RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
397
398#define	WI_NIC_HWB1153_ID	0x8007
399#define	WI_NIC_HWB1153_STR	"RF:PRISM1 MAC:HFA3841 CARD:HWB1153"
400
401#define	WI_NIC_P2_SST_ID	0x8008	/* Prism2 with SST flush */
402#define	WI_NIC_P2_SST_STR	"RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
403
404#define	WI_NIC_EVB2_SST_ID	0x8009
405#define	WI_NIC_EVB2_SST_STR	"RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
406
407#define	WI_NIC_3842_EVA_ID	0x800A	/* 3842 Evaluation Board */
408#define	WI_NIC_3842_EVA_STR	"RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
409
410#define	WI_NIC_3842_PCMCIA_AMD_ID	0x800B	/* Prism2.5 PCMCIA */
411#define	WI_NIC_3842_PCMCIA_SST_ID	0x800C
412#define	WI_NIC_3842_PCMCIA_ATL_ID	0x800D
413#define	WI_NIC_3842_PCMCIA_ATS_ID	0x800E
414#define	WI_NIC_3842_PCMCIA_STR		"RF:PRISM2.5 MAC:ISL3873"
415
416#define	WI_NIC_3842_MINI_AMD_ID		0x8012	/* Prism2.5 Mini-PCI */
417#define	WI_NIC_3842_MINI_SST_ID		0x8013
418#define	WI_NIC_3842_MINI_ATL_ID		0x8014
419#define	WI_NIC_3842_MINI_ATS_ID		0x8015
420#define	WI_NIC_3842_MINI_STR		"RF:PRISM2.5 MAC:ISL3874A(Mini-PCI)"
421
422#define	WI_NIC_3842_PCI_AMD_ID		0x8016	/* Prism2.5 PCI-bridge */
423#define	WI_NIC_3842_PCI_SST_ID		0x8017
424#define	WI_NIC_3842_PCI_ATL_ID		0x8018
425#define	WI_NIC_3842_PCI_ATS_ID		0x8019
426#define	WI_NIC_3842_PCI_STR		"RF:PRISM2.5 MAC:ISL3874A(PCI-bridge)"
427
428#define	WI_NIC_P3_PCMCIA_AMD_ID		0x801A	/* Prism3 PCMCIA */
429#define	WI_NIC_P3_PCMCIA_SST_ID		0x801B
430#define	WI_NIC_P3_PCMCIA_ATL_ID		0x801C
431#define	WI_NIC_P3_PCMCIA_ATS_ID		0x801D
432#define	WI_NIC_P3_PCMCIA_STR		"RF:PRISM3(PCMCIA)"
433
434#define WI_NIC_P3_USB_AMD_ID		0x801E
435#define WI_NIC_P3_USB_SST_ID		0x801F
436#define	WI_NIC_P3_USB_ATL_ID		0x8020
437
438#define	WI_NIC_P3_MINI_AMD_ID		0x8021	/* Prism3 Mini-PCI */
439#define	WI_NIC_P3_MINI_SST_ID		0x8022
440#define	WI_NIC_P3_MINI_ATL_ID		0x8023
441#define	WI_NIC_P3_MINI_ATS_ID		0x8024
442#define	WI_NIC_P3_MINI_STR		"RF:PRISM3(Mini-PCI)"
443
444/*
445 * List of intended regulatory domains (0xFD11).
446 */
447struct wi_ltv_domains {
448	u_int16_t		wi_len;
449	u_int16_t		wi_type;
450	u_int16_t		wi_num_dom;
451	u_int8_t		wi_domains[10];
452};
453
454/*
455 * CIS struct (0xFD13).
456 */
457struct wi_cis {
458	u_int16_t		wi_cis[240];
459};
460
461/*
462 * Communications quality (0xFD43).
463 */
464struct wi_commqual {
465	u_int16_t		wi_coms_qual;
466	u_int16_t		wi_sig_lvl;
467	u_int16_t		wi_noise_lvl;
468};
469
470/*
471 * Actual system scale thresholds (0xFC06, 0xFD46).
472 */
473struct wi_scalethresh {
474	u_int16_t		wi_energy_detect;
475	u_int16_t		wi_carrier_detect;
476	u_int16_t		wi_defer;
477	u_int16_t		wi_cell_search;
478	u_int16_t		wi_out_of_range;
479	u_int16_t		wi_delta_snr;
480};
481
482/*
483 * PCF info struct (0xFD87).
484 */
485struct wi_pcf {
486	u_int16_t		wi_medium_occupancy_limit;
487	u_int16_t		wi_cfp_period;
488	u_int16_t		wi_cfp_max_duration;
489};
490
491/*
492 * Connection control characteristics. (0xFC00)
493 * 0 == IBSS (802.11 compliant mode) (Only PRISM2)
494 * 1 == Basic Service Set (BSS)
495 * 2 == Wireless Distribudion System (WDS)
496 * 3 == Pseudo IBSS
497 *	(Only PRISM2; not 802.11 compliant mode, testing use only)
498 * 6 == HOST AP (Only PRISM2)
499 */
500#define	WI_PORTTYPE_IBSS	0x0
501#define WI_PORTTYPE_BSS		0x1
502#define WI_PORTTYPE_WDS		0x2
503#define WI_PORTTYPE_ADHOC	0x3
504#define WI_PORTTYPE_APSILENT	0x5
505#define	WI_PORTTYPE_HOSTAP	0x6
506
507/*
508 * Mac addresses. (0xFC01, 0xFC08)
509 */
510struct wi_macaddr {
511	u_int8_t		wi_mac_addr[6];
512};
513
514/*
515 * Station set identification (SSID). (0xFC02, 0xFC04)
516 */
517struct wi_ssid {
518	u_int16_t		wi_len;
519	u_int8_t		wi_ssid[32];
520};
521
522/*
523 * Set our station name. (0xFC0E)
524 */
525struct wi_nodename {
526	u_int16_t		wi_nodelen;
527	u_int8_t		wi_nodename[32];
528};
529
530/*
531 * Multicast addresses to be put in filter. We're
532 * allowed up to 16 addresses in the filter. (0xFC80)
533 */
534struct wi_mcast {
535	struct ether_addr	wi_mcast[16];
536};
537
538/*
539 * Join request. (0xFCE2)
540 */
541struct wi_joinreq {
542	struct ether_addr	wi_bssid;
543	u_int16_t		wi_chan;
544};
545
546/*
547 * supported rates. (0xFCB4)
548 */
549#define WI_SUPPRATES_1M		0x0001
550#define WI_SUPPRATES_2M		0x0002
551#define WI_SUPPRATES_5M		0x0004
552#define WI_SUPPRATES_11M	0x0008
553#define	WI_RATES_BITS	"\20\0011M\0022M\0035.5M\00411M"
554
555/*
556 * Information frame types.
557 */
558#define WI_INFO_NOTIFY		0xF000	/* Handover address */
559#define WI_INFO_COUNTERS	0xF100	/* Statistics counters */
560#define WI_INFO_SCAN_RESULTS	0xF101	/* Scan results */
561#define WI_INFO_HOST_SCAN_RESULTS	0xF104	/* Scan results */
562#define WI_INFO_LINK_STAT	0xF200	/* Link status */
563#define	WI_INFO_LINK_STAT_CONNECTED	1
564#define	WI_INFO_LINK_STAT_DISCONNECTED	2
565#define	WI_INFO_LINK_STAT_AP_CHG	3	/* AP Change */
566#define	WI_INFO_LINK_STAT_AP_OOR	4	/* AP Out Of Range */
567#define	WI_INFO_LINK_STAT_AP_INR	5	/* AP In Range */
568#define	WI_INFO_LINK_STAT_ASSOC_FAILED	6
569#define WI_INFO_ASSOC_STAT	0xF201	/* Association status */
570#define	WI_INFO_AUTH_REQUEST	0xF202	/* Authentication Request (AP) */
571#define	WI_INFO_POWERSAVE_COUNT	0xF203	/* PowerSave User Count (AP) */
572
573struct wi_assoc {
574	u_int16_t		wi_assoc_stat;	/* Association Status */
575#define	ASSOC		1
576#define	REASSOC		2
577#define	DISASSOC	3
578#define	ASSOCFAIL	4
579#define	AUTHFAIL	5
580	u_int8_t		wi_assoc_sta[6];	/* Station Address */
581	u_int8_t		wi_assoc_osta[6];	/* OLD Station Address */
582	u_int16_t		wi_assoc_reason;	/* Reason */
583	u_int16_t		wi_assoc_reserve;	/* Reserved */
584};
585
586/*
587 * Scan Results of Prism2 chip
588 */
589
590struct wi_scan_header {
591	u_int16_t		wi_reserve;	/* future use */
592	u_int16_t		wi_reason;	/* The reason this scan was initiated
593						   1: Host initiated
594						   2: Firmware initiated
595						   3: Inquiry request from host */
596};
597
598struct wi_scan_data_p2 {
599	u_int16_t		wi_chid;	/* BSS Channel ID from Probe Res.(PR)*/
600	u_int16_t		wi_noise;	/* Average Noise Level of the PR */
601	u_int16_t		wi_signal;	/* Signal Level on the PR */
602	u_int8_t		wi_bssid[6];	/* MACaddress of BSS responder from PR */
603	u_int16_t		wi_interval;	/* BSS beacon interval */
604	u_int16_t		wi_capinfo;	/* BSS Capability Information
605						   IEEE Std 802.11(1997) ,see 7.3.1.4 */
606	u_int16_t		wi_namelen;	/* Length of SSID strings */
607	u_int8_t		wi_name[32];	/* SSID strings */
608	u_int16_t		wi_suprate[5];	/* Supported Rates element from the PR
609						   IEEE Std 802.11(1997) ,see 7.3.2.2 */
610	u_int16_t		wi_rate;	/* Data rate of the PR */
611#define	WI_APRATE_1		0x0A		/* 1 Mbps */
612#define	WI_APRATE_2		0x14		/* 2 Mbps */
613#define	WI_APRATE_5		0x37		/* 5.5 Mbps */
614#define	WI_APRATE_11		0x6E		/* 11 Mbps */
615};
616
617/*
618 * Scan Results of Lucent chip
619 */
620struct wi_scan_data {
621	u_int16_t		wi_chid;	/* BSS Channel ID from PR */
622	u_int16_t		wi_noise;	/* Average Noise Level of the PR */
623	u_int16_t		wi_signal;	/* Signal Level on the PR */
624	u_int8_t		wi_bssid[6];	/* MACaddress of BSS responder from PR */
625	u_int16_t		wi_interval;	/* BSS beacon interval */
626	u_int16_t		wi_capinfo;	/* BSS Capability Information
627						   IEEE Std 802.11(1997) ,see 7.3.1.4 */
628	u_int16_t		wi_namelen;	/* Length of SSID strings */
629	u_int8_t		wi_name[32];	/* SSID strings */
630};
631
632/*
633 * transmit/receive frame structure
634 */
635struct wi_frame {
636	u_int16_t		wi_status;	/* 0x00 */
637	u_int16_t		wi_rx_tstamp1;	/* 0x02 */
638	u_int16_t		wi_rx_tstamp0;	/* 0x04 */
639	u_int8_t		wi_rx_silence;	/* 0x06 */
640	u_int8_t		wi_rx_signal;	/* 0x07 */
641	u_int8_t		wi_rx_rate;	/* 0x08 */
642	u_int8_t		wi_rx_flow;	/* 0x09 */
643	u_int8_t		wi_tx_rtry;	/* 0x0a */ /* Prism2 AP Only */
644	u_int8_t		wi_tx_rate;	/* 0x0b */ /* Prism2 AP Only */
645	u_int16_t		wi_tx_ctl;	/* 0x0c */
646	struct ieee80211_frame_addr4 wi_whdr;	/* 0x0e */
647	u_int16_t		wi_dat_len;	/* 0x2c */
648	struct ether_header	wi_ehdr;	/* 0x2e */
649} __attribute__((__packed__));
650
651/* Tx Status Field */
652#define	WI_TXSTAT_RET_ERR	0x0001
653#define	WI_TXSTAT_AGED_ERR	0x0002
654#define	WI_TXSTAT_DISCONNECT	0x0004
655#define	WI_TXSTAT_FORM_ERR	0x0008
656
657/* Rx Status Field */
658#define WI_STAT_BADCRC		0x0001
659#define WI_STAT_UNDECRYPTABLE	0x0002
660#define WI_STAT_ERRSTAT		0x0003
661#define WI_STAT_MAC_PORT	0x0700
662#define	WI_STAT_PCF		0x1000
663#define WI_RXSTAT_MSG_TYPE	0xE000
664#define  WI_STAT_1042		0x2000	/* RFC1042 encoded */
665#define  WI_STAT_TUNNEL		0x4000	/* Bridge-tunnel encoded */
666#define  WI_STAT_WMP_MSG	0x6000	/* WaveLAN-II management protocol */
667#define	 WI_STAT_MGMT		0x8000	/* 802.11b management frames */
668
669#define WI_ENC_TX_E_II		0x0E
670
671#define WI_ENC_TX_1042		0x00
672#define WI_ENC_TX_TUNNEL	0xF8
673
674/* TxControl Field (enhanced) */
675#define	WI_TXCNTL_TX_OK		0x0002
676#define	WI_TXCNTL_TX_EX		0x0004
677#define	WI_TXCNTL_STRUCT_TYPE	0x0018
678#define	 WI_ENC_TX_802_3	0x00
679#define	 WI_ENC_TX_802_11	0x08
680#define	WI_TXCNTL_ALTRTRY	0x0020
681#define	WI_TXCNTL_NOCRYPT	0x0080
682
683/*
684 * HFA3861/3863 (BBP) Control Registers
685 */
686#define WI_HFA386X_CR_A_D_TEST_MODES2 0x1A
687#define WI_HFA386X_CR_MANUAL_TX_POWER 0x3E
688
689#ifdef IEEE80211_RADIOTAP_F_CFP
690/*
691 * Radio capture format for Prism.
692 */
693#define WI_RX_RADIOTAP_PRESENT \
694	((1 << IEEE80211_RADIOTAP_TSFT) | \
695	 (1 << IEEE80211_RADIOTAP_FLAGS) | \
696	 (1 << IEEE80211_RADIOTAP_RATE) | \
697	 (1 << IEEE80211_RADIOTAP_CHANNEL) | \
698	 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) | \
699	 (1 << IEEE80211_RADIOTAP_DB_ANTNOISE))
700
701struct wi_rx_radiotap_header {
702	struct ieee80211_radiotap_header wr_ihdr;
703	u_int64_t	wr_tsf;
704	u_int8_t	wr_flags;
705	u_int8_t	wr_rate;
706	u_int16_t	wr_chan_freq;
707	u_int16_t	wr_chan_flags;
708	u_int8_t	wr_antsignal;
709	u_int8_t	wr_antnoise;
710} __packed __aligned(8);
711
712#define WI_TX_RADIOTAP_PRESENT \
713	((1 << IEEE80211_RADIOTAP_FLAGS) | \
714	 (1 << IEEE80211_RADIOTAP_RATE) | \
715	 (1 << IEEE80211_RADIOTAP_CHANNEL))
716
717struct wi_tx_radiotap_header {
718	struct ieee80211_radiotap_header wt_ihdr;
719	u_int8_t	wt_flags;
720	u_int8_t	wt_rate;
721	u_int16_t	wt_chan_freq;
722	u_int16_t	wt_chan_flags;
723} __packed;
724#endif /* IEEE80211_RADIOTAP_F_CFP */
725