xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8821cs/include/rtl8188e_xmit.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3  *
4  * Copyright(c) 2007 - 2017 Realtek Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of version 2 of the GNU General Public License as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13  * more details.
14  *
15  *****************************************************************************/
16 #ifndef __RTL8188E_XMIT_H__
17 #define __RTL8188E_XMIT_H__
18 
19 
20 
21 
22 /* For 88e early mode */
23 #define SET_EARLYMODE_PKTNUM(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr, 0, 3, __Value)
24 #define SET_EARLYMODE_LEN0(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr, 4, 12, __Value)
25 #define SET_EARLYMODE_LEN1(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr, 16, 12, __Value)
26 #define SET_EARLYMODE_LEN2_1(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr, 28, 4, __Value)
27 #define SET_EARLYMODE_LEN2_2(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr+4, 0, 8, __Value)
28 #define SET_EARLYMODE_LEN3(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr+4, 8, 12, __Value)
29 #define SET_EARLYMODE_LEN4(__pAddr, __Value) SET_BITS_TO_LE_4BYTE(__pAddr+4, 20, 12, __Value)
30 
31 /*
32  * defined for TX DESC Operation
33  *   */
34 
35 #define MAX_TID (15)
36 
37 /* OFFSET 0 */
38 #define OFFSET_SZ	0
39 #define OFFSET_SHT	16
40 #define BMC		BIT(24)
41 #define LSG		BIT(26)
42 #define FSG		BIT(27)
43 #define OWN		BIT(31)
44 
45 
46 /* OFFSET 4 */
47 #define PKT_OFFSET_SZ		0
48 #define QSEL_SHT			8
49 #define RATE_ID_SHT			16
50 #define NAVUSEHDR			BIT(20)
51 #define SEC_TYPE_SHT		22
52 #define PKT_OFFSET_SHT		26
53 
54 /* OFFSET 8 */
55 #define AGG_EN				BIT(12)
56 #define AGG_BK					BIT(16)
57 #define AMPDU_DENSITY_SHT	20
58 #define ANTSEL_A			BIT(24)
59 #define ANTSEL_B			BIT(25)
60 #define TX_ANT_CCK_SHT		26
61 #define TX_ANTL_SHT			28
62 #define TX_ANT_HT_SHT		30
63 
64 /* OFFSET 12 */
65 #define SEQ_SHT				16
66 #define EN_HWSEQ			BIT(31)
67 
68 /* OFFSET 16 */
69 #define	QOS                          BIT(6)
70 #define	HW_SSN				BIT(7)
71 #define	USERATE			BIT(8)
72 #define	DISDATAFB			BIT(10)
73 #define   CTS_2_SELF			BIT(11)
74 #define	RTS_EN				BIT(12)
75 #define	HW_RTS_EN			BIT(13)
76 #define	DATA_SHORT			BIT(24)
77 #define	PWR_STATUS_SHT	15
78 #define	DATA_SC_SHT		20
79 #define	DATA_BW			BIT(25)
80 
81 /* OFFSET 20 */
82 #define	RTY_LMT_EN			BIT(17)
83 
84 
85 /* OFFSET 20 */
86 #define SGI					BIT(6)
87 #define USB_TXAGG_NUM_SHT	24
88 
89 typedef struct txdesc_88e {
90 	/* Offset 0 */
91 	u32 pktlen:16;
92 	u32 offset:8;
93 	u32 bmc:1;
94 	u32 htc:1;
95 	u32 ls:1;
96 	u32 fs:1;
97 	u32 linip:1;
98 	u32 noacm:1;
99 	u32 gf:1;
100 	u32 own:1;
101 
102 	/* Offset 4 */
103 	u32 macid:6;
104 	u32 rsvd0406:2;
105 	u32 qsel:5;
106 	u32 rd_nav_ext:1;
107 	u32 lsig_txop_en:1;
108 	u32 pifs:1;
109 	u32 rate_id:4;
110 	u32 navusehdr:1;
111 	u32 en_desc_id:1;
112 	u32 sectype:2;
113 	u32 rsvd0424:2;
114 	u32 pkt_offset:5;	/* unit: 8 bytes */
115 	u32 rsvd0431:1;
116 
117 	/* Offset 8 */
118 	u32 rts_rc:6;
119 	u32 data_rc:6;
120 	u32 agg_en:1;
121 	u32 rd_en:1;
122 	u32 bar_rty_th:2;
123 	u32 bk:1;
124 	u32 morefrag:1;
125 	u32 raw:1;
126 	u32 ccx:1;
127 	u32 ampdu_density:3;
128 	u32 bt_null:1;
129 	u32 ant_sel_a:1;
130 	u32 ant_sel_b:1;
131 	u32 tx_ant_cck:2;
132 	u32 tx_antl:2;
133 	u32 tx_ant_ht:2;
134 
135 	/* Offset 12 */
136 	u32 nextheadpage:8;
137 	u32 tailpage:8;
138 	u32 seq:12;
139 	u32 cpu_handle:1;
140 	u32 tag1:1;
141 	u32 trigger_int:1;
142 	u32 hwseq_en:1;
143 
144 	/* Offset 16 */
145 	u32 rtsrate:5;
146 	u32 ap_dcfe:1;
147 	u32 hwseq_sel:2;
148 	u32 userate:1;
149 	u32 disrtsfb:1;
150 	u32 disdatafb:1;
151 	u32 cts2self:1;
152 	u32 rtsen:1;
153 	u32 hw_rts_en:1;
154 	u32 port_id:1;
155 	u32 pwr_status:3;
156 	u32 wait_dcts:1;
157 	u32 cts2ap_en:1;
158 	u32 data_sc:2;
159 	u32 data_stbc:2;
160 	u32 data_short:1;
161 	u32 data_bw:1;
162 	u32 rts_short:1;
163 	u32 rts_bw:1;
164 	u32 rts_sc:2;
165 	u32 vcs_stbc:2;
166 
167 	/* Offset 20 */
168 	u32 datarate:6;
169 	u32 sgi:1;
170 	u32 try_rate:1;
171 	u32 data_ratefb_lmt:5;
172 	u32 rts_ratefb_lmt:4;
173 	u32 rty_lmt_en:1;
174 	u32 data_rt_lmt:6;
175 	u32 usb_txagg_num:8;
176 
177 	/* Offset 24 */
178 	u32 txagg_a:5;
179 	u32 txagg_b:5;
180 	u32 use_max_len:1;
181 	u32 max_agg_num:5;
182 	u32 mcsg1_max_len:4;
183 	u32 mcsg2_max_len:4;
184 	u32 mcsg3_max_len:4;
185 	u32 mcs7_sgi_max_len:4;
186 
187 	/* Offset 28 */
188 	u32 checksum:16;	/* TxBuffSize(PCIe)/CheckSum(USB) */
189 	u32 sw0:8; /* offset 30 */
190 	u32 sw1:4;
191 	u32 mcs15_sgi_max_len:4;
192 } TXDESC_8188E, *PTXDESC_8188E;
193 
194 #define txdesc_set_ccx_sw_88e(txdesc, value) \
195 	do { \
196 		((struct txdesc_88e *)(txdesc))->sw1 = (((value)>>8) & 0x0f); \
197 		((struct txdesc_88e *)(txdesc))->sw0 = ((value) & 0xff); \
198 	} while (0)
199 
200 struct txrpt_ccx_88e {
201 	/* offset 0 */
202 	u8 tag1:1;
203 	u8 pkt_num:3;
204 	u8 txdma_underflow:1;
205 	u8 int_bt:1;
206 	u8 int_tri:1;
207 	u8 int_ccx:1;
208 
209 	/* offset 1 */
210 	u8 mac_id:6;
211 	u8 pkt_ok:1;
212 	u8 bmc:1;
213 
214 	/* offset 2 */
215 	u8 retry_cnt:6;
216 	u8 lifetime_over:1;
217 	u8 retry_over:1;
218 
219 	/* offset 3 */
220 	u8 ccx_qtime0;
221 	u8 ccx_qtime1;
222 
223 	/* offset 5 */
224 	u8 final_data_rate;
225 
226 	/* offset 6 */
227 	u8 sw1:4;
228 	u8 qsel:4;
229 
230 	/* offset 7 */
231 	u8 sw0;
232 };
233 
234 #define txrpt_ccx_sw_88e(txrpt_ccx) ((txrpt_ccx)->sw0 + ((txrpt_ccx)->sw1<<8))
235 #define txrpt_ccx_qtime_88e(txrpt_ccx) ((txrpt_ccx)->ccx_qtime0+((txrpt_ccx)->ccx_qtime1<<8))
236 
237 #define SET_TX_DESC_SEC_TYPE_8188E(__pTxDesc, __Value) SET_BITS_TO_LE_4BYTE(__pTxDesc+4, 22, 2, __Value)
238 
239 void rtl8188e_fill_fake_txdesc(PADAPTER	padapter, u8 *pDesc, u32 BufferLen,
240 			       u8 IsPsPoll, u8	IsBTQosNull, u8 bDataFrame);
241 void rtl8188e_cal_txdesc_chksum(struct tx_desc	*ptxdesc);
242 void fill_txdesc_force_bmc_camid(struct pkt_attrib *pattrib, struct tx_desc *ptxdesc);
243 
244 #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_GSPI_HCI)
245 	s32 rtl8188es_init_xmit_priv(PADAPTER padapter);
246 	void rtl8188es_free_xmit_priv(PADAPTER padapter);
247 	s32 rtl8188es_hal_xmit(PADAPTER padapter, struct xmit_frame *pxmitframe);
248 	s32 rtl8188es_mgnt_xmit(PADAPTER padapter, struct xmit_frame *pmgntframe);
249 #ifdef CONFIG_RTW_MGMT_QUEUE
250 	s32 rtl8188es_hal_mgmt_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
251 #endif
252 	s32	rtl8188es_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
253 	thread_return rtl8188es_xmit_thread(thread_context context);
254 	s32 rtl8188es_xmit_buf_handler(PADAPTER padapter);
255 
256 	#ifdef CONFIG_SDIO_TX_TASKLET
257 		void rtl8188es_xmit_tasklet(void *priv);
258 	#endif
259 #endif
260 
261 #ifdef CONFIG_USB_HCI
262 	s32 rtl8188eu_init_xmit_priv(PADAPTER padapter);
263 	void rtl8188eu_free_xmit_priv(PADAPTER padapter);
264 	s32 rtl8188eu_hal_xmit(PADAPTER padapter, struct xmit_frame *pxmitframe);
265 	s32 rtl8188eu_mgnt_xmit(PADAPTER padapter, struct xmit_frame *pmgntframe);
266 #ifdef CONFIG_RTW_MGMT_QUEUE
267 	s32 rtl8188eu_hal_mgmt_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
268 #endif
269 	s32	rtl8188eu_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
270 	s32 rtl8188eu_xmit_buf_handler(PADAPTER padapter);
271 	void rtl8188eu_xmit_tasklet(void *priv);
272 	s32 rtl8188eu_xmitframe_complete(_adapter *padapter, struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf);
273 #endif
274 
275 #ifdef CONFIG_PCI_HCI
276 	s32 rtl8188ee_init_xmit_priv(PADAPTER padapter);
277 	void rtl8188ee_free_xmit_priv(PADAPTER padapter);
278 	void	rtl8188ee_xmitframe_resume(_adapter *padapter);
279 	s32 rtl8188ee_hal_xmit(PADAPTER padapter, struct xmit_frame *pxmitframe);
280 	s32 rtl8188ee_mgnt_xmit(PADAPTER padapter, struct xmit_frame *pmgntframe);
281 #ifdef CONFIG_RTW_MGMT_QUEUE
282 	s32 rtl8188ee_hal_mgmt_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
283 #endif
284 	s32	rtl8188ee_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
285 	void rtl8188ee_xmit_tasklet(void *priv);
286 #endif
287 
288 
289 
290 #ifdef CONFIG_TX_EARLY_MODE
291 	void UpdateEarlyModeInfo8188E(struct xmit_priv *pxmitpriv, struct xmit_buf *pxmitbuf);
292 #endif
293 
294 #ifdef CONFIG_XMIT_ACK
295 	void dump_txrpt_ccx_88e(void *buf);
296 	void handle_txrpt_ccx_88e(_adapter *adapter, u8 *buf);
297 #else
298 	#define dump_txrpt_ccx_88e(buf) do {} while (0)
299 	#define handle_txrpt_ccx_88e(adapter, buf) do {} while (0)
300 #endif /* CONFIG_XMIT_ACK */
301 
302 void _dbg_dump_tx_info(_adapter	*padapter, int frame_tag, struct tx_desc *ptxdesc);
303 #endif /* __RTL8188E_XMIT_H__ */
304