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