1 /******************************************************************************
3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19 ******************************************************************************/
20 #ifndef __HAL_COMMON_REG_H__
21 #define __HAL_COMMON_REG_H__
24 #define MAC_ADDR_LEN 6
26 #define HAL_NAV_UPPER_UNIT 128 /* micro-second */
28 /* 8188E PKT_BUFF_ACCESS_CTRL value */
29 #define TXPKT_BUF_SELECT 0x69
30 #define RXPKT_BUF_SELECT 0xA5
31 #define DISABLE_TRXPKT_BUF_ACCESS 0x0
34 /* ************************************************************
36 * ************************************************************ */
38 /* -----------------------------------------------------
40 * 0x0000h ~ 0x00FFh System Configuration
42 * ----------------------------------------------------- */
43 #define REG_SYS_ISO_CTRL 0x0000
44 #define REG_SYS_FUNC_EN 0x0002
45 #define REG_APS_FSMCO 0x0004
46 #define REG_SYS_CLKR 0x0008
47 #define REG_SYS_CLK_CTRL REG_SYS_CLKR
48 #define REG_9346CR 0x000A
49 #define REG_SYS_EEPROM_CTRL 0x000A
50 #define REG_EE_VPD 0x000C
51 #define REG_AFE_MISC 0x0010
52 #define REG_SPS0_CTRL 0x0011
53 #define REG_SPS0_CTRL_6 0x0016
54 #define REG_POWER_OFF_IN_PROCESS 0x0017
55 #define REG_SPS_OCP_CFG 0x0018
56 #define REG_RSV_CTRL 0x001C
57 #define REG_RF_CTRL 0x001F
58 #define REG_LDOA15_CTRL 0x0020
59 #define REG_LDOV12D_CTRL 0x0021
60 #define REG_LDOHCI12_CTRL 0x0022
61 #define REG_LPLDO_CTRL 0x0023
62 #define REG_AFE_XTAL_CTRL 0x0024
63 #define REG_AFE_LDO_CTRL 0x0027 /* 1.5v for 8188EE test chip, 1.4v for MP chip */
64 #define REG_AFE_PLL_CTRL 0x0028
65 #define REG_MAC_PHY_CTRL 0x002c /* for 92d, DMDP, SMSP, DMSP contrl */
66 #define REG_APE_PLL_CTRL_EXT 0x002c
67 #define REG_EFUSE_CTRL 0x0030
68 #define REG_EFUSE_TEST 0x0034
69 #define REG_PWR_DATA 0x0038
70 #define REG_CAL_TIMER 0x003C
71 #define REG_ACLK_MON 0x003E
72 #define REG_GPIO_MUXCFG 0x0040
73 #define REG_GPIO_IO_SEL 0x0042
74 #define REG_MAC_PINMUX_CFG 0x0043
75 #define REG_GPIO_PIN_CTRL 0x0044
76 #define REG_GPIO_INTM 0x0048
77 #define REG_LEDCFG0 0x004C
78 #define REG_LEDCFG1 0x004D
79 #define REG_LEDCFG2 0x004E
80 #define REG_LEDCFG3 0x004F
81 #define REG_FSIMR 0x0050
82 #define REG_FSISR 0x0054
83 #define REG_HSIMR 0x0058
84 #define REG_HSISR 0x005c
85 #define REG_GPIO_PIN_CTRL_2 0x0060 /* RTL8723 WIFI/BT/GPS Multi-Function GPIO Pin Control. */
86 #define REG_GPIO_IO_SEL_2 0x0062 /* RTL8723 WIFI/BT/GPS Multi-Function GPIO Select. */
87 #define REG_PAD_CTRL_1 0x0064
88 #define REG_MULTI_FUNC_CTRL 0x0068 /* RTL8723 WIFI/BT/GPS Multi-Function control source. */
89 #define REG_GSSR 0x006c
90 #define REG_AFE_XTAL_CTRL_EXT 0x0078 /* RTL8188E */
91 #define REG_XCK_OUT_CTRL 0x007c /* RTL8188E */
92 #define REG_MCUFWDL 0x0080
93 #define REG_WOL_EVENT 0x0081 /* RTL8188E */
94 #define REG_MCUTSTCFG 0x0084
95 #define REG_FDHM0 0x0088
96 #define REG_HOST_SUSP_CNT 0x00BC /* RTL8192C Host suspend counter on FPGA platform */
97 #define REG_SYSTEM_ON_CTRL 0x00CC /* For 8723AE Reset after S3 */
98 #define REG_EFUSE_ACCESS 0x00CF /* Efuse access protection for RTL8723 */
99 #define REG_BIST_SCAN 0x00D0
100 #define REG_BIST_RPT 0x00D4
101 #define REG_BIST_ROM_RPT 0x00D8
102 #define REG_USB_SIE_INTF 0x00E0
103 #define REG_PCIE_MIO_INTF 0x00E4
104 #define REG_PCIE_MIO_INTD 0x00E8
105 #define REG_HPON_FSM 0x00EC
106 #define REG_SYS_CFG 0x00F0
107 #define REG_GPIO_OUTSTS 0x00F4 /* For RTL8723 only. */
108 #define REG_TYPE_ID 0x00FC
111 * 2010/12/29 MH Add for 92D
113 #define REG_MAC_PHY_CTRL_NORMAL 0x00f8
116 /* -----------------------------------------------------
118 * 0x0100h ~ 0x01FFh MACTOP General Configuration
120 * ----------------------------------------------------- */
121 #define REG_CR 0x0100
122 #define REG_PBP 0x0104
123 #define REG_PKT_BUFF_ACCESS_CTRL 0x0106
124 #define REG_TRXDMA_CTRL 0x010C
125 #define REG_TRXFF_BNDY 0x0114
126 #define REG_TRXFF_STATUS 0x0118
127 #define REG_RXFF_PTR 0x011C
128 #define REG_HIMR 0x0120
129 #define REG_HISR 0x0124
130 #define REG_HIMRE 0x0128
131 #define REG_HISRE 0x012C
132 #define REG_CPWM 0x012F
133 #define REG_FWIMR 0x0130
134 #define REG_FWISR 0x0134
135 #define REG_FTIMR 0x0138
136 #define REG_FTISR 0x013C /* RTL8192C */
137 #define REG_PKTBUF_DBG_CTRL 0x0140
138 #define REG_RXPKTBUF_CTRL (REG_PKTBUF_DBG_CTRL+2)
139 #define REG_PKTBUF_DBG_DATA_L 0x0144
140 #define REG_PKTBUF_DBG_DATA_H 0x0148
142 #define REG_TC0_CTRL 0x0150
143 #define REG_TC1_CTRL 0x0154
144 #define REG_TC2_CTRL 0x0158
145 #define REG_TC3_CTRL 0x015C
146 #define REG_TC4_CTRL 0x0160
147 #define REG_TCUNIT_BASE 0x0164
148 #define REG_MBIST_START 0x0174
149 #define REG_MBIST_DONE 0x0178
150 #define REG_MBIST_FAIL 0x017C
151 #define REG_32K_CTRL 0x0194 /* RTL8188E */
152 #define REG_C2HEVT_MSG_NORMAL 0x01A0
153 #define REG_C2HEVT_CLEAR 0x01AF
154 #define REG_MCUTST_1 0x01c0
155 #define REG_MCUTST_WOWLAN 0x01C7 /* Defined after 8188E series. */
156 #define REG_FMETHR 0x01C8
157 #define REG_HMETFR 0x01CC
158 #define REG_HMEBOX_0 0x01D0
159 #define REG_HMEBOX_1 0x01D4
160 #define REG_HMEBOX_2 0x01D8
161 #define REG_HMEBOX_3 0x01DC
162 #define REG_LLT_INIT 0x01E0
163 #define REG_HMEBOX_EXT_0 0x01F0
164 #define REG_HMEBOX_EXT_1 0x01F4
165 #define REG_HMEBOX_EXT_2 0x01F8
166 #define REG_HMEBOX_EXT_3 0x01FC
169 /* -----------------------------------------------------
171 * 0x0200h ~ 0x027Fh TXDMA Configuration
173 * ----------------------------------------------------- */
174 #define REG_RQPN 0x0200
175 #define REG_FIFOPAGE 0x0204
176 #define REG_TDECTRL 0x0208
177 #define REG_TXDMA_OFFSET_CHK 0x020C
178 #define REG_TXDMA_STATUS 0x0210
179 #define REG_RQPN_NPQ 0x0214
180 #define REG_AUTO_LLT 0x0224
183 /* -----------------------------------------------------
185 * 0x0280h ~ 0x02FFh RXDMA Configuration
187 * ----------------------------------------------------- */
188 #define REG_RXDMA_AGG_PG_TH 0x0280
189 #define REG_RXPKT_NUM 0x0284
190 #define REG_RXDMA_STATUS 0x0288
192 /* -----------------------------------------------------
194 * 0x0300h ~ 0x03FFh PCIe
196 * ----------------------------------------------------- */
197 #ifndef CONFIG_TRX_BD_ARCH /* prevent CONFIG_TRX_BD_ARCH to use old registers */
199 #define REG_PCIE_CTRL_REG 0x0300
200 #define REG_INT_MIG 0x0304 /* Interrupt Migration */
201 #define REG_BCNQ_DESA 0x0308 /* TX Beacon Descriptor Address */
202 #define REG_HQ_DESA 0x0310 /* TX High Queue Descriptor Address */
203 #define REG_MGQ_DESA 0x0318 /* TX Manage Queue Descriptor Address */
204 #define REG_VOQ_DESA 0x0320 /* TX VO Queue Descriptor Address */
205 #define REG_VIQ_DESA 0x0328 /* TX VI Queue Descriptor Address */
206 #define REG_BEQ_DESA 0x0330 /* TX BE Queue Descriptor Address */
207 #define REG_BKQ_DESA 0x0338 /* TX BK Queue Descriptor Address */
208 #define REG_RX_DESA 0x0340 /* RX Queue Descriptor Address */
209 /* sherry added for DBI Read/Write 20091126 */
210 #define REG_DBI_WDATA 0x0348 /* Backdoor REG for Access Configuration */
211 #define REG_DBI_RDATA 0x034C /* Backdoor REG for Access Configuration */
212 #define REG_DBI_CTRL 0x0350 /* Backdoor REG for Access Configuration */
213 #define REG_DBI_FLAG 0x0352 /* Backdoor REG for Access Configuration */
214 #define REG_MDIO 0x0354 /* MDIO for Access PCIE PHY */
215 #define REG_DBG_SEL 0x0360 /* Debug Selection Register */
216 #define REG_PCIE_HRPWM 0x0361 /* PCIe RPWM */
217 #define REG_PCIE_HCPWM 0x0363 /* PCIe CPWM */
218 #define REG_WATCH_DOG 0x0368
219 #define REG_RX_RXBD_NUM 0x0382
221 /* RTL8723 series ------------------------------- */
222 #define REG_PCIE_HISR_EN 0x0394 /* PCIE Local Interrupt Enable Register */
223 #define REG_PCIE_HISR 0x03A0
224 #define REG_PCIE_HISRE 0x03A4
225 #define REG_PCIE_HIMR 0x03A8
226 #define REG_PCIE_HIMRE 0x03AC
228 #endif /* !CONFIG_TRX_BD_ARCH */
230 #define REG_USB_HIMR 0xFE38
231 #define REG_USB_HIMRE 0xFE3C
232 #define REG_USB_HISR 0xFE78
233 #define REG_USB_HISRE 0xFE7C
236 /* -----------------------------------------------------
238 * 0x0400h ~ 0x047Fh Protocol Configuration
240 * ----------------------------------------------------- */
243 #define REG_VOQ_INFO 0x0400
244 #define REG_VIQ_INFO 0x0404
245 #define REG_BEQ_INFO 0x0408
246 #define REG_BKQ_INFO 0x040C
248 /* 88E, 8723A, 8812A, 8821A, 92E, 8723B */
249 #define REG_Q0_INFO 0x400
250 #define REG_Q1_INFO 0x404
251 #define REG_Q2_INFO 0x408
252 #define REG_Q3_INFO 0x40C
254 #define REG_MGQ_INFO 0x0410
255 #define REG_HGQ_INFO 0x0414
256 #define REG_BCNQ_INFO 0x0418
257 #define REG_TXPKT_EMPTY 0x041A
258 #define REG_CPU_MGQ_INFORMATION 0x041C
259 #define REG_FWHW_TXQ_CTRL 0x0420
260 #define REG_HWSEQ_CTRL 0x0423
261 #define REG_BCNQ_BDNY 0x0424
262 #define REG_MGQ_BDNY 0x0425
263 #define REG_LIFETIME_CTRL 0x0426
264 #define REG_MULTI_BCNQ_OFFSET 0x0427
265 #define REG_SPEC_SIFS 0x0428
266 #define REG_RL 0x042A
267 #define REG_DARFRC 0x0430
268 #define REG_RARFRC 0x0438
269 #define REG_RRSR 0x0440
270 #define REG_ARFR0 0x0444
271 #define REG_ARFR1 0x0448
272 #define REG_ARFR2 0x044C
273 #define REG_ARFR3 0x0450
274 #define REG_CCK_CHECK 0x0454
275 #define REG_BCNQ1_BDNY 0x0457
277 #define REG_AGGLEN_LMT 0x0458
278 #define REG_AMPDU_MIN_SPACE 0x045C
279 #define REG_WMAC_LBK_BF_HD 0x045D
280 #define REG_FAST_EDCA_CTRL 0x0460
281 #define REG_RD_RESP_PKT_TH 0x0463
283 /* 8723A, 8812A, 8821A, 92E, 8723B */
284 #define REG_Q4_INFO 0x468
285 #define REG_Q5_INFO 0x46C
286 #define REG_Q6_INFO 0x470
287 #define REG_Q7_INFO 0x474
289 #define REG_INIRTS_RATE_SEL 0x0480
290 #define REG_INIDATA_RATE_SEL 0x0484
292 /* 8723B, 92E, 8812A, 8821A*/
293 #define REG_MACID_SLEEP_3 0x0484
294 #define REG_MACID_SLEEP_1 0x0488
296 #define REG_POWER_STAGE1 0x04B4
297 #define REG_POWER_STAGE2 0x04B8
298 #define REG_PKT_VO_VI_LIFE_TIME 0x04C0
299 #define REG_PKT_BE_BK_LIFE_TIME 0x04C2
300 #define REG_STBC_SETTING 0x04C4
301 #define REG_QUEUE_CTRL 0x04C6
302 #define REG_SINGLE_AMPDU_CTRL 0x04c7
303 #define REG_PROT_MODE_CTRL 0x04C8
304 #define REG_MAX_AGGR_NUM 0x04CA
305 #define REG_RTS_MAX_AGGR_NUM 0x04CB
306 #define REG_BAR_MODE_CTRL 0x04CC
307 #define REG_RA_TRY_RATE_AGG_LMT 0x04CF
310 #define REG_MACID_DROP 0x04D0
313 #define REG_EARLY_MODE_CONTROL 0x04D0
315 /* 8723B, 92E, 8812A, 8821A */
316 #define REG_MACID_SLEEP_2 0x04D0
318 /* 8723A, 8723B, 92E, 8812A, 8821A */
319 #define REG_MACID_SLEEP 0x04D4
321 #define REG_NQOS_SEQ 0x04DC
322 #define REG_QOS_SEQ 0x04DE
323 #define REG_NEED_CPU_HANDLE 0x04E0
324 #define REG_PKT_LOSE_RPT 0x04E1
325 #define REG_PTCL_ERR_STATUS 0x04E2
326 #define REG_TX_RPT_CTRL 0x04EC
327 #define REG_TX_RPT_TIME 0x04F0 /* 2 byte */
328 #define REG_DUMMY 0x04FC
330 /* -----------------------------------------------------
332 * 0x0500h ~ 0x05FFh EDCA Configuration
334 * ----------------------------------------------------- */
335 #define REG_EDCA_VO_PARAM 0x0500
336 #define REG_EDCA_VI_PARAM 0x0504
337 #define REG_EDCA_BE_PARAM 0x0508
338 #define REG_EDCA_BK_PARAM 0x050C
339 #define REG_BCNTCFG 0x0510
340 #define REG_PIFS 0x0512
341 #define REG_RDG_PIFS 0x0513
342 #define REG_SIFS_CTX 0x0514
343 #define REG_SIFS_TRX 0x0516
344 #define REG_TSFTR_SYN_OFFSET 0x0518
345 #define REG_AGGR_BREAK_TIME 0x051A
346 #define REG_SLOT 0x051B
347 #define REG_TX_PTCL_CTRL 0x0520
348 #define REG_TXPAUSE 0x0522
349 #define REG_DIS_TXREQ_CLR 0x0523
350 #define REG_RD_CTRL 0x0524
352 * Format for offset 540h-542h:
353 * [3:0]: TBTT prohibit setup in unit of 32us. The time for HW getting beacon content before TBTT.
355 * [19:8]: TBTT prohibit hold in unit of 32us. The time for HW holding to send the beacon packet.
359 * |<--Setup--|--Hold------------>|
360 * --------------|----------------------
363 * Note: We cannot update beacon content to HW or send any AC packets during the time between Setup and Hold.
364 * Described by Designer Tim and Bruce, 2011-01-14.
366 #define REG_TBTT_PROHIBIT 0x0540
367 #define REG_RD_NAV_NXT 0x0544
368 #define REG_NAV_PROT_LEN 0x0546
369 #define REG_BCN_CTRL 0x0550
370 #define REG_BCN_CTRL_1 0x0551
371 #define REG_MBID_NUM 0x0552
372 #define REG_DUAL_TSF_RST 0x0553
373 #define REG_BCN_INTERVAL 0x0554 /* The same as REG_MBSSID_BCN_SPACE */
374 #define REG_DRVERLYINT 0x0558
375 #define REG_BCNDMATIM 0x0559
376 #define REG_ATIMWND 0x055A
377 #define REG_USTIME_TSF 0x055C
378 #define REG_BCN_MAX_ERR 0x055D
379 #define REG_RXTSF_OFFSET_CCK 0x055E
380 #define REG_RXTSF_OFFSET_OFDM 0x055F
381 #define REG_TSFTR 0x0560
382 #define REG_TSFTR1 0x0568 /* HW Port 1 TSF Register */
383 #define REG_ATIMWND_1 0x0570
384 #define REG_P2P_CTWIN 0x0572 /* 1 Byte long (in unit of TU) */
385 #define REG_PSTIMER 0x0580
386 #define REG_TIMER0 0x0584
387 #define REG_TIMER1 0x0588
388 #define REG_ACMHWCTRL 0x05C0
389 #define REG_NOA_DESC_SEL 0x05CF
390 #define REG_NOA_DESC_DURATION 0x05E0
391 #define REG_NOA_DESC_INTERVAL 0x05E4
392 #define REG_NOA_DESC_START 0x05E8
393 #define REG_NOA_DESC_COUNT 0x05EC
395 #define REG_DMC 0x05F0 /* Dual MAC Co-Existence Register */
396 #define REG_SCH_TX_CMD 0x05F8
398 #define REG_FW_RESET_TSF_CNT_1 0x05FC
399 #define REG_FW_RESET_TSF_CNT_0 0x05FD
400 #define REG_FW_BCN_DIS_CNT 0x05FE
402 /* -----------------------------------------------------
404 * 0x0600h ~ 0x07FFh WMAC Configuration
406 * ----------------------------------------------------- */
407 #define REG_APSD_CTRL 0x0600
408 #define REG_BWOPMODE 0x0603
409 #define REG_TCR 0x0604
410 #define REG_RCR 0x0608
411 #define REG_RX_PKT_LIMIT 0x060C
412 #define REG_RX_DLK_TIME 0x060D
413 #define REG_RX_DRVINFO_SZ 0x060F
415 #define REG_MACID 0x0610
416 #define REG_BSSID 0x0618
417 #define REG_MAR 0x0620
418 #define REG_MBIDCAMCFG_1 0x0628
419 #define REG_MBIDCAMCFG_2 0x062C
421 #define REG_PNO_STATUS 0x0631
422 #define REG_USTIME_EDCA 0x0638
423 #define REG_MAC_SPEC_SIFS 0x063A
424 /* 20100719 Joseph: Hardware register definition change. (HW datasheet v54) */
425 #define REG_RESP_SIFS_CCK 0x063C /* [15:8]SIFS_R2T_OFDM, [7:0]SIFS_R2T_CCK */
426 #define REG_RESP_SIFS_OFDM 0x063E /* [15:8]SIFS_T2T_OFDM, [7:0]SIFS_T2T_CCK */
428 #define REG_ACKTO 0x0640
429 #define REG_CTS2TO 0x0641
430 #define REG_EIFS 0x0642
434 #define RXERR_TYPE_OFDM_PPDU 0
435 #define RXERR_TYPE_OFDM_FALSE_ALARM 1
436 #define RXERR_TYPE_OFDM_MPDU_OK 2
437 #define RXERR_TYPE_OFDM_MPDU_FAIL 3
438 #define RXERR_TYPE_CCK_PPDU 4
439 #define RXERR_TYPE_CCK_FALSE_ALARM 5
440 #define RXERR_TYPE_CCK_MPDU_OK 6
441 #define RXERR_TYPE_CCK_MPDU_FAIL 7
442 #define RXERR_TYPE_HT_PPDU 8
443 #define RXERR_TYPE_HT_FALSE_ALARM 9
444 #define RXERR_TYPE_HT_MPDU_TOTAL 10
445 #define RXERR_TYPE_HT_MPDU_OK 11
446 #define RXERR_TYPE_HT_MPDU_FAIL 12
447 #define RXERR_TYPE_RX_FULL_DROP 15
449 #define RXERR_COUNTER_MASK 0xFFFFF
450 #define RXERR_RPT_RST BIT(27)
451 #define _RXERR_RPT_SEL(type) ((type) << 28)
455 * The NAV upper value is very important to WiFi 11n 5.2.3 NAV test. The default value is
456 * always too small, but the WiFi TestPlan test by 25,000 microseconds of NAV through sending
457 * CTS in the air. We must update this value greater than 25,000 microseconds to pass the item.
458 * The offset of NAV_UPPER in 8192C Spec is incorrect, and the offset should be 0x0652. Commented
460 * By Bruce, 2011-07-18.
462 #define REG_NAV_UPPER 0x0652 /* unit of 128 */
465 #define REG_NAV_CTRL 0x0650
466 #define REG_BACAMCMD 0x0654
467 #define REG_BACAMCONTENT 0x0658
468 #define REG_LBDLY 0x0660
469 #define REG_FWDLY 0x0661
470 #define REG_RXERR_RPT 0x0664
471 #define REG_WMAC_TRXPTCL_CTL 0x0668
474 #define REG_CAMCMD 0x0670
475 #define REG_CAMWRITE 0x0674
476 #define REG_CAMREAD 0x0678
477 #define REG_CAMDBG 0x067C
478 #define REG_SECCFG 0x0680
481 #define REG_WOW_CTRL 0x0690
482 #define REG_PS_RX_INFO 0x0692
483 #define REG_WMMPS_UAPSD_TID 0x0693
484 #define REG_WKFMCAM_CMD 0x0698
485 #define REG_WKFMCAM_NUM REG_WKFMCAM_CMD
486 #define REG_WKFMCAM_RWD 0x069C
487 #define REG_RXFLTMAP0 0x06A0
488 #define REG_RXFLTMAP1 0x06A2
489 #define REG_RXFLTMAP2 0x06A4
490 #define REG_BCN_PSR_RPT 0x06A8
491 #define REG_BT_COEX_TABLE 0x06C0
493 /* Hardware Port 1 */
494 #define REG_MACID1 0x0700
495 #define REG_BSSID1 0x0708
496 /* Hardware Port 2 */
497 #define REG_MACID2 0x1620
498 #define REG_BSSID2 0x1628
500 #define REG_MACID3 0x1630
501 #define REG_BSSID3 0x1638
502 /* Hardware Port 4 */
503 #define REG_MACID4 0x1640
504 #define REG_BSSID4 0x1648
507 #define REG_CR_EXT 0x1100
509 /* -----------------------------------------------------
511 * 0xFE00h ~ 0xFE55h USB Configuration
513 * ----------------------------------------------------- */
514 #define REG_USB_INFO 0xFE17
515 #define REG_USB_SPECIAL_OPTION 0xFE55
516 #define REG_USB_DMA_AGG_TO 0xFE5B
517 #define REG_USB_AGG_TO 0xFE5C
518 #define REG_USB_AGG_TH 0xFE5D
520 #define REG_USB_HRPWM 0xFE58
521 #define REG_USB_HCPWM 0xFE57
523 /* for 92DU high_Queue low_Queue Normal_Queue select */
524 #define REG_USB_High_NORMAL_Queue_Select_MAC0 0xFE44
525 /* #define REG_USB_LOW_Queue_Select_MAC0 0xFE45 */
526 #define REG_USB_High_NORMAL_Queue_Select_MAC1 0xFE47
527 /* #define REG_USB_LOW_Queue_Select_MAC1 0xFE48 */
530 #define REG_TEST_USB_TXQS 0xFE48
531 #define REG_TEST_SIE_VID 0xFE60 /* 0xFE60~0xFE61 */
532 #define REG_TEST_SIE_PID 0xFE62 /* 0xFE62~0xFE63 */
533 #define REG_TEST_SIE_OPTIONAL 0xFE64
534 #define REG_TEST_SIE_CHIRP_K 0xFE65
535 #define REG_TEST_SIE_PHY 0xFE66 /* 0xFE66~0xFE6B */
536 #define REG_TEST_SIE_MAC_ADDR 0xFE70 /* 0xFE70~0xFE75 */
537 #define REG_TEST_SIE_STRING 0xFE80 /* 0xFE80~0xFEB9 */
540 /* For normal chip */
541 #define REG_NORMAL_SIE_VID 0xFE60 /* 0xFE60~0xFE61 */
542 #define REG_NORMAL_SIE_PID 0xFE62 /* 0xFE62~0xFE63 */
543 #define REG_NORMAL_SIE_OPTIONAL 0xFE64
544 #define REG_NORMAL_SIE_EP 0xFE65 /* 0xFE65~0xFE67 */
545 #define REG_NORMAL_SIE_PHY 0xFE68 /* 0xFE68~0xFE6B */
546 #define REG_NORMAL_SIE_OPTIONAL2 0xFE6C
547 #define REG_NORMAL_SIE_GPS_EP 0xFE6D /* 0xFE6D, for RTL8723 only. */
548 #define REG_NORMAL_SIE_MAC_ADDR 0xFE70 /* 0xFE70~0xFE75 */
549 #define REG_NORMAL_SIE_STRING 0xFE80 /* 0xFE80~0xFEDF */
552 /* -----------------------------------------------------
554 * Redifine 8192C register definition for compatibility
556 * ----------------------------------------------------- */
558 /* TODO: use these definition when using REG_xxx naming rule.
559 * NOTE: DO NOT Remove these definition. Use later. */
561 #define EFUSE_CTRL REG_EFUSE_CTRL /* E-Fuse Control. */
562 #define EFUSE_TEST REG_EFUSE_TEST /* E-Fuse Test. */
563 #define MSR (REG_CR + 2) /* Media Status register */
564 /* #define ISR REG_HISR */
565 #define MSR1 REG_CR_EXT
567 #define TSFR REG_TSFTR /* Timing Sync Function Timer Register. */
568 #define TSFR1 REG_TSFTR1 /* HW Port 1 TSF Register */
572 /* Redifine MACID register, to compatible prior ICs. */
573 #define IDR0 REG_MACID /* MAC ID Register, Offset 0x0050-0x0053 */
574 #define IDR4 (REG_MACID + 4) /* MAC ID Register, Offset 0x0054-0x0055 */
578 * 9. Security Control Registers (Offset: )
580 #define RWCAM REG_CAMCMD /* IN 8190 Data Sheet is called CAMcmd */
581 #define WCAMI REG_CAMWRITE /* Software write CAM input content */
582 #define RCAMO REG_CAMREAD /* Software read/write CAM config */
583 #define CAMDBG REG_CAMDBG
584 #define SECR REG_SECCFG /* Security Configuration Register */
586 /* Unused register */
587 #define UnusedRegister 0x1BF
588 #define DCAM UnusedRegister
589 #define PSR UnusedRegister
590 #define BBAddr UnusedRegister
591 #define PhyDataR UnusedRegister
593 /* Min Spacing related settings. */
594 #define MAX_MSS_DENSITY_2T 0x13
595 #define MAX_MSS_DENSITY_1T 0x0A
597 /* ----------------------------------------------------------------------------
598 * 8192C Cmd9346CR bits (Offset 0xA, 16bit)
599 * ---------------------------------------------------------------------------- */
600 #define CmdEEPROM_En BIT(5) /* EEPROM enable when set 1 */
601 #define CmdEERPOMSEL BIT(4) /* System EEPROM select, 0: boot from E-FUSE, 1: The EEPROM used is 9346 */
602 #define Cmd9346CR_9356SEL BIT(4)
604 /* ----------------------------------------------------------------------------
605 * 8192C GPIO MUX Configuration Register (offset 0x40, 4 byte)
606 * ---------------------------------------------------------------------------- */
607 #define GPIOSEL_GPIO 0
608 #define GPIOSEL_ENBT BIT(5)
610 /* ----------------------------------------------------------------------------
611 * 8192C GPIO PIN Control Register (offset 0x44, 4 byte)
612 * ---------------------------------------------------------------------------- */
613 #define GPIO_IN REG_GPIO_PIN_CTRL /* GPIO pins input value */
614 #define GPIO_OUT (REG_GPIO_PIN_CTRL+1) /* GPIO pins output value */
615 #define GPIO_IO_SEL (REG_GPIO_PIN_CTRL+2) /* GPIO pins output enable when a bit is set to "1"; otherwise, input is configured. */
616 #define GPIO_MOD (REG_GPIO_PIN_CTRL+3)
618 /* ----------------------------------------------------------------------------
619 * 8811A GPIO PIN Control Register (offset 0x60, 4 byte)
620 * ---------------------------------------------------------------------------- */
621 #define GPIO_IN_8811A REG_GPIO_PIN_CTRL_2 /* GPIO pins input value */
622 #define GPIO_OUT_8811A (REG_GPIO_PIN_CTRL_2+1) /* GPIO pins output value */
623 #define GPIO_IO_SEL_8811A (REG_GPIO_PIN_CTRL_2+2) /* GPIO pins output enable when a bit is set to "1"; otherwise, input is configured. */
624 #define GPIO_MOD_8811A (REG_GPIO_PIN_CTRL_2+3)
626 /* ----------------------------------------------------------------------------
627 * 8723/8188E Host System Interrupt Mask Register (offset 0x58, 32 byte)
628 * ---------------------------------------------------------------------------- */
629 #define HSIMR_GPIO12_0_INT_EN BIT(0)
630 #define HSIMR_SPS_OCP_INT_EN BIT(5)
631 #define HSIMR_RON_INT_EN BIT(6)
632 #define HSIMR_PDN_INT_EN BIT(7)
633 #define HSIMR_GPIO9_INT_EN BIT(25)
635 /* ----------------------------------------------------------------------------
636 * 8723/8188E Host System Interrupt Status Register (offset 0x5C, 32 byte)
637 * ---------------------------------------------------------------------------- */
638 #define HSISR_GPIO12_0_INT BIT(0)
639 #define HSISR_SPS_OCP_INT BIT(5)
640 #define HSISR_RON_INT BIT(6)
641 #define HSISR_PDNINT BIT(7)
642 #define HSISR_GPIO9_INT BIT(25)
644 /* ----------------------------------------------------------------------------
645 * 8192C (MSR) Media Status Register (Offset 0x4C, 8 bits)
646 * ---------------------------------------------------------------------------- */
650 01: Link in ad hoc network
651 10: Link in infrastructure network
655 #define MSR_NOLINK 0x00
656 #define MSR_ADHOC 0x01
657 #define MSR_INFRA 0x02
660 /* ----------------------------------------------------------------------------
662 * ---------------------------------------------------------------------------- */
663 #define USB_C2H_CMDID_OFFSET 0
664 #define USB_C2H_SEQ_OFFSET 1
665 #define USB_C2H_EVENT_OFFSET 2
666 #define USB_INTR_CPWM_OFFSET 16
667 #define USB_INTR_CONTENT_C2H_OFFSET 0
668 #define USB_INTR_CONTENT_CPWM1_OFFSET 16
669 #define USB_INTR_CONTENT_CPWM2_OFFSET 20
670 #define USB_INTR_CONTENT_HISR_OFFSET 48
671 #define USB_INTR_CONTENT_HISRE_OFFSET 52
672 #define USB_INTR_CONTENT_LENGTH 56
674 /* ----------------------------------------------------------------------------
675 * Response Rate Set Register (offset 0x440, 24bits)
676 * ---------------------------------------------------------------------------- */
677 #define RRSR_1M BIT(0)
678 #define RRSR_2M BIT(1)
679 #define RRSR_5_5M BIT(2)
680 #define RRSR_11M BIT(3)
681 #define RRSR_6M BIT(4)
682 #define RRSR_9M BIT(5)
683 #define RRSR_12M BIT(6)
684 #define RRSR_18M BIT(7)
685 #define RRSR_24M BIT(8)
686 #define RRSR_36M BIT(9)
687 #define RRSR_48M BIT(10)
688 #define RRSR_54M BIT(11)
689 #define RRSR_MCS0 BIT(12)
690 #define RRSR_MCS1 BIT(13)
691 #define RRSR_MCS2 BIT(14)
692 #define RRSR_MCS3 BIT(15)
693 #define RRSR_MCS4 BIT(16)
694 #define RRSR_MCS5 BIT(17)
695 #define RRSR_MCS6 BIT(18)
696 #define RRSR_MCS7 BIT(19)
698 #define RRSR_CCK_RATES (RRSR_11M | RRSR_5_5M | RRSR_2M | RRSR_1M)
699 #define RRSR_OFDM_RATES (RRSR_54M | RRSR_48M | RRSR_36M | RRSR_24M | RRSR_18M | RRSR_12M | RRSR_9M | RRSR_6M)
701 /* WOL bit information */
702 #define HAL92C_WOL_PTK_UPDATE_EVENT BIT(0)
703 #define HAL92C_WOL_GTK_UPDATE_EVENT BIT(1)
704 #define HAL92C_WOL_DISASSOC_EVENT BIT(2)
705 #define HAL92C_WOL_DEAUTH_EVENT BIT(3)
706 #define HAL92C_WOL_FW_DISCONNECT_EVENT BIT(4)
709 /*----------------------------------------------------------------------------
710 ** REG_CCK_CHECK (offset 0x454)
711 ------------------------------------------------------------------------------*/
712 #define BIT_BCN_PORT_SEL BIT(5)
714 #endif /* RTW_HALMAC */
716 /* ----------------------------------------------------------------------------
718 * ---------------------------------------------------------------------------- */
720 #define RATR_1M 0x00000001
721 #define RATR_2M 0x00000002
722 #define RATR_55M 0x00000004
723 #define RATR_11M 0x00000008
725 #define RATR_6M 0x00000010
726 #define RATR_9M 0x00000020
727 #define RATR_12M 0x00000040
728 #define RATR_18M 0x00000080
729 #define RATR_24M 0x00000100
730 #define RATR_36M 0x00000200
731 #define RATR_48M 0x00000400
732 #define RATR_54M 0x00000800
733 /* MCS 1 Spatial Stream */
734 #define RATR_MCS0 0x00001000
735 #define RATR_MCS1 0x00002000
736 #define RATR_MCS2 0x00004000
737 #define RATR_MCS3 0x00008000
738 #define RATR_MCS4 0x00010000
739 #define RATR_MCS5 0x00020000
740 #define RATR_MCS6 0x00040000
741 #define RATR_MCS7 0x00080000
742 /* MCS 2 Spatial Stream */
743 #define RATR_MCS8 0x00100000
744 #define RATR_MCS9 0x00200000
745 #define RATR_MCS10 0x00400000
746 #define RATR_MCS11 0x00800000
747 #define RATR_MCS12 0x01000000
748 #define RATR_MCS13 0x02000000
749 #define RATR_MCS14 0x04000000
750 #define RATR_MCS15 0x08000000
753 #define RATE_1M BIT(0)
754 #define RATE_2M BIT(1)
755 #define RATE_5_5M BIT(2)
756 #define RATE_11M BIT(3)
758 #define RATE_6M BIT(4)
759 #define RATE_9M BIT(5)
760 #define RATE_12M BIT(6)
761 #define RATE_18M BIT(7)
762 #define RATE_24M BIT(8)
763 #define RATE_36M BIT(9)
764 #define RATE_48M BIT(10)
765 #define RATE_54M BIT(11)
766 /* MCS 1 Spatial Stream */
767 #define RATE_MCS0 BIT(12)
768 #define RATE_MCS1 BIT(13)
769 #define RATE_MCS2 BIT(14)
770 #define RATE_MCS3 BIT(15)
771 #define RATE_MCS4 BIT(16)
772 #define RATE_MCS5 BIT(17)
773 #define RATE_MCS6 BIT(18)
774 #define RATE_MCS7 BIT(19)
775 /* MCS 2 Spatial Stream */
776 #define RATE_MCS8 BIT(20)
777 #define RATE_MCS9 BIT(21)
778 #define RATE_MCS10 BIT(22)
779 #define RATE_MCS11 BIT(23)
780 #define RATE_MCS12 BIT(24)
781 #define RATE_MCS13 BIT(25)
782 #define RATE_MCS14 BIT(26)
783 #define RATE_MCS15 BIT(27)
787 #define RATE_ALL_CCK (RATR_1M | RATR_2M | RATR_55M | RATR_11M)
788 #define RATE_ALL_OFDM_AG (RATR_6M | RATR_9M | RATR_12M | RATR_18M | RATR_24M|\
789 RATR_36M | RATR_48M | RATR_54M)
790 #define RATE_ALL_OFDM_1SS (RATR_MCS0 | RATR_MCS1 | RATR_MCS2 | RATR_MCS3 |\
791 RATR_MCS4 | RATR_MCS5 | RATR_MCS6 | RATR_MCS7)
792 #define RATE_ALL_OFDM_2SS (RATR_MCS8 | RATR_MCS9 | RATR_MCS10 | RATR_MCS11|\
793 RATR_MCS12 | RATR_MCS13 | RATR_MCS14 | RATR_MCS15)
795 #define RATE_BITMAP_ALL 0xFFFFF
797 /* Only use CCK 1M rate for ACK */
798 #define RATE_RRSR_CCK_ONLY_1M 0xFFFF1
799 #define RATE_RRSR_WITHOUT_CCK 0xFFFF0
801 /* ----------------------------------------------------------------------------
802 * BW_OPMODE bits (Offset 0x603, 8bit)
803 * ---------------------------------------------------------------------------- */
804 #define BW_OPMODE_20MHZ BIT(2)
805 #define BW_OPMODE_5G BIT(1)
807 /* ----------------------------------------------------------------------------
808 * CAM Config Setting (offset 0x680, 1 byte)
809 * ---------------------------------------------------------------------------- */
810 #define CAM_VALID BIT(15)
811 #define CAM_NOTVALID 0x0000
812 #define CAM_USEDK BIT(5)
814 #define CAM_CONTENT_COUNT 8
817 #define CAM_WEP40 0x01
818 #define CAM_TKIP 0x02
820 #define CAM_WEP104 0x05
823 #define TOTAL_CAM_ENTRY 32
824 #define HALF_CAM_ENTRY 16
826 #define CAM_CONFIG_USEDK _TRUE
827 #define CAM_CONFIG_NO_USEDK _FALSE
829 #define CAM_WRITE BIT(16)
830 #define CAM_READ 0x00000000
831 #define CAM_POLLINIG BIT(31)
834 * 10. Power Save Control Registers
836 #define WOW_PMEN BIT(0) /* Power management Enable. */
837 #define WOW_WOMEN BIT(1) /* WoW function on or off. */
838 #define WOW_MAGIC BIT(2) /* Magic packet */
839 #define WOW_UWF BIT(3) /* Unicast Wakeup frame. */
842 * 12. Host Interrupt Status Registers
844 * ----------------------------------------------------------------------------
846 * ---------------------------------------------------------------------------- */
847 #define IMR8190_DISABLED 0x0
848 #define IMR_DISABLED 0x0
849 /* IMR DW0 Bit 0-31 */
850 #define IMR_BCNDMAINT6 BIT(31) /* Beacon DMA Interrupt 6 */
851 #define IMR_BCNDMAINT5 BIT(30) /* Beacon DMA Interrupt 5 */
852 #define IMR_BCNDMAINT4 BIT(29) /* Beacon DMA Interrupt 4 */
853 #define IMR_BCNDMAINT3 BIT(28) /* Beacon DMA Interrupt 3 */
854 #define IMR_BCNDMAINT2 BIT(27) /* Beacon DMA Interrupt 2 */
855 #define IMR_BCNDMAINT1 BIT(26) /* Beacon DMA Interrupt 1 */
856 #define IMR_BCNDOK8 BIT(25) /* Beacon Queue DMA OK Interrupt 8 */
857 #define IMR_BCNDOK7 BIT(24) /* Beacon Queue DMA OK Interrupt 7 */
858 #define IMR_BCNDOK6 BIT(23) /* Beacon Queue DMA OK Interrupt 6 */
859 #define IMR_BCNDOK5 BIT(22) /* Beacon Queue DMA OK Interrupt 5 */
860 #define IMR_BCNDOK4 BIT(21) /* Beacon Queue DMA OK Interrupt 4 */
861 #define IMR_BCNDOK3 BIT(20) /* Beacon Queue DMA OK Interrupt 3 */
862 #define IMR_BCNDOK2 BIT(19) /* Beacon Queue DMA OK Interrupt 2 */
863 #define IMR_BCNDOK1 BIT(18) /* Beacon Queue DMA OK Interrupt 1 */
864 #define IMR_TIMEOUT2 BIT(17) /* Timeout interrupt 2 */
865 #define IMR_TIMEOUT1 BIT(16) /* Timeout interrupt 1 */
866 #define IMR_TXFOVW BIT(15) /* Transmit FIFO Overflow */
867 #define IMR_PSTIMEOUT BIT(14) /* Power save time out interrupt */
868 #define IMR_BcnInt BIT(13) /* Beacon DMA Interrupt 0 */
869 #define IMR_RXFOVW BIT(12) /* Receive FIFO Overflow */
870 #define IMR_RDU BIT(11) /* Receive Descriptor Unavailable */
871 #define IMR_ATIMEND BIT(10) /* For 92C, ATIM Window End Interrupt. For 8723 and later ICs, it also means P2P CTWin End interrupt. */
872 #define IMR_BDOK BIT(9) /* Beacon Queue DMA OK Interrupt */
873 #define IMR_HIGHDOK BIT(8) /* High Queue DMA OK Interrupt */
874 #define IMR_TBDOK BIT(7) /* Transmit Beacon OK interrupt */
875 #define IMR_MGNTDOK BIT(6) /* Management Queue DMA OK Interrupt */
876 #define IMR_TBDER BIT(5) /* For 92C, Transmit Beacon Error Interrupt */
877 #define IMR_BKDOK BIT(4) /* AC_BK DMA OK Interrupt */
878 #define IMR_BEDOK BIT(3) /* AC_BE DMA OK Interrupt */
879 #define IMR_VIDOK BIT(2) /* AC_VI DMA OK Interrupt */
880 #define IMR_VODOK BIT(1) /* AC_VO DMA Interrupt */
881 #define IMR_ROK BIT(0) /* Receive DMA OK Interrupt */
883 /* 13. Host Interrupt Status Extension Register (Offset: 0x012C-012Eh) */
884 #define IMR_TSF_BIT32_TOGGLE BIT(15)
885 #define IMR_BcnInt_E BIT(12)
886 #define IMR_TXERR BIT(11)
887 #define IMR_RXERR BIT(10)
888 #define IMR_C2HCMD BIT(9)
889 #define IMR_CPWM BIT(8)
891 #define IMR_OCPINT BIT(1)
892 #define IMR_WLANOFF BIT(0)
894 /* ----------------------------------------------------------------------------
895 * 8723E series PCIE Host IMR/ISR bit
896 * ---------------------------------------------------------------------------- */
897 /* IMR DW0 Bit 0-31 */
898 #define PHIMR_TIMEOUT2 BIT(31)
899 #define PHIMR_TIMEOUT1 BIT(30)
900 #define PHIMR_PSTIMEOUT BIT(29)
901 #define PHIMR_GTINT4 BIT(28)
902 #define PHIMR_GTINT3 BIT(27)
903 #define PHIMR_TXBCNERR BIT(26)
904 #define PHIMR_TXBCNOK BIT(25)
905 #define PHIMR_TSF_BIT32_TOGGLE BIT(24)
906 #define PHIMR_BCNDMAINT3 BIT(23)
907 #define PHIMR_BCNDMAINT2 BIT(22)
908 #define PHIMR_BCNDMAINT1 BIT(21)
909 #define PHIMR_BCNDMAINT0 BIT(20)
910 #define PHIMR_BCNDOK3 BIT(19)
911 #define PHIMR_BCNDOK2 BIT(18)
912 #define PHIMR_BCNDOK1 BIT(17)
913 #define PHIMR_BCNDOK0 BIT(16)
914 #define PHIMR_HSISR_IND_ON BIT(15)
915 #define PHIMR_BCNDMAINT_E BIT(14)
916 #define PHIMR_ATIMEND_E BIT(13)
917 #define PHIMR_ATIM_CTW_END BIT(12)
918 #define PHIMR_HISRE_IND BIT(11) /* RO. HISRE Indicator (HISRE & HIMRE is true, this bit is set to 1) */
919 #define PHIMR_C2HCMD BIT(10)
920 #define PHIMR_CPWM2 BIT(9)
921 #define PHIMR_CPWM BIT(8)
922 #define PHIMR_HIGHDOK BIT(7) /* High Queue DMA OK Interrupt */
923 #define PHIMR_MGNTDOK BIT(6) /* Management Queue DMA OK Interrupt */
924 #define PHIMR_BKDOK BIT(5) /* AC_BK DMA OK Interrupt */
925 #define PHIMR_BEDOK BIT(4) /* AC_BE DMA OK Interrupt */
926 #define PHIMR_VIDOK BIT(3) /* AC_VI DMA OK Interrupt */
927 #define PHIMR_VODOK BIT(2) /* AC_VO DMA Interrupt */
928 #define PHIMR_RDU BIT(1) /* Receive Descriptor Unavailable */
929 #define PHIMR_ROK BIT(0) /* Receive DMA OK Interrupt */
931 /* PCIE Host Interrupt Status Extension bit */
932 #define PHIMR_BCNDMAINT7 BIT(23)
933 #define PHIMR_BCNDMAINT6 BIT(22)
934 #define PHIMR_BCNDMAINT5 BIT(21)
935 #define PHIMR_BCNDMAINT4 BIT(20)
936 #define PHIMR_BCNDOK7 BIT(19)
937 #define PHIMR_BCNDOK6 BIT(18)
938 #define PHIMR_BCNDOK5 BIT(17)
939 #define PHIMR_BCNDOK4 BIT(16)
941 #define PHIMR_TXERR BIT(11)
942 #define PHIMR_RXERR BIT(10)
943 #define PHIMR_TXFOVW BIT(9)
944 #define PHIMR_RXFOVW BIT(8)
946 #define PHIMR_OCPINT BIT(1)
949 #define UHIMR_TIMEOUT2 BIT(31)
950 #define UHIMR_TIMEOUT1 BIT(30)
951 #define UHIMR_PSTIMEOUT BIT(29)
952 #define UHIMR_GTINT4 BIT(28)
953 #define UHIMR_GTINT3 BIT(27)
954 #define UHIMR_TXBCNERR BIT(26)
955 #define UHIMR_TXBCNOK BIT(25)
956 #define UHIMR_TSF_BIT32_TOGGLE BIT(24)
957 #define UHIMR_BCNDMAINT3 BIT(23)
958 #define UHIMR_BCNDMAINT2 BIT(22)
959 #define UHIMR_BCNDMAINT1 BIT(21)
960 #define UHIMR_BCNDMAINT0 BIT(20)
961 #define UHIMR_BCNDOK3 BIT(19)
962 #define UHIMR_BCNDOK2 BIT(18)
963 #define UHIMR_BCNDOK1 BIT(17)
964 #define UHIMR_BCNDOK0 BIT(16)
965 #define UHIMR_HSISR_IND BIT(15)
966 #define UHIMR_BCNDMAINT_E BIT(14)
968 #define UHIMR_CTW_END BIT(12)
970 #define UHIMR_C2HCMD BIT(10)
971 #define UHIMR_CPWM2 BIT(9)
972 #define UHIMR_CPWM BIT(8)
973 #define UHIMR_HIGHDOK BIT(7) /* High Queue DMA OK Interrupt */
974 #define UHIMR_MGNTDOK BIT(6) /* Management Queue DMA OK Interrupt */
975 #define UHIMR_BKDOK BIT(5) /* AC_BK DMA OK Interrupt */
976 #define UHIMR_BEDOK BIT(4) /* AC_BE DMA OK Interrupt */
977 #define UHIMR_VIDOK BIT(3) /* AC_VI DMA OK Interrupt */
978 #define UHIMR_VODOK BIT(2) /* AC_VO DMA Interrupt */
979 #define UHIMR_RDU BIT(1) /* Receive Descriptor Unavailable */
980 #define UHIMR_ROK BIT(0) /* Receive DMA OK Interrupt */
982 /* USB Host Interrupt Status Extension bit */
983 #define UHIMR_BCNDMAINT7 BIT(23)
984 #define UHIMR_BCNDMAINT6 BIT(22)
985 #define UHIMR_BCNDMAINT5 BIT(21)
986 #define UHIMR_BCNDMAINT4 BIT(20)
987 #define UHIMR_BCNDOK7 BIT(19)
988 #define UHIMR_BCNDOK6 BIT(18)
989 #define UHIMR_BCNDOK5 BIT(17)
990 #define UHIMR_BCNDOK4 BIT(16)
992 #define UHIMR_ATIMEND_E BIT(13)
993 #define UHIMR_ATIMEND BIT(12)
994 #define UHIMR_TXERR BIT(11)
995 #define UHIMR_RXERR BIT(10)
996 #define UHIMR_TXFOVW BIT(9)
997 #define UHIMR_RXFOVW BIT(8)
999 #define UHIMR_OCPINT BIT(1)
1003 #define HAL_NIC_UNPLUG_ISR 0xFFFFFFFF /* The value when the NIC is unplugged for PCI. */
1004 #define HAL_NIC_UNPLUG_PCI_ISR 0xEAEAEAEA /* The value when the NIC is unplugged for PCI in PCI interrupt (page 3). */
1006 /* ----------------------------------------------------------------------------
1008 * ---------------------------------------------------------------------------- */
1009 #define IMR_DISABLED_88E 0x0
1010 /* IMR DW0(0x0060-0063) Bit 0-31 */
1011 #define IMR_TXCCK_88E BIT(30) /* TXRPT interrupt when CCX bit of the packet is set */
1012 #define IMR_PSTIMEOUT_88E BIT(29) /* Power Save Time Out Interrupt */
1013 #define IMR_GTINT4_88E BIT(28) /* When GTIMER4 expires, this bit is set to 1 */
1014 #define IMR_GTINT3_88E BIT(27) /* When GTIMER3 expires, this bit is set to 1 */
1015 #define IMR_TBDER_88E BIT(26) /* Transmit Beacon0 Error */
1016 #define IMR_TBDOK_88E BIT(25) /* Transmit Beacon0 OK */
1017 #define IMR_TSF_BIT32_TOGGLE_88E BIT(24) /* TSF Timer BIT32 toggle indication interrupt */
1018 #define IMR_BCNDMAINT0_88E BIT(20) /* Beacon DMA Interrupt 0 */
1019 #define IMR_BCNDERR0_88E BIT(16) /* Beacon Queue DMA Error 0 */
1020 #define IMR_HSISR_IND_ON_INT_88E BIT(15) /* HSISR Indicator (HSIMR & HSISR is true, this bit is set to 1) */
1021 #define IMR_BCNDMAINT_E_88E BIT(14) /* Beacon DMA Interrupt Extension for Win7 */
1022 #define IMR_ATIMEND_88E BIT(12) /* CTWidnow End or ATIM Window End */
1023 #define IMR_HISR1_IND_INT_88E BIT(11) /* HISR1 Indicator (HISR1 & HIMR1 is true, this bit is set to 1) */
1024 #define IMR_C2HCMD_88E BIT(10) /* CPU to Host Command INT Status, Write 1 clear */
1025 #define IMR_CPWM2_88E BIT(9) /* CPU power Mode exchange INT Status, Write 1 clear */
1026 #define IMR_CPWM_88E BIT(8) /* CPU power Mode exchange INT Status, Write 1 clear */
1027 #define IMR_HIGHDOK_88E BIT(7) /* High Queue DMA OK */
1028 #define IMR_MGNTDOK_88E BIT(6) /* Management Queue DMA OK */
1029 #define IMR_BKDOK_88E BIT(5) /* AC_BK DMA OK */
1030 #define IMR_BEDOK_88E BIT(4) /* AC_BE DMA OK */
1031 #define IMR_VIDOK_88E BIT(3) /* AC_VI DMA OK */
1032 #define IMR_VODOK_88E BIT(2) /* AC_VO DMA OK */
1033 #define IMR_RDU_88E BIT(1) /* Rx Descriptor Unavailable */
1034 #define IMR_ROK_88E BIT(0) /* Receive DMA OK */
1036 /* IMR DW1(0x00B4-00B7) Bit 0-31 */
1037 #define IMR_BCNDMAINT7_88E BIT(27) /* Beacon DMA Interrupt 7 */
1038 #define IMR_BCNDMAINT6_88E BIT(26) /* Beacon DMA Interrupt 6 */
1039 #define IMR_BCNDMAINT5_88E BIT(25) /* Beacon DMA Interrupt 5 */
1040 #define IMR_BCNDMAINT4_88E BIT(24) /* Beacon DMA Interrupt 4 */
1041 #define IMR_BCNDMAINT3_88E BIT(23) /* Beacon DMA Interrupt 3 */
1042 #define IMR_BCNDMAINT2_88E BIT(22) /* Beacon DMA Interrupt 2 */
1043 #define IMR_BCNDMAINT1_88E BIT(21) /* Beacon DMA Interrupt 1 */
1044 #define IMR_BCNDOK7_88E BIT(20) /* Beacon Queue DMA OK Interrupt 7 */
1045 #define IMR_BCNDOK6_88E BIT(19) /* Beacon Queue DMA OK Interrupt 6 */
1046 #define IMR_BCNDOK5_88E BIT(18) /* Beacon Queue DMA OK Interrupt 5 */
1047 #define IMR_BCNDOK4_88E BIT(17) /* Beacon Queue DMA OK Interrupt 4 */
1048 #define IMR_BCNDOK3_88E BIT(16) /* Beacon Queue DMA OK Interrupt 3 */
1049 #define IMR_BCNDOK2_88E BIT(15) /* Beacon Queue DMA OK Interrupt 2 */
1050 #define IMR_BCNDOK1_88E BIT(14) /* Beacon Queue DMA OK Interrupt 1 */
1051 #define IMR_ATIMEND_E_88E BIT(13) /* ATIM Window End Extension for Win7 */
1052 #define IMR_TXERR_88E BIT(11) /* Tx Error Flag Interrupt Status, write 1 clear. */
1053 #define IMR_RXERR_88E BIT(10) /* Rx Error Flag INT Status, Write 1 clear */
1054 #define IMR_TXFOVW_88E BIT(9) /* Transmit FIFO Overflow */
1055 #define IMR_RXFOVW_88E BIT(8) /* Receive FIFO Overflow */
1057 /*===================================================================
1058 =====================================================================
1059 Here the register defines are for 92C. When the define is as same with 92C,
1060 we will use the 92C's define for the consistency
1061 So the following defines for 92C is not entire!!!!!!
1062 =====================================================================
1063 =====================================================================*/
1065 Based on Datasheet V33---090401
1068 0x0000h ~ 0x00FFh System Configuration (256 Bytes)
1069 0x0100h ~ 0x01FFh MACTOP General Configuration (256 Bytes)
1070 0x0200h ~ 0x027Fh TXDMA Configuration (128 Bytes)
1071 0x0280h ~ 0x02FFh RXDMA Configuration (128 Bytes)
1072 0x0300h ~ 0x03FFh PCIE EMAC Reserved Region (256 Bytes)
1073 0x0400h ~ 0x04FFh Protocol Configuration (256 Bytes)
1074 0x0500h ~ 0x05FFh EDCA Configuration (256 Bytes)
1075 0x0600h ~ 0x07FFh WMAC Configuration (512 Bytes)
1076 0x2000h ~ 0x3FFFh 8051 FW Download Region (8196 Bytes)
1078 /* ---------------------------------------------------------------------------- */
1079 /* 8192C (TXPAUSE) transmission pause (Offset 0x522, 8 bits) */
1080 /* ---------------------------------------------------------------------------- */
1082 * The the bits of stoping AC(VO/VI/BE/BK) queue in datasheet RTL8192S/RTL8192C are wrong,
1083 * the correct arragement is VO - Bit0, VI - Bit1, BE - Bit2, and BK - Bit3.
1084 * 8723 and 88E may be not correct either in the eralier version. Confirmed with DD Tim.
1085 * By Bruce, 2011-09-22. */
1086 #define StopBecon BIT(6)
1087 #define StopHigh BIT(5)
1088 #define StopMgt BIT(4)
1089 #define StopBK BIT(3)
1090 #define StopBE BIT(2)
1091 #define StopVI BIT(1)
1092 #define StopVO BIT(0)
1094 /* ----------------------------------------------------------------------------
1095 * 8192C (RCR) Receive Configuration Register (Offset 0x608, 32 bits)
1096 * ---------------------------------------------------------------------------- */
1097 #define RCR_APPFCS BIT(31) /* WMAC append FCS after pauload */
1098 #define RCR_APP_MIC BIT(30) /* MACRX will retain the MIC at the bottom of the packet. */
1099 #define RCR_APP_ICV BIT(29) /* MACRX will retain the ICV at the bottom of the packet. */
1100 #define RCR_APP_PHYST_RXFF BIT(28) /* PHY Status is appended before RX packet in RXFF */
1101 #define RCR_APP_BA_SSN BIT(27) /* SSN of previous TXBA is appended as after original RXDESC as the 4-th DW of RXDESC. */
1102 #define RCR_VHT_DACK BIT(26) /* This bit to control response type for vht single mpdu data packet. 1. ACK as response 0. BA as response */
1103 #define RCR_TCPOFLD_EN BIT(25) /* Enable TCP checksum offload */
1104 #define RCR_ENMBID BIT(24) /* Enable Multiple BssId. Only response ACK to the packets whose DID(A1) matching to the addresses in the MBSSID CAM Entries. */
1105 #define RCR_LSIGEN BIT(23) /* Enable LSIG TXOP Protection function. Search KEYCAM for each rx packet to check if LSIGEN bit is set. */
1106 #define RCR_MFBEN BIT(22) /* Enable immediate MCS Feedback function. When Rx packet with MRQ = 1'b1, then search KEYCAM to find sender's MCS Feedback function and send response. */
1107 #define RCR_DISCHKPPDLLEN BIT(21) /* Do not check PPDU while the PPDU length is smaller than 14 byte. */
1108 #define RCR_PKTCTL_DLEN BIT(20) /* While rx path dead lock occurs, reset rx path */
1109 #define RCR_DISGCLK BIT(19) /* Disable macrx clock gating control (no used) */
1110 #define RCR_TIM_PARSER_EN BIT(18) /* RX Beacon TIM Parser. */
1111 #define RCR_BC_MD_EN BIT(17) /* Broadcast data packet more data bit check interrupt enable.*/
1112 #define RCR_UC_MD_EN BIT(16) /* Unicast data packet more data bit check interrupt enable. */
1113 #define RCR_RXSK_PERPKT BIT(15) /* Executing key search per MPDU */
1114 #define RCR_HTC_LOC_CTRL BIT(14) /* MFC<--HTC = 1 MFC-->HTC = 0 */
1115 #define RCR_AMF BIT(13) /* Accept management type frame */
1116 #define RCR_ACF BIT(12) /* Accept control type frame. Control frames BA, BAR, and PS-Poll (when in AP mode) are not controlled by this bit. They are controlled by ADF. */
1117 #define RCR_ADF BIT(11) /* Accept data type frame. This bit also regulates BA, BAR, and PS-Poll (AP mode only). */
1118 #define RCR_DISDECMYPKT BIT(10) /* This bit determines whether hw need to do decryption.1: If A1 match, do decryption.0: Do decryption. */
1119 #define RCR_AICV BIT(9) /* Accept ICV error packet */
1120 #define RCR_ACRC32 BIT(8) /* Accept CRC32 error packet */
1121 #define RCR_CBSSID_BCN BIT(7) /* Accept BSSID match packet (Rx beacon, probe rsp) */
1122 #define RCR_CBSSID_DATA BIT(6) /* Accept BSSID match packet (Data) */
1123 #define RCR_APWRMGT BIT(5) /* Accept power management packet */
1124 #define RCR_ADD3 BIT(4) /* Accept address 3 match packet */
1125 #define RCR_AB BIT(3) /* Accept broadcast packet */
1126 #define RCR_AM BIT(2) /* Accept multicast packet */
1127 #define RCR_APM BIT(1) /* Accept physical match packet */
1128 #define RCR_AAP BIT(0) /* Accept all unicast packet */
1131 /* -----------------------------------------------------
1133 * 0x0000h ~ 0x00FFh System Configuration
1135 * ----------------------------------------------------- */
1137 /* 2 SYS_ISO_CTRL */
1138 #define ISO_MD2PP BIT(0)
1139 #define ISO_UA2USB BIT(1)
1140 #define ISO_UD2CORE BIT(2)
1141 #define ISO_PA2PCIE BIT(3)
1142 #define ISO_PD2CORE BIT(4)
1143 #define ISO_IP2MAC BIT(5)
1144 #define ISO_DIOP BIT(6)
1145 #define ISO_DIOE BIT(7)
1146 #define ISO_EB2CORE BIT(8)
1147 #define ISO_DIOR BIT(9)
1148 #define PWC_EV12V BIT(15)
1152 #define FEN_BBRSTB BIT(0)
1153 #define FEN_BB_GLB_RSTn BIT(1)
1154 #define FEN_USBA BIT(2)
1155 #define FEN_UPLL BIT(3)
1156 #define FEN_USBD BIT(4)
1157 #define FEN_DIO_PCIE BIT(5)
1158 #define FEN_PCIEA BIT(6)
1159 #define FEN_PPLL BIT(7)
1160 #define FEN_PCIED BIT(8)
1161 #define FEN_DIOE BIT(9)
1162 #define FEN_CPUEN BIT(10)
1163 #define FEN_DCORE BIT(11)
1164 #define FEN_ELDR BIT(12)
1165 #define FEN_EN_25_1 BIT(13)
1166 #define FEN_HWPDN BIT(14)
1167 #define FEN_MREGEN BIT(15)
1170 #define PFM_LDALL BIT(0)
1171 #define PFM_ALDN BIT(1)
1172 #define PFM_LDKP BIT(2)
1173 #define PFM_WOWL BIT(3)
1174 #define EnPDN BIT(4)
1175 #define PDN_PL BIT(5)
1176 #define APFM_ONMAC BIT(8)
1177 #define APFM_OFF BIT(9)
1178 #define APFM_RSM BIT(10)
1179 #define AFSM_HSUS BIT(11)
1180 #define AFSM_PCIE BIT(12)
1181 #define APDM_MAC BIT(13)
1182 #define APDM_HOST BIT(14)
1183 #define APDM_HPDN BIT(15)
1184 #define RDY_MACON BIT(16)
1185 #define SUS_HOST BIT(17)
1186 #define ROP_ALD BIT(20)
1187 #define ROP_PWR BIT(21)
1188 #define ROP_SPS BIT(22)
1189 #define SOP_MRST BIT(25)
1190 #define SOP_FUSE BIT(26)
1191 #define SOP_ABG BIT(27)
1192 #define SOP_AMB BIT(28)
1193 #define SOP_RCK BIT(29)
1194 #define SOP_A8M BIT(30)
1195 #define XOP_BTCK BIT(31)
1198 #define ANAD16V_EN BIT(0)
1199 #define ANA8M BIT(1)
1200 #define MACSLP BIT(4)
1201 #define LOADER_CLK_EN BIT(5)
1204 /* 2 9346CR /REG_SYS_EEPROM_CTRL */
1205 #define BOOT_FROM_EEPROM BIT(4)
1206 #define EEPROMSEL BIT(4)
1207 #define EEPROM_EN BIT(5)
1211 #define RF_EN BIT(0)
1212 #define RF_RSTB BIT(1)
1213 #define RF_SDMRSTB BIT(2)
1216 /* 2 LDOV12D_CTRL */
1217 #define LDV12_EN BIT(0)
1218 #define LDV12_SDBY BIT(1)
1219 #define LPLDO_HSM BIT(2)
1220 #define LPLDO_LSM_DIS BIT(3)
1221 #define _LDV12_VADJ(x) (((x) & 0xF) << 4)
1225 /* 2 EFUSE_TEST (For RTL8723 partially) */
1226 #define EF_TRPT BIT(7)
1227 #define EF_CELL_SEL (BIT(8) | BIT(9)) /* 00: Wifi Efuse, 01: BT Efuse0, 10: BT Efuse1, 11: BT Efuse2 */
1228 #define LDOE25_EN BIT(31)
1229 #define EFUSE_SEL(x) (((x) & 0x3) << 8)
1230 #define EFUSE_SEL_MASK 0x300
1231 #define EFUSE_WIFI_SEL_0 0x0
1232 #define EFUSE_BT_SEL_0 0x1
1233 #define EFUSE_BT_SEL_1 0x2
1234 #define EFUSE_BT_SEL_2 0x3
1239 #define MCUFWDL_EN BIT(0)
1240 #define MCUFWDL_RDY BIT(1)
1241 #define FWDL_ChkSum_rpt BIT(2)
1242 #define MACINI_RDY BIT(3)
1243 #define BBINI_RDY BIT(4)
1244 #define RFINI_RDY BIT(5)
1245 #define WINTINI_RDY BIT(6)
1246 #define RAM_DL_SEL BIT(7)
1247 #define CPU_DL_READY BIT(15) /* add flag by gw for fw download ready 20130826 */
1248 #define ROM_DLEN BIT(19)
1249 #define CPRST BIT(23)
1253 #define XCLK_VLD BIT(0)
1254 #define ACLK_VLD BIT(1)
1255 #define UCLK_VLD BIT(2)
1256 #define PCLK_VLD BIT(3)
1257 #define PCIRSTB BIT(4)
1258 #define V15_VLD BIT(5)
1259 #define SW_OFFLOAD_EN BIT(7)
1260 #define SIC_IDLE BIT(8)
1261 #define BD_MAC2 BIT(9)
1262 #define BD_MAC1 BIT(10)
1263 #define IC_MACPHY_MODE BIT(11)
1264 #define CHIP_VER (BIT(12) | BIT(13) | BIT(14) | BIT(15))
1265 #define BT_FUNC BIT(16)
1266 #define VENDOR_ID BIT(19)
1267 #define EXT_VENDOR_ID (BIT(18) | BIT(19)) /* Currently only for RTL8723B */
1268 #define PAD_HWPD_IDN BIT(22)
1269 #define TRP_VAUX_EN BIT(23) /* RTL ID */
1270 #define TRP_BT_EN BIT(24)
1271 #define BD_PKG_SEL BIT(25)
1272 #define BD_HCI_SEL BIT(26)
1273 #define TYPE_ID BIT(27)
1274 #define RF_TYPE_ID BIT(27)
1276 #define RTL_ID BIT(23) /* TestChip ID, 1:Test(RLE); 0:MP(RL) */
1277 #define SPS_SEL BIT(24) /* 1:LDO regulator mode; 0:Switching regulator mode */
1280 #define CHIP_VER_RTL_MASK 0xF000 /* Bit 12 ~ 15 */
1281 #define CHIP_VER_RTL_SHIFT 12
1282 #define EXT_VENDOR_ID_SHIFT 18
1284 /* 2 REG_GPIO_OUTSTS (For RTL8723 only) */
1285 #define EFS_HCI_SEL (BIT(0) | BIT(1))
1286 #define PAD_HCI_SEL (BIT(2) | BIT(3))
1287 #define HCI_SEL (BIT(4) | BIT(5))
1288 #define PKG_SEL_HCI BIT(6)
1289 #define FEN_GPS BIT(7)
1290 #define FEN_BT BIT(8)
1291 #define FEN_WL BIT(9)
1292 #define FEN_PCI BIT(10)
1293 #define FEN_USB BIT(11)
1294 #define BTRF_HWPDN_N BIT(12)
1295 #define WLRF_HWPDN_N BIT(13)
1296 #define PDN_BT_N BIT(14)
1297 #define PDN_GPS_N BIT(15)
1298 #define BT_CTL_HWPDN BIT(16)
1299 #define GPS_CTL_HWPDN BIT(17)
1300 #define PPHY_SUSB BIT(20)
1301 #define UPHY_SUSB BIT(21)
1302 #define PCI_SUSEN BIT(22)
1303 #define USB_SUSEN BIT(23)
1304 #define RF_RL_ID (BIT(31) | BIT(30) | BIT(29) | BIT(28))
1307 /* -----------------------------------------------------
1309 * 0x0100h ~ 0x01FFh MACTOP General Configuration
1311 * ----------------------------------------------------- */
1313 /* 2 Function Enable Registers
1315 #define HCI_TXDMA_EN BIT(0)
1316 #define HCI_RXDMA_EN BIT(1)
1317 #define TXDMA_EN BIT(2)
1318 #define RXDMA_EN BIT(3)
1319 #define PROTOCOL_EN BIT(4)
1320 #define SCHEDULE_EN BIT(5)
1321 #define MACTXEN BIT(6)
1322 #define MACRXEN BIT(7)
1323 #define ENSWBCN BIT(8)
1324 #define ENSEC BIT(9)
1325 #define CALTMR_EN BIT(10) /* 32k CAL TMR enable */
1328 #define _NETTYPE(x) (((x) & 0x3) << 16)
1329 #define MASK_NETTYPE 0x30000
1330 #define NT_NO_LINK 0x0
1331 #define NT_LINK_AD_HOC 0x1
1332 #define NT_LINK_AP 0x2
1333 #define NT_AS_AP 0x3
1335 /* 2 PBP - Page Size Register */
1336 #define GET_RX_PAGE_SIZE(value) ((value) & 0xF)
1337 #define GET_TX_PAGE_SIZE(value) (((value) & 0xF0) >> 4)
1338 #define _PSRX_MASK 0xF
1339 #define _PSTX_MASK 0xF0
1340 #define _PSRX(x) (x)
1341 #define _PSTX(x) ((x) << 4)
1347 #define PBP_1024 0x4
1351 #define RXDMA_ARBBW_EN BIT(0)
1352 #define RXSHFT_EN BIT(1)
1353 #define RXDMA_AGG_EN BIT(2)
1354 #define QS_VO_QUEUE BIT(8)
1355 #define QS_VI_QUEUE BIT(9)
1356 #define QS_BE_QUEUE BIT(10)
1357 #define QS_BK_QUEUE BIT(11)
1358 #define QS_MANAGER_QUEUE BIT(12)
1359 #define QS_HIGH_QUEUE BIT(13)
1361 #define HQSEL_VOQ BIT(0)
1362 #define HQSEL_VIQ BIT(1)
1363 #define HQSEL_BEQ BIT(2)
1364 #define HQSEL_BKQ BIT(3)
1365 #define HQSEL_MGTQ BIT(4)
1366 #define HQSEL_HIQ BIT(5)
1368 /* For normal driver, 0x10C */
1369 #define _TXDMA_CMQ_MAP(x) (((x) & 0x3) << 16)
1370 #define _TXDMA_HIQ_MAP(x) (((x) & 0x3) << 14)
1371 #define _TXDMA_MGQ_MAP(x) (((x) & 0x3) << 12)
1372 #define _TXDMA_BKQ_MAP(x) (((x) & 0x3) << 10)
1373 #define _TXDMA_BEQ_MAP(x) (((x) & 0x3) << 8)
1374 #define _TXDMA_VIQ_MAP(x) (((x) & 0x3) << 6)
1375 #define _TXDMA_VOQ_MAP(x) (((x) & 0x3) << 4)
1377 #define QUEUE_EXTRA 0
1379 #define QUEUE_NORMAL 2
1380 #define QUEUE_HIGH 3
1387 #define _LLT_NO_ACTIVE 0x0
1388 #define _LLT_WRITE_ACCESS 0x1
1389 #define _LLT_READ_ACCESS 0x2
1391 #define _LLT_INIT_DATA(x) ((x) & 0xFF)
1392 #define _LLT_INIT_ADDR(x) (((x) & 0xFF) << 8)
1393 #define _LLT_OP(x) (((x) & 0x3) << 30)
1394 #define _LLT_OP_VALUE(x) (((x) >> 30) & 0x3)
1397 /* -----------------------------------------------------
1399 * 0x0200h ~ 0x027Fh TXDMA Configuration
1401 * ----------------------------------------------------- */
1403 #define _HPQ(x) ((x) & 0xFF)
1404 #define _LPQ(x) (((x) & 0xFF) << 8)
1405 #define _PUBQ(x) (((x) & 0xFF) << 16)
1406 #define _NPQ(x) ((x) & 0xFF) /* NOTE: in RQPN_NPQ register */
1407 #define _EPQ(x) (((x) & 0xFF) << 16) /* NOTE: in RQPN_EPQ register */
1410 #define HPQ_PUBLIC_DIS BIT(24)
1411 #define LPQ_PUBLIC_DIS BIT(25)
1412 #define LD_RQPN BIT(31)
1416 #define BLK_DESC_NUM_SHIFT 4
1417 #define BLK_DESC_NUM_MASK 0xF
1420 /* 2 TXDMA_OFFSET_CHK */
1421 #define DROP_DATA_EN BIT(9)
1424 #define BIT_SHIFT_TXPKTNUM 24
1425 #define BIT_MASK_TXPKTNUM 0xff
1426 #define BIT_TXPKTNUM(x) (((x) & BIT_MASK_TXPKTNUM) << BIT_SHIFT_TXPKTNUM)
1428 #define BIT_TDE_DBG_SEL BIT(23)
1429 #define BIT_AUTO_INIT_LLT BIT(16)
1431 #define BIT_SHIFT_Tx_OQT_free_space 8
1432 #define BIT_MASK_Tx_OQT_free_space 0xff
1433 #define BIT_Tx_OQT_free_space(x) (((x) & BIT_MASK_Tx_OQT_free_space) << BIT_SHIFT_Tx_OQT_free_space)
1436 /* -----------------------------------------------------
1438 * 0x0280h ~ 0x028Bh RX DMA Configuration
1440 * ----------------------------------------------------- */
1442 /* 2 REG_RXDMA_CONTROL, 0x0286h
1443 * Write only. When this bit is set, RXDMA will decrease RX PKT counter by one. Before
1444 * this bit is polled, FW shall update RXFF_RD_PTR first. This register is write pulse and auto clear.
1445 * #define RXPKT_RELEASE_POLL BIT(0)
1446 * Read only. When RXMA finishes on-going DMA operation, RXMDA will report idle state in
1447 * this bit. FW can start releasing packets after RXDMA entering idle mode.
1448 * #define RXDMA_IDLE BIT(1)
1449 * When this bit is set, RXDMA will enter this mode after on-going RXDMA packet to host
1450 * completed, and stop DMA packet to host. RXDMA will then report Default: 0;
1451 * #define RW_RELEASE_EN BIT(2) */
1453 /* 2 REG_RXPKT_NUM, 0x0284 */
1454 #define RXPKT_RELEASE_POLL BIT(16)
1455 #define RXDMA_IDLE BIT(17)
1456 #define RW_RELEASE_EN BIT(18)
1458 /* -----------------------------------------------------
1460 * 0x0400h ~ 0x047Fh Protocol Configuration
1462 * ----------------------------------------------------- */
1463 /* 2 FWHW_TXQ_CTRL */
1464 #define EN_AMPDU_RTY_NEW BIT(7)
1468 #define _SPEC_SIFS_CCK(x) ((x) & 0xFF)
1469 #define _SPEC_SIFS_OFDM(x) (((x) & 0xFF) << 8)
1472 #define RETRY_LIMIT_SHORT_SHIFT 8
1473 #define RETRY_LIMIT_LONG_SHIFT 0
1475 /* -----------------------------------------------------
1477 * 0x0500h ~ 0x05FFh EDCA Configuration
1479 * ----------------------------------------------------- */
1481 /* 2 EDCA setting */
1482 #define AC_PARAM_TXOP_LIMIT_OFFSET 16
1483 #define AC_PARAM_ECW_MAX_OFFSET 12
1484 #define AC_PARAM_ECW_MIN_OFFSET 8
1485 #define AC_PARAM_AIFS_OFFSET 0
1488 #define _LRL(x) ((x) & 0x3F)
1489 #define _SRL(x) (((x) & 0x3F) << 8)
1493 #define EN_TXBCN_RPT BIT(2)
1494 #define EN_BCN_FUNCTION BIT(3)
1495 #define STOP_BCNQ BIT(6)
1496 #define DIS_RX_BSSID_FIT BIT(6)
1498 #define DIS_ATIM BIT(0)
1499 #define DIS_BCNQ_SUB BIT(1)
1500 #define DIS_TSF_UDT BIT(4)
1502 /* The same function but different bit field. */
1503 #define DIS_TSF_UDT0_NORMAL_CHIP BIT(4)
1504 #define DIS_TSF_UDT0_TEST_CHIP BIT(5)
1508 #define AcmHw_HwEn BIT(0)
1509 #define AcmHw_BeqEn BIT(1)
1510 #define AcmHw_ViqEn BIT(2)
1511 #define AcmHw_VoqEn BIT(3)
1512 #define AcmHw_BeqStatus BIT(4)
1513 #define AcmHw_ViqStatus BIT(5)
1514 #define AcmHw_VoqStatus BIT(6)
1516 /* 2 */ /* REG_DUAL_TSF_RST (0x553) */
1517 #define DUAL_TSF_RST_P2P BIT(4)
1519 /* 2 */ /* REG_NOA_DESC_SEL (0x5CF) */
1520 #define NOA_DESC_SEL_0 0
1521 #define NOA_DESC_SEL_1 BIT(4)
1523 /* -----------------------------------------------------
1525 * 0x0600h ~ 0x07FFh WMAC Configuration
1527 * ----------------------------------------------------- */
1530 #define APSDOFF BIT(6)
1533 #define TSFRST BIT(0)
1534 #define DIS_GCLK BIT(1)
1535 #define PAD_SEL BIT(2)
1536 #define PWR_ST BIT(6)
1537 #define PWRBIT_OW_EN BIT(7)
1539 #define CFENDFORM BIT(9)
1549 #define APWRMGT BIT(5)
1550 #define CBSSID BIT(6)
1551 #define CBSSID_DATA BIT(6)
1552 #define CBSSID_BCN BIT(7)
1553 #define ACRC32 BIT(8)
1558 #define HTC_LOC_CTRL BIT(14)
1559 #define UC_DATA_EN BIT(16)
1560 #define BM_DATA_EN BIT(17)
1561 #define MFBEN BIT(22)
1562 #define LSIGEN BIT(23)
1563 #define EnMBID BIT(24)
1564 #define FORCEACK BIT(26)
1565 #define APP_BASSN BIT(27)
1566 #define APP_PHYSTS BIT(28)
1567 #define APP_ICV BIT(29)
1568 #define APP_MIC BIT(30)
1569 #define APP_FCS BIT(31)
1573 #define SCR_TxUseDK BIT(0) /* Force Tx Use Default Key */
1574 #define SCR_RxUseDK BIT(1) /* Force Rx Use Default Key */
1575 #define SCR_TxEncEnable BIT(2) /* Enable Tx Encryption */
1576 #define SCR_RxDecEnable BIT(3) /* Enable Rx Decryption */
1577 #define SCR_SKByA2 BIT(4) /* Search kEY BY A2 */
1578 #define SCR_NoSKMC BIT(5) /* No Key Search Multicast */
1579 #define SCR_TXBCUSEDK BIT(6) /* Force Tx Broadcast packets Use Default Key */
1580 #define SCR_RXBCUSEDK BIT(7) /* Force Rx Broadcast packets Use Default Key */
1581 #define SCR_CHK_KEYID BIT(8)
1582 #define SCR_CHK_BMC BIT(9) /* add option to support a2+keyid+bcm */
1584 /*REG_MBIDCAMCFG (Offset 0x0628/0x62C)*/
1585 #define BIT_MBIDCAM_POLL BIT(31)
1586 #define BIT_MBIDCAM_WT_EN BIT(30)
1588 #define MBIDCAM_ADDR_MASK 0x1F
1589 #define MBIDCAM_ADDR_SHIFT 24
1591 #define BIT_MBIDCAM_VALID BIT(23)
1592 #define BIT_LSIC_TXOP_EN BIT(17)
1593 #define BIT_CTS_EN BIT(16)
1595 /* -----------------------------------------------------
1597 * SDIO Bus Specification
1599 * ----------------------------------------------------- */
1601 /* I/O bus domain address mapping */
1602 #define SDIO_LOCAL_BASE 0x10250000
1603 #define WLAN_IOREG_BASE 0x10260000
1604 #define FIRMWARE_FIFO_BASE 0x10270000
1605 #define TX_HIQ_BASE 0x10310000
1606 #define TX_MIQ_BASE 0x10320000
1607 #define TX_LOQ_BASE 0x10330000
1608 #define TX_EPQ_BASE 0x10350000
1609 #define RX_RX0FF_BASE 0x10340000
1611 /* SDIO host local register space mapping. */
1612 #define SDIO_LOCAL_MSK 0x0FFF
1613 #define WLAN_IOREG_MSK 0x7FFF
1614 #define WLAN_FIFO_MSK 0x1FFF /* Aggregation Length[12:0] */
1615 #define WLAN_RX0FF_MSK 0x0003
1617 #define SDIO_WITHOUT_REF_DEVICE_ID 0 /* Without reference to the SDIO Device ID */
1618 #define SDIO_LOCAL_DEVICE_ID 0 /* 0b[16], 000b[15:13] */
1619 #define WLAN_TX_HIQ_DEVICE_ID 4 /* 0b[16], 100b[15:13] */
1620 #define WLAN_TX_MIQ_DEVICE_ID 5 /* 0b[16], 101b[15:13] */
1621 #define WLAN_TX_LOQ_DEVICE_ID 6 /* 0b[16], 110b[15:13] */
1622 #define WLAN_TX_EXQ_DEVICE_ID 3 /* 0b[16], 011b[15:13] */
1623 #define WLAN_RX0FF_DEVICE_ID 7 /* 0b[16], 111b[15:13] */
1624 #define WLAN_IOREG_DEVICE_ID 8 /* 1b[16] */
1626 /* SDIO Tx Free Page Index */
1627 #define HI_QUEUE_IDX 0
1628 #define MID_QUEUE_IDX 1
1629 #define LOW_QUEUE_IDX 2
1630 #define PUBLIC_QUEUE_IDX 3
1632 #define SDIO_MAX_TX_QUEUE 3 /* HIQ, MIQ and LOQ */
1633 #define SDIO_MAX_RX_QUEUE 1
1635 #define SDIO_REG_TX_CTRL 0x0000 /* SDIO Tx Control */
1636 #define SDIO_REG_HIMR 0x0014 /* SDIO Host Interrupt Mask */
1637 #define SDIO_REG_HISR 0x0018 /* SDIO Host Interrupt Service Routine */
1638 #define SDIO_REG_HCPWM 0x0019 /* HCI Current Power Mode */
1639 #define SDIO_REG_RX0_REQ_LEN 0x001C /* RXDMA Request Length */
1640 #define SDIO_REG_OQT_FREE_PG 0x001E /* OQT Free Page */
1641 #define SDIO_REG_FREE_TXPG 0x0020 /* Free Tx Buffer Page */
1642 #define SDIO_REG_HCPWM1 0x0024 /* HCI Current Power Mode 1 */
1643 #define SDIO_REG_HCPWM2 0x0026 /* HCI Current Power Mode 2 */
1644 #define SDIO_REG_FREE_TXPG_SEQ 0x0028 /* Free Tx Page Sequence */
1645 #define SDIO_REG_HTSFR_INFO 0x0030 /* HTSF Informaion */
1646 #define SDIO_REG_HRPWM1 0x0080 /* HCI Request Power Mode 1 */
1647 #define SDIO_REG_HRPWM2 0x0082 /* HCI Request Power Mode 2 */
1648 #define SDIO_REG_HPS_CLKR 0x0084 /* HCI Power Save Clock */
1649 #define SDIO_REG_HSUS_CTRL 0x0086 /* SDIO HCI Suspend Control */
1650 #define SDIO_REG_HIMR_ON 0x0090 /* SDIO Host Extension Interrupt Mask Always */
1651 #define SDIO_REG_HISR_ON 0x0091 /* SDIO Host Extension Interrupt Status Always */
1653 #define SDIO_HIMR_DISABLED 0
1655 /* RTL8723/RTL8188E SDIO Host Interrupt Mask Register */
1656 #define SDIO_HIMR_RX_REQUEST_MSK BIT(0)
1657 #define SDIO_HIMR_AVAL_MSK BIT(1)
1658 #define SDIO_HIMR_TXERR_MSK BIT(2)
1659 #define SDIO_HIMR_RXERR_MSK BIT(3)
1660 #define SDIO_HIMR_TXFOVW_MSK BIT(4)
1661 #define SDIO_HIMR_RXFOVW_MSK BIT(5)
1662 #define SDIO_HIMR_TXBCNOK_MSK BIT(6)
1663 #define SDIO_HIMR_TXBCNERR_MSK BIT(7)
1664 #define SDIO_HIMR_BCNERLY_INT_MSK BIT(16)
1665 #define SDIO_HIMR_C2HCMD_MSK BIT(17)
1666 #define SDIO_HIMR_CPWM1_MSK BIT(18)
1667 #define SDIO_HIMR_CPWM2_MSK BIT(19)
1668 #define SDIO_HIMR_HSISR_IND_MSK BIT(20)
1669 #define SDIO_HIMR_GTINT3_IND_MSK BIT(21)
1670 #define SDIO_HIMR_GTINT4_IND_MSK BIT(22)
1671 #define SDIO_HIMR_PSTIMEOUT_MSK BIT(23)
1672 #define SDIO_HIMR_OCPINT_MSK BIT(24)
1673 #define SDIO_HIMR_ATIMEND_MSK BIT(25)
1674 #define SDIO_HIMR_ATIMEND_E_MSK BIT(26)
1675 #define SDIO_HIMR_CTWEND_MSK BIT(27)
1677 /* RTL8188E SDIO Specific */
1678 #define SDIO_HIMR_MCU_ERR_MSK BIT(28)
1679 #define SDIO_HIMR_TSF_BIT32_TOGGLE_MSK BIT(29)
1681 /* SDIO Host Interrupt Service Routine */
1682 #define SDIO_HISR_RX_REQUEST BIT(0)
1683 #define SDIO_HISR_AVAL BIT(1)
1684 #define SDIO_HISR_TXERR BIT(2)
1685 #define SDIO_HISR_RXERR BIT(3)
1686 #define SDIO_HISR_TXFOVW BIT(4)
1687 #define SDIO_HISR_RXFOVW BIT(5)
1688 #define SDIO_HISR_TXBCNOK BIT(6)
1689 #define SDIO_HISR_TXBCNERR BIT(7)
1690 #define SDIO_HISR_BCNERLY_INT BIT(16)
1691 #define SDIO_HISR_C2HCMD BIT(17)
1692 #define SDIO_HISR_CPWM1 BIT(18)
1693 #define SDIO_HISR_CPWM2 BIT(19)
1694 #define SDIO_HISR_HSISR_IND BIT(20)
1695 #define SDIO_HISR_GTINT3_IND BIT(21)
1696 #define SDIO_HISR_GTINT4_IND BIT(22)
1697 #define SDIO_HISR_PSTIMEOUT BIT(23)
1698 #define SDIO_HISR_OCPINT BIT(24)
1699 #define SDIO_HISR_ATIMEND BIT(25)
1700 #define SDIO_HISR_ATIMEND_E BIT(26)
1701 #define SDIO_HISR_CTWEND BIT(27)
1703 /* RTL8188E SDIO Specific */
1704 #define SDIO_HISR_MCU_ERR BIT(28)
1705 #define SDIO_HISR_TSF_BIT32_TOGGLE BIT(29)
1707 #define MASK_SDIO_HISR_CLEAR (SDIO_HISR_TXERR |\
1711 SDIO_HISR_TXBCNOK |\
1712 SDIO_HISR_TXBCNERR |\
1716 SDIO_HISR_HSISR_IND |\
1717 SDIO_HISR_GTINT3_IND |\
1718 SDIO_HISR_GTINT4_IND |\
1719 SDIO_HISR_PSTIMEOUT |\
1722 /* SDIO HCI Suspend Control Register */
1723 #define HCI_RESUME_PWR_RDY BIT(1)
1724 #define HCI_SUS_CTRL BIT(0)
1726 /* SDIO Tx FIFO related */
1727 #define SDIO_TX_FREE_PG_QUEUE 4 /* The number of Tx FIFO free page */
1728 #define SDIO_TX_FIFO_PAGE_SZ 128
1730 #ifdef CONFIG_SDIO_HCI
1731 #define MAX_TX_AGG_PACKET_NUMBER 0x8
1733 #define MAX_TX_AGG_PACKET_NUMBER 0xFF
1734 #define MAX_TX_AGG_PACKET_NUMBER_8812 64
1737 /* -----------------------------------------------------
1739 * 0xFE00h ~ 0xFE55h USB Configuration
1741 * ----------------------------------------------------- */
1743 /* 2 USB Information (0xFE17) */
1744 #define USB_IS_HIGH_SPEED 0
1745 #define USB_IS_FULL_SPEED 1
1746 #define USB_SPEED_MASK BIT(5)
1748 #define USB_NORMAL_SIE_EP_MASK 0xF
1749 #define USB_NORMAL_SIE_EP_SHIFT 4
1751 /* 2 Special Option */
1752 #define USB_AGG_EN BIT(3)
1754 /* 0; Use interrupt endpoint to upload interrupt pkt
1755 * 1; Use bulk endpoint to upload interrupt pkt, */
1756 #define INT_BULK_SEL BIT(4)
1758 /* 2REG_C2HEVT_CLEAR */
1759 #define C2H_EVT_HOST_CLOSE 0x00 /* Set by driver and notify FW that the driver has read the C2H command message */
1760 #define C2H_EVT_FW_CLOSE 0xFF /* Set by FW indicating that FW had set the C2H command message and it's not yet read by driver. */
1763 /* 2REG_MULTI_FUNC_CTRL(For RTL8723 Only) */
1764 #define WL_HWPDN_EN BIT(0) /* Enable GPIO[9] as WiFi HW PDn source */
1765 #define WL_HWPDN_SL BIT(1) /* WiFi HW PDn polarity control */
1766 #define WL_FUNC_EN BIT(2) /* WiFi function enable */
1767 #define WL_HWROF_EN BIT(3) /* Enable GPIO[9] as WiFi RF HW PDn source */
1768 #define BT_HWPDN_EN BIT(16) /* Enable GPIO[11] as BT HW PDn source */
1769 #define BT_HWPDN_SL BIT(17) /* BT HW PDn polarity control */
1770 #define BT_FUNC_EN BIT(18) /* BT function enable */
1771 #define BT_HWROF_EN BIT(19) /* Enable GPIO[11] as BT/GPS RF HW PDn source */
1772 #define GPS_HWPDN_EN BIT(20) /* Enable GPIO[10] as GPS HW PDn source */
1773 #define GPS_HWPDN_SL BIT(21) /* GPS HW PDn polarity control */
1774 #define GPS_FUNC_EN BIT(22) /* GPS function enable */
1776 /* 3 REG_LIFECTRL_CTRL */
1777 #define HAL92C_EN_PKT_LIFE_TIME_BK BIT(3)
1778 #define HAL92C_EN_PKT_LIFE_TIME_BE BIT(2)
1779 #define HAL92C_EN_PKT_LIFE_TIME_VI BIT(1)
1780 #define HAL92C_EN_PKT_LIFE_TIME_VO BIT(0)
1782 #define HAL92C_MSDU_LIFE_TIME_UNIT 128 /* in us, said by Tim. */
1784 /* 2 8192D PartNo. */
1785 #define PARTNO_92D_NIC (BIT7 | BIT6)
1786 #define PARTNO_92D_NIC_REMARK (BIT5 | BIT4)
1787 #define PARTNO_SINGLE_BAND_VS BIT(3)
1788 #define PARTNO_SINGLE_BAND_VS_REMARK BIT(1)
1789 #define PARTNO_CONCURRENT_BAND_VC (BIT3 | BIT2)
1790 #define PARTNO_CONCURRENT_BAND_VC_REMARK (BIT1 | BIT0)
1792 /* ********************************************************
1793 * General definitions
1794 * ******************************************************** */
1796 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8188E(__Adapter) (IS_VENDOR_8188E_I_CUT_SERIES(__Adapter) ? 255 : 175)
1797 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8812 255
1798 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8723B 255
1799 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8192C 255
1800 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8703B 255
1801 #define LAST_ENTRY_OF_TX_PKT_BUFFER_DUAL_MAC 127
1802 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8188F 255
1803 #define LAST_ENTRY_OF_TX_PKT_BUFFER_8723D 255
1805 #define POLLING_LLT_THRESHOLD 20
1806 #if defined(CONFIG_RTL8723B) && defined(CONFIG_PCI_HCI)
1807 #define POLLING_READY_TIMEOUT_COUNT 6000
1809 #define POLLING_READY_TIMEOUT_COUNT 1000
1814 #define HAL_8812A_HW_GPIO_WPS_BIT BIT(2)
1815 #define HAL_8192C_HW_GPIO_WPS_BIT BIT(2)
1816 #define HAL_8192EU_HW_GPIO_WPS_BIT BIT(7)
1817 #define HAL_8188E_HW_GPIO_WPS_BIT BIT(7)
1819 #endif /* __HAL_COMMON_H__ */
projects / firefly-linux-kernel-4.4.55.git / blob