OSDN Git Service

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