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