1 /* $NetBSD: if_wpireg.h,v 1.8 2007/11/28 22:51:49 degroote Exp $ */
5 * Damien Bergamini <damien.bergamini@free.fr>
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.
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.
20 #define WPI_TX_RING_COUNT 256
21 #define WPI_CMD_RING_COUNT 256
22 #define WPI_RX_RING_COUNT 64
24 #define WPI_BUF_ALIGN 4096
27 * Rings must be aligned on a four 4K-pages boundary.
28 * I had a hard time figuring this out.
30 #define WPI_RING_DMA_ALIGN 0x4000
32 /* maximum scatter/gather */
33 #define WPI_MAX_SCATTER 4
35 /* maximum Rx buffer size (larger than MCLBYTES) */
36 #define WPI_RBUF_SIZE (3 * 1024) /* XXX 3000 but must be aligned! */
39 * Control and status registers.
41 #define WPI_HWCONFIG 0x000
42 #define WPI_INTR 0x008
43 #define WPI_MASK 0x00c
44 #define WPI_INTR_STATUS 0x010
45 #define WPI_GPIO_STATUS 0x018
46 #define WPI_RESET 0x020
47 #define WPI_GPIO_CTL 0x024
48 #define WPI_EEPROM_CTL 0x02c
49 #define WPI_EEPROM_STATUS 0x030
50 #define WPI_UCODE_CLR 0x05c
51 #define WPI_TEMPERATURE 0x060
52 #define WPI_CHICKEN 0x100
53 #define WPI_PLL_CTL 0x20c
54 #define WPI_WRITE_MEM_ADDR 0x444
55 #define WPI_READ_MEM_ADDR 0x448
56 #define WPI_WRITE_MEM_DATA 0x44c
57 #define WPI_READ_MEM_DATA 0x450
58 #define WPI_TX_WIDX 0x460
59 #define WPI_TX_CTL(qid) (0x940 + (qid) * 8)
60 #define WPI_TX_BASE(qid) (0x944 + (qid) * 8)
61 #define WPI_TX_DESC(qid) (0x980 + (qid) * 80)
62 #define WPI_RX_CONFIG 0xc00
63 #define WPI_RX_BASE 0xc04
64 #define WPI_RX_WIDX 0xc20
65 #define WPI_RX_RIDX_PTR 0xc24
66 #define WPI_RX_CTL 0xcc0
67 #define WPI_RX_STATUS 0xcc4
68 #define WPI_TX_CONFIG(qid) (0xd00 + (qid) * 32)
69 #define WPI_TX_CREDIT(qid) (0xd04 + (qid) * 32)
70 #define WPI_TX_STATE(qid) (0xd08 + (qid) * 32)
71 #define WPI_TX_BASE_PTR 0xe80
72 #define WPI_MSG_CONFIG 0xe88
73 #define WPI_TX_STATUS 0xe90
77 * NIC internal memory offsets.
79 #define WPI_MEM_MODE 0x2e00
80 #define WPI_MEM_RA 0x2e04
81 #define WPI_MEM_TXCFG 0x2e10
82 #define WPI_MEM_MAGIC4 0x2e14
83 #define WPI_MEM_MAGIC5 0x2e20
84 #define WPI_MEM_BYPASS1 0x2e2c
85 #define WPI_MEM_BYPASS2 0x2e30
86 #define WPI_MEM_CLOCK1 0x3004
87 #define WPI_MEM_CLOCK2 0x3008
88 #define WPI_MEM_POWER 0x300c
89 #define WPI_MEM_PCIDEV 0x3010
90 #define WPI_MEM_RFKILL 0x3014
91 #define WPI_MEM_UCODE_CTL 0x3400
92 #define WPI_MEM_UCODE_SRC 0x3404
93 #define WPI_MEM_UCODE_DST 0x3408
94 #define WPI_MEM_UCODE_SIZE 0x340c
95 #define WPI_MEM_UCODE_BASE 0x3800
98 #define WPI_MEM_TEXT_BASE 0x3490
99 #define WPI_MEM_TEXT_SIZE 0x3494
100 #define WPI_MEM_DATA_BASE 0x3498
101 #define WPI_MEM_DATA_SIZE 0x349c
103 /* possible flags for register WPI_HWCONFIG */
104 #define WPI_HW_ALM_MB (1 << 8)
105 #define WPI_HW_ALM_MM (1 << 9)
106 #define WPI_HW_SKU_MRC (1 << 10)
107 #define WPI_HW_REV_D (1 << 11)
108 #define WPI_HW_TYPE_B (1 << 12)
110 /* possible flags for registers WPI_READ_MEM_ADDR/WPI_WRITE_MEM_ADDR */
111 #define WPI_MEM_4 ((sizeof (uint32_t) - 1) << 24)
113 /* possible values for WPI_MEM_UCODE_DST */
114 #define WPI_FW_TEXT 0x00000000
116 /* possible flags for WPI_GPIO_STATUS */
117 #define WPI_POWERED (1 << 9)
119 /* possible flags for register WPI_RESET */
120 #define WPI_NEVO_RESET (1 << 0)
121 #define WPI_SW_RESET (1 << 7)
122 #define WPI_MASTER_DISABLED (1 << 8)
123 #define WPI_STOP_MASTER (1 << 9)
125 /* possible flags for register WPI_GPIO_CTL */
126 #define WPI_GPIO_CLOCK (1 << 0)
127 #define WPI_GPIO_INIT (1 << 2)
128 #define WPI_GPIO_MAC (1 << 3)
129 #define WPI_GPIO_SLEEP (1 << 4)
130 #define WPI_GPIO_PWR_STATUS 0x07000000
131 #define WPI_GPIO_PWR_SLEEP (4 << 24)
133 /* possible flags for register WPI_CHICKEN */
134 #define WPI_CHICKEN_RXNOLOS (1 << 23)
136 /* possible flags for register WPI_PLL_CTL */
137 #define WPI_PLL_INIT (1 << 24)
139 /* possible flags for register WPI_UCODE_CLR */
140 #define WPI_RADIO_OFF (1 << 1)
141 #define WPI_DISABLE_CMD (1 << 2)
143 /* possible flags for WPI_RX_STATUS */
144 #define WPI_RX_IDLE (1 << 24)
146 /* possible flags for register WPI_UC_CTL */
147 #define WPI_UC_ENABLE (1 << 30)
148 #define WPI_UC_RUN (1 << 31)
150 /* possible flags for register WPI_INTR_CSR */
151 #define WPI_ALIVE_INTR (1 << 0)
152 #define WPI_WAKEUP_INTR (1 << 1)
153 #define WPI_SW_ERROR (1 << 25)
154 #define WPI_TX_INTR (1 << 27)
155 #define WPI_HW_ERROR (1 << 29)
156 #define WPI_RX_INTR (1 << 31)
158 #define WPI_INTR_MASK \
159 (WPI_SW_ERROR | WPI_HW_ERROR | WPI_TX_INTR | WPI_RX_INTR | \
160 WPI_ALIVE_INTR | WPI_WAKEUP_INTR)
162 /* possible flags for register WPI_TX_STATUS */
163 #define WPI_TX_IDLE(qid) (1 << ((qid) + 24) | 1 << ((qid) + 16))
165 /* possible flags for register WPI_EEPROM_CTL */
166 #define WPI_EEPROM_READY (1 << 0)
168 /* possible flags for register WPI_EEPROM_STATUS */
169 #define WPI_EEPROM_VERSION 0x00000007
170 #define WPI_EEPROM_LOCKED 0x00000180
176 uint32_t reserved
[2];
179 #define WPI_MAX_SEG_LEN 65520
182 #define WPI_PAD32(x) ((((x) + 3) & ~3) - (x))
187 } __packed segs
[WPI_MAX_SCATTER
];
188 uint8_t reserved
[28];
203 #define WPI_UC_READY 1
204 #define WPI_RX_DONE 27
205 #define WPI_TX_DONE 28
206 #define WPI_START_SCAN 130
207 #define WPI_STOP_SCAN 132
208 #define WPI_STATE_CHANGED 161
217 #define WPI_STAT_MAXLEN 20
220 uint8_t rssi
; /* received signal strength */
221 #define WPI_RSSI_OFFSET 95
223 uint8_t agc
; /* access gain control */
238 #define WPI_RX_NO_CRC_ERR (1 << 0)
239 #define WPI_RX_NO_OVFL_ERR (1 << 1)
240 /* shortcut for the above */
241 #define WPI_RX_NOERROR (WPI_RX_NO_CRC_ERR | WPI_RX_NO_OVFL_ERR)
249 #define WPI_CMD_CONFIGURE 16
250 #define WPI_CMD_ASSOCIATE 17
251 #define WPI_CMD_SET_WME 19
252 #define WPI_CMD_TSF 20
253 #define WPI_CMD_ADD_NODE 24
254 #define WPI_CMD_TX_DATA 28
255 #define WPI_CMD_MRR_SETUP 71
256 #define WPI_CMD_SET_LED 72
257 #define WPI_CMD_SET_POWER_MODE 119
258 #define WPI_CMD_SCAN 128
259 #define WPI_CMD_SET_BEACON 145
260 #define WPI_CMD_TXPOWER 151
261 #define WPI_CMD_BLUETOOTH 155
269 /* structure for WPI_CMD_CONFIGURE */
271 uint8_t myaddr
[IEEE80211_ADDR_LEN
];
273 uint8_t bssid
[IEEE80211_ADDR_LEN
];
275 uint32_t reserved3
[2];
277 #define WPI_MODE_HOSTAP 1
278 #define WPI_MODE_STA 3
279 #define WPI_MODE_IBSS 4
280 #define WPI_MODE_MONITOR 6
282 uint8_t reserved4
[3];
288 #define WPI_CONFIG_24GHZ (1 << 0)
289 #define WPI_CONFIG_CCK (1 << 1)
290 #define WPI_CONFIG_AUTO (1 << 2)
291 #define WPI_CONFIG_SHSLOT (1 << 4)
292 #define WPI_CONFIG_SHPREAMBLE (1 << 5)
293 #define WPI_CONFIG_NODIVERSITY (1 << 7)
294 #define WPI_CONFIG_ANTENNA_A (1 << 8)
295 #define WPI_CONFIG_ANTENNA_B (1 << 9)
296 #define WPI_CONFIG_TSF (1 << 15)
299 #define WPI_FILTER_PROMISC (1 << 0)
300 #define WPI_FILTER_CTL (1 << 1)
301 #define WPI_FILTER_MULTICAST (1 << 2)
302 #define WPI_FILTER_NODECRYPT (1 << 3)
303 #define WPI_FILTER_BSS (1 << 5)
304 #define WPI_FILTER_BEACON (1 << 6)
307 uint8_t reserved6
[3];
310 /* structure for command WPI_CMD_ASSOCIATE */
319 /* structure for command WPI_CMD_SET_WME */
320 struct wpi_wme_setup
{
328 } __packed ac
[WME_NUM_AC
];
331 /* structure for command WPI_CMD_TSF */
341 /* structure for WPI_CMD_ADD_NODE */
342 struct wpi_node_info
{
344 #define WPI_NODE_UPDATE (1 << 0)
346 uint8_t reserved1
[3];
347 uint8_t bssid
[IEEE80211_ADDR_LEN
];
351 #define WPI_ID_BROADCAST 24
360 uint8_t key
[IEEE80211_KEYBUF_SIZE
];
362 #define WPI_ACTION_SET_RATE 4
368 #define WPI_ANTENNA_A (1 << 6)
369 #define WPI_ANTENNA_B (1 << 7)
370 #define WPI_ANTENNA_BOTH (WPI_ANTENNA_A | WPI_ANTENNA_B)
374 uint16_t add_imm_start
;
377 /* structure for command WPI_CMD_TX_DATA */
378 struct wpi_cmd_data
{
382 #define WPI_TX_NEED_RTS (1 << 1)
383 #define WPI_TX_NEED_ACK (1 << 3)
384 #define WPI_TX_FULL_TXOP (1 << 7)
385 #define WPI_TX_BT_DISABLE (1 << 12) /* bluetooth coexistence */
386 #define WPI_TX_AUTO_SEQ (1 << 13)
387 #define WPI_TX_INSERT_TSTAMP (1 << 16)
393 uint8_t key
[IEEE80211_KEYBUF_SIZE
];
394 uint8_t tkip
[IEEE80211_WEP_MICLEN
];
397 #define WPI_LIFETIME_INFINITE 0xffffffff
407 /* structure for command WPI_CMD_SET_BEACON */
408 struct wpi_cmd_beacon
{
411 uint32_t flags
; /* same as wpi_cmd_data */
414 uint8_t reserved2
[30];
418 uint16_t reserved3
[3];
422 struct ieee80211_frame wh
;
425 /* structure for WPI_CMD_MRR_SETUP */
426 struct wpi_mrr_setup
{
428 #define WPI_MRR_CTL 0
429 #define WPI_MRR_DATA 1
442 } __packed rates
[WPI_CCK11
+ 1];
445 /* structure for WPI_CMD_SET_LED */
447 uint32_t unit
; /* multiplier (in usecs) */
449 #define WPI_LED_ACTIVITY 1
450 #define WPI_LED_LINK 2
457 /* structure for WPI_CMD_SET_POWER_MODE */
460 #define WPI_POWER_CAM 0 /* constantly awake mode */
467 /* structure for command WPI_CMD_SCAN */
469 struct wpi_scan_essid
{
472 uint8_t data
[IEEE80211_NWID_LEN
];
475 struct wpi_scan_hdr
{
480 uint16_t plcp_threshold
;
481 uint16_t crc_threshold
;
483 uint32_t max_svc
; /* background scans */
484 uint32_t pause_svc
; /* background scans */
488 /* wpi_cmd_data structure */
496 uint8_t key
[IEEE80211_KEYBUF_SIZE
];
497 uint8_t tkip
[IEEE80211_WEP_MICLEN
];
507 struct wpi_scan_essid essid
[4];
509 /* followed by probe request body */
510 /* followed by nchan x wpi_scan_chan */
513 struct wpi_scan_chan
{
516 #define WPI_CHAN_ACTIVE (1 << 0)
517 #define WPI_CHAN_DIRECT (1 << 1)
521 uint16_t active
; /* msecs */
522 uint16_t passive
; /* msecs */
525 /* structure for WPI_CMD_TXPOWER */
526 struct wpi_cmd_txpower
{
528 #define WPI_BAND_5GHZ 0
529 #define WPI_BAND_2GHZ 1
538 } __packed rates
[WPI_CCK11
+ 1];
541 /* structure for WPI_CMD_BLUETOOTH */
542 struct wpi_bluetooth
{
552 /* structure for WPI_UC_READY notification */
553 struct wpi_ucode_info
{
565 /* structure for WPI_START_SCAN notification */
566 struct wpi_start_scan
{
575 /* structure for WPI_STOP_SCAN notification */
576 struct wpi_stop_scan
{
584 /* firmware image header */
585 struct wpi_firmware_hdr
{
587 uint32_t main_textsz
;
588 uint32_t main_datasz
;
589 uint32_t init_textsz
;
590 uint32_t init_datasz
;
591 uint32_t boot_textsz
;
594 #define WPI_FW_MAIN_TEXT_MAXSZ (80 * 1024)
595 #define WPI_FW_MAIN_DATA_MAXSZ (32 * 1024)
596 #define WPI_FW_INIT_TEXT_MAXSZ (80 * 1024)
597 #define WPI_FW_INIT_DATA_MAXSZ (32 * 1024)
598 #define WPI_FW_BOOT_TEXT_MAXSZ (80 * 1024)
600 #define WPI_FW_UPDATED (1 << 31)
602 + * Offsets into EEPROM.
605 #define WPI_EEPROM_MAC 0x015
606 #define WPI_EEPROM_REVISION 0x035
607 #define WPI_EEPROM_CAPABILITIES 0x045
608 #define WPI_EEPROM_TYPE 0x04a
609 #define WPI_EEPROM_DOMAIN 0x060
610 #define WPI_EEPROM_BAND1 0x063
611 #define WPI_EEPROM_BAND2 0x072
612 #define WPI_EEPROM_BAND3 0x080
613 #define WPI_EEPROM_BAND4 0x08d
614 #define WPI_EEPROM_BAND5 0x099
615 #define WPI_EEPROM_POWER_GRP 0x100
617 struct wpi_eeprom_chan
{
619 #define WPI_EEPROM_CHAN_VALID (1 << 0)
620 #define WPI_EEPROM_CHAN_IBSS (1 << 1)
621 #define WPI_EEPROM_CHAN_ACTIVE (1 << 3)
622 #define WPI_EEPROM_CHAN_RADAR (1 << 4)
627 struct wpi_eeprom_sample
{
633 #define WPI_POWER_GROUPS_COUNT 5
634 struct wpi_eeprom_group
{
635 struct wpi_eeprom_sample samples
[5];
643 #define WPI_CHAN_BANDS_COUNT 5
644 #define WPI_MAX_CHAN_PER_BAND 14
645 static const struct wpi_chan_band
{
646 uint32_t addr
; /* offset in EEPROM */
648 uint8_t chan
[WPI_MAX_CHAN_PER_BAND
];
650 { WPI_EEPROM_BAND1
, 14,
651 { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 } },
652 { WPI_EEPROM_BAND2
, 13,
653 { 183, 184, 185, 187, 188, 189, 192, 196, 7, 8, 11, 12, 16 } },
654 { WPI_EEPROM_BAND3
, 12,
655 { 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64 } },
656 { WPI_EEPROM_BAND4
, 11,
657 { 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 } },
658 { WPI_EEPROM_BAND5
, 6,
659 { 145, 149, 153, 157, 161, 165 } }
662 /* convert rate index (device view) into rate in 500Kbps unit */
663 static const uint8_t wpi_ridx_to_rate
[] = {
664 12, 18, 24, 36, 48, 72, 96, 108, /* OFDM */
665 2, 4, 11, 22 /* CCK */
668 /* convert rate index (device view) into PLCP code */
669 static const uint8_t wpi_ridx_to_plcp
[] = {
670 0xd, 0xf, 0x5, 0x7, 0x9, 0xb, 0x1, 0x3, /* OFDM R1-R4 */
671 10, 20, 55, 110 /* CCK */
674 #define WPI_MAX_PWR_INDEX 77
676 * RF Tx gain values from highest to lowest power (values obtained from
677 * the reference driver.)
679 static const uint8_t wpi_rf_gain_2ghz
[WPI_MAX_PWR_INDEX
+ 1] = {
680 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xbb, 0xbb, 0xbb,
681 0xbb, 0xf3, 0xf3, 0xf3, 0xf3, 0xf3, 0xd3, 0xd3, 0xb3, 0xb3, 0xb3,
682 0x93, 0x93, 0x93, 0x93, 0x93, 0x93, 0x93, 0x73, 0xeb, 0xeb, 0xeb,
683 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xcb, 0xab, 0xab, 0xab, 0x8b,
684 0xe3, 0xe3, 0xe3, 0xe3, 0xe3, 0xe3, 0xc3, 0xc3, 0xc3, 0xc3, 0xa3,
685 0xa3, 0xa3, 0xa3, 0x83, 0x83, 0x83, 0x83, 0x63, 0x63, 0x63, 0x63,
686 0x43, 0x43, 0x43, 0x43, 0x23, 0x23, 0x23, 0x23, 0x03, 0x03, 0x03,
690 static const uint8_t wpi_rf_gain_5ghz
[WPI_MAX_PWR_INDEX
+ 1] = {
691 0xfb, 0xfb, 0xfb, 0xdb, 0xdb, 0xbb, 0xbb, 0x9b, 0x9b, 0x7b, 0x7b,
692 0x7b, 0x7b, 0x5b, 0x3b, 0x3b, 0x3b, 0x3b, 0x3b, 0x3b, 0x1b, 0x1b,
693 0x1b, 0x73, 0x73, 0x73, 0x53, 0x53, 0x53, 0x53, 0x53, 0x33, 0x33,
694 0x33, 0x33, 0x13, 0x13, 0x13, 0x13, 0x13, 0xab, 0xab, 0xab, 0x8b,
695 0x8b, 0x8b, 0x8b, 0x6b, 0x6b, 0x6b, 0x6b, 0x4b, 0x4b, 0x4b, 0x4b,
696 0x2b, 0x2b, 0x2b, 0x2b, 0x0b, 0x0b, 0x0b, 0x0b, 0x83, 0x83, 0x63,
697 0x63, 0x63, 0x63, 0x43, 0x43, 0x43, 0x43, 0x23, 0x23, 0x23, 0x23,
702 * DSP pre-DAC gain values from highest to lowest power (values obtained
703 * from the reference driver.)
705 static const uint8_t wpi_dsp_gain_2ghz
[WPI_MAX_PWR_INDEX
+ 1] = {
706 0x7f, 0x7f, 0x7f, 0x7f, 0x7d, 0x6e, 0x69, 0x62, 0x7d, 0x73, 0x6c,
707 0x63, 0x77, 0x6f, 0x69, 0x61, 0x5c, 0x6a, 0x64, 0x78, 0x71, 0x6b,
708 0x7d, 0x77, 0x70, 0x6a, 0x65, 0x61, 0x5b, 0x6b, 0x79, 0x73, 0x6d,
709 0x7f, 0x79, 0x73, 0x6c, 0x66, 0x60, 0x5c, 0x6e, 0x68, 0x62, 0x74,
710 0x7d, 0x77, 0x71, 0x6b, 0x65, 0x60, 0x71, 0x6a, 0x66, 0x5f, 0x71,
711 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f,
712 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66, 0x5f, 0x71, 0x6a, 0x66,
716 static const uint8_t wpi_dsp_gain_5ghz
[WPI_MAX_PWR_INDEX
+ 1] = {
717 0x7f, 0x78, 0x72, 0x77, 0x65, 0x71, 0x66, 0x72, 0x67, 0x75, 0x6b,
718 0x63, 0x5c, 0x6c, 0x7d, 0x76, 0x6d, 0x66, 0x60, 0x5a, 0x68, 0x62,
719 0x5c, 0x76, 0x6f, 0x68, 0x7e, 0x79, 0x71, 0x69, 0x63, 0x76, 0x6f,
720 0x68, 0x62, 0x74, 0x6d, 0x66, 0x62, 0x5d, 0x71, 0x6b, 0x63, 0x78,
721 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63,
722 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x6b, 0x63, 0x78,
723 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63, 0x78, 0x71, 0x6b, 0x63,
727 #define WPI_READ(sc, reg) \
728 bus_space_read_4((sc)->sc_st, (sc)->sc_sh, (reg))
730 #define WPI_WRITE(sc, reg, val) \
731 bus_space_write_4((sc)->sc_st, (sc)->sc_sh, (reg), (val))
733 #define WPI_WRITE_REGION_4(sc, offset, datap, count) \
734 bus_space_write_region_4((sc)->sc_st, (sc)->sc_sh, (offset), \