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