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