if_wpireg.h revision 282369
1/* $FreeBSD: head/sys/dev/wpi/if_wpireg.h 282369 2015-05-03 20:56:33Z adrian $ */ 2 3/*- 4 * Copyright (c) 2006,2007 5 * Damien Bergamini <damien.bergamini@free.fr> 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20#define WPI_TX_RING_COUNT 256 21#define WPI_TX_RING_LOMARK 192 22#define WPI_TX_RING_HIMARK 224 23 24#ifdef DIAGNOSTIC 25#define WPI_RX_RING_COUNT_LOG 8 26#else 27#define WPI_RX_RING_COUNT_LOG 6 28#endif 29 30#define WPI_RX_RING_COUNT (1 << WPI_RX_RING_COUNT_LOG) 31 32#define WPI_NTXQUEUES 8 33#define WPI_DRV_NTXQUEUES 5 34#define WPI_CMD_QUEUE_NUM 4 35 36#define WPI_NDMACHNLS 6 37 38/* Maximum scatter/gather. */ 39#define WPI_MAX_SCATTER 4 40 41/* 42 * Rings must be aligned on a 16K boundary. 43 */ 44#define WPI_RING_DMA_ALIGN 0x4000 45 46/* Maximum Rx buffer size. */ 47#define WPI_RBUF_SIZE ( 3 * 1024 ) /* XXX 3000 but must be aligned */ 48 49/* 50 * Control and status registers. 51 */ 52#define WPI_HW_IF_CONFIG 0x000 53#define WPI_INT 0x008 54#define WPI_INT_MASK 0x00c 55#define WPI_FH_INT 0x010 56#define WPI_GPIO_IN 0x018 57#define WPI_RESET 0x020 58#define WPI_GP_CNTRL 0x024 59#define WPI_EEPROM 0x02c 60#define WPI_EEPROM_GP 0x030 61#define WPI_GIO 0x03c 62#define WPI_UCODE_GP1 0x054 63#define WPI_UCODE_GP1_SET 0x058 64#define WPI_UCODE_GP1_CLR 0x05c 65#define WPI_UCODE_GP2 0x060 66#define WPI_GIO_CHICKEN 0x100 67#define WPI_ANA_PLL 0x20c 68#define WPI_DBG_HPET_MEM 0x240 69#define WPI_MEM_RADDR 0x40c 70#define WPI_MEM_WADDR 0x410 71#define WPI_MEM_WDATA 0x418 72#define WPI_MEM_RDATA 0x41c 73#define WPI_PRPH_WADDR 0x444 74#define WPI_PRPH_RADDR 0x448 75#define WPI_PRPH_WDATA 0x44c 76#define WPI_PRPH_RDATA 0x450 77#define WPI_HBUS_TARG_WRPTR 0x460 78 79/* 80 * Flow-Handler registers. 81 */ 82#define WPI_FH_CBBC_CTRL(qid) (0x940 + (qid) * 8) 83#define WPI_FH_CBBC_BASE(qid) (0x944 + (qid) * 8) 84#define WPI_FH_RX_CONFIG 0xc00 85#define WPI_FH_RX_BASE 0xc04 86#define WPI_FH_RX_WPTR 0xc20 87#define WPI_FH_RX_RPTR_ADDR 0xc24 88#define WPI_FH_RSSR_TBL 0xcc0 89#define WPI_FH_RX_STATUS 0xcc4 90#define WPI_FH_TX_CONFIG(qid) (0xd00 + (qid) * 32) 91#define WPI_FH_TX_BASE 0xe80 92#define WPI_FH_MSG_CONFIG 0xe88 93#define WPI_FH_TX_STATUS 0xe90 94 95 96/* 97 * NIC internal memory offsets. 98 */ 99#define WPI_ALM_SCHED_MODE 0x2e00 100#define WPI_ALM_SCHED_ARASTAT 0x2e04 101#define WPI_ALM_SCHED_TXFACT 0x2e10 102#define WPI_ALM_SCHED_TXF4MF 0x2e14 103#define WPI_ALM_SCHED_TXF5MF 0x2e20 104#define WPI_ALM_SCHED_SBYPASS_MODE1 0x2e2c 105#define WPI_ALM_SCHED_SBYPASS_MODE2 0x2e30 106#define WPI_APMG_CLK_CTRL 0x3000 107#define WPI_APMG_CLK_EN 0x3004 108#define WPI_APMG_CLK_DIS 0x3008 109#define WPI_APMG_PS 0x300c 110#define WPI_APMG_PCI_STT 0x3010 111#define WPI_APMG_RFKILL 0x3014 112#define WPI_BSM_WR_CTRL 0x3400 113#define WPI_BSM_WR_MEM_SRC 0x3404 114#define WPI_BSM_WR_MEM_DST 0x3408 115#define WPI_BSM_WR_DWCOUNT 0x340c 116#define WPI_BSM_DRAM_TEXT_ADDR 0x3490 117#define WPI_BSM_DRAM_TEXT_SIZE 0x3494 118#define WPI_BSM_DRAM_DATA_ADDR 0x3498 119#define WPI_BSM_DRAM_DATA_SIZE 0x349c 120#define WPI_BSM_SRAM_BASE 0x3800 121 122 123/* Possible flags for register WPI_HW_IF_CONFIG. */ 124#define WPI_HW_IF_CONFIG_ALM_MB (1 << 8) 125#define WPI_HW_IF_CONFIG_ALM_MM (1 << 9) 126#define WPI_HW_IF_CONFIG_SKU_MRC (1 << 10) 127#define WPI_HW_IF_CONFIG_REV_D (1 << 11) 128#define WPI_HW_IF_CONFIG_TYPE_B (1 << 12) 129 130/* Possible flags for registers WPI_PRPH_RADDR/WPI_PRPH_WADDR. */ 131#define WPI_PRPH_DWORD ((sizeof (uint32_t) - 1) << 24) 132 133/* Possible values for WPI_BSM_WR_MEM_DST. */ 134#define WPI_FW_TEXT_BASE 0x00000000 135#define WPI_FW_DATA_BASE 0x00800000 136 137/* Possible flags for WPI_GPIO_IN. */ 138#define WPI_GPIO_IN_VMAIN (1 << 9) 139 140/* Possible flags for register WPI_RESET. */ 141#define WPI_RESET_NEVO (1 << 0) 142#define WPI_RESET_SW (1 << 7) 143#define WPI_RESET_MASTER_DISABLED (1 << 8) 144#define WPI_RESET_STOP_MASTER (1 << 9) 145 146/* Possible flags for register WPI_GP_CNTRL. */ 147#define WPI_GP_CNTRL_MAC_ACCESS_ENA (1 << 0) 148#define WPI_GP_CNTRL_MAC_CLOCK_READY (1 << 0) 149#define WPI_GP_CNTRL_INIT_DONE (1 << 2) 150#define WPI_GP_CNTRL_MAC_ACCESS_REQ (1 << 3) 151#define WPI_GP_CNTRL_SLEEP (1 << 4) 152#define WPI_GP_CNTRL_PS_MASK (7 << 24) 153#define WPI_GP_CNTRL_MAC_PS (4 << 24) 154#define WPI_GP_CNTRL_RFKILL (1 << 27) 155 156/* Possible flags for register WPI_GIO_CHICKEN. */ 157#define WPI_GIO_CHICKEN_L1A_NO_L0S_RX (1 << 23) 158#define WPI_GIO_CHICKEN_DIS_L0S_TIMER (1 << 29) 159 160/* Possible flags for register WPI_GIO. */ 161#define WPI_GIO_L0S_ENA (1 << 1) 162 163/* Possible flags for register WPI_FH_RX_CONFIG. */ 164#define WPI_FH_RX_CONFIG_DMA_ENA (1U << 31) 165#define WPI_FH_RX_CONFIG_RDRBD_ENA (1 << 29) 166#define WPI_FH_RX_CONFIG_WRSTATUS_ENA (1 << 27) 167#define WPI_FH_RX_CONFIG_MAXFRAG (1 << 24) 168#define WPI_FH_RX_CONFIG_NRBD(x) ((x) << 20) 169#define WPI_FH_RX_CONFIG_IRQ_DST_HOST (1 << 12) 170#define WPI_FH_RX_CONFIG_IRQ_TIMEOUT(x) ((x) << 4) 171 172/* Possible flags for register WPI_ANA_PLL. */ 173#define WPI_ANA_PLL_INIT (1 << 24) 174 175/* Possible flags for register WPI_UCODE_GP1*. */ 176#define WPI_UCODE_GP1_MAC_SLEEP (1 << 0) 177#define WPI_UCODE_GP1_RFKILL (1 << 1) 178#define WPI_UCODE_GP1_CMD_BLOCKED (1 << 2) 179 180/* Possible flags for register WPI_FH_RX_STATUS. */ 181#define WPI_FH_RX_STATUS_IDLE (1 << 24) 182 183/* Possible flags for register WPI_BSM_WR_CTRL. */ 184#define WPI_BSM_WR_CTRL_START_EN (1 << 30) 185#define WPI_BSM_WR_CTRL_START (1U << 31) 186 187/* Possible flags for register WPI_INT. */ 188#define WPI_INT_ALIVE (1 << 0) 189#define WPI_INT_WAKEUP (1 << 1) 190#define WPI_INT_SW_RX (1 << 3) 191#define WPI_INT_SW_ERR (1 << 25) 192#define WPI_INT_FH_TX (1 << 27) 193#define WPI_INT_HW_ERR (1 << 29) 194#define WPI_INT_FH_RX (1U << 31) 195 196/* Shortcut. */ 197#define WPI_INT_MASK_DEF \ 198 (WPI_INT_SW_ERR | WPI_INT_HW_ERR | WPI_INT_FH_TX | \ 199 WPI_INT_FH_RX | WPI_INT_ALIVE | WPI_INT_WAKEUP | \ 200 WPI_INT_SW_RX) 201 202/* Possible flags for register WPI_FH_INT. */ 203#define WPI_FH_INT_RX_CHNL(x) (1 << ((x) + 16)) 204#define WPI_FH_INT_HI_PRIOR (1 << 30) 205/* Shortcuts for the above. */ 206#define WPI_FH_INT_RX \ 207 (WPI_FH_INT_RX_CHNL(0) | \ 208 WPI_FH_INT_RX_CHNL(1) | \ 209 WPI_FH_INT_RX_CHNL(2) | \ 210 WPI_FH_INT_HI_PRIOR) 211 212/* Possible flags for register WPI_FH_TX_STATUS. */ 213#define WPI_FH_TX_STATUS_IDLE(qid) \ 214 (1 << ((qid) + 24) | 1 << ((qid) + 16)) 215 216/* Possible flags for register WPI_EEPROM. */ 217#define WPI_EEPROM_READ_VALID (1 << 0) 218 219/* Possible flags for register WPI_EEPROM_GP. */ 220#define WPI_EEPROM_VERSION 0x00000007 221#define WPI_EEPROM_GP_IF_OWNER 0x00000180 222 223/* Possible flags for register WPI_APMG_PS. */ 224#define WPI_APMG_PS_PWR_SRC_MASK (3 << 24) 225 226/* Possible flags for registers WPI_APMG_CLK_*. */ 227#define WPI_APMG_CLK_CTRL_DMA_CLK_RQT (1 << 9) 228#define WPI_APMG_CLK_CTRL_BSM_CLK_RQT (1 << 11) 229 230/* Possible flags for register WPI_APMG_PCI_STT. */ 231#define WPI_APMG_PCI_STT_L1A_DIS (1 << 11) 232 233struct wpi_shared { 234 uint32_t txbase[WPI_NTXQUEUES]; 235 uint32_t next; 236 uint32_t reserved[2]; 237} __packed; 238 239#define WPI_MAX_SEG_LEN 65520 240struct wpi_tx_desc { 241 uint8_t reserved1[3]; 242 uint8_t nsegs; 243#define WPI_PAD32(x) (roundup2(x, 4) - (x)) 244 245 struct { 246 uint32_t addr; 247 uint32_t len; 248 } __packed segs[WPI_MAX_SCATTER]; 249 uint8_t reserved2[28]; 250} __packed; 251 252struct wpi_tx_stat { 253 uint8_t rtsfailcnt; 254 uint8_t ackfailcnt; 255 uint8_t btkillcnt; 256 uint8_t rate; 257 uint32_t duration; 258 uint32_t status; 259} __packed; 260 261struct wpi_rx_desc { 262 uint32_t len; 263 uint8_t type; 264#define WPI_UC_READY 1 265#define WPI_RX_DONE 27 266#define WPI_TX_DONE 28 267#define WPI_START_SCAN 130 268#define WPI_SCAN_RESULTS 131 269#define WPI_STOP_SCAN 132 270#define WPI_BEACON_SENT 144 271#define WPI_RX_STATISTICS 156 272#define WPI_BEACON_STATISTICS 157 273#define WPI_STATE_CHANGED 161 274#define WPI_BEACON_MISSED 162 275 276 uint8_t flags; 277 uint8_t idx; 278 uint8_t qid; 279} __packed; 280 281#define WPI_RX_DESC_QID_MSK 0x07 282#define WPI_UNSOLICITED_RX_NOTIF 0x80 283 284struct wpi_rx_stat { 285 uint8_t len; 286#define WPI_STAT_MAXLEN 20 287 288 uint8_t id; 289 uint8_t rssi; /* received signal strength */ 290#define WPI_RSSI_OFFSET -95 291 292 uint8_t agc; /* access gain control */ 293 uint16_t signal; 294 uint16_t noise; 295} __packed; 296 297struct wpi_rx_head { 298 uint16_t chan; 299 uint16_t flags; 300#define WPI_STAT_FLAG_SHPREAMBLE (1 << 2) 301 302 uint8_t reserved; 303 uint8_t plcp; 304 uint16_t len; 305} __packed; 306 307struct wpi_rx_tail { 308 uint32_t flags; 309#define WPI_RX_NO_CRC_ERR (1 << 0) 310#define WPI_RX_NO_OVFL_ERR (1 << 1) 311/* shortcut for the above */ 312#define WPI_RX_NOERROR (WPI_RX_NO_CRC_ERR | WPI_RX_NO_OVFL_ERR) 313#define WPI_RX_CIPHER_MASK (7 << 8) 314#define WPI_RX_CIPHER_CCMP (2 << 8) 315#define WPI_RX_DECRYPT_MASK (3 << 11) 316#define WPI_RX_DECRYPT_OK (3 << 11) 317 318 uint64_t tstamp; 319 uint32_t tbeacon; 320} __packed; 321 322struct wpi_tx_cmd { 323 uint8_t code; 324#define WPI_CMD_RXON 16 325#define WPI_CMD_RXON_ASSOC 17 326#define WPI_CMD_EDCA_PARAMS 19 327#define WPI_CMD_TIMING 20 328#define WPI_CMD_ADD_NODE 24 329#define WPI_CMD_DEL_NODE 25 330#define WPI_CMD_TX_DATA 28 331#define WPI_CMD_MRR_SETUP 71 332#define WPI_CMD_SET_LED 72 333#define WPI_CMD_SET_POWER_MODE 119 334#define WPI_CMD_SCAN 128 335#define WPI_CMD_SET_BEACON 145 336#define WPI_CMD_TXPOWER 151 337#define WPI_CMD_BT_COEX 155 338#define WPI_CMD_GET_STATISTICS 156 339 340 uint8_t flags; 341 uint8_t idx; 342 uint8_t qid; 343 uint8_t data[124]; 344} __packed; 345 346/* Structure for command WPI_CMD_RXON. */ 347struct wpi_rxon { 348 uint8_t myaddr[IEEE80211_ADDR_LEN]; 349 uint16_t reserved1; 350 uint8_t bssid[IEEE80211_ADDR_LEN]; 351 uint16_t reserved2; 352 uint8_t wlap[IEEE80211_ADDR_LEN]; 353 uint16_t reserved3; 354 uint8_t mode; 355#define WPI_MODE_HOSTAP 1 356#define WPI_MODE_STA 3 357#define WPI_MODE_IBSS 4 358#define WPI_MODE_MONITOR 6 359 360 uint8_t air; 361 uint16_t reserved4; 362 uint8_t ofdm_mask; 363 uint8_t cck_mask; 364 uint16_t associd; 365 uint32_t flags; 366#define WPI_RXON_24GHZ (1 << 0) 367#define WPI_RXON_CCK (1 << 1) 368#define WPI_RXON_AUTO (1 << 2) 369#define WPI_RXON_SHSLOT (1 << 4) 370#define WPI_RXON_SHPREAMBLE (1 << 5) 371#define WPI_RXON_NODIVERSITY (1 << 7) 372#define WPI_RXON_ANTENNA_A (1 << 8) 373#define WPI_RXON_ANTENNA_B (1 << 9) 374#define WPI_RXON_TSF (1 << 15) 375#define WPI_RXON_CTS_TO_SELF (1 << 30) 376 377 uint32_t filter; 378#define WPI_FILTER_PROMISC (1 << 0) 379#define WPI_FILTER_CTL (1 << 1) 380#define WPI_FILTER_MULTICAST (1 << 2) 381#define WPI_FILTER_NODECRYPT (1 << 3) 382#define WPI_FILTER_BSS (1 << 5) 383#define WPI_FILTER_BEACON (1 << 6) 384#define WPI_FILTER_ASSOC (1 << 7) /* Accept associaton requests. */ 385 386 uint8_t chan; 387 uint16_t reserved5; 388} __packed; 389 390/* Structure for command WPI_CMD_RXON_ASSOC. */ 391struct wpi_assoc { 392 uint32_t flags; 393 uint32_t filter; 394 uint8_t ofdm_mask; 395 uint8_t cck_mask; 396 uint16_t reserved; 397} __packed; 398 399/* Structure for command WPI_CMD_EDCA_PARAMS. */ 400struct wpi_edca_params { 401 uint32_t flags; 402#define WPI_EDCA_UPDATE (1 << 0) 403 404 struct { 405 uint16_t cwmin; 406 uint16_t cwmax; 407 uint8_t aifsn; 408 uint8_t reserved; 409 uint16_t txoplimit; 410 } __packed ac[WME_NUM_AC]; 411} __packed; 412 413/* Structure for command WPI_CMD_TIMING. */ 414struct wpi_cmd_timing { 415 uint64_t tstamp; 416 uint16_t bintval; 417 uint16_t atim; 418 uint32_t binitval; 419 uint16_t lintval; 420 uint16_t reserved; 421} __packed; 422 423/* Structure for command WPI_CMD_ADD_NODE. */ 424struct wpi_node_info { 425 uint8_t control; 426#define WPI_NODE_UPDATE (1 << 0) 427 428 uint8_t reserved1[3]; 429 uint8_t macaddr[IEEE80211_ADDR_LEN]; 430 uint16_t reserved2; 431 uint8_t id; 432#define WPI_ID_BSS 0 433#define WPI_ID_IBSS_MIN 2 434#define WPI_ID_IBSS_MAX 23 435#define WPI_ID_BROADCAST 24 436#define WPI_ID_UNDEFINED (uint8_t)-1 437 438 uint8_t flags; 439#define WPI_FLAG_KEY_SET (1 << 0) 440 441 uint16_t reserved3; 442 uint16_t kflags; 443#define WPI_KFLAG_CCMP (1 << 1) 444#define WPI_KFLAG_KID(kid) ((kid) << 8) 445#define WPI_KFLAG_MULTICAST (1 << 14) 446 447 uint8_t tsc2; 448 uint8_t reserved4; 449 uint16_t ttak[5]; 450 uint16_t reserved5; 451 uint8_t key[IEEE80211_KEYBUF_SIZE]; 452 uint32_t action; 453#define WPI_ACTION_SET_RATE (1 << 2) 454 455 uint32_t mask; 456 uint16_t tid; 457 uint8_t plcp; 458 uint8_t antenna; 459#define WPI_ANTENNA_A (1 << 6) 460#define WPI_ANTENNA_B (1 << 7) 461#define WPI_ANTENNA_BOTH (WPI_ANTENNA_A | WPI_ANTENNA_B) 462 463 uint8_t add_imm; 464 uint8_t del_imm; 465 uint16_t add_imm_start; 466} __packed; 467 468/* Structure for command WPI_CMD_DEL_NODE. */ 469struct wpi_cmd_del_node { 470 uint8_t count; 471 uint8_t reserved1[3]; 472 uint8_t macaddr[IEEE80211_ADDR_LEN]; 473 uint16_t reserved2; 474} __packed; 475 476/* Structure for command WPI_CMD_TX_DATA. */ 477struct wpi_cmd_data { 478 uint16_t len; 479 uint16_t lnext; 480 uint32_t flags; 481#define WPI_TX_NEED_RTS (1 << 1) 482#define WPI_TX_NEED_CTS (1 << 2) 483#define WPI_TX_NEED_ACK (1 << 3) 484#define WPI_TX_FULL_TXOP (1 << 7) 485#define WPI_TX_BT_DISABLE (1 << 12) /* bluetooth coexistence */ 486#define WPI_TX_AUTO_SEQ (1 << 13) 487#define WPI_TX_MORE_FRAG (1 << 14) 488#define WPI_TX_INSERT_TSTAMP (1 << 16) 489 490 uint8_t plcp; 491 uint8_t id; 492 uint8_t tid; 493 uint8_t security; 494#define WPI_CIPHER_WEP 1 495#define WPI_CIPHER_CCMP 2 496#define WPI_CIPHER_TKIP 3 497#define WPI_CIPHER_WEP104 9 498 499 uint8_t key[IEEE80211_KEYBUF_SIZE]; 500 uint8_t tkip[IEEE80211_WEP_MICLEN]; 501 uint32_t fnext; 502 uint32_t lifetime; 503#define WPI_LIFETIME_INFINITE 0xffffffff 504 505 uint8_t ofdm_mask; 506 uint8_t cck_mask; 507 uint8_t rts_ntries; 508 uint8_t data_ntries; 509 uint16_t timeout; 510 uint16_t txop; 511} __packed; 512 513/* Structure for command WPI_CMD_SET_BEACON. */ 514struct wpi_cmd_beacon { 515 uint16_t len; 516 uint16_t reserved1; 517 uint32_t flags; /* same as wpi_cmd_data */ 518 uint8_t plcp; 519 uint8_t id; 520 uint8_t reserved2[30]; 521 uint32_t lifetime; 522 uint8_t ofdm_mask; 523 uint8_t cck_mask; 524 uint16_t reserved3[3]; 525 uint16_t tim; 526 uint8_t timsz; 527 uint8_t reserved4; 528} __packed; 529 530/* Structure for notification WPI_BEACON_MISSED. */ 531struct wpi_beacon_missed { 532 uint32_t consecutive; 533 uint32_t total; 534 uint32_t expected; 535 uint32_t received; 536} __packed; 537 538 539/* Structure for command WPI_CMD_MRR_SETUP. */ 540#define WPI_RIDX_MAX 11 541struct wpi_mrr_setup { 542 uint32_t which; 543#define WPI_MRR_CTL 0 544#define WPI_MRR_DATA 1 545 546 struct { 547 uint8_t plcp; 548 uint8_t flags; 549 uint8_t ntries; 550#define WPI_NTRIES_DEFAULT 2 551 552 uint8_t next; 553 } __packed rates[WPI_RIDX_MAX + 1]; 554} __packed; 555 556/* Structure for command WPI_CMD_SET_LED. */ 557struct wpi_cmd_led { 558 uint32_t unit; /* multiplier (in usecs) */ 559 uint8_t which; 560#define WPI_LED_ACTIVITY 1 561#define WPI_LED_LINK 2 562 563 uint8_t off; 564 uint8_t on; 565 uint8_t reserved; 566} __packed; 567 568/* Structure for command WPI_CMD_SET_POWER_MODE. */ 569struct wpi_pmgt_cmd { 570 uint16_t flags; 571#define WPI_PS_ALLOW_SLEEP (1 << 0) 572#define WPI_PS_NOTIFY (1 << 1) 573#define WPI_PS_SLEEP_OVER_DTIM (1 << 2) 574#define WPI_PS_PCI_PMGT (1 << 3) 575 576 uint8_t reserved[2]; 577 uint32_t rxtimeout; 578 uint32_t txtimeout; 579 uint32_t intval[5]; 580} __packed; 581 582/* Structures for command WPI_CMD_SCAN. */ 583#define WPI_SCAN_MAX_ESSIDS 4 584struct wpi_scan_essid { 585 uint8_t id; 586 uint8_t len; 587 uint8_t data[IEEE80211_NWID_LEN]; 588} __packed; 589 590struct wpi_scan_hdr { 591 uint16_t len; 592 uint8_t reserved1; 593 uint8_t nchan; 594 uint16_t quiet_time; 595 uint16_t quiet_threshold; 596 uint16_t crc_threshold; 597 uint16_t reserved2; 598 uint32_t max_svc; /* background scans */ 599 uint32_t pause_svc; /* background scans */ 600 uint32_t flags; 601 uint32_t filter; 602 603 /* Followed by a struct wpi_cmd_data. */ 604 /* Followed by an array of 4 structs wpi_scan_essid. */ 605 /* Followed by probe request body. */ 606 /* Followed by an array of ``nchan'' structs wpi_scan_chan. */ 607} __packed; 608 609struct wpi_scan_chan { 610 uint8_t flags; 611#define WPI_CHAN_ACTIVE (1 << 0) 612#define WPI_CHAN_NPBREQS(x) (((1 << (x)) - 1) << 1) 613 614 uint8_t chan; 615 uint8_t rf_gain; 616 uint8_t dsp_gain; 617 uint16_t active; /* msecs */ 618 uint16_t passive; /* msecs */ 619} __packed; 620 621#define WPI_SCAN_CRC_TH_DEFAULT htole16(1) 622#define WPI_SCAN_CRC_TH_NEVER htole16(0xffff) 623 624/* Maximum size of a scan command. */ 625#define WPI_SCAN_MAXSZ (MCLBYTES - 4) 626 627#define WPI_ACTIVE_DWELL_TIME_2GHZ (30) /* all times in msec */ 628#define WPI_ACTIVE_DWELL_TIME_5GHZ (20) 629#define WPI_ACTIVE_DWELL_FACTOR_2GHZ ( 3) 630#define WPI_ACTIVE_DWELL_FACTOR_5GHZ ( 2) 631 632#define WPI_PASSIVE_DWELL_TIME_2GHZ ( 20) 633#define WPI_PASSIVE_DWELL_TIME_5GHZ ( 10) 634#define WPI_PASSIVE_DWELL_BASE (100) 635 636/* Structure for command WPI_CMD_TXPOWER. */ 637struct wpi_cmd_txpower { 638 uint8_t band; 639#define WPI_BAND_5GHZ 0 640#define WPI_BAND_2GHZ 1 641 642 uint8_t reserved; 643 uint16_t chan; 644 645 struct { 646 uint8_t plcp; 647 uint8_t rf_gain; 648 uint8_t dsp_gain; 649 uint8_t reserved; 650 } __packed rates[WPI_RIDX_MAX + 1]; 651 652} __packed; 653 654/* Structure for command WPI_CMD_BT_COEX. */ 655struct wpi_bluetooth { 656 uint8_t flags; 657#define WPI_BT_COEX_DISABLE 0 658#define WPI_BT_COEX_MODE_2WIRE 1 659#define WPI_BT_COEX_MODE_3WIRE 2 660#define WPI_BT_COEX_MODE_4WIRE 3 661 662 uint8_t lead_time; 663#define WPI_BT_LEAD_TIME_DEF 30 664 665 uint8_t max_kill; 666#define WPI_BT_MAX_KILL_DEF 5 667 668 uint8_t reserved; 669 uint32_t kill_ack; 670 uint32_t kill_cts; 671} __packed; 672 673/* Structure for WPI_UC_READY notification. */ 674struct wpi_ucode_info { 675 uint8_t minor; 676 uint8_t major; 677 uint16_t reserved1; 678 uint8_t revision[8]; 679 uint8_t type; 680 uint8_t subtype; 681 uint16_t reserved2; 682 uint32_t logptr; 683 uint32_t errptr; 684 uint32_t tstamp; 685 uint32_t valid; 686} __packed; 687 688/* Structure for WPI_START_SCAN notification. */ 689struct wpi_start_scan { 690 uint64_t tstamp; 691 uint32_t tbeacon; 692 uint8_t chan; 693 uint8_t band; 694 uint16_t reserved; 695 uint32_t status; 696} __packed; 697 698/* Structure for WPI_STOP_SCAN notification. */ 699struct wpi_stop_scan { 700 uint8_t nchan; 701 uint8_t status; 702 uint8_t reserved; 703 uint8_t chan; 704 uint64_t tsf; 705} __packed; 706 707/* Structures for WPI_{RX,BEACON}_STATISTICS notification. */ 708struct wpi_rx_phy_stats { 709 uint32_t ina; 710 uint32_t fina; 711 uint32_t bad_plcp; 712 uint32_t bad_crc32; 713 uint32_t overrun; 714 uint32_t eoverrun; 715 uint32_t good_crc32; 716 uint32_t fa; 717 uint32_t bad_fina_sync; 718 uint32_t sfd_timeout; 719 uint32_t fina_timeout; 720 uint32_t no_rts_ack; 721 uint32_t rxe_limit; 722 uint32_t ack; 723 uint32_t cts; 724} __packed; 725 726struct wpi_rx_general_stats { 727 uint32_t bad_cts; 728 uint32_t bad_ack; 729 uint32_t not_bss; 730 uint32_t filtered; 731 uint32_t bad_chan; 732} __packed; 733 734struct wpi_rx_stats { 735 struct wpi_rx_phy_stats ofdm; 736 struct wpi_rx_phy_stats cck; 737 struct wpi_rx_general_stats general; 738} __packed; 739 740struct wpi_tx_stats { 741 uint32_t preamble; 742 uint32_t rx_detected; 743 uint32_t bt_defer; 744 uint32_t bt_kill; 745 uint32_t short_len; 746 uint32_t cts_timeout; 747 uint32_t ack_timeout; 748 uint32_t exp_ack; 749 uint32_t ack; 750} __packed; 751 752struct wpi_general_stats { 753 uint32_t temp; 754 uint32_t burst_check; 755 uint32_t burst; 756 uint32_t reserved[4]; 757 uint32_t sleep; 758 uint32_t slot_out; 759 uint32_t slot_idle; 760 uint32_t ttl_tstamp; 761 uint32_t tx_ant_a; 762 uint32_t tx_ant_b; 763 uint32_t exec; 764 uint32_t probe; 765} __packed; 766 767struct wpi_stats { 768 uint32_t flags; 769 struct wpi_rx_stats rx; 770 struct wpi_tx_stats tx; 771 struct wpi_general_stats general; 772} __packed; 773 774/* Possible flags for command WPI_CMD_GET_STATISTICS. */ 775#define WPI_STATISTICS_BEACON_DISABLE (1 << 1) 776 777 778/* Firmware error dump entry. */ 779struct wpi_fw_dump { 780 uint32_t desc; 781 uint32_t time; 782 uint32_t blink[2]; 783 uint32_t ilink[2]; 784 uint32_t data; 785} __packed; 786 787/* Firmware image file header. */ 788struct wpi_firmware_hdr { 789 790#define WPI_FW_MINVERSION 2144 791#define WPI_FW_NAME "wpifw" 792 793 uint16_t driver; 794 uint8_t minor; 795 uint8_t major; 796 uint32_t rtextsz; 797 uint32_t rdatasz; 798 uint32_t itextsz; 799 uint32_t idatasz; 800 uint32_t btextsz; 801} __packed; 802 803#define WPI_FW_TEXT_MAXSZ ( 80 * 1024 ) 804#define WPI_FW_DATA_MAXSZ ( 32 * 1024 ) 805#define WPI_FW_BOOT_TEXT_MAXSZ 1024 806 807#define WPI_FW_UPDATED (1U << 31 ) 808 809/* 810 * Offsets into EEPROM. 811 */ 812#define WPI_EEPROM_MAC 0x015 813#define WPI_EEPROM_REVISION 0x035 814#define WPI_EEPROM_SKU_CAP 0x045 815#define WPI_EEPROM_TYPE 0x04a 816#define WPI_EEPROM_DOMAIN 0x060 817#define WPI_EEPROM_BAND1 0x063 818#define WPI_EEPROM_BAND2 0x072 819#define WPI_EEPROM_BAND3 0x080 820#define WPI_EEPROM_BAND4 0x08d 821#define WPI_EEPROM_BAND5 0x099 822#define WPI_EEPROM_POWER_GRP 0x100 823 824struct wpi_eeprom_chan { 825 uint8_t flags; 826#define WPI_EEPROM_CHAN_VALID (1 << 0) 827#define WPI_EEPROM_CHAN_IBSS (1 << 1) 828#define WPI_EEPROM_CHAN_ACTIVE (1 << 3) 829#define WPI_EEPROM_CHAN_RADAR (1 << 4) 830 831 int8_t maxpwr; 832} __packed; 833 834struct wpi_eeprom_sample { 835 uint8_t index; 836 int8_t power; 837 uint16_t volt; 838} __packed; 839 840#define WPI_POWER_GROUPS_COUNT 5 841struct wpi_eeprom_group { 842 struct wpi_eeprom_sample samples[5]; 843 int32_t coef[5]; 844 int32_t corr[5]; 845 int8_t maxpwr; 846 uint8_t chan; 847 int16_t temp; 848} __packed; 849 850#define WPI_CHAN_BANDS_COUNT 5 851#define WPI_MAX_CHAN_PER_BAND 14 852static const struct wpi_chan_band { 853 uint32_t addr; /* offset in EEPROM */ 854 uint8_t nchan; 855 uint8_t chan[WPI_MAX_CHAN_PER_BAND]; 856} wpi_bands[] = { 857 /* 20MHz channels, 2GHz band. */ 858 { WPI_EEPROM_BAND1, 14, 859 { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 } }, 860 /* 20MHz channels, 5GHz band. */ 861 { WPI_EEPROM_BAND2, 13, 862 { 183, 184, 185, 187, 188, 189, 192, 196, 7, 8, 11, 12, 16 } }, 863 { WPI_EEPROM_BAND3, 12, 864 { 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64 } }, 865 { WPI_EEPROM_BAND4, 11, 866 { 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 } }, 867 { WPI_EEPROM_BAND5, 6, 868 { 145, 149, 153, 157, 161, 165 } } 869}; 870 871/* HW rate indices. */ 872#define WPI_RIDX_OFDM6 0 873#define WPI_RIDX_OFDM36 5 874#define WPI_RIDX_OFDM48 6 875#define WPI_RIDX_OFDM54 7 876#define WPI_RIDX_CCK1 8 877#define WPI_RIDX_CCK2 9 878#define WPI_RIDX_CCK11 11 879 880static const uint8_t wpi_ridx_to_plcp[] = { 881 /* OFDM: IEEE Std 802.11a-1999, pp. 14 Table 80 */ 882 /* R1-R4 (ral/ural is R4-R1) */ 883 0xd, 0xf, 0x5, 0x7, 0x9, 0xb, 0x1, 0x3, 884 /* CCK: device-dependent */ 885 10, 20, 55, 110 886}; 887 888#define WPI_MAX_PWR_INDEX 77 889 890/* 891 * RF Tx gain values from highest to lowest power (values obtained from 892 * the reference driver.) 893 */ 894static const uint8_t wpi_rf_gain_2ghz[WPI_MAX_PWR_INDEX + 1] = { 895 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xbb, 0xbb, 0xbb, 896 0xbb, 0xf3, 0xf3, 0xf3, 0xf3, 0xf3, 0xd3, 0xd3, 0xb3, 0xb3, 0xb3, 897 0x93, 0x93, 0x93, 0x93, 0x93, 0x93, 0x93, 0x73, 0xeb, 0xeb, 0xeb, 898 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xab, 0xab, 0xab, 0x8b, 899 0xe3, 0xe3, 0xe3, 0xe3, 0xe3, 0xe3, 0xc3, 0xc3, 0xc3, 0xc3, 0xa3, 900 0xa3, 0xa3, 0xa3, 0x83, 0x83, 0x83, 0x83, 0x63, 0x63, 0x63, 0x63, 901 0x43, 0x43, 0x43, 0x43, 0x23, 0x23, 0x23, 0x23, 0x03, 0x03, 0x03, 902 0x03 903}; 904 905static const uint8_t wpi_rf_gain_5ghz[WPI_MAX_PWR_INDEX + 1] = { 906 0xfb, 0xfb, 0xfb, 0xdb, 0xdb, 0xbb, 0xbb, 0x9b, 0x9b, 0x7b, 0x7b, 907 0x7b, 0x7b, 0x5b, 0x3b, 0x3b, 0x3b, 0x3b, 0x3b, 0x3b, 0x1b, 0x1b, 908 0x1b, 0x73, 0x73, 0x73, 0x53, 0x53, 0x53, 0x53, 0x53, 0x33, 0x33, 909 0x33, 0x33, 0x13, 0x13, 0x13, 0x13, 0x13, 0xab, 0xab, 0xab, 0x8b, 910 0x8b, 0x8b, 0x8b, 0x6b, 0x6b, 0x6b, 0x6b, 0x4b, 0x4b, 0x4b, 0x4b, 911 0x2b, 0x2b, 0x2b, 0x2b, 0x0b, 0x0b, 0x0b, 0x0b, 0x83, 0x83, 0x63, 912 0x63, 0x63, 0x63, 0x43, 0x43, 0x43, 0x43, 0x23, 0x23, 0x23, 0x23, 913 0x03 914}; 915 916/* 917 * DSP pre-DAC gain values from highest to lowest power (values obtained 918 * from the reference driver.) 919 */ 920static const uint8_t wpi_dsp_gain_2ghz[WPI_MAX_PWR_INDEX + 1] = { 921 0x7f, 0x7f, 0x7f, 0x7f, 0x7d, 0x6e, 0x69, 0x62, 0x7d, 0x73, 0x6c, 922 0x63, 0x77, 0x6f, 0x69, 0x61, 0x5c, 0x6a, 0x64, 0x78, 0x71, 0x6b, 923 0x7d, 0x77, 0x70, 0x6a, 0x65, 0x61, 0x5b, 0x6b, 0x79, 0x73, 0x6d, 924 0x7f, 0x79, 0x73, 0x6c, 0x66, 0x60, 0x5c, 0x6e, 0x68, 0x62, 0x74, 925 0x7d, 0x77, 0x71, 0x6b, 0x65, 0x60, 0x71, 0x6a, 0x66, 0x5f, 0x71, 926 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f, 927 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 928 0x5f 929}; 930 931static const uint8_t wpi_dsp_gain_5ghz[WPI_MAX_PWR_INDEX + 1] = { 932 0x7f, 0x78, 0x72, 0x77, 0x65, 0x71, 0x66, 0x72, 0x67, 0x75, 0x6b, 933 0x63, 0x5c, 0x6c, 0x7d, 0x76, 0x6d, 0x66, 0x60, 0x5a, 0x68, 0x62, 934 0x5c, 0x76, 0x6f, 0x68, 0x7e, 0x79, 0x71, 0x69, 0x63, 0x76, 0x6f, 935 0x68, 0x62, 0x74, 0x6d, 0x66, 0x62, 0x5d, 0x71, 0x6b, 0x63, 0x78, 936 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 937 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x6b, 0x63, 0x78, 938 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 939 0x78 940}; 941 942/* 943 * Power saving settings (values obtained from the reference driver.) 944 */ 945#define WPI_NDTIMRANGES 2 946#define WPI_NPOWERLEVELS 6 947static const struct wpi_pmgt { 948 uint32_t rxtimeout; 949 uint32_t txtimeout; 950 uint32_t intval[5]; 951 int skip_dtim; 952} wpi_pmgt[WPI_NDTIMRANGES][WPI_NPOWERLEVELS] = { 953 /* DTIM <= 10 */ 954 { 955 { 0, 0, { 0, 0, 0, 0, 0 }, 0 }, /* CAM */ 956 { 200, 500, { 1, 2, 3, 4, 4 }, 0 }, /* PS level 1 */ 957 { 200, 300, { 2, 4, 6, 7, 7 }, 0 }, /* PS level 2 */ 958 { 50, 100, { 2, 6, 9, 9, 10 }, 0 }, /* PS level 3 */ 959 { 50, 25, { 2, 7, 9, 9, 10 }, 1 }, /* PS level 4 */ 960 { 25, 25, { 4, 7, 10, 10, 10 }, 1 } /* PS level 5 */ 961 }, 962 /* DTIM >= 11 */ 963 { 964 { 0, 0, { 0, 0, 0, 0, 0 }, 0 }, /* CAM */ 965 { 200, 500, { 1, 2, 3, 4, -1 }, 0 }, /* PS level 1 */ 966 { 200, 300, { 2, 4, 6, 7, -1 }, 0 }, /* PS level 2 */ 967 { 50, 100, { 2, 6, 9, 9, -1 }, 0 }, /* PS level 3 */ 968 { 50, 25, { 2, 7, 9, 9, -1 }, 0 }, /* PS level 4 */ 969 { 25, 25, { 4, 7, 10, 10, -1 }, 0 } /* PS level 5 */ 970 } 971}; 972 973/* Firmware errors. */ 974static const char * const wpi_fw_errmsg[] = { 975 "OK", 976 "FAIL", 977 "BAD_PARAM", 978 "BAD_CHECKSUM", 979 "NMI_INTERRUPT", 980 "SYSASSERT", 981 "FATAL_ERROR" 982}; 983 984#define WPI_READ(sc, reg) \ 985 bus_space_read_4((sc)->sc_st, (sc)->sc_sh, (reg)) 986 987#define WPI_WRITE(sc, reg, val) \ 988 bus_space_write_4((sc)->sc_st, (sc)->sc_sh, (reg), (val)) 989 990#define WPI_WRITE_REGION_4(sc, offset, datap, count) \ 991 bus_space_write_region_4((sc)->sc_st, (sc)->sc_sh, (offset), \ 992 (datap), (count)) 993 994#define WPI_SETBITS(sc, reg, mask) \ 995 WPI_WRITE(sc, reg, WPI_READ(sc, reg) | (mask)) 996 997#define WPI_CLRBITS(sc, reg, mask) \ 998 WPI_WRITE(sc, reg, WPI_READ(sc, reg) & ~(mask)) 999 1000#define WPI_BARRIER_WRITE(sc) \ 1001 bus_space_barrier((sc)->sc_st, (sc)->sc_sh, 0, (sc)->sc_sz, \ 1002 BUS_SPACE_BARRIER_WRITE) 1003 1004#define WPI_BARRIER_READ_WRITE(sc) \ 1005 bus_space_barrier((sc)->sc_st, (sc)->sc_sh, 0, (sc)->sc_sz, \ 1006 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE) 1007