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