sys/dev/ic/wireg.h

   1 /*      $NetBSD: wireg.h,v 1.52 2005/12/11 12:21:29 christos Exp $      */
   2
   3 /*
   4  * Copyright (c) 1997, 1998, 1999
   5  *      Bill Paul <wpaul@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_DELAY       5
  41 #define WI_TIMEOUT     (500000/WI_DELAY)       /* 500 ms */
  42
  43 #define WI_PORT0        (0 << 8)
  44 #define WI_PORT1        (1 << 8)
  45 #define WI_PORT2        (2 << 8)
  46 #define WI_PORT3        (3 << 8)
  47 #define WI_PORT4        (4 << 8)
  48 #define WI_PORT5        (5 << 8)
  49
  50 /*
  51  * The WaveLAN/IEEE cards contain an 802.11 MAC controller which Lucent
  52  * calls 'Hermes.' In typical fashion, getting documentation about this
  53  * controller is about as easy as squeezing blood from a stone. Here
  54  * is more or less what I know:
  55  *
  56  * - The Hermes controller is firmware driven, and the host interacts
  57  *   with the Hermes via a firmware interface, which can change.
  58  *
  59  * - The Hermes is described in a document called: "Hermes Firmware
  60  *   WaveLAN/IEEE Station Functions," document #010245, which of course
  61  *   Lucent will not release without an NDA.
  62  *
  63  * - Lucent has created a library called HCF (Hardware Control Functions)
  64  *   though which it wants developers to interact with the card. The HCF
  65  *   is needlessly complex, ill conceived and badly documented. Actually,
  66  *   the comments in the HCP code itself aren't bad, but the publically
  67  *   available manual that comes with it is awful, probably due largely to
  68  *   the fact that it has been emasculated in order to hide information
  69  *   that Lucent wants to keep proprietary. The purpose of the HCF seems
  70  *   to be to insulate the driver programmer from the Hermes itself so that
  71  *   Lucent has an excuse not to release programming in for it.
  72  *
  73  * - Lucent only makes available documentation and code for 'HCF Light'
  74  *   which is a stripped down version of HCF with certain features not
  75  *   implemented, most notably support for 802.11 frames.
  76  *
  77  * - The HCF code which I have seen blows goats. Whoever decided to
  78  *   use a 132 column format should be shot.
  79  *
  80  * Rather than actually use the Lucent HCF library, I have stripped all
  81  * the useful information from it and used it to create a driver in the
  82  * usual BSD form. Note: I don't want to hear anybody whining about the
  83  * fact that the Lucent code is GPLed and mine isn't. I did not actually
  84  * put any of Lucent's code in this driver: I only used it as a reference
  85  * to obtain information about the underlying hardware. The Hermes
  86  * programming interface is not GPLed, so bite me.
  87  */
  88
  89 /*
  90  * Size of Hermes & Prism2 I/O space.
  91  */
  92 #define WI_IOSIZE               0x40
  93
  94 /*
  95  * Hermes & Prism2 register definitions
  96  */
  97
  98 /* Hermes command/status registers. */
  99 #define WI_COMMAND              0x00
 100 #define WI_PARAM0               0x02
 101 #define WI_PARAM1               0x04
 102 #define WI_PARAM2               0x06
 103 #define WI_STATUS               0x08
 104 #define WI_RESP0                0x0A
 105 #define WI_RESP1                0x0C
 106 #define WI_RESP2                0x0E
 107
 108 /* Command register values. */
 109 #define WI_CMD_BUSY             0x8000 /* busy bit */
 110 #define WI_CMD_INI              0x0000 /* initialize */
 111 #define WI_CMD_ENABLE           0x0001 /* enable */
 112 #define WI_CMD_DISABLE          0x0002 /* disable */
 113 #define WI_CMD_DIAG             0x0003
 114 #define WI_CMD_ALLOC_MEM        0x000A /* allocate NIC memory */
 115 #define WI_CMD_TX               0x000B /* transmit */
 116 #define WI_CMD_NOTIFY           0x0010
 117 #define WI_CMD_INQUIRE          0x0011
 118 #define WI_CMD_ACCESS           0x0021
 119 #define WI_CMD_PROGRAM          0x0022
 120 #define WI_CMD_READEE           0x0030
 121 #define WI_CMD_TEST             0x0038 /* PRISM2 test mode */
 122
 123 #define WI_CMD_CODE_MASK        0x003F
 124
 125 /*
 126  * Reclaim qualifier bit, applicable to the
 127  * TX and INQUIRE commands.
 128  */
 129 #define WI_RECLAIM              0x0100 /* reclaim NIC memory */
 130
 131 /*
 132  * ACCESS command qualifier bits.
 133  */
 134 #define WI_ACCESS_READ          0x0000
 135 #define WI_ACCESS_WRITE         0x0100
 136
 137 /*
 138  * PROGRAM command qualifier bits.
 139  */
 140 #define WI_PROGRAM_DISABLE      0x0000
 141 #define WI_PROGRAM_ENABLE_RAM   0x0100
 142 #define WI_PROGRAM_ENABLE_NVRAM 0x0200
 143 #define WI_PROGRAM_NVRAM        0x0300
 144
 145 /*
 146  * DEBUG mode options.
 147  */
 148 #define WI_TEST_MONITOR         0x0B /* monitor mode for testing */
 149
 150 /* Status register values */
 151 #define WI_STAT_CMD_CODE        0x003F
 152 #define WI_STAT_DIAG_ERR        0x0100
 153 #define WI_STAT_INQ_ERR         0x0500
 154 #define WI_STAT_CMD_RESULT      0x7F00
 155
 156 /* memory handle management registers */
 157 #define WI_INFO_FID             0x10
 158 #define WI_RX_FID               0x20
 159 #define WI_ALLOC_FID            0x22
 160 #define WI_TX_CMP_FID           0x24
 161
 162 /*
 163  * Buffer Access Path (BAP) registers.
 164  * These are I/O channels. I believe you can use each one for
 165  * any desired purpose independently of the other.
 166  * Currently, we only use BAP0, and perhaps BAP1 can be used
 167  * within interrupt context.
 168  */
 169 #define WI_SEL0                 0x18
 170 #define WI_SEL1                 0x1A
 171 #define WI_OFF0                 0x1C
 172 #define WI_OFF1                 0x1E
 173 #define WI_DATA0                0x36
 174 #define WI_DATA1                0x38
 175
 176 #define WI_OFF_BUSY             0x8000
 177 #define WI_OFF_ERR              0x4000
 178 #define WI_OFF_DATAOFF          0x0FFF
 179
 180 /* Event registers */
 181 #define WI_EVENT_STAT           0x30    /* Event status */
 182 #define WI_INT_EN               0x32    /* Interrupt enable/disable */
 183 #define WI_EVENT_ACK            0x34    /* Ack event */
 184
 185 /* Events */
 186 #define WI_EV_TICK              0x8000  /* aux timer tick */
 187 #define WI_EV_RES               0x4000  /* controller h/w error (time out) */
 188 #define WI_EV_INFO_DROP         0x2000  /* no RAM to build unsolicited frame */
 189 #define WI_EV_NO_CARD           0x0800  /* card removed (hunh?) */
 190 #define WI_EV_DUIF_RX           0x0400  /* wavelan management packet received */
 191 #define WI_EV_INFO              0x0080  /* async info frame */
 192 #define WI_EV_CMD               0x0010  /* command completed */
 193 #define WI_EV_ALLOC             0x0008  /* async alloc/reclaim completed */
 194 #define WI_EV_TX_EXC            0x0004  /* async xmit completed with failure */
 195 #define WI_EV_TX                0x0002  /* async xmit completed successfully */
 196 #define WI_EV_RX                0x0001  /* async rx completed */
 197
 198 /* Host software registers */
 199 #define WI_SW0                  0x28
 200 #define WI_SW1                  0x2A
 201 #define WI_SW2                  0x2C
 202 #define WI_SW3                  0x2E    /* does not appear in Prism2 */
 203
 204 #define WI_CNTL                 0x14
 205
 206 #define WI_CNTL_AUX_ENA         0xC000
 207 #define WI_CNTL_AUX_ENA_STAT    0xC000
 208 #define WI_CNTL_AUX_DIS_STAT    0x0000
 209 #define WI_CNTL_AUX_ENA_CNTL    0x8000
 210 #define WI_CNTL_AUX_DIS_CNTL    0x4000
 211
 212 #define WI_AUX_PAGE             0x3A
 213 #define WI_AUX_OFFSET           0x3C
 214 #define WI_AUX_DATA             0x3E
 215
 216 #define WI_AUX_PGSZ             128
 217 #define WI_AUX_KEY0             0xfe01
 218 #define WI_AUX_KEY1             0xdc23
 219 #define WI_AUX_KEY2             0xba45
 220
 221 #define WI_COR                  0x40    /* only for Symbol */
 222 #define WI_COR_RESET            0x0080
 223 #define WI_COR_IOMODE           0x0041
 224
 225 #define WI_HCR                  0x42    /* only for Symbol */
 226 #define WI_HCR_4WIRE            0x0010
 227 #define WI_HCR_RUN              0x0007
 228 #define WI_HCR_HOLD             0x000f
 229 #define WI_HCR_EEHOLD           0x00ce
 230
 231 #define WI_TMD_COR              0x14    /* Prism COR (TMD) */
 232 #define WI_TMD_IO               0x18    /* Prism I/O space (TMD) */
 233
 234 /*
 235  * PCI Host Interface Registers (HFA3842 Specific)
 236  * The value of all Register's Offset, such as WI_INFO_FID and WI_PARAM0,
 237  * has doubled.
 238  * About WI_PCI_COR: In this Register, only soft-reset bit implement; Bit(7).
 239  */
 240 #define WI_PCI_COR              0x4C
 241 #define WI_PCI_HCR              0x5C
 242 #define WI_PCI_MASTER0_ADDRH    0x80
 243 #define WI_PCI_MASTER0_ADDRL    0x84
 244 #define WI_PCI_MASTER0_LEN      0x88
 245 #define WI_PCI_MASTER0_CON      0x8C
 246
 247 #define WI_PCI_STATUS           0x98
 248
 249 #define WI_PCI_MASTER1_ADDRH    0xA0
 250 #define WI_PCI_MASTER1_ADDRL    0xA4
 251 #define WI_PCI_MASTER1_LEN      0xA8
 252 #define WI_PCI_MASTER1_CON      0xAC
 253
 254 #define WI_COR_SOFT_RESET       (1 << 7)
 255 #define WI_COR_CLEAR            0x00
 256
 257 /*
 258  * One form of communication with the Hermes is with what Lucent calls
 259  * LTV records, where LTV stands for Length, Type and Value. The length
 260  * and type are 16 bits and are in native byte order. The value is in
 261  * multiples of 16 bits and is in little endian byte order.
 262  */
 263 struct wi_lt_hdr {
 264         u_int16_t               wi_len;
 265         u_int16_t               wi_type;
 266         /* value is vary depends on resource id */
 267 };
 268
 269 /*
 270  * Download buffer location and length (0xFD01).
 271  */
 272 struct wi_dnld_buf {
 273         u_int16_t               wi_buf_pg; /* page addr of intermediate dl buf*/
 274         u_int16_t               wi_buf_off; /* offset of idb */
 275         u_int16_t               wi_buf_len; /* len of idb */
 276 };
 277
 278 /*
 279  * Mem sizes (0xFD02).
 280  */
 281 struct wi_memsz {
 282         u_int16_t               wi_mem_ram;
 283         u_int16_t               wi_mem_nvram;
 284 };
 285
 286 /*
 287  * NIC Identification (0xFD0B, 0xFD20)
 288  */
 289 struct wi_ver {
 290         u_int16_t               wi_ver[4];
 291 };
 292
 293 /* define card ident */
 294 /* Lucent */
 295 #define WI_NIC_LUCENT_ID        0x0001
 296 #define WI_NIC_LUCENT_STR       "Lucent Technologies, WaveLAN/IEEE"
 297
 298 #define WI_NIC_SONY_ID          0x0002
 299 #define WI_NIC_SONY_STR         "Sony WaveLAN/IEEE"
 300
 301 #define WI_NIC_LUCENT_EMB_ID    0x0005
 302 #define WI_NIC_LUCENT_EMB_STR   "Lucent Embedded WaveLAN/IEEE"
 303
 304 /* Intersil */
 305 #define WI_NIC_EVB2_ID          0x8000
 306 #define WI_NIC_EVB2_STR         "RF:PRISM2 MAC:HFA3841"
 307
 308 #define WI_NIC_HWB3763_ID       0x8001
 309 #define WI_NIC_HWB3763_STR      "RF:PRISM2 MAC:HFA3841 CARD:HWB3763 rev.B"
 310
 311 #define WI_NIC_HWB3163_ID       0x8002
 312 #define WI_NIC_HWB3163_STR      "RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.A"
 313
 314 #define WI_NIC_HWB3163B_ID      0x8003
 315 #define WI_NIC_HWB3163B_STR     "RF:PRISM2 MAC:HFA3841 CARD:HWB3163 rev.B"
 316
 317 #define WI_NIC_EVB3_ID          0x8004
 318 #define WI_NIC_EVB3_STR         "RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
 319
 320 #define WI_NIC_HWB1153_ID       0x8007
 321 #define WI_NIC_HWB1153_STR      "RF:PRISM1 MAC:HFA3841 CARD:HWB1153"
 322
 323 #define WI_NIC_P2_SST_ID        0x8008  /* Prism2 with SST flush */
 324 #define WI_NIC_P2_SST_STR       "RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
 325
 326 #define WI_NIC_EVB2_SST_ID      0x8009
 327 #define WI_NIC_EVB2_SST_STR     "RF:PRISM2 MAC:HFA3841 CARD:HWB3163-SST-flash"
 328
 329 #define WI_NIC_3842_EVA_ID      0x800A  /* Prism2 3842 Evaluation Board */
 330 #define WI_NIC_3842_EVA_STR     "RF:PRISM2 MAC:HFA3842 CARD:HFA3842 EVAL"
 331
 332 #define WI_NIC_3842_PCMCIA_AMD_ID       0x800B  /* Prism2.5 PCMCIA */
 333 #define WI_NIC_3842_PCMCIA_SST_ID       0x800C
 334 #define WI_NIC_3842_PCMCIA_ATM_ID       0x800D
 335 #define WI_NIC_3842_PCMCIA_STR          "RF:PRISM2.5 MAC:ISL3873B(PCMCIA)"
 336
 337 #define WI_NIC_3842_MINI_AMD_ID         0x8012  /* Prism2.5 Mini-PCI */
 338 #define WI_NIC_3842_MINI_SST_ID         0x8013
 339 #define WI_NIC_3842_MINI_ATM_ID         0x8014
 340 #define WI_NIC_3842_MINI_STR            "RF:PRISM2.5 MAC:ISL3874A(Mini-PCI)"
 341
 342 #define WI_NIC_3842_PCI_AMD_ID          0x8016  /* Prism2.5 PCI-bridge */
 343 #define WI_NIC_3842_PCI_SST_ID          0x8017
 344 #define WI_NIC_3842_PCI_ATM_ID          0x8018
 345 #define WI_NIC_3842_PCI_STR             "RF:PRISM2.5 MAC:ISL3874A(PCI-bridge)"
 346
 347 #define WI_NIC_P3_PCMCIA_AMD_ID         0x801A  /* Prism3 PCMCIA */
 348 #define WI_NIC_P3_PCMCIA_SST_ID         0x801B
 349 #define WI_NIC_P3_PCMCIA_STR            "RF:PRISM3 MAC:ISL3871(PCMCIA)"
 350
 351 #define WI_NIC_P3_MINI_AMD_ID           0x8021  /* Prism3 Mini-PCI */
 352 #define WI_NIC_P3_MINI_SST_ID           0x8022
 353 #define WI_NIC_P3_MINI_STR              "RF:PRISM3 MAC:ISL3871(Mini-PCI)"
 354
 355 /*
 356  * List of intended regulatory domains (0xFD11).
 357  */
 358 struct wi_domains {
 359         u_int16_t               wi_domains[6];
 360 };
 361
 362 /*
 363  * CIS struct (0xFD13).
 364  */
 365 struct wi_cis {
 366         u_int16_t               wi_cis[240];
 367 };
 368
 369 /*
 370  * Communications quality (0xFD43).
 371  */
 372 struct wi_commqual {
 373         u_int16_t               wi_coms_qual;
 374         u_int16_t               wi_sig_lvl;
 375         u_int16_t               wi_noise_lvl;
 376 };
 377
 378 /*
 379  * Actual system scale thresholds (0xFC06, 0xFD46).
 380  */
 381 struct wi_scalethresh {
 382         u_int16_t               wi_energy_detect;
 383         u_int16_t               wi_carrier_detect;
 384         u_int16_t               wi_defer;
 385         u_int16_t               wi_cell_search;
 386         u_int16_t               wi_out_of_range;
 387         u_int16_t               wi_delta_snr;
 388 };
 389
 390 /*
 391  * PCF info struct (0xFD87).
 392  */
 393 struct wi_pcf {
 394         u_int16_t               wi_medium_occupancy_limit;
 395         u_int16_t               wi_cfp_period;
 396         u_int16_t               wi_cfp_max_duration;
 397 };
 398
 399 /*
 400  * Connection control characteristics. (0xFC00)
 401  * 0 == IBSS (802.11 compliant mode) (Only PRISM2)
 402  * 1 == Basic Service Set (BSS)
 403  * 2 == Wireless Distribution System (WDS)
 404  * 3 == Pseudo IBSS
 405  *      (Only PRISM2; not 802.11 compliant mode, testing use only)
 406  * 6 == HOST AP (Only PRISM2)
 407  */
 408 #define WI_PORTTYPE_IBSS        0x0
 409 #define WI_PORTTYPE_BSS         0x1
 410 #define WI_PORTTYPE_WDS         0x2
 411 #define WI_PORTTYPE_ADHOC       0x3
 412 #define WI_PORTTYPE_HOSTAP      0x6
 413
 414 /*
 415  * Mac addresses. (0xFC01, 0xFC08, 0xFD42)
 416  */
 417 struct wi_macaddr {
 418         union {
 419                 u_int16_t       wi_mu_mac_addr_aligned[3];
 420                 u_int8_t        wi_mu_mac_addr[6];
 421         } mu;
 422 };
 423 #define wi_mac_addr_aligned     mu.wi_mu_mac_addr_aligned
 424 #define wi_mac_addr             mu.wi_mu_mac_addr
 425
 426 /*
 427  * Station set identification (SSID). (0xFC02, 0xFC04)
 428  */
 429 struct wi_ssid {
 430         u_int16_t               wi_len;
 431         u_int8_t                wi_ssid[32];
 432 };
 433
 434 /*
 435  * Set our station name. (0xFC0E)
 436  */
 437 struct wi_nodename {
 438         u_int16_t               wi_nodelen;
 439         u_int8_t                wi_nodename[32];
 440 };
 441
 442 /*
 443  * Multicast addresses to be put in filter. We're
 444  * allowed up to 16 addresses in the filter. (0xFC80)
 445  */
 446 struct wi_mcast {
 447         struct ether_addr       wi_mcast[16];
 448 };
 449
 450 /*
 451  * Join request. (0xFCE2)
 452  */
 453 struct wi_joinreq {
 454         struct ether_addr       wi_bssid;
 455         u_int16_t               wi_chan;
 456 };
 457
 458 /*
 459  * Information frame types.
 460  */
 461 #define WI_INFO_NOTIFY          0xF000  /* Handover address */
 462 #define WI_INFO_COUNTERS        0xF100  /* Statistics counters */
 463 #define WI_INFO_SCAN_RESULTS    0xF101  /* Scan results */
 464 #define WI_INFO_HOST_SCAN_RESULTS       0xF104  /* Scan results */
 465 #define WI_INFO_LINK_STAT       0xF200  /* Link status */
 466 #define CONNECTED       1
 467 #define DISCONNECTED    2
 468 #define AP_CHANGE       3
 469 #define AP_OUT_OF_RANGE 4
 470 #define AP_IN_RANGE     5
 471 #define ASSOC_FAILED    6
 472 #define WI_INFO_ASSOC_STAT      0xF201  /* Association status */
 473 struct wi_assoc {
 474         u_int16_t               wi_assoc_stat;  /* Association Status */
 475 #define ASSOC           1
 476 #define REASSOC         2
 477 #define DISASSOC        3
 478 #define ASSOCFAIL       4
 479 #define AUTHFAIL        5
 480         u_int8_t                wi_assoc_sta[6];        /* Station Address */
 481         u_int8_t                wi_assoc_osta[6];       /* OLD Station Address */
 482         u_int16_t               wi_assoc_reason;        /* Reason */
 483         u_int16_t               wi_assoc_reserve;       /* Reserved */
 484 };
 485
 486 #define WI_INFO_AUTH_REQUEST    0xF202  /* Authentication Request (AP) */
 487 #define WI_INFO_POWERSAVE_COUNT 0xF203  /* PowerSave User Count (AP) */
 488
 489 /*
 490  * Scan Results of Prism2 chip
 491  */
 492
 493 #define MAXAPINFO               30
 494 struct wi_scan_header {
 495         u_int16_t               wi_reserve;     /* future use */
 496         u_int16_t               wi_reason;      /* The reason this scan was initiated
 497                                                    1: Host initiated
 498                                                    2: Firmware initiated
 499                                                    3: Inquiry request from host */
 500 };
 501
 502 struct wi_scan_data_p2 {
 503         u_int16_t               wi_chid;        /* BSS Channel ID from Probe Res.(PR)*/
 504         u_int16_t               wi_noise;       /* Average Noise Level of the PR */
 505         u_int16_t               wi_signal;      /* Signal Level on the PR */
 506         u_int8_t                wi_bssid[6];    /* MACaddress of BSS responder from PR */
 507         u_int16_t               wi_interval;    /* BSS beacon interval */
 508         u_int16_t               wi_capinfo;     /* BSS Capability Information
 509                                                    IEEE Std 802.11(1997) ,see 7.3.1.4 */
 510         u_int16_t               wi_namelen;     /* Length of SSID strings */
 511         u_int8_t                wi_name[32];    /* SSID strings */
 512         u_int16_t               wi_suprate[5];  /* Supported Rates element from the PR
 513                                                    IEEE Std 802.11(1997) ,see 7.3.2.2 */
 514         u_int16_t               wi_rate;        /* Data rate of the PR */
 515 #define WI_APRATE_1             0x0A            /* 1 Mbps */
 516 #define WI_APRATE_2             0x14            /* 2 Mbps */
 517 #define WI_APRATE_5             0x37            /* 5.5 Mbps */
 518 #define WI_APRATE_11            0x6E            /* 11 Mbps */
 519 };
 520
 521 /*
 522  * Scan Results of Lucent chip
 523  */
 524 struct wi_scan_data {
 525         u_int16_t               wi_chid;        /* BSS Channel ID from PR */
 526         u_int16_t               wi_noise;       /* Average Noise Level of the PR */
 527         u_int16_t               wi_signal;      /* Signal Level on the PR */
 528         u_int8_t                wi_bssid[6];    /* MACaddress of BSS responder from PR */
 529         u_int16_t               wi_interval;    /* BSS beacon interval */
 530         u_int16_t               wi_capinfo;     /* BSS Capability Information
 531                                                    IEEE Std 802.11(1997) ,see 7.3.1.4 */
 532         u_int16_t               wi_namelen;     /* Length of SSID strings */
 533         u_int8_t                wi_name[32];    /* SSID strings */
 534 };
 535
 536 /*
 537  * transmit/receive frame structure
 538  */
 539 struct wi_frame {
 540         u_int16_t               wi_status;      /* 0x00 */
 541         u_int16_t               wi_rx_tstamp1;  /* 0x02 */
 542         u_int16_t               wi_rx_tstamp0;  /* 0x04 */
 543         u_int8_t                wi_rx_silence;  /* 0x06 */
 544         u_int8_t                wi_rx_signal;   /* 0x07 */
 545         u_int8_t                wi_rx_rate;     /* 0x08 */
 546         u_int8_t                wi_rx_flow;     /* 0x09 */
 547         u_int8_t                wi_tx_rtry;     /* 0x0a */ /* Prism2 AP Only */
 548         u_int8_t                wi_tx_rate;     /* 0x0b */ /* Prism2 AP Only */
 549         u_int16_t               wi_tx_ctl;      /* 0x0c */
 550         struct ieee80211_frame_addr4 wi_whdr;   /* 0x0e */
 551         u_int16_t               wi_dat_len;     /* 0x2c */
 552         struct ether_header     wi_ehdr;        /* 0x2e */
 553 } __packed;
 554
 555 /* Software support fields are returned untouched by TxOK, TxExc events. */
 556 #define wi_tx_swsup0            wi_rx_silence
 557 #define wi_tx_swsup1            wi_rx_signal
 558 #define wi_tx_swsup2            wi_rx_rate
 559 #define wi_tx_idx               wi_rx_flow
 560
 561 /* Tx Status Field */
 562 #define WI_TXSTAT_RET_ERR       0x0001
 563 #define WI_TXSTAT_AGED_ERR      0x0002
 564 #define WI_TXSTAT_DISCONNECT    0x0004
 565 #define WI_TXSTAT_FORM_ERR      0x0008
 566
 567 /* Rx Status Field */
 568 #define WI_STAT_BADCRC          0x0001
 569 #define WI_STAT_UNDECRYPTABLE   0x0002
 570 #define WI_STAT_ERRSTAT         0x0003
 571 #define WI_STAT_MAC_PORT        0x0700
 572 #define WI_STAT_PCF             0x1000
 573 #define WI_RXSTAT_MSG_TYPE      0xE000
 574 #define  WI_STAT_1042           0x2000  /* RFC1042 encoded */
 575 #define  WI_STAT_TUNNEL         0x4000  /* Bridge-tunnel encoded */
 576 #define  WI_STAT_WMP_MSG        0x6000  /* WaveLAN-II management protocol */
 577 #define  WI_STAT_MGMT           0x8000  /* 802.11b management frames */
 578
 579 #define WI_ENC_TX_E_II          0x0E
 580
 581 #define WI_ENC_TX_1042          0x00
 582 #define WI_ENC_TX_TUNNEL        0xF8
 583
 584 /* TxControl Field (enhanced) */
 585 #define WI_TXCNTL_TX_OK         0x0002
 586 #define WI_TXCNTL_TX_EX         0x0004
 587 #define WI_TXCNTL_STRUCT_TYPE   0x0018
 588 #define  WI_ENC_TX_802_3        0x00
 589 #define  WI_ENC_TX_802_11       0x08
 590 #define WI_TXCNTL_ALTRTRY       0x0020
 591 #define WI_TXCNTL_NOCRYPT       0x0080
 592
 593 /* Limit on the number of AIDs handled in the PRISM2-based Host AP mode. */
 594 #define WI_MAX_AID              256