sys/dev/netif/wi/if_wireg.h

   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.31.2.2 2002/08/02 07:11:34 imp Exp $
  33  * $DragonFly: src/sys/dev/netif/wi/if_wireg.h,v 1.3 2004/02/12 00:00:18 dillon Exp $
  34  */
  35
  36 #define WI_DELAY        5
  37 #define WI_TIMEOUT      (500000/WI_DELAY)       /* 500 ms */
  38
  39 #define WI_PORT0        0
  40 #define WI_PORT1        1
  41 #define WI_PORT2        2
  42 #define WI_PORT3        3
  43 #define WI_PORT4        4
  44 #define WI_PORT5        5
  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 << 8)
  59
  60 /* Default TX rate: 2Mbps, auto fallback */
  61 #define WI_DEFAULT_TX_RATE      3
  62
  63 /* Default network name: ANY */
  64 /*
  65  * [sommerfeld 1999/07/15] Changed from "ANY" to ""; according to Bill Fenner,
  66  * ANY is used in MS driver user interfaces, while "" is used over the
  67  * wire..
  68  */
  69 #define WI_DEFAULT_NETNAME      ""
  70
  71 #define WI_DEFAULT_AP_DENSITY   1
  72
  73 #define WI_DEFAULT_RTS_THRESH   2347
  74
  75 #define WI_DEFAULT_DATALEN      2304
  76
  77 #define WI_DEFAULT_CREATE_IBSS  0
  78
  79 #define WI_DEFAULT_PM_ENABLED   0
  80
  81 #define WI_DEFAULT_MAX_SLEEP    100
  82
  83 #define WI_DEFAULT_ROAMING      1
  84
  85 #define WI_DEFAULT_AUTHTYPE     1
  86
  87 #ifdef __NetBSD__
  88 #define OS_STRING_NAME  "NetBSD"
  89 #endif
  90 #ifdef __DragonFly__
  91 #define OS_STRING_NAME  "DragonFly"
  92 #endif
  93 #ifdef __OpenBSD__
  94 #define OS_STRING_NAME  "OpenBSD"
  95 #endif
  96
  97 #define WI_DEFAULT_NODENAME     OS_STRING_NAME " WaveLAN/IEEE node"
  98
  99 #define WI_DEFAULT_IBSS         OS_STRING_NAME " IBSS"
 100
 101 #define WI_DEFAULT_CHAN         3
 102
 103 #define WI_BUS_PCCARD           0       /* pccard device */
 104 #define WI_BUS_PCI_PLX          1       /* PCI card w/ PLX PCI/PCMICA bridge */
 105 #define WI_BUS_PCI_NATIVE       2       /* native PCI device (Prism 2.5) */
 106
 107 /*
 108  * register space access macros
 109  */
 110 #define CSR_WRITE_4(sc, reg, val)                               \
 111         bus_space_write_4((sc)->wi_btag, (sc)->wi_bhandle,      \
 112             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
 113 #define CSR_WRITE_2(sc, reg, val)                               \
 114         bus_space_write_2((sc)->wi_btag, (sc)->wi_bhandle,      \
 115             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
 116 #define CSR_WRITE_1(sc, reg, val)                               \
 117         bus_space_write_1((sc)->wi_btag, (sc)->wi_bhandle,      \
 118             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg), val)
 119
 120 #define CSR_READ_4(sc, reg)                                     \
 121         bus_space_read_4((sc)->wi_btag, (sc)->wi_bhandle,       \
 122             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
 123 #define CSR_READ_2(sc, reg)                                     \
 124         bus_space_read_2((sc)->wi_btag, (sc)->wi_bhandle,       \
 125             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
 126 #define CSR_READ_1(sc, reg)                                     \
 127         bus_space_read_1((sc)->wi_btag, (sc)->wi_bhandle,       \
 128             (sc)->wi_bus_type == WI_BUS_PCI_NATIVE ? (reg)*2 : (reg))
 129
 130 #define CSM_WRITE_1(sc, off, val)       \
 131         bus_space_write_1((sc)->wi_bmemtag, (sc)->wi_bmemhandle, off, val)
 132
 133 #define CSM_READ_1(sc, off)             \
 134         bus_space_read_1((sc)->wi_bmemtag, (sc)->wi_bmemhandle, off)
 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_PROGRAM          0x0022
 206
 207 #define WI_CMD_CODE_MASK        0x003F
 208
 209 /*
 210  * Reclaim qualifier bit, applicable to the
 211  * TX and INQUIRE commands.
 212  */
 213 #define WI_RECLAIM              0x0100 /* reclaim NIC memory */
 214
 215 /*
 216  * ACCESS command qualifier bits.
 217  */
 218 #define WI_ACCESS_READ          0x0000
 219 #define WI_ACCESS_WRITE         0x0100
 220
 221 /*
 222  * PROGRAM command qualifier bits.
 223  */
 224 #define WI_PROGRAM_DISABLE      0x0000
 225 #define WI_PROGRAM_ENABLE_RAM   0x0100
 226 #define WI_PROGRAM_ENABLE_NVRAM 0x0200
 227 #define WI_PROGRAM_NVRAM        0x0300
 228
 229 /* Status register values */
 230 #define WI_STAT_CMD_CODE        0x003F
 231 #define WI_STAT_DIAG_ERR        0x0100
 232 #define WI_STAT_INQ_ERR         0x0500
 233 #define WI_STAT_CMD_RESULT      0x7F00
 234
 235 /* memory handle management registers */
 236 #define WI_INFO_FID             0x10
 237 #define WI_RX_FID               0x20
 238 #define WI_ALLOC_FID            0x22
 239 #define WI_TX_CMP_FID           0x24
 240
 241 /*
 242  * Buffer Access Path (BAP) registers.
 243  * These are I/O channels. I believe you can use each one for
 244  * any desired purpose independently of the other. In general
 245  * though, we use BAP1 for reading and writing LTV records and
 246  * reading received data frames, and BAP0 for writing transmit
 247  * frames. This is a convention though, not a rule.
 248  */
 249 #define WI_SEL0                 0x18
 250 #define WI_SEL1                 0x1A
 251 #define WI_OFF0                 0x1C
 252 #define WI_OFF1                 0x1E
 253 #define WI_DATA0                0x36
 254 #define WI_DATA1                0x38
 255 #define WI_BAP0                 WI_DATA0
 256 #define WI_BAP1                 WI_DATA1
 257
 258 #define WI_OFF_BUSY             0x8000
 259 #define WI_OFF_ERR              0x4000
 260 #define WI_OFF_DATAOFF          0x0FFF
 261
 262 /* Event registers */
 263 #define WI_EVENT_STAT           0x30    /* Event status */
 264 #define WI_INT_EN               0x32    /* Interrupt enable/disable */
 265 #define WI_EVENT_ACK            0x34    /* Ack event */
 266
 267 /* Events */
 268 #define WI_EV_TICK              0x8000  /* aux timer tick */
 269 #define WI_EV_RES               0x4000  /* controller h/w error (time out) */
 270 #define WI_EV_INFO_DROP         0x2000  /* no RAM to build unsolicited frame */
 271 #define WI_EV_NO_CARD           0x0800  /* card removed (hunh?) */
 272 #define WI_EV_DUIF_RX           0x0400  /* wavelan management packet received */
 273 #define WI_EV_INFO              0x0080  /* async info frame */
 274 #define WI_EV_CMD               0x0010  /* command completed */
 275 #define WI_EV_ALLOC             0x0008  /* async alloc/reclaim completed */
 276 #define WI_EV_TX_EXC            0x0004  /* async xmit completed with failure */
 277 #define WI_EV_TX                0x0002  /* async xmit completed succesfully */
 278 #define WI_EV_RX                0x0001  /* async rx completed */
 279
 280 #define WI_INTRS        \
 281         (WI_EV_RX|WI_EV_TX|WI_EV_TX_EXC|WI_EV_ALLOC|WI_EV_INFO|WI_EV_INFO_DROP)
 282
 283 /* Host software registers */
 284 #define WI_SW0                  0x28
 285 #define WI_SW1                  0x2A
 286 #define WI_SW2                  0x2C
 287 #define WI_SW3                  0x2E    /* does not appear in Prism2 */
 288
 289 #define WI_CNTL                 0x14
 290
 291 #define WI_CNTL_AUX_ENA         0xC000
 292 #define WI_CNTL_AUX_ENA_STAT    0xC000
 293 #define WI_CNTL_AUX_DIS_STAT    0x0000
 294 #define WI_CNTL_AUX_ENA_CNTL    0x8000
 295 #define WI_CNTL_AUX_DIS_CNTL    0x4000
 296
 297 #define WI_AUX_PAGE             0x3A
 298 #define WI_AUX_OFFSET           0x3C
 299 #define WI_AUX_DATA             0x3E
 300
 301 #define WI_COR_OFFSET   0x3e0
 302 #define WI_COR_VALUE    0x41
 303
 304 /*
 305  * One form of communication with the Hermes is with what Lucent calls
 306  * LTV records, where LTV stands for Length, Type and Value. The length
 307  * and type are 16 bits and are in native byte order. The value is in
 308  * multiples of 16 bits and is in little endian byte order.
 309  */
 310 struct wi_ltv_gen {
 311         u_int16_t               wi_len;
 312         u_int16_t               wi_type;
 313         u_int16_t               wi_val;
 314 };
 315
 316 struct wi_ltv_str {
 317         u_int16_t               wi_len;
 318         u_int16_t               wi_type;
 319         u_int16_t               wi_str[17];
 320 };
 321
 322 #define WI_SETVAL(recno, val)                   \
 323         do {                                    \
 324                 struct wi_ltv_gen       g;      \
 325                                                 \
 326                 g.wi_len = 2;                   \
 327                 g.wi_type = recno;              \
 328                 g.wi_val = htole16(val);        \
 329                 wi_write_record(sc, &g);        \
 330         } while (0)
 331
 332 #define WI_SETSTR(recno, str)                                   \
 333         do {                                                    \
 334                 struct wi_ltv_str       s;                      \
 335                 int                     l;                      \
 336                                                                 \
 337                 l = (strlen(str) + 1) & ~0x1;                   \
 338                 bzero((char *)&s, sizeof(s));                   \
 339                 s.wi_len = (l / 2) + 2;                         \
 340                 s.wi_type = recno;                              \
 341                 s.wi_str[0] = htole16(strlen(str));             \
 342                 bcopy(str, (char *)&s.wi_str[1], strlen(str));  \
 343                 wi_write_record(sc, (struct wi_ltv_gen *)&s);   \
 344         } while (0)
 345
 346 /*
 347  * Download buffer location and length (0xFD01).
 348  */
 349 struct wi_ltv_dnld_buf {
 350         u_int16_t               wi_len;
 351         u_int16_t               wi_type;
 352         u_int16_t               wi_buf_pg; /* page addr of intermediate dl buf*/
 353         u_int16_t               wi_buf_off; /* offset of idb */
 354         u_int16_t               wi_buf_len; /* len of idb */
 355 };
 356
 357 /*
 358  * Mem sizes (0xFD02).
 359  */
 360 struct wi_ltv_memsz {
 361         u_int16_t               wi_len;
 362         u_int16_t               wi_type;
 363         u_int16_t               wi_mem_ram;
 364         u_int16_t               wi_mem_nvram;
 365 };
 366
 367 /*
 368  * NIC Identification (0xFD0B, 0xFD20)
 369  */
 370 struct wi_ltv_ver {
 371         u_int16_t               wi_len;
 372         u_int16_t               wi_type;
 373         u_int16_t               wi_ver[4];
 374 };
 375
 376 /* define card ident */
 377 #define WI_NIC_LUCENT_ID        0x0001
 378 #define WI_NIC_LUCENT_STR       "Lucent Technologies, WaveLAN/IEEE"
 379
 380 #define WI_NIC_SONY_ID          0x0002
 381 #define WI_NIC_SONY_STR         "Sony WaveLAN/IEEE"
 382
 383 #define WI_NIC_LUCENT_EMB_ID    0x0005
 384 #define WI_NIC_LUCENT_EMB_STR   "Lucent Embedded WaveLAN/IEEE"
 385
 386 #define WI_NIC_EVB2_ID          0x8000
 387 #define WI_NIC_EVB2_STR         "RF:PRISM2 MAC:HFA3841"
 388
 389 #define WI_NIC_HWB3763_ID       0x8001
 390 #define WI_NIC_HWB3763_STR      "RF:PRISM2 MAC:HFA3841 CARD:HWB3763 rev.B"
 391
 392 #define WI_NIC_HWB3163_ID       0x8002
 393 #define WI_NIC_HWB3163_STR      "RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.A"
 394
 395 #define WI_NIC_HWB3163B_ID      0x8003
 396 #define WI_NIC_HWB3163B_STR     "RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.B"
 397
 398 #define WI_NIC_EVB3_ID          0x8004
 399 #define WI_NIC_EVB3_STR         "RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
 400
 401 #define WI_NIC_HWB1153_ID       0x8007
 402 #define WI_NIC_HWB1153_STR      "RF:PRISM1 MAC:HFA3841 CARD:HWB1153"
 403
 404 #define WI_NIC_P2_SST_ID        0x8008  /* Prism2 with SST flush */
 405 #define WI_NIC_P2_SST_STR       "RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
 406
 407 #define WI_NIC_EVB2_SST_ID      0x8009
 408 #define WI_NIC_EVB2_SST_STR     "RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
 409
 410 #define WI_NIC_3842_EVA_ID      0x800A  /* 3842 Evaluation Board */
 411 #define WI_NIC_3842_EVA_STR     "RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
 412
 413 #define WI_NIC_3842_PCMCIA_AMD_ID       0x800B  /* Prism2.5 PCMCIA */
 414 #define WI_NIC_3842_PCMCIA_SST_ID       0x800C
 415 #define WI_NIC_3842_PCMCIA_ATM_ID       0x800D
 416 #define WI_NIC_3842_PCMCIA_STR          "RF:PRISM2.5 MAC:ISL3873"
 417
 418 #define WI_NIC_3842_MINI_AMD_ID         0x8012  /* Prism2.5 Mini-PCI */
 419 #define WI_NIC_3842_MINI_SST_ID         0x8013
 420 #define WI_NIC_3842_MINI_ATM_ID         0x8014
 421 #define WI_NIC_3842_MINI_STR            "RF:PRISM2.5 MAC:ISL3874A(Mini-PCI)"
 422
 423 #define WI_NIC_3842_PCI_AMD_ID          0x8016  /* Prism2.5 PCI-bridge */
 424 #define WI_NIC_3842_PCI_SST_ID          0x8017
 425 #define WI_NIC_3842_PCI_ATM_ID          0x8018
 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_STR            "RF:PRISM3(PCMCIA)"
 431
 432 #define WI_NIC_P3_MINI_AMD_ID           0x8021  /* Prism3 Mini-PCI */
 433 #define WI_NIC_P3_MINI_SST_ID           0x8022
 434 #define WI_NIC_P3_MINI_STR              "RF:PRISM3(Mini-PCI)"
 435
 436 /*
 437  * List of intended regulatory domains (0xFD11).
 438  */
 439 struct wi_ltv_domains {
 440         u_int16_t               wi_len;
 441         u_int16_t               wi_type;
 442         u_int16_t               wi_domains[6];
 443 };
 444
 445 /*
 446  * CIS struct (0xFD13).
 447  */
 448 struct wi_ltv_cis {
 449         u_int16_t               wi_len;
 450         u_int16_t               wi_type;
 451         u_int16_t               wi_cis[240];
 452 };
 453
 454 /*
 455  * Communications quality (0xFD43).
 456  */
 457 struct wi_ltv_commqual {
 458         u_int16_t               wi_len;
 459         u_int16_t               wi_type;
 460         u_int16_t               wi_coms_qual;
 461         u_int16_t               wi_sig_lvl;
 462         u_int16_t               wi_noise_lvl;
 463 };
 464
 465 /*
 466  * Actual system scale thresholds (0xFC06, 0xFD46).
 467  */
 468 struct wi_ltv_scalethresh {
 469         u_int16_t               wi_len;
 470         u_int16_t               wi_type;
 471         u_int16_t               wi_energy_detect;
 472         u_int16_t               wi_carrier_detect;
 473         u_int16_t               wi_defer;
 474         u_int16_t               wi_cell_search;
 475         u_int16_t               wi_out_of_range;
 476         u_int16_t               wi_delta_snr;
 477 };
 478
 479 /*
 480  * PCF info struct (0xFD87).
 481  */
 482 struct wi_ltv_pcf {
 483         u_int16_t               wi_len;
 484         u_int16_t               wi_type;
 485         u_int16_t               wi_energy_detect;
 486         u_int16_t               wi_carrier_detect;
 487         u_int16_t               wi_defer;
 488         u_int16_t               wi_cell_search;
 489         u_int16_t               wi_range;
 490 };
 491
 492 /*
 493  * Connection control characteristics. (0xFC00)
 494  * 0 == IBSS (802.11 compliant mode) (Only PRISM2)
 495  * 1 == Basic Service Set (BSS)
 496  * 2 == Wireless Distribudion System (WDS)
 497  * 3 == Pseudo IBSS
 498  *      (Only PRISM2; not 802.11 compliant mode, testing use only)
 499  * 6 == HOST AP (Only PRISM2)
 500  */
 501 #define WI_PORTTYPE_BSS         0x1
 502 #define WI_PORTTYPE_WDS         0x2
 503 #define WI_PORTTYPE_ADHOC       0x3
 504 #define WI_PORTTYPE_IBSS        0x4
 505 #define WI_PORTTYPE_AP          0x6
 506
 507 /*
 508  * Mac addresses. (0xFC01, 0xFC08)
 509  */
 510 struct wi_ltv_macaddr {
 511         u_int16_t               wi_len;
 512         u_int16_t               wi_type;
 513         u_int16_t               wi_mac_addr[3];
 514 };
 515
 516 /*
 517  * Station set identification (SSID). (0xFC02, 0xFC04)
 518  */
 519 struct wi_ltv_ssid {
 520         u_int16_t               wi_len;
 521         u_int16_t               wi_type;
 522         u_int16_t               wi_id[17];
 523 };
 524
 525 /*
 526  * Set our station name. (0xFC0E)
 527  */
 528 struct wi_ltv_nodename {
 529         u_int16_t               wi_len;
 530         u_int16_t               wi_type;
 531         u_int16_t               wi_nodename[17];
 532 };
 533
 534 /*
 535  * Multicast addresses to be put in filter. We're
 536  * allowed up to 16 addresses in the filter. (0xFC80)
 537  */
 538 struct wi_ltv_mcast {
 539         u_int16_t               wi_len;
 540         u_int16_t               wi_type;
 541         struct ether_addr       wi_mcast[16];
 542 };
 543
 544 /*
 545  * supported rates. (0xFCB4)
 546  */
 547 #define WI_SUPPRATES_1M         0x0001
 548 #define WI_SUPPRATES_2M         0x0002
 549 #define WI_SUPPRATES_5M         0x0004
 550 #define WI_SUPPRATES_11M        0x0008
 551 #define WI_RATES_BITS   "\20\0011M\0022M\0035.5M\00411M"
 552
 553 /*
 554  * Information frame types.
 555  */
 556 #define WI_INFO_NOTIFY          0xF000  /* Handover address */
 557 #define WI_INFO_COUNTERS        0xF100  /* Statistics counters */
 558 #define WI_INFO_SCAN_RESULTS    0xF101  /* Scan results */
 559 #define WI_INFO_LINK_STAT       0xF200  /* Link status */
 560 #define WI_INFO_ASSOC_STAT      0xF201  /* Association status */
 561
 562 /*
 563  * Hermes transmit/receive frame structure
 564  */
 565 struct wi_frame {
 566         u_int16_t               wi_status;      /* 0x00 */
 567         u_int16_t               wi_rsvd0;       /* 0x02 */
 568         u_int16_t               wi_rsvd1;       /* 0x04 */
 569         u_int16_t               wi_q_info;      /* 0x06 */
 570         u_int16_t               wi_rsvd2;       /* 0x08 */
 571         u_int8_t                wi_tx_rtry;     /* 0x0A */
 572         u_int8_t                wi_tx_rate;     /* 0x0B */
 573         u_int16_t               wi_tx_ctl;      /* 0x0C */
 574         u_int16_t               wi_frame_ctl;   /* 0x0E */
 575         u_int16_t               wi_id;          /* 0x10 */
 576         u_int8_t                wi_addr1[6];    /* 0x12 */
 577         u_int8_t                wi_addr2[6];    /* 0x18 */
 578         u_int8_t                wi_addr3[6];    /* 0x1E */
 579         u_int16_t               wi_seq_ctl;     /* 0x24 */
 580         u_int8_t                wi_addr4[6];    /* 0x26 */
 581         u_int16_t               wi_dat_len;     /* 0x2C */
 582         u_int8_t                wi_dst_addr[6]; /* 0x2E */
 583         u_int8_t                wi_src_addr[6]; /* 0x34 */
 584         u_int16_t               wi_len;         /* 0x3A */
 585         u_int16_t               wi_dat[3];      /* 0x3C */ /* SNAP header */
 586         u_int16_t               wi_type;        /* 0x42 */
 587 };
 588
 589 #define WI_802_3_OFFSET         0x2E
 590 #define WI_802_11_OFFSET        0x44
 591 #define WI_802_11_OFFSET_RAW    0x3C
 592 #define WI_802_11_OFFSET_HDR    0x0E
 593
 594 #define WI_STAT_BADCRC          0x0001
 595 #define WI_STAT_UNDECRYPTABLE   0x0002
 596 #define WI_STAT_ERRSTAT         0x0003
 597 #define WI_STAT_MAC_PORT        0x0700
 598 #define WI_STAT_1042            0x2000  /* RFC1042 encoded */
 599 #define WI_STAT_TUNNEL          0x4000  /* Bridge-tunnel encoded */
 600 #define WI_STAT_WMP_MSG         0x6000  /* WaveLAN-II management protocol */
 601 #define WI_STAT_MGMT            0x8000  /* 802.11b management frames */
 602 #define WI_RXSTAT_MSG_TYPE      0xE000
 603
 604 #define WI_ENC_TX_802_3         0x00
 605 #define WI_ENC_TX_802_11        0x11
 606 #define WI_ENC_TX_MGMT          0x08
 607 #define WI_ENC_TX_E_II          0x0E
 608
 609 #define WI_ENC_TX_1042          0x00
 610 #define WI_ENC_TX_TUNNEL        0xF8
 611
 612 #define WI_TXCNTL_MACPORT       0x00FF
 613 #define WI_TXCNTL_STRUCTTYPE    0xFF00
 614 #define WI_TXCNTL_TX_EX         0x0004
 615 #define WI_TXCNTL_TX_OK         0x0002
 616 #define WI_TXCNTL_NOCRYPT       0x0080
 617
 618 /*
 619  * SNAP (sub-network access protocol) constants for transmission
 620  * of IP datagrams over IEEE 802 networks, taken from RFC1042.
 621  * We need these for the LLC/SNAP header fields in the TX/RX frame
 622  * structure.
 623  */
 624 #define WI_SNAP_K1              0xaa    /* assigned global SAP for SNAP */
 625 #define WI_SNAP_K2              0x00
 626 #define WI_SNAP_CONTROL         0x03    /* unnumbered information format */
 627 #define WI_SNAP_WORD0           (WI_SNAP_K1 | (WI_SNAP_K1 << 8))
 628 #define WI_SNAP_WORD1           (WI_SNAP_K2 | (WI_SNAP_CONTROL << 8))
 629 #define WI_SNAPHDR_LEN          0x6
 630 #define WI_FCS_LEN              0x4