xref: /OK3568_Linux_fs/external/rkwifibt/drivers/rtl8723ds/include/rtl8814a_recv.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /******************************************************************************
2*4882a593Smuzhiyun  *
3*4882a593Smuzhiyun  * Copyright(c) 2007 - 2017 Realtek Corporation.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * This program is free software; you can redistribute it and/or modify it
6*4882a593Smuzhiyun  * under the terms of version 2 of the GNU General Public License as
7*4882a593Smuzhiyun  * published by the Free Software Foundation.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * This program is distributed in the hope that it will be useful, but WITHOUT
10*4882a593Smuzhiyun  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11*4882a593Smuzhiyun  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12*4882a593Smuzhiyun  * more details.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *****************************************************************************/
15*4882a593Smuzhiyun #ifndef __RTL8814A_RECV_H__
16*4882a593Smuzhiyun #define __RTL8814A_RECV_H__
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #if defined(CONFIG_USB_HCI)
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun 	#ifndef MAX_RECVBUF_SZ
21*4882a593Smuzhiyun 		#ifndef CONFIG_MINIMAL_MEMORY_USAGE
22*4882a593Smuzhiyun 			#ifdef CONFIG_PLATFORM_MSTAR
23*4882a593Smuzhiyun 				#define MAX_RECVBUF_SZ (8192) /* 8K */
24*4882a593Smuzhiyun 			#else
25*4882a593Smuzhiyun 				#define MAX_RECVBUF_SZ (32768) /* 32k */
26*4882a593Smuzhiyun 			#endif
27*4882a593Smuzhiyun 			/* #define MAX_RECVBUF_SZ (24576) */ /* 24k */
28*4882a593Smuzhiyun 			/* #define MAX_RECVBUF_SZ (20480) */ /* 20K */
29*4882a593Smuzhiyun 			/* #define MAX_RECVBUF_SZ (10240) */ /* 10K */
30*4882a593Smuzhiyun 			/* #define MAX_RECVBUF_SZ (15360) */ /* 15k < 16k */
31*4882a593Smuzhiyun 			/* #define MAX_RECVBUF_SZ (8192+1024) */ /* 8K+1k */
32*4882a593Smuzhiyun 		#else
33*4882a593Smuzhiyun 			#define MAX_RECVBUF_SZ (4000) /* about 4K */
34*4882a593Smuzhiyun 		#endif
35*4882a593Smuzhiyun 	#endif /* !MAX_RECVBUF_SZ */
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun #elif defined(CONFIG_PCI_HCI)
38*4882a593Smuzhiyun 	/* #ifndef CONFIG_MINIMAL_MEMORY_USAGE */
39*4882a593Smuzhiyun 	/*	#define MAX_RECVBUF_SZ (9100) */
40*4882a593Smuzhiyun 	/* #else */
41*4882a593Smuzhiyun 	#define MAX_RECVBUF_SZ (4000) /* about 4K
42*4882a593Smuzhiyun 	* #endif */
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #elif defined(CONFIG_SDIO_HCI)
46*4882a593Smuzhiyun 	#if 0
47*4882a593Smuzhiyun 		/* temp solution */
48*4882a593Smuzhiyun 		#ifdef CONFIG_SDIO_RX_COPY
49*4882a593Smuzhiyun 			#define MAX_RECVBUF_SZ (10240)
50*4882a593Smuzhiyun 		#else /*  !CONFIG_SDIO_RX_COPY */
51*4882a593Smuzhiyun 			#define MAX_RECVBUF_SZ	MAX_RX_DMA_BUFFER_SIZE_8821
52*4882a593Smuzhiyun 		#endif /*  !CONFIG_SDIO_RX_COPY */
53*4882a593Smuzhiyun 	#endif
54*4882a593Smuzhiyun #endif
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun /* RX buffer descriptor */
58*4882a593Smuzhiyun /* DWORD 0 */
59*4882a593Smuzhiyun #define SET_RX_BUFFER_DESC_DATA_LENGTH_8814A(__pRxStatusDesc, __Value)		SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 0, 14, __Value)
60*4882a593Smuzhiyun #define SET_RX_BUFFER_DESC_LS_8814A(__pRxStatusDesc, __Value)					SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 14, 1, __Value)
61*4882a593Smuzhiyun #define SET_RX_BUFFER_DESC_FS_8814A(__pRxStatusDesc, __Value)					SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 15, 1, __Value)
62*4882a593Smuzhiyun #define SET_RX_BUFFER_DESC_TOTAL_LENGTH_8814A(__pRxStatusDesc, __Value)		SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 16, 16, __Value)
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun #define GET_RX_BUFFER_DESC_OWN_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc, 31, 1)
65*4882a593Smuzhiyun #define GET_RX_BUFFER_DESC_LS_8814A(__pRxStatusDesc)							LE_BITS_TO_4BYTE(__pRxStatusDesc, 14, 1)
66*4882a593Smuzhiyun #define GET_RX_BUFFER_DESC_FS_8814A(__pRxStatusDesc)							LE_BITS_TO_4BYTE(__pRxStatusDesc, 15, 1)
67*4882a593Smuzhiyun #define GET_RX_BUFFER_DESC_TOTAL_LENGTH_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc, 16, 15)
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /* DWORD 1 */
70*4882a593Smuzhiyun #define SET_RX_BUFFER_PHYSICAL_LOW_8814A(__pRxStatusDesc, __Value)			SET_BITS_TO_LE_4BYTE(__pRxStatusDesc+4, 0, 32, __Value)
71*4882a593Smuzhiyun #define GET_RX_BUFFER_PHYSICAL_LOW_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 0, 32)
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun /* DWORD 2 */
74*4882a593Smuzhiyun #define SET_RX_BUFFER_PHYSICAL_HIGH_8814A(__pRxStatusDesc, __Value)			SET_BITS_TO_LE_4BYTE(__pRxStatusDesc+8, 0, 32, __Value)
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun /* DWORD 3*/ /* RESERVED */
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #if 0
80*4882a593Smuzhiyun 	/* =============
81*4882a593Smuzhiyun 	* RX Info
82*4882a593Smuzhiyun 	* ============== */
83*4882a593Smuzhiyun #endif
84*4882a593Smuzhiyun /* DWORD 0 */
85*4882a593Smuzhiyun #define SET_RX_STATUS_DESC_PKT_LEN_8814A(__pRxStatusDesc, __Value)		SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 0, 14, __Value)
86*4882a593Smuzhiyun #define SET_RX_STATUS_DESC_EOR_8814A(__pRxStatusDesc, __Value)			SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 30, 1, __Value)
87*4882a593Smuzhiyun #define SET_RX_STATUS_DESC_OWN_8814AE(__pRxStatusDesc, __Value)		SET_BITS_TO_LE_4BYTE(__pRxStatusDesc, 31, 1, __Value)
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PKT_LEN_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc, 0, 14)
90*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_CRC32_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc, 14, 1)
91*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_ICV_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc, 15, 1)
92*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_DRVINFO_SIZE_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc, 16, 4)
93*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_SECURITY_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc, 20, 3)
94*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_QOS_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc, 23, 1)
95*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_SHIFT_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc, 24, 2)
96*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PHY_STATUS_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc, 26, 1)
97*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_SWDEC_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc, 27, 1)
98*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_LAST_SEG_8814AE(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc, 28, 1)
99*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_EOR_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc, 30, 1)
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun /* DWORD 1 */
102*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MACID_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 0, 7)
103*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_EXT_SECTYPE_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 7, 1)/* 20130415 KaiYuan add for 8814 */
104*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TID_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 8, 4)
105*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MACID_VLD_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 12, 1)
106*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_AMSDU_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 13, 1)
107*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_RXID_MATCH_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 14, 1)
108*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PAGGR_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 15, 1)
109*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TCPOFFLOAD_CHKERR_8814A(__pRxStatusDesc)		LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 20, 1)
110*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TCPOFFLOAD_IPVER_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 21, 1)
111*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TCPOFFLOAD_IS_TCPUDP_8814A(__pRxStatusDesc)		LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 22, 1)
112*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TCPOFFLOAD_CHK_VLD_8814A(__pRxStatusDesc)		LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 23, 1)
113*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PAM_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 24, 1)
114*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PWR_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 25, 1)
115*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MORE_DATA_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 26, 1)
116*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MORE_FRAG_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 27, 1)
117*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TYPE_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 28, 2)
118*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_FIRST_SEG_8814AE(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc, 29, 1)
119*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_EOR_8814AE(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc, 30, 1)
120*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MC_8814A(__pRxStatusDesc)							LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 30, 1)
121*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_BC_8814A(__pRxStatusDesc)							LE_BITS_TO_4BYTE(__pRxStatusDesc+4, 31, 1)
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun /* DWORD 2 */
124*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_SEQ_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 0, 12)
125*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_FRAG_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 12, 4)
126*4882a593Smuzhiyun #ifdef CONFIG_USB_RX_AGGREGATION
127*4882a593Smuzhiyun 	#define GET_RX_STATUS_DESC_USB_AGG_PKTNUM_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 16, 8)
128*4882a593Smuzhiyun #else
129*4882a593Smuzhiyun 	#define GET_RX_STATUS_DESC_RX_IS_QOS_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 16, 1)
130*4882a593Smuzhiyun #endif
131*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_WLANHD_IV_LEN_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 18, 6)
132*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_HWRSVD_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 24, 4)
133*4882a593Smuzhiyun #define GET_RX_STATUS_C2H_8814A(__pRxStatusDesc)								LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 28, 1)
134*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_FCS_OK_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+8, 31, 1)
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun /* DWORD 3 */
137*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_RX_RATE_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 0, 7)
138*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_BSSID_FIT_H_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 7, 3)/* 20130415 KaiYuan add for 8814 */
139*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_HTC_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 10, 1)
140*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_EOSP_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 11, 1)
141*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_BSSID_FIT_L_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 12, 2)
142*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_DMA_AGG_NUM_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 16, 8)/* 20130415 KaiYuan Check if it exist anymore */
143*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PATTERN_MATCH_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 29, 1)
144*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_UNICAST_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 30, 1)
145*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_MAGIC_WAKE_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+12, 31, 1)
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun /* DWORD 4 */
148*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_PATTERN_IDX_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+16, 0, 8)
149*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_RX_EOF_8814A(__pRxStatusDesc)					LE_BITS_TO_4BYTE(__pRxStatusDesc+16, 8, 1)
150*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_RX_SCRAMBLER_8814A(__pRxStatusDesc)				LE_BITS_TO_4BYTE(__pRxStatusDesc+16, 9, 7)
151*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_RX_PRE_NDP_VLD_8814A(__pRxStatusDesc)			LE_BITS_TO_4BYTE(__pRxStatusDesc+16, 16, 1)
152*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_A1_FIT_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+16, 24, 5)
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun /* DWORD 5 */
156*4882a593Smuzhiyun #define GET_RX_STATUS_DESC_TSFL_8814A(__pRxStatusDesc)						LE_BITS_TO_4BYTE(__pRxStatusDesc+20, 0, 32)
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun /* Rx smooth factor */
160*4882a593Smuzhiyun #define Rx_Smooth_Factor (20)
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun #ifdef CONFIG_USB_HCI
163*4882a593Smuzhiyun 	s32 rtl8814au_init_recv_priv(PADAPTER padapter);
164*4882a593Smuzhiyun 	void rtl8814au_free_recv_priv(PADAPTER padapter);
165*4882a593Smuzhiyun #endif
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun #ifdef CONFIG_PCI_HCI
168*4882a593Smuzhiyun 	s32 rtl8814ae_init_recv_priv(PADAPTER padapter);
169*4882a593Smuzhiyun 	void rtl8814ae_free_recv_priv(PADAPTER padapter);
170*4882a593Smuzhiyun #endif
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun #if 0
173*4882a593Smuzhiyun 	/* temp solution */
174*4882a593Smuzhiyun 	#ifdef CONFIG_SDIO_HCI
175*4882a593Smuzhiyun 		s32 InitRecvPriv8821AS(PADAPTER padapter);
176*4882a593Smuzhiyun 		void FreeRecvPriv8821AS(PADAPTER padapter);
177*4882a593Smuzhiyun 	#endif /*  CONFIG_SDIO_HCI */
178*4882a593Smuzhiyun #endif
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun void rtl8814_query_rx_desc_status(union recv_frame *precvframe, u8 *pdesc);
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun #endif /* __RTL8814A_RECV_H__ */
183