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