Home | History | Annotate | Line # | Download | only in ic
wireg.h revision 1.11
      1 /*	$NetBSD: wireg.h,v 1.11 2001/10/13 15:00:23 ichiro Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1997, 1998, 1999
      5  *	Bill Paul <wpaul (at) 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 
     35 /*
     36  * FreeBSD driver ported to NetBSD by Bill Sommerfeld in the back of the
     37  * Oslo IETF plenary meeting.
     38  */
     39 
     40 #define WI_TIMEOUT	65536
     41 
     42 #define WI_PORT0	0
     43 #define WI_PORT1	1
     44 #define WI_PORT2	2
     45 #define WI_PORT3	3
     46 #define WI_PORT4	4
     47 #define WI_PORT5	5
     48 
     49 /* Default port: 0 (only 0 exists on stations) */
     50 #define WI_DEFAULT_PORT	(WI_PORT0 << 8)
     51 
     52 /* Default TX rate: 2Mbps, auto fallback */
     53 #define WI_DEFAULT_TX_RATE	3
     54 
     55 /* Default network name: ANY */
     56 /*
     57  * [sommerfeld 1999/07/15] Changed from "ANY" to ""; according to Bill Fenner,
     58  * ANY is used in MS driver user interfaces, while "" is used over the
     59  * wire..
     60  */
     61 #define WI_DEFAULT_NETNAME	""
     62 
     63 #define WI_DEFAULT_AP_DENSITY	1
     64 
     65 #define WI_DEFAULT_RTS_THRESH	2347
     66 
     67 #define WI_DEFAULT_DATALEN	2304
     68 
     69 #define WI_DEFAULT_CREATE_IBSS	0
     70 
     71 #define WI_DEFAULT_PM_ENABLED	0
     72 
     73 #define WI_DEFAULT_MAX_SLEEP	100
     74 
     75 #define WI_DEFAULT_ROAMING	1
     76 
     77 #define WI_DEFAULT_AUTHTYPE	1
     78 
     79 #ifdef __NetBSD__
     80 #define OS_STRING_NAME	"NetBSD"
     81 #endif
     82 #ifdef __FreeBSD__
     83 #define OS_STRING_NAME	"FreeBSD"
     84 #endif
     85 #ifdef __OpenBSD__
     86 #define OS_STRING_NAME	"OpenBSD"
     87 #endif
     88 
     89 #define WI_DEFAULT_NODENAME	OS_STRING_NAME " WaveLAN/IEEE node"
     90 
     91 #define WI_DEFAULT_IBSS		OS_STRING_NAME " IBSS"
     92 
     93 #define WI_DEFAULT_CHAN		3
     94 
     95 /*
     96  * register space access macros
     97  */
     98 #define CSR_WRITE_4(sc, reg, val)	\
     99 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,	\
    100 			(sc->sc_pci? reg * 2: reg) , val)
    101 #define CSR_WRITE_2(sc, reg, val)	\
    102 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,	\
    103 			(sc->sc_pci? reg * 2: reg), val)
    104 #define CSR_WRITE_1(sc, reg, val)	\
    105 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,	\
    106 			(sc->sc_pci? reg * 2: reg), val)
    107 
    108 #define CSR_READ_4(sc, reg)		\
    109 	bus_space_read_4(sc->sc_iot, sc->sc_ioh,	\
    110 			(sc->sc_pci? reg * 2: reg))
    111 #define CSR_READ_2(sc, reg)		\
    112 	bus_space_read_2(sc->sc_iot, sc->sc_ioh,	\
    113 			(sc->sc_pci? reg * 2: reg))
    114 #define CSR_READ_1(sc, reg)		\
    115 	bus_space_read_1(sc->sc_iot, sc->sc_ioh,	\
    116 			(sc->sc_pci? reg * 2: reg))
    117 
    118 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
    119 #define bus_space_write_stream_2	bus_space_write_2
    120 #define bus_space_write_multi_stream_2	bus_space_write_multi_2
    121 #define bus_space_read_stream_2		bus_space_read_2
    122 #define bus_space_read_multi_stream_2		bus_space_read_multi_2
    123 #endif
    124 
    125 #define CSR_WRITE_STREAM_2(sc, reg, val)	\
    126 	bus_space_write_stream_2(sc->sc_iot, sc->sc_ioh,	\
    127 			(sc->sc_pci? reg * 2: reg), val)
    128 #define CSR_WRITE_MULTI_STREAM_2(sc, reg, val, count)	\
    129 	bus_space_write_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
    130 			(sc->sc_pci? reg * 2: reg), val, count)
    131 #define CSR_READ_STREAM_2(sc, reg)		\
    132 	bus_space_read_stream_2(sc->sc_iot, sc->sc_ioh,	\
    133 			(sc->sc_pci? reg * 2: reg))
    134 #define CSR_READ_MULTI_STREAM_2(sc, reg, buf, count)		\
    135 	bus_space_read_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
    136 			(sc->sc_pci? reg * 2: reg), buf, count)
    137 
    138 /*
    139  * The WaveLAN/IEEE cards contain an 802.11 MAC controller which Lucent
    140  * calls 'Hermes.' In typical fashion, getting documentation about this
    141  * controller is about as easy as squeezing blood from a stone. Here
    142  * is more or less what I know:
    143  *
    144  * - The Hermes controller is firmware driven, and the host interacts
    145  *   with the Hermes via a firmware interface, which can change.
    146  *
    147  * - The Hermes is described in a document called: "Hermes Firmware
    148  *   WaveLAN/IEEE Station Functions," document #010245, which of course
    149  *   Lucent will not release without an NDA.
    150  *
    151  * - Lucent has created a library called HCF (Hardware Control Functions)
    152  *   though which it wants developers to interact with the card. The HCF
    153  *   is needlessly complex, ill conceived and badly documented. Actually,
    154  *   the comments in the HCP code itself aren't bad, but the publically
    155  *   available manual that comes with it is awful, probably due largely to
    156  *   the fact that it has been emasculated in order to hide information
    157  *   that Lucent wants to keep proprietary. The purpose of the HCF seems
    158  *   to be to insulate the driver programmer from the Hermes itself so that
    159  *   Lucent has an excuse not to release programming in for it.
    160  *
    161  * - Lucent only makes available documentation and code for 'HCF Light'
    162  *   which is a stripped down version of HCF with certain features not
    163  *   implemented, most notably support for 802.11 frames.
    164  *
    165  * - The HCF code which I have seen blows goats. Whoever decided to
    166  *   use a 132 column format should be shot.
    167  *
    168  * Rather than actually use the Lucent HCF library, I have stripped all
    169  * the useful information from it and used it to create a driver in the
    170  * usual BSD form. Note: I don't want to hear anybody whining about the
    171  * fact that the Lucent code is GPLed and mine isn't. I did not actually
    172  * put any of Lucent's code in this driver: I only used it as a reference
    173  * to obtain information about the underlying hardware. The Hermes
    174  * programming interface is not GPLed, so bite me.
    175  */
    176 
    177 /*
    178  * Size of Hermes & Prism2 I/O space.
    179  */
    180 #define WI_IOSIZE		0x40
    181 #define WI_PCI_CBMA		0x10	/* Configuration Base Memory Address */
    182 
    183 /*
    184  * Hermes & Prism2 register definitions
    185  */
    186 
    187 /* Hermes command/status registers. */
    188 #define WI_COMMAND		0x00
    189 #define WI_PARAM0		0x02
    190 #define WI_PARAM1		0x04
    191 #define WI_PARAM2		0x06
    192 #define WI_STATUS		0x08
    193 #define WI_RESP0		0x0A
    194 #define WI_RESP1		0x0C
    195 #define WI_RESP2		0x0E
    196 
    197 /* Command register values. */
    198 #define WI_CMD_BUSY		0x8000 /* busy bit */
    199 #define WI_CMD_INI		0x0000 /* initialize */
    200 #define WI_CMD_ENABLE		0x0001 /* enable */
    201 #define WI_CMD_DISABLE		0x0002 /* disable */
    202 #define WI_CMD_DIAG		0x0003
    203 #define WI_CMD_ALLOC_MEM	0x000A /* allocate NIC memory */
    204 #define WI_CMD_TX		0x000B /* transmit */
    205 #define WI_CMD_NOTIFY		0x0010
    206 #define WI_CMD_INQUIRE		0x0011
    207 #define WI_CMD_ACCESS		0x0021
    208 #define WI_CMD_PROGRAM		0x0022
    209 #define WI_CMD_READMIF		0x0030 /* prism2 only? */
    210 #define WI_CMD_WRITEMIF		0x0031 /* prism2 only? */
    211 #define WI_CMD_TEST		0x0038 /* prism2 only? */
    212 
    213 #define WI_CMD_CODE_MASK	0x003F
    214 
    215 /*
    216  * prism2 test mode commands
    217  */
    218 #define WI_TEST_MONITOR		0x000b
    219 #define WI_TEST_STOP		0x000f
    220 
    221 /*
    222  * Reclaim qualifier bit, applicable to the
    223  * TX and INQUIRE commands.
    224  */
    225 #define WI_RECLAIM		0x0100 /* reclaim NIC memory */
    226 
    227 /*
    228  * ACCESS command qualifier bits.
    229  */
    230 #define WI_ACCESS_READ		0x0000
    231 #define WI_ACCESS_WRITE		0x0100
    232 
    233 /*
    234  * PROGRAM command qualifier bits.
    235  */
    236 #define WI_PROGRAM_DISABLE	0x0000
    237 #define WI_PROGRAM_ENABLE_RAM	0x0100
    238 #define WI_PROGRAM_ENABLE_NVRAM	0x0200
    239 #define WI_PROGRAM_NVRAM	0x0300
    240 
    241 /* Status register values */
    242 #define WI_STAT_CMD_CODE	0x003F
    243 #define WI_STAT_DIAG_ERR	0x0100
    244 #define WI_STAT_INQ_ERR		0x0500
    245 #define WI_STAT_CMD_RESULT	0x7F00
    246 
    247 /* memory handle management registers */
    248 #define WI_INFO_FID		0x10
    249 #define WI_RX_FID		0x20
    250 #define WI_ALLOC_FID		0x22
    251 #define WI_TX_CMP_FID		0x24
    252 
    253 /*
    254  * Buffer Access Path (BAP) registers.
    255  * These are I/O channels. I believe you can use each one for
    256  * any desired purpose independently of the other. In general
    257  * though, we use BAP1 for reading and writing LTV records and
    258  * reading received data frames, and BAP0 for writing transmit
    259  * frames. This is a convention though, not a rule.
    260  */
    261 #define WI_SEL0			0x18
    262 #define WI_SEL1			0x1A
    263 #define WI_OFF0			0x1C
    264 #define WI_OFF1			0x1E
    265 #define WI_DATA0		0x36
    266 #define WI_DATA1		0x38
    267 #define WI_BAP0			WI_DATA0
    268 #define WI_BAP1			WI_DATA1
    269 
    270 #define WI_OFF_BUSY		0x8000
    271 #define WI_OFF_ERR		0x4000
    272 #define WI_OFF_DATAOFF		0x0FFF
    273 
    274 /* Event registers */
    275 #define WI_EVENT_STAT		0x30	/* Event status */
    276 #define WI_INT_EN		0x32	/* Interrupt enable/disable */
    277 #define WI_EVENT_ACK		0x34	/* Ack event */
    278 
    279 /* Events */
    280 #define WI_EV_TICK		0x8000	/* aux timer tick */
    281 #define WI_EV_RES		0x4000	/* controller h/w error (time out) */
    282 #define WI_EV_INFO_DROP		0x2000	/* no RAM to build unsolicited frame */
    283 #define WI_EV_NO_CARD		0x0800	/* card removed (hunh?) */
    284 #define WI_EV_AWAKE		0x0100
    285 #define WI_EV_INFO		0x0080	/* async info frame */
    286 #define WI_EV_CMD		0x0010	/* command completed */
    287 #define WI_EV_ALLOC		0x0008	/* async alloc/reclaim completed */
    288 #define WI_EV_TX_EXC		0x0004	/* async xmit completed with failure */
    289 #define WI_EV_TX		0x0002	/* async xmit completed succesfully */
    290 #define WI_EV_RX		0x0001	/* async rx completed */
    291 
    292 #define WI_INTRS	\
    293 	(WI_EV_RX|WI_EV_TX|WI_EV_TX_EXC|WI_EV_ALLOC|WI_EV_INFO|WI_EV_INFO_DROP)
    294 
    295 /* Host software registers */
    296 #define WI_SW0			0x28
    297 #define WI_SW1			0x2A
    298 #define WI_SW2			0x2C
    299 #define WI_SW3			0x2E 	/* does not appear in Prism2 */
    300 
    301 #define WI_CNTL			0x14
    302 
    303 #define WI_CNTL_AUX_ENA		0xC000
    304 #define WI_CNTL_AUX_ENA_STAT	0xC000
    305 #define WI_CNTL_AUX_DIS_STAT	0x0000
    306 #define WI_CNTL_AUX_ENA_CNTL	0x8000
    307 #define WI_CNTL_AUX_DIS_CNTL	0x4000
    308 
    309 #define WI_AUX_PAGE		0x3A
    310 #define WI_AUX_OFFSET		0x3C
    311 #define WI_AUX_DATA		0x3E
    312 
    313 /*
    314  * PCI Host Interface Registers (HFA3842 Specific)
    315  * The value of all Register's Offset, such as WI_INFO_FID and WI_PARAM0,
    316  * has doubled.
    317  */
    318 #define WI_PCI_COR		0x4C
    319 #define WI_PCI_HCR		0x5C
    320 #define WI_PCI_MASTER0_ADDRH	0x80
    321 #define WI_PCI_MASTER0_ADDRL	0x84
    322 #define WI_PCI_MASTER0_LEN	0x88
    323 #define WI_PCI_MASTER0_CON	0x8C
    324 
    325 #define WI_PCI_STATUS		0x98
    326 
    327 #define WI_PCI_MASTER1_ADDRH	0xA0
    328 #define WI_PCI_MASTER1_ADDRL	0xA4
    329 #define WI_PCI_MASTER1_LEN	0xA8
    330 #define WI_PCI_MASTER1_CON	0xAC
    331 
    332 /*
    333  * One form of communication with the Hermes is with what Lucent calls
    334  * LTV records, where LTV stands for Length, Type and Value. The length
    335  * and type are 16 bits and are in native byte order. The value is in
    336  * multiples of 16 bits and is in little endian byte order.
    337  */
    338 struct wi_ltv_gen {
    339 	u_int16_t		wi_len;
    340 	u_int16_t		wi_type;
    341 	u_int16_t		wi_val;
    342 };
    343 
    344 struct wi_ltv_str {
    345 	u_int16_t		wi_len;
    346 	u_int16_t		wi_type;
    347 	u_int16_t		wi_str[17];
    348 };
    349 
    350 #define WI_SETVAL(recno, val)			\
    351 	do {					\
    352 		struct wi_ltv_gen	g;	\
    353 						\
    354 		g.wi_len = 2;			\
    355 		g.wi_type = recno;		\
    356 		g.wi_val = htole16(val);	\
    357 		wi_write_record(sc, &g);	\
    358 	} while (0)
    359 
    360 #define WI_SETSTR(recno, str)					\
    361 	do {							\
    362 		struct wi_ltv_str	s;			\
    363 		int			l;			\
    364 								\
    365 		l = (strlen(str) + 1) & ~0x1;			\
    366 		memset((char *)&s, 0, sizeof(s));		\
    367 		s.wi_len = (l / 2) + 2;				\
    368 		s.wi_type = recno;				\
    369 		s.wi_str[0] = htole16(strlen(str));		\
    370 		memcpy((char *)&s.wi_str[1], str, strlen(str));	\
    371 		wi_write_record(sc, (struct wi_ltv_gen *)&s);	\
    372 	} while (0)
    373 
    374 /*
    375  * Download buffer location and length (0xFD01).
    376  */
    377 #define WI_RID_DNLD_BUF		0xFD01
    378 struct wi_ltv_dnld_buf {
    379 	u_int16_t		wi_len;
    380 	u_int16_t		wi_type;
    381 	u_int16_t		wi_buf_pg; /* page addr of intermediate dl buf*/
    382 	u_int16_t		wi_buf_off; /* offset of idb */
    383 	u_int16_t		wi_buf_len; /* len of idb */
    384 };
    385 
    386 /*
    387  * Mem sizes (0xFD02).
    388  */
    389 #define WI_RID_MEMSZ		0xFD02
    390 struct wi_ltv_memsz {
    391 	u_int16_t		wi_len;
    392 	u_int16_t		wi_type;
    393 	u_int16_t		wi_mem_ram;
    394 	u_int16_t		wi_mem_nvram;
    395 };
    396 
    397 /*
    398  * NIC Identification (0xFD0B)
    399  */
    400 #define WI_RID_CARDID		0xFD0B
    401 #define WI_RID_IDENT		0xFD20
    402 struct wi_ltv_ver {
    403 	u_int16_t		wi_len;
    404 	u_int16_t		wi_type;
    405 	u_int16_t		wi_ver[4];
    406 #define WI_NIC_EVB2	0x8000
    407 #define WI_NIC_HWB3763	0x8001
    408 #define WI_NIC_HWB3163	0x8002
    409 #define WI_NIC_HWB3163B	0x8003
    410 #define WI_NIC_EVB3	0x8004
    411 #define WI_NIC_HWB1153	0x8007
    412 #define WI_NIC_P2_SST	0x8008	/* Prism2 with SST flush */
    413 #define WI_NIC_PRISM2_5	0x800C
    414 #define WI_NIC_3874A	0x8013	/* Prism2.5 Mini-PCI */
    415 };
    416 
    417 /*
    418  * List of intended regulatory domains (0xFD11).
    419  */
    420 #define WI_RID_DOMAINS		0xFD11
    421 struct wi_ltv_domains {
    422 	u_int16_t		wi_len;
    423 	u_int16_t		wi_type;
    424 	u_int16_t		wi_domains[6];
    425 };
    426 
    427 /*
    428  * CIS struct (0xFD13).
    429  */
    430 #define WI_RID_CIS		0xFD13
    431 struct wi_ltv_cis {
    432 	u_int16_t		wi_len;
    433 	u_int16_t		wi_type;
    434 	u_int16_t		wi_cis[240];
    435 };
    436 
    437 /*
    438  * Communications quality (0xFD43).
    439  */
    440 #define WI_RID_COMMQUAL		0xFD43
    441 struct wi_ltv_commqual {
    442 	u_int16_t		wi_len;
    443 	u_int16_t		wi_type;
    444 	u_int16_t		wi_coms_qual;
    445 	u_int16_t		wi_sig_lvl;
    446 	u_int16_t		wi_noise_lvl;
    447 };
    448 
    449 /*
    450  * Actual system scale thresholds (0xFD46).
    451  */
    452 #define WI_RID_SYSTEM_SCALE	0xFC06
    453 #define WI_RID_SCALETHRESH	0xFD46
    454 struct wi_ltv_scalethresh {
    455 	u_int16_t		wi_len;
    456 	u_int16_t		wi_type;
    457 	u_int16_t		wi_energy_detect;
    458 	u_int16_t		wi_carrier_detect;
    459 	u_int16_t		wi_defer;
    460 	u_int16_t		wi_cell_search;
    461 	u_int16_t		wi_out_of_range;
    462 	u_int16_t		wi_delta_snr;
    463 };
    464 
    465 /*
    466  * PCF info struct (0xFD87).
    467  */
    468 #define WI_RID_PCF		0xFD87
    469 struct wi_ltv_pcf {
    470 	u_int16_t		wi_len;
    471 	u_int16_t		wi_type;
    472 	u_int16_t		wi_medium_occupancy_limit;
    473 	u_int16_t		wi_cfp_period;
    474 	u_int16_t		wi_cfp_max_duration;
    475 };
    476 
    477 /*
    478  * Connection control characteristics.
    479  * 1 == Basic Service Set (BSS)
    480  * 2 == Wireless Distribudion System (WDS)
    481  * 3 == Pseudo IBSS
    482  */
    483 #define WI_RID_PORTTYPE		0xFC00
    484 #define WI_PORTTYPE_BSS		0x1
    485 #define WI_PORTTYPE_WDS		0x2
    486 #define WI_PORTTYPE_ADHOC	0x3
    487 
    488 /*
    489  * Mac addresses.
    490  */
    491 #define WI_RID_MAC_NODE		0xFC01
    492 #define WI_RID_MAC_WDS		0xFC08
    493 struct wi_ltv_macaddr {
    494 	u_int16_t		wi_len;
    495 	u_int16_t		wi_type;
    496 	u_int8_t		wi_mac_addr[6];
    497 };
    498 
    499 /*
    500  * Station set identification (SSID).
    501  */
    502 #define WI_RID_DESIRED_SSID	0xFC02
    503 #define WI_RID_OWN_SSID		0xFC04
    504 struct wi_ltv_ssid {
    505 	u_int16_t		wi_len;
    506 	u_int16_t		wi_type;
    507 	u_int16_t		wi_id[17];
    508 };
    509 
    510 /*
    511  * Set communications channel (radio frequency).
    512  */
    513 #define WI_RID_OWN_CHNL		0xFC03
    514 
    515 /*
    516  * Frame data size.
    517  */
    518 #define WI_RID_MAX_DATALEN	0xFC07
    519 
    520 /*
    521  * ESS power management enable
    522  */
    523 #define WI_RID_PM_ENABLED	0xFC09
    524 
    525 /*
    526  * ESS max PM sleep internal
    527  */
    528 #define WI_RID_MAX_SLEEP	0xFC0C
    529 
    530 /*
    531  * Set our station name.
    532  */
    533 #define WI_RID_NODENAME		0xFC0E
    534 struct wi_ltv_nodename {
    535 	u_int16_t		wi_len;
    536 	u_int16_t		wi_type;
    537 	u_int16_t		wi_nodename[17];
    538 };
    539 
    540 /*
    541  * Multicast addresses to be put in filter. We're
    542  * allowed up to 16 addresses in the filter.
    543  */
    544 #define WI_RID_MCAST		0xFC80
    545 struct wi_ltv_mcast {
    546 	u_int16_t		wi_len;
    547 	u_int16_t		wi_type;
    548 	struct ether_addr	wi_mcast[16];
    549 };
    550 
    551 /*
    552  * Create IBSS.
    553  */
    554 #define WI_RID_CREATE_IBSS	0xFC81
    555 
    556 #define WI_RID_FRAG_THRESH	0xFC82
    557 #define WI_RID_RTS_THRESH	0xFC83
    558 
    559 /*
    560  * TX rate control
    561  * 0 == Fixed 1mbps
    562  * 1 == Fixed 2mbps
    563  * 2 == auto fallback
    564  */
    565 #define WI_RID_TX_RATE		0xFC84
    566 
    567 /*
    568  * promiscuous mode.
    569  */
    570 #define WI_RID_PROMISC		0xFC85
    571 
    572 /*
    573  * Auxiliary Timer tick interval
    574  */
    575 #define WI_RID_TICK_TIME	0xFCE0
    576 
    577 /*
    578  * Information frame types.
    579  */
    580 #define WI_INFO_NOTIFY		0xF000	/* Handover address */
    581 #define WI_INFO_COUNTERS	0xF100	/* Statistics counters */
    582 #define WI_INFO_SCAN_RESULTS	0xF101	/* Scan results */
    583 #define WI_INFO_LINK_STAT	0xF200	/* Link status */
    584 #define WI_INFO_ASSOC_STAT	0xF201	/* Association status */
    585 
    586 /*
    587  * Hermes transmit/receive frame structure
    588  */
    589 struct wi_frame {
    590 	u_int16_t		wi_status;	/* 0x00 */
    591 	u_int16_t		wi_rsvd0;	/* 0x02 */
    592 	u_int16_t		wi_rsvd1;	/* 0x04 */
    593 	u_int16_t		wi_q_info;	/* 0x06 */
    594 	u_int16_t		wi_rsvd2;	/* 0x08 */
    595 	u_int16_t		wi_rsvd3;	/* 0x0A */
    596 	u_int16_t		wi_tx_ctl;	/* 0x0C */
    597 	/* 802.11 */
    598 	u_int16_t		wi_frame_ctl;	/* 0x0E */
    599 	u_int16_t		wi_id;		/* 0x10 */
    600 	u_int8_t		wi_addr1[6];	/* 0x12 */
    601 	u_int8_t		wi_addr2[6];	/* 0x18 */
    602 	u_int8_t		wi_addr3[6];	/* 0x1E */
    603 	u_int16_t		wi_seq_ctl;	/* 0x24 */
    604 	u_int8_t		wi_addr4[6];	/* 0x26 */
    605 	u_int16_t		wi_dat_len;	/* 0x2C */
    606 	/* 802.3 */
    607 	u_int8_t		wi_dst_addr[6];	/* 0x2E */
    608 	u_int8_t		wi_src_addr[6];	/* 0x34 */
    609 	u_int16_t		wi_len;		/* 0x3A */
    610 	/* SNAP header */
    611 	u_int16_t		wi_dat[3];	/* 0x3C */
    612 	u_int16_t		wi_type;	/* 0x42 */
    613 };
    614 
    615 #define WI_802_3_OFFSET		0x2E
    616 #define WI_802_11_OFFSET	0x44
    617 #define WI_802_11_OFFSET_RAW	0x3C
    618 
    619 #define WI_STAT_BADCRC		0x0001
    620 #define WI_STAT_UNDECRYPTABLE	0x0002
    621 #define WI_STAT_ERRSTAT		0x0003
    622 #define WI_STAT_MAC_PORT	0x0700
    623 #define WI_STAT_1042		0x2000	/* RFC1042 encoded */
    624 #define WI_STAT_TUNNEL		0x4000	/* Bridge-tunnel encoded */
    625 #define WI_STAT_WMP_MSG		0x6000	/* WaveLAN-II management protocol */
    626 #define WI_RXSTAT_MSG_TYPE	0xE000
    627 
    628 #define BIT(x) (1 << (x))
    629 
    630 #define WLAN_FC_GET_TYPE(fc) (((fc) & (BIT(3) | BIT(2))) >> 2)
    631 #define WLAN_FC_GET_STYPE(fc) \
    632 	(((fc) & (BIT(7) | BIT(6) | BIT(5) | BIT(4))) >> 4)
    633 
    634 #define WLAN_FC_TYPE_MGMT 0
    635 #define WLAN_FC_TYPE_CTRL 1
    636 #define WLAN_FC_TYPE_DATA 2
    637 
    638 #define WI_ENC_TX_802_3		0x00
    639 #define WI_ENC_TX_802_11	0x11
    640 #define WI_ENC_TX_E_II		0x0E
    641 
    642 #define WI_ENC_TX_1042		0x00
    643 #define WI_ENC_TX_TUNNEL	0xF8
    644 
    645 #define WI_TXCNTL_MACPORT	0x00FF
    646 #define WI_TXCNTL_STRUCTTYPE	0xFF00
    647 
    648 /*
    649  * SNAP (sub-network access protocol) constants for transmission
    650  * of IP datagrams over IEEE 802 networks, taken from RFC1042.
    651  * We need these for the LLC/SNAP header fields in the TX/RX frame
    652  * structure.
    653  */
    654 #define WI_SNAP_K1		0xaa	/* assigned global SAP for SNAP */
    655 #define WI_SNAP_K2		0x00
    656 #define WI_SNAP_CONTROL		0x03	/* unnumbered information format */
    657 #define WI_SNAP_WORD0		(WI_SNAP_K1 | (WI_SNAP_K1 << 8))
    658 #define WI_SNAP_WORD1		(WI_SNAP_K2 | (WI_SNAP_CONTROL << 8))
    659 #define WI_SNAPHDR_LEN		0x6
    660