rtw_recv.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/******************************************************************************
  3 *
  4 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
  5 *
  6 ******************************************************************************/
  7#ifndef _RTW_RECV_H_
  8#define _RTW_RECV_H_
  9
 10#define NR_RECVBUFF (8)
 11
 12#define NR_RECVFRAME 256
 13
 14#define RXFRAME_ALIGN	8
 15#define RXFRAME_ALIGN_SZ	(1<<RXFRAME_ALIGN)
 16
 17#define DRVINFO_SZ	4 /*  unit is 8bytes */
 18
 19#define MAX_RX_NUMBLKS		(32)
 20#define RECVFRAME_HDR_ALIGN 128
 21
 22#define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
 23
 24#define MAX_SUBFRAME_COUNT	64
 25
 26#define LLC_HEADER_LENGTH	6
 27
 28/* for Rx reordering buffer control */
 29struct recv_reorder_ctrl {
 30	struct adapter	*padapter;
 31	u8 enable;
 32	u16 indicate_seq;/* wstart_b, init_value = 0xffff */
 33	u16 wend_b;
 34	u8 wsize_b;
 35	struct __queue pending_recvframe_queue;
 36	struct timer_list reordering_ctrl_timer;
 37};
 38
 39struct	stainfo_rxcache	{
 40	u16 tid_rxseq[16];
 41/*
 42	unsigned short	tid0_rxseq;
 43	unsigned short	tid1_rxseq;
 44	unsigned short	tid2_rxseq;
 45	unsigned short	tid3_rxseq;
 46	unsigned short	tid4_rxseq;
 47	unsigned short	tid5_rxseq;
 48	unsigned short	tid6_rxseq;
 49	unsigned short	tid7_rxseq;
 50	unsigned short	tid8_rxseq;
 51	unsigned short	tid9_rxseq;
 52	unsigned short	tid10_rxseq;
 53	unsigned short	tid11_rxseq;
 54	unsigned short	tid12_rxseq;
 55	unsigned short	tid13_rxseq;
 56	unsigned short	tid14_rxseq;
 57	unsigned short	tid15_rxseq;
 58*/
 59};
 60
 61
 62struct signal_stat {
 63	u8 update_req;		/* used to indicate */
 64	u8 avg_val;		/* avg of valid elements */
 65	u32 total_num;		/* num of valid elements */
 66	u32 total_val;		/* sum of valid elements */
 67};
 68
 69struct phy_info {
 70	u8 rx_pwd_ba11;
 71
 72	u8 SignalQuality;	 /*  in 0-100 index. */
 73	s8		rx_mimo_signal_quality[4];	/* per-path's EVM */
 74	u8 RxMIMOEVMdbm[4];		/* per-path's EVM dbm */
 75
 76	u8 rx_mimo_signal_strength[4];/*  in 0~100 index */
 77
 78	u16 	Cfo_short[4];			/*  per-path's Cfo_short */
 79	u16 	Cfo_tail[4];			/*  per-path's Cfo_tail */
 80
 81	s8		RxPower; /*  in dBm Translate from PWdB */
 82	s8		RecvSignalPower;/*  Real power in dBm for this packet, no beautification and aggregation. Keep this raw info to be used for the other procedures. */
 83	u8 bt_rx_rssi_percentage;
 84	u8 SignalStrength; /*  in 0-100 index. */
 85
 86	s8		RxPwr[4];				/* per-path's pwdb */
 87	u8 RxSNR[4];				/* per-path's SNR */
 88	u8 BandWidth;
 89	u8 btCoexPwrAdjust;
 90};
 91
 92struct rx_pkt_attrib	{
 93	u16 pkt_len;
 94	u8 physt;
 95	u8 drvinfo_sz;
 96	u8 shift_sz;
 97	u8 hdrlen; /* the WLAN Header Len */
 98	u8 to_fr_ds;
 99	u8 amsdu;
100	u8 qos;
101	u8 priority;
102	u8 pw_save;
103	u8 mdata;
104	u16 seq_num;
105	u8 frag_num;
106	u8 mfrag;
107	u8 order;
108	u8 privacy; /* in frame_ctrl field */
109	u8 bdecrypted;
110	u8 encrypt; /* when 0 indicates no encryption; when non-zero, indicates the encryption algorithm */
111	u8 iv_len;
112	u8 icv_len;
113	u8 crc_err;
114	u8 icv_err;
115
116	u16 eth_type;
117
118	u8 dst[ETH_ALEN];
119	u8 src[ETH_ALEN];
120	u8 ta[ETH_ALEN];
121	u8 ra[ETH_ALEN];
122	u8 bssid[ETH_ALEN];
123
124	u8 ack_policy;
125
126	u8 key_index;
127
128	u8 data_rate;
129	u8 sgi;
130	u8 pkt_rpt_type;
131	u32 MacIDValidEntry[2];	/*  64 bits present 64 entry. */
132
133/*
134	u8 signal_qual;
135	s8	rx_mimo_signal_qual[2];
136	u8 signal_strength;
137	u32 rx_pwd_ba11;
138	s32	RecvSignalPower;
139*/
140	struct phy_info phy_info;
141};
142
143
144/* These definition is used for Rx packet reordering. */
145#define SN_LESS(a, b)		(((a - b) & 0x800) != 0)
146#define SN_EQUAL(a, b)	(a == b)
147/* define REORDER_WIN_SIZE	128 */
148/* define REORDER_ENTRY_NUM	128 */
149#define REORDER_WAIT_TIME	(50) /*  (ms) */
150
151#define RECVBUFF_ALIGN_SZ 8
152
153#define RXDESC_SIZE	24
154
155struct recv_stat {
156	__le32 rxdw0;
157	__le32 rxdw1;
158	__le32 rxdw2;
159	__le32 rxdw3;
160#ifndef BUF_DESC_ARCH
161	__le32 rxdw4;
162	__le32 rxdw5;
163#endif /* if BUF_DESC_ARCH is defined, rx_buf_desc occupy 4 double words */
164};
165
166/*
167accesser of recv_priv: rtw_recv_entry(dispatch / passive level); recv_thread(passive) ; returnpkt(dispatch)
168; halt(passive) ;
169
170using enter_critical section to protect
171*/
172struct recv_priv {
173	spinlock_t	lock;
174	struct __queue	free_recv_queue;
175	struct __queue	recv_pending_queue;
176	struct __queue	uc_swdec_pending_queue;
177	u8 *pallocated_frame_buf;
178	u8 *precv_frame_buf;
179	uint free_recvframe_cnt;
180	struct adapter	*adapter;
181	u32 bIsAnyNonBEPkts;
182	u64	rx_bytes;
183	u64	rx_pkts;
184	u64	rx_drop;
185	uint  rx_icv_err;
186	uint  rx_largepacket_crcerr;
187	uint  rx_smallpacket_crcerr;
188	uint  rx_middlepacket_crcerr;
189
190	struct tasklet_struct irq_prepare_beacon_tasklet;
191	struct tasklet_struct recv_tasklet;
192	struct sk_buff_head free_recv_skb_queue;
193	struct sk_buff_head rx_skb_queue;
194
195	u8 *pallocated_recv_buf;
196	u8 *precv_buf;    /*  4 alignment */
197	struct __queue	free_recv_buf_queue;
198	u32 free_recv_buf_queue_cnt;
199
200	struct __queue	recv_buf_pending_queue;
201
202	/* For display the phy information */
203	u8 is_signal_dbg;	/*  for debug */
204	u8 signal_strength_dbg;	/*  for debug */
205
206	u8 signal_strength;
207	u8 signal_qual;
208	s8 rssi;	/* translate_percentage_to_dbm(ptarget_wlan->network.PhyInfo.SignalStrength); */
209	/* s8 rxpwdb; */
210	s16 noise;
211	/* int RxSNRdB[2]; */
212	/* s8 RxRssi[2]; */
213	/* int FalseAlmCnt_all; */
214
215
216	struct timer_list signal_stat_timer;
217	u32 signal_stat_sampling_interval;
218	/* u32 signal_stat_converging_constant; */
219	struct signal_stat signal_qual_data;
220	struct signal_stat signal_strength_data;
221};
222
223#define rtw_set_signal_stat_timer(recvpriv) _set_timer(&(recvpriv)->signal_stat_timer, (recvpriv)->signal_stat_sampling_interval)
224
225struct sta_recv_priv {
226
227	spinlock_t	lock;
228	signed int	option;
229
230	/* struct __queue	blk_strms[MAX_RX_NUMBLKS]; */
231	struct __queue defrag_q;	 /* keeping the fragment frame until defrag */
232
233	struct	stainfo_rxcache rxcache;
234
235	/* uint	sta_rx_bytes; */
236	/* uint	sta_rx_pkts; */
237	/* uint	sta_rx_fail; */
238
239};
240
241
242struct recv_buf {
243	struct list_head list;
244
245	spinlock_t recvbuf_lock;
246
247	u32 ref_cnt;
248
249	struct adapter *adapter;
250
251	u8 *pbuf;
252	u8 *pallocated_buf;
253
254	u32 len;
255	u8 *phead;
256	u8 *pdata;
257	u8 *ptail;
258	u8 *pend;
259
260	struct sk_buff	*pskb;
261	u8 reuse;
262};
263
264
265/*
266	head  ----->
267
268		data  ----->
269
270			payload
271
272		tail  ----->
273
274
275	end   ----->
276
277	len = (unsigned int)(tail - data);
278
279*/
280struct recv_frame_hdr {
281	struct list_head	list;
282	struct sk_buff	 *pkt;
283	struct sk_buff	 *pkt_newalloc;
284
285	struct adapter  *adapter;
286
287	u8 fragcnt;
288
289	int frame_tag;
290
291	struct rx_pkt_attrib attrib;
292
293	uint  len;
294	u8 *rx_head;
295	u8 *rx_data;
296	u8 *rx_tail;
297	u8 *rx_end;
298
299	void *precvbuf;
300
301
302	/*  */
303	struct sta_info *psta;
304
305	/* for A-MPDU Rx reordering buffer control */
306	struct recv_reorder_ctrl *preorder_ctrl;
307};
308
309
310union recv_frame {
311	union{
312		struct list_head list;
313		struct recv_frame_hdr hdr;
314		uint mem[RECVFRAME_HDR_ALIGN>>2];
315	} u;
316
317	/* uint mem[MAX_RXSZ>>2]; */
318
319};
320
321enum {
322	NORMAL_RX,/* Normal rx packet */
323	TX_REPORT1,/* CCX */
324	TX_REPORT2,/* TX RPT */
325	HIS_REPORT,/*  USB HISR RPT */
326	C2H_PACKET
327};
328
329extern union recv_frame *_rtw_alloc_recvframe(struct __queue *pfree_recv_queue);  /* get a free recv_frame from pfree_recv_queue */
330extern union recv_frame *rtw_alloc_recvframe(struct __queue *pfree_recv_queue);  /* get a free recv_frame from pfree_recv_queue */
331extern int	 rtw_free_recvframe(union recv_frame *precvframe, struct __queue *pfree_recv_queue);
332
333extern int _rtw_enqueue_recvframe(union recv_frame *precvframe, struct __queue *queue);
334extern int rtw_enqueue_recvframe(union recv_frame *precvframe, struct __queue *queue);
335
336extern void rtw_free_recvframe_queue(struct __queue *pframequeue,  struct __queue *pfree_recv_queue);
337u32 rtw_free_uc_swdec_pending_queue(struct adapter *adapter);
338
339signed int rtw_enqueue_recvbuf_to_head(struct recv_buf *precvbuf, struct __queue *queue);
340signed int rtw_enqueue_recvbuf(struct recv_buf *precvbuf, struct __queue *queue);
341struct recv_buf *rtw_dequeue_recvbuf(struct __queue *queue);
342
343void rtw_reordering_ctrl_timeout_handler(struct timer_list *t);
344
345signed int _rtw_init_recv_priv(struct recv_priv *precvpriv, struct adapter *padapter);
346void _rtw_free_recv_priv(struct recv_priv *precvpriv);
347s32  rtw_recv_entry(union recv_frame *precv_frame);
348
349static inline u8 *get_rxmem(union recv_frame *precvframe)
350{
351	/* always return rx_head... */
352	if (precvframe == NULL)
353		return NULL;
354
355	return precvframe->u.hdr.rx_head;
356}
357
358static inline u8 *recvframe_pull(union recv_frame *precvframe, signed int sz)
359{
360	/*  rx_data += sz; move rx_data sz bytes  hereafter */
361
362	/* used for extract sz bytes from rx_data, update rx_data and return the updated rx_data to the caller */
363
364
365	if (precvframe == NULL)
366		return NULL;
367
368
369	precvframe->u.hdr.rx_data += sz;
370
371	if (precvframe->u.hdr.rx_data > precvframe->u.hdr.rx_tail) {
372		precvframe->u.hdr.rx_data -= sz;
373		return NULL;
374	}
375
376	precvframe->u.hdr.len -= sz;
377
378	return precvframe->u.hdr.rx_data;
379
380}
381
382static inline u8 *recvframe_put(union recv_frame *precvframe, signed int sz)
383{
384	/*  rx_tai += sz; move rx_tail sz bytes  hereafter */
385
386	/* used for append sz bytes from ptr to rx_tail, update rx_tail and return the updated rx_tail to the caller */
387	/* after putting, rx_tail must be still larger than rx_end. */
388	unsigned char *prev_rx_tail;
389
390	if (precvframe == NULL)
391		return NULL;
392
393	prev_rx_tail = precvframe->u.hdr.rx_tail;
394
395	precvframe->u.hdr.rx_tail += sz;
396
397	if (precvframe->u.hdr.rx_tail > precvframe->u.hdr.rx_end) {
398		precvframe->u.hdr.rx_tail = prev_rx_tail;
399		return NULL;
400	}
401
402	precvframe->u.hdr.len += sz;
403
404	return precvframe->u.hdr.rx_tail;
405
406}
407
408
409
410static inline u8 *recvframe_pull_tail(union recv_frame *precvframe, signed int sz)
411{
412	/*  rmv data from rx_tail (by yitsen) */
413
414	/* used for extract sz bytes from rx_end, update rx_end and return the updated rx_end to the caller */
415	/* after pulling, rx_end must be still larger than rx_data. */
416
417	if (precvframe == NULL)
418		return NULL;
419
420	precvframe->u.hdr.rx_tail -= sz;
421
422	if (precvframe->u.hdr.rx_tail < precvframe->u.hdr.rx_data) {
423		precvframe->u.hdr.rx_tail += sz;
424		return NULL;
425	}
426
427	precvframe->u.hdr.len -= sz;
428
429	return precvframe->u.hdr.rx_tail;
430
431}
432
433static inline signed int get_recvframe_len(union recv_frame *precvframe)
434{
435	return precvframe->u.hdr.len;
436}
437
438
439static inline s32 translate_percentage_to_dbm(u32 SignalStrengthIndex)
440{
441	s32	SignalPower; /*  in dBm. */
442
443	/*  Translate to dBm (x = 0.5y-95). */
444	SignalPower = (s32)((SignalStrengthIndex + 1) >> 1);
445	SignalPower -= 95;
446
447	return SignalPower;
448}
449
450
451struct sta_info;
452
453extern void _rtw_init_sta_recv_priv(struct sta_recv_priv *psta_recvpriv);
454
455extern void  mgt_dispatcher(struct adapter *padapter, union recv_frame *precv_frame);
456
457#endif