1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /* Copyright(c) 2007 - 2012 Realtek Corporation. */
3
4 #ifndef _RTW_RECV_H_
5 #define _RTW_RECV_H_
6
7 #include "osdep_service.h"
8 #include "drv_types.h"
9
10 #define NR_RECVFRAME 256
11
12 #define RXFRAME_ALIGN 8
13 #define RXFRAME_ALIGN_SZ (1<<RXFRAME_ALIGN)
14
15 #define MAX_RXFRAME_CNT 512
16 #define MAX_RX_NUMBLKS (32)
17 #define RECVFRAME_HDR_ALIGN 128
18
19 #define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
20
21 #define MAX_SUBFRAME_COUNT 64
22
23 #define LLC_HEADER_SIZE 6
24
25 /* for Rx reordering buffer control */
26 struct recv_reorder_ctrl {
27 struct adapter *padapter;
28 u8 enable;
29 u16 indicate_seq;/* wstart_b, init_value=0xffff */
30 u16 wend_b;
31 u8 wsize_b;
32 struct __queue pending_recvframe_queue;
33 struct timer_list reordering_ctrl_timer;
34 };
35
36 struct stainfo_rxcache {
37 u16 tid_rxseq[16];
38 /*
39 unsigned short tid0_rxseq;
40 unsigned short tid1_rxseq;
41 unsigned short tid2_rxseq;
42 unsigned short tid3_rxseq;
43 unsigned short tid4_rxseq;
44 unsigned short tid5_rxseq;
45 unsigned short tid6_rxseq;
46 unsigned short tid7_rxseq;
47 unsigned short tid8_rxseq;
48 unsigned short tid9_rxseq;
49 unsigned short tid10_rxseq;
50 unsigned short tid11_rxseq;
51 unsigned short tid12_rxseq;
52 unsigned short tid13_rxseq;
53 unsigned short tid14_rxseq;
54 unsigned short tid15_rxseq;
55 */
56 };
57
58 struct signal_stat {
59 u8 update_req; /* used to indicate */
60 u8 avg_val; /* avg of valid elements */
61 u32 total_num; /* num of valid elements */
62 u32 total_val; /* sum of valid elements */
63 };
64 #define MAX_PATH_NUM_92CS 3
65 struct phy_info {
66 u8 RxPWDBAll;
67 u8 SignalQuality; /* in 0-100 index. */
68 u8 RxMIMOSignalStrength[MAX_PATH_NUM_92CS];/* in 0~100 index */
69 s8 RxPower; /* in dBm Translate from PWdB */
70 /* Real power in dBm for this packet, no beautification and aggregation.
71 * Keep this raw info to be used for the other procedures. */
72 s8 recvpower;
73 u8 SignalStrength; /* in 0-100 index. */
74 u8 RxPwr[MAX_PATH_NUM_92CS];/* per-path's pwdb */
75 };
76
77 struct rx_pkt_attrib {
78 u16 pkt_len;
79 u8 physt;
80 u8 drvinfo_sz;
81 u8 shift_sz;
82 u8 hdrlen; /* the WLAN Header Len */
83 u8 amsdu;
84 bool qos;
85 u8 priority;
86 u8 pw_save;
87 u8 mdata;
88 u16 seq_num;
89 u8 frag_num;
90 u8 mfrag;
91 u8 order;
92 u8 privacy; /* in frame_ctrl field */
93 u8 bdecrypted;
94 u8 encrypt; /* when 0 indicate no encrypt. when non-zero,
95 * indicate the encrypt algorith */
96 u8 iv_len;
97 u8 icv_len;
98 u8 crc_err;
99 u8 icv_err;
100
101 u16 eth_type;
102
103 u8 dst[ETH_ALEN] __aligned(2);
104 u8 src[ETH_ALEN] __aligned(2);
105 u8 ta[ETH_ALEN] __aligned(2);
106 u8 ra[ETH_ALEN] __aligned(2);
107 u8 bssid[ETH_ALEN] __aligned(2);
108
109 u8 ack_policy;
110
111 u8 key_index;
112
113 u8 mcs_rate;
114 u8 rxht;
115 u8 sgi;
116 u8 pkt_rpt_type;
117 u32 MacIDValidEntry[2]; /* 64 bits present 64 entry. */
118
119 struct phy_info phy_info;
120 };
121
122 /* These definition is used for Rx packet reordering. */
123 #define SN_LESS(a, b) (((a - b) & 0x800) != 0)
124 #define SN_EQUAL(a, b) (a == b)
125 #define REORDER_WAIT_TIME (50) /* (ms) */
126
127 #define RECVBUFF_ALIGN_SZ 8
128
129 #define RXDESC_SIZE 24
130 #define RXDESC_OFFSET RXDESC_SIZE
131
132 struct recv_stat {
133 __le32 rxdw0;
134 __le32 rxdw1;
135 __le32 rxdw2;
136 __le32 rxdw3;
137 __le32 rxdw4;
138 __le32 rxdw5;
139 };
140
141 #define EOR BIT(30)
142
143 /*
144 accesser of recv_priv: rtw_recv_entry(dispatch / passive level);
145 recv_thread(passive) ; returnpkt(dispatch)
146 ; halt(passive) ;
147
148 using enter_critical section to protect
149 */
150 struct recv_priv {
151 spinlock_t lock;
152 struct __queue free_recv_queue;
153 struct __queue recv_pending_queue;
154 struct __queue uc_swdec_pending_queue;
155 u8 *pallocated_frame_buf;
156 u8 *precv_frame_buf;
157 uint free_recvframe_cnt;
158 struct adapter *adapter;
159 u32 bIsAnyNonBEPkts;
160 u64 rx_bytes;
161 u64 rx_pkts;
162 u64 rx_drop;
163 u64 last_rx_bytes;
164
165 uint rx_icv_err;
166 uint rx_largepacket_crcerr;
167 uint rx_smallpacket_crcerr;
168 uint rx_middlepacket_crcerr;
169 u8 rx_pending_cnt;
170
171 struct tasklet_struct recv_tasklet;
172 struct sk_buff_head free_recv_skb_queue;
173 struct sk_buff_head rx_skb_queue;
174 u8 *pallocated_recv_buf;
175 u8 *precv_buf; /* 4 alignment */
176 struct __queue free_recv_buf_queue;
177 u32 free_recv_buf_queue_cnt;
178 /* For display the phy informatiom */
179 u8 is_signal_dbg; /* for debug */
180 u8 signal_strength_dbg; /* for debug */
181 s8 rssi;
182 s8 rxpwdb;
183 u8 signal_strength;
184 u8 signal_qual;
185 u8 noise;
186 int RxSNRdB[2];
187 s8 RxRssi[2];
188 int FalseAlmCnt_all;
189
190 struct timer_list signal_stat_timer;
191 u32 signal_stat_sampling_interval;
192 struct signal_stat signal_qual_data;
193 struct signal_stat signal_strength_data;
194 };
195
196 #define rtw_set_signal_stat_timer(recvpriv) \
197 _set_timer(&(recvpriv)->signal_stat_timer, \
198 (recvpriv)->signal_stat_sampling_interval)
199
200 struct sta_recv_priv {
201 spinlock_t lock;
202 int option;
203 struct __queue defrag_q; /* keeping the fragment frame until defrag */
204 struct stainfo_rxcache rxcache;
205 };
206
207 struct recv_buf {
208 struct adapter *adapter;
209 struct urb *purb;
210 struct sk_buff *pskb;
211 u8 reuse;
212 };
213
214 /*
215 head ----->
216
217 data ----->
218
219 payload
220
221 tail ----->
222
223 end ----->
224
225 len = (unsigned int )(tail - data);
226
227 */
228 struct recv_frame {
229 struct list_head list;
230 struct sk_buff *pkt;
231 struct adapter *adapter;
232 u8 fragcnt;
233 int frame_tag;
234 struct rx_pkt_attrib attrib;
235 uint len;
236 u8 *rx_head;
237 u8 *rx_data;
238 u8 *rx_tail;
239 u8 *rx_end;
240 void *precvbuf;
241 struct sta_info *psta;
242 /* for A-MPDU Rx reordering buffer control */
243 struct recv_reorder_ctrl *preorder_ctrl;
244 };
245
246 int _rtw_init_recv_priv(struct recv_priv *precvpriv, struct adapter *padapter);
247 void _rtw_free_recv_priv(struct recv_priv *precvpriv);
248 s32 rtw_recv_entry(struct recv_frame *precv_frame);
249 struct recv_frame *_rtw_alloc_recvframe(struct __queue *pfree_recv_queue);
250 struct recv_frame *rtw_alloc_recvframe(struct __queue *pfree_recv_queue);
251 int rtw_free_recvframe(struct recv_frame *precvframe,
252 struct __queue *pfree_recv_queue);
253 int _rtw_enqueue_recvframe(struct recv_frame *precvframe, struct __queue *queue);
254 int rtw_enqueue_recvframe(struct recv_frame *precvframe, struct __queue *queue);
255 void rtw_free_recvframe_queue(struct __queue *pframequeue,
256 struct __queue *pfree_recv_queue);
257 u32 rtw_free_uc_swdec_pending_queue(struct adapter *adapter);
258
259 void rtw_reordering_ctrl_timeout_handler(void *pcontext);
260
get_rxmem(struct recv_frame * precvframe)261 static inline u8 *get_rxmem(struct recv_frame *precvframe)
262 {
263 /* always return rx_head... */
264 if (precvframe == NULL)
265 return NULL;
266 return precvframe->rx_head;
267 }
268
recvframe_pull(struct recv_frame * precvframe,int sz)269 static inline u8 *recvframe_pull(struct recv_frame *precvframe, int sz)
270 {
271 /* rx_data += sz; move rx_data sz bytes hereafter */
272
273 /* used for extract sz bytes from rx_data, update rx_data and return
274 * the updated rx_data to the caller */
275
276 if (precvframe == NULL)
277 return NULL;
278 precvframe->rx_data += sz;
279 if (precvframe->rx_data > precvframe->rx_tail) {
280 precvframe->rx_data -= sz;
281 return NULL;
282 }
283 precvframe->len -= sz;
284 return precvframe->rx_data;
285 }
286
recvframe_put(struct recv_frame * precvframe,int sz)287 static inline u8 *recvframe_put(struct recv_frame *precvframe, int sz)
288 {
289 /* used for append sz bytes from ptr to rx_tail, update rx_tail
290 * and return the updated rx_tail to the caller */
291 /* after putting, rx_tail must be still larger than rx_end. */
292
293 if (precvframe == NULL)
294 return NULL;
295
296 precvframe->rx_tail += sz;
297
298 if (precvframe->rx_tail > precvframe->rx_end) {
299 precvframe->rx_tail -= sz;
300 return NULL;
301 }
302 precvframe->len += sz;
303 return precvframe->rx_tail;
304 }
305
recvframe_pull_tail(struct recv_frame * precvframe,int sz)306 static inline u8 *recvframe_pull_tail(struct recv_frame *precvframe, int sz)
307 {
308 /* rmv data from rx_tail (by yitsen) */
309
310 /* used for extract sz bytes from rx_end, update rx_end and return
311 * the updated rx_end to the caller */
312 /* after pulling, rx_end must be still larger than rx_data. */
313
314 if (precvframe == NULL)
315 return NULL;
316 precvframe->rx_tail -= sz;
317 if (precvframe->rx_tail < precvframe->rx_data) {
318 precvframe->rx_tail += sz;
319 return NULL;
320 }
321 precvframe->len -= sz;
322 return precvframe->rx_tail;
323 }
324
get_recvframe_len(struct recv_frame * precvframe)325 static inline int get_recvframe_len(struct recv_frame *precvframe)
326 {
327 return precvframe->len;
328 }
329
translate_percentage_to_dbm(u32 sig_stren_index)330 static inline s32 translate_percentage_to_dbm(u32 sig_stren_index)
331 {
332 s32 power; /* in dBm. */
333
334 /* Translate to dBm (x=0.5y-95). */
335 power = (s32)((sig_stren_index + 1) >> 1);
336 power -= 95;
337
338 return power;
339 }
340
341 struct sta_info;
342
343 void _rtw_init_sta_recv_priv(struct sta_recv_priv *psta_recvpriv);
344
345 void mgt_dispatcher(struct adapter *padapter, struct recv_frame *precv_frame);
346
347 #endif
348
