text: /* SPDX-License-Identifier: GPL-2.0 */
  /******************************************************************************
   *
   * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
   *
   ******************************************************************************/
  #ifndef _RTW_RECV_H_
  #define _RTW_RECV_H_
  
  #define NR_RECVBUFF (8)
  
  #define NR_PREALLOC_RECV_SKB (8)
  
  #define NR_RECVFRAME 256
  
  #define RXFRAME_ALIGN	8
  #define RXFRAME_ALIGN_SZ	(1<<RXFRAME_ALIGN)
  
  #define DRVINFO_SZ	4 /*  unit is 8bytes */
  
  #define MAX_RXFRAME_CNT	512
  #define MAX_RX_NUMBLKS		(32)
  #define RECVFRAME_HDR_ALIGN 128
  
  
  #define PHY_RSSI_SLID_WIN_MAX				100
  #define PHY_LINKQUALITY_SLID_WIN_MAX		20
  
  
  #define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
  
  #define RX_MPDU_QUEUE				0
  #define RX_CMD_QUEUE				1
  #define RX_MAX_QUEUE				2
  
  #define MAX_SUBFRAME_COUNT	64
  
  #define LLC_HEADER_LENGTH	6
  
  /* for Rx reordering buffer control */
  struct recv_reorder_ctrl {
  	struct adapter	*padapter;
  	u8 enable;
  	u16 indicate_seq;/* wstart_b, init_value = 0xffff */
  	u16 wend_b;
  	u8 wsize_b;
  	struct __queue pending_recvframe_queue;
  	struct timer_list reordering_ctrl_timer;
  };
  
  struct	stainfo_rxcache	{
  	u16 tid_rxseq[16];
  /*
  	unsigned short	tid0_rxseq;
  	unsigned short	tid1_rxseq;
  	unsigned short	tid2_rxseq;
  	unsigned short	tid3_rxseq;
  	unsigned short	tid4_rxseq;
  	unsigned short	tid5_rxseq;
  	unsigned short	tid6_rxseq;
  	unsigned short	tid7_rxseq;
  	unsigned short	tid8_rxseq;
  	unsigned short	tid9_rxseq;
  	unsigned short	tid10_rxseq;
  	unsigned short	tid11_rxseq;
  	unsigned short	tid12_rxseq;
  	unsigned short	tid13_rxseq;
  	unsigned short	tid14_rxseq;
  	unsigned short	tid15_rxseq;
  */
  };
  
  
  struct signal_stat {
  	u8 update_req;		/* used to indicate */
  	u8 avg_val;		/* avg of valid elements */
  	u32 total_num;		/* num of valid elements */
  	u32 total_val;		/* sum of valid elements */
  };
  
  struct phy_info {
  	u8 rx_pwd_ba11;
  
  	u8 SignalQuality;	 /*  in 0-100 index. */
  	s8		rx_mimo_signal_quality[4];	/* per-path's EVM */
  	u8 RxMIMOEVMdbm[4];		/* per-path's EVM dbm */
  
  	u8 rx_mimo_signal_strength[4];/*  in 0~100 index */
  
  	u16 	Cfo_short[4];			/*  per-path's Cfo_short */
  	u16 	Cfo_tail[4];			/*  per-path's Cfo_tail */
  
  	s8		RxPower; /*  in dBm Translate from PWdB */
  	s8		RecvSignalPower;/*  Real power in dBm for this packet, no beautification and aggregation. Keep this raw info to be used for the other procedures. */
  	u8 bt_rx_rssi_percentage;
  	u8 SignalStrength; /*  in 0-100 index. */
  
  	s8		RxPwr[4];				/* per-path's pwdb */
  	u8 RxSNR[4];				/* per-path's SNR */
  	u8 BandWidth;
  	u8 btCoexPwrAdjust;
  };
  
  #ifdef DBG_RX_SIGNAL_DISPLAY_RAW_DATA
  struct rx_raw_rssi {
  	u8 data_rate;
  	u8 pwdball;
  	s8 pwr_all;
  
  	u8 mimo_signal_strength[4];/*  in 0~100 index */
  	u8 mimo_signal_quality[4];
  
  	s8 ofdm_pwr[4];
  	u8 ofdm_snr[4];
  
  };
  #endif
  
  struct rx_pkt_attrib	{
  	u16 pkt_len;
  	u8 physt;
  	u8 drvinfo_sz;
  	u8 shift_sz;
  	u8 hdrlen; /* the WLAN Header Len */
  	u8 to_fr_ds;
  	u8 amsdu;
  	u8 qos;
  	u8 priority;
  	u8 pw_save;
  	u8 mdata;
  	u16 seq_num;
  	u8 frag_num;
  	u8 mfrag;
  	u8 order;
  	u8 privacy; /* in frame_ctrl field */
  	u8 bdecrypted;
  	u8 encrypt; /* when 0 indicates no encryption; when non-zero, indicates the encryption algorithm */
  	u8 iv_len;
  	u8 icv_len;
  	u8 crc_err;
  	u8 icv_err;
  
  	u16 eth_type;
  
  	u8 dst[ETH_ALEN];
  	u8 src[ETH_ALEN];
  	u8 ta[ETH_ALEN];
  	u8 ra[ETH_ALEN];
  	u8 bssid[ETH_ALEN];
  
  	u8 ack_policy;
  
  	u8 key_index;
  
  	u8 data_rate;
  	u8 sgi;
  	u8 pkt_rpt_type;
  	u32 MacIDValidEntry[2];	/*  64 bits present 64 entry. */
  
  /*
  	u8 signal_qual;
  	s8	rx_mimo_signal_qual[2];
  	u8 signal_strength;
  	u32 rx_pwd_ba11;
  	s32	RecvSignalPower;
  */
  	struct phy_info phy_info;
  };
  
  
  /* These definition is used for Rx packet reordering. */
  #define SN_LESS(a, b)		(((a - b) & 0x800) != 0)
  #define SN_EQUAL(a, b)	(a == b)
  /* define REORDER_WIN_SIZE	128 */
  /* define REORDER_ENTRY_NUM	128 */
  #define REORDER_WAIT_TIME	(50) /*  (ms) */
  
  #define RECVBUFF_ALIGN_SZ 8
  
  #define RXDESC_SIZE	24
  #define RXDESC_OFFSET RXDESC_SIZE
  
  struct recv_stat {
  	__le32 rxdw0;
  	__le32 rxdw1;
  	__le32 rxdw2;
  	__le32 rxdw3;
  #ifndef BUF_DESC_ARCH
  	__le32 rxdw4;
  	__le32 rxdw5;
  #endif /* if BUF_DESC_ARCH is defined, rx_buf_desc occupy 4 double words */
  };
  
  #define EOR BIT(30)
  
  /*
  accesser of recv_priv: rtw_recv_entry(dispatch / passive level); recv_thread(passive) ; returnpkt(dispatch)
  ; halt(passive) ;
  
  using enter_critical section to protect
  */
  struct recv_priv {
  	spinlock_t	lock;
  	struct __queue	free_recv_queue;
  	struct __queue	recv_pending_queue;
  	struct __queue	uc_swdec_pending_queue;
  	u8 *pallocated_frame_buf;
  	u8 *precv_frame_buf;
  	uint free_recvframe_cnt;
  	struct adapter	*adapter;
  	u32 bIsAnyNonBEPkts;
  	u64	rx_bytes;
  	u64	rx_pkts;
  	u64	rx_drop;
  	uint  rx_icv_err;
  	uint  rx_largepacket_crcerr;
  	uint  rx_smallpacket_crcerr;
  	uint  rx_middlepacket_crcerr;
  
  	struct tasklet_struct irq_prepare_beacon_tasklet;
  	struct tasklet_struct recv_tasklet;
  	struct sk_buff_head free_recv_skb_queue;
  	struct sk_buff_head rx_skb_queue;
  
  	u8 *pallocated_recv_buf;
  	u8 *precv_buf;    /*  4 alignment */
  	struct __queue	free_recv_buf_queue;
  	u32 free_recv_buf_queue_cnt;
  
  	struct __queue	recv_buf_pending_queue;
  
  	/* For display the phy information */
  	u8 is_signal_dbg;	/*  for debug */
  	u8 signal_strength_dbg;	/*  for debug */
  
  	u8 signal_strength;
  	u8 signal_qual;
  	s8 rssi;	/* translate_percentage_to_dbm(ptarget_wlan->network.PhyInfo.SignalStrength); */
  	#ifdef DBG_RX_SIGNAL_DISPLAY_RAW_DATA
  	struct rx_raw_rssi raw_rssi_info;
  	#endif
  	/* s8 rxpwdb; */
  	s16 noise;
  	/* int RxSNRdB[2]; */
  	/* s8 RxRssi[2]; */
  	/* int FalseAlmCnt_all; */
  
  
  	struct timer_list signal_stat_timer;
  	u32 signal_stat_sampling_interval;
  	/* u32 signal_stat_converging_constant; */
  	struct signal_stat signal_qual_data;
  	struct signal_stat signal_strength_data;
  };
  
  #define rtw_set_signal_stat_timer(recvpriv) _set_timer(&(recvpriv)->signal_stat_timer, (recvpriv)->signal_stat_sampling_interval)
  
  struct sta_recv_priv {
  
  	spinlock_t	lock;
  	signed int	option;
  
  	/* struct __queue	blk_strms[MAX_RX_NUMBLKS]; */
  	struct __queue defrag_q;	 /* keeping the fragment frame until defrag */
  
  	struct	stainfo_rxcache rxcache;
  
  	/* uint	sta_rx_bytes; */
  	/* uint	sta_rx_pkts; */
  	/* uint	sta_rx_fail; */
  
  };
  
  
  struct recv_buf {
  	struct list_head list;
  
  	spinlock_t recvbuf_lock;
  
  	u32 ref_cnt;
  
  	struct adapter *adapter;
  
  	u8 *pbuf;
  	u8 *pallocated_buf;
  
  	u32 len;
  	u8 *phead;
  	u8 *pdata;
  	u8 *ptail;
  	u8 *pend;
  
  	struct sk_buff	*pskb;
  	u8 reuse;
  };
  
  
  /*
  	head  ----->
  
  		data  ----->
  
  			payload
  
  		tail  ----->
  
  
  	end   ----->
  
  	len = (unsigned int)(tail - data);
  
  */
  struct recv_frame_hdr {
  	struct list_head	list;
  	struct sk_buff	 *pkt;
  	struct sk_buff	 *pkt_newalloc;
  
  	struct adapter  *adapter;
  
  	u8 fragcnt;
  
  	int frame_tag;
  
  	struct rx_pkt_attrib attrib;
  
  	uint  len;
  	u8 *rx_head;
  	u8 *rx_data;
  	u8 *rx_tail;
  	u8 *rx_end;
  
  	void *precvbuf;
  
  
  	/*  */
  	struct sta_info *psta;
  
  	/* for A-MPDU Rx reordering buffer control */
  	struct recv_reorder_ctrl *preorder_ctrl;
  };
  
  
  union recv_frame {
  	union{
  		struct list_head list;
  		struct recv_frame_hdr hdr;
  		uint mem[RECVFRAME_HDR_ALIGN>>2];
  	} u;
  
  	/* uint mem[MAX_RXSZ>>2]; */
  
  };
  
  enum {
  	NORMAL_RX,/* Normal rx packet */
  	TX_REPORT1,/* CCX */
  	TX_REPORT2,/* TX RPT */
  	HIS_REPORT,/*  USB HISR RPT */
  	C2H_PACKET
  };
  
  extern union recv_frame *_rtw_alloc_recvframe(struct __queue *pfree_recv_queue);  /* get a free recv_frame from pfree_recv_queue */
  extern union recv_frame *rtw_alloc_recvframe(struct __queue *pfree_recv_queue);  /* get a free recv_frame from pfree_recv_queue */
  extern int	 rtw_free_recvframe(union recv_frame *precvframe, struct __queue *pfree_recv_queue);
  
  #define rtw_dequeue_recvframe(queue) rtw_alloc_recvframe(queue)
  extern int _rtw_enqueue_recvframe(union recv_frame *precvframe, struct __queue *queue);
  extern int rtw_enqueue_recvframe(union recv_frame *precvframe, struct __queue *queue);
  
  extern void rtw_free_recvframe_queue(struct __queue *pframequeue,  struct __queue *pfree_recv_queue);
  u32 rtw_free_uc_swdec_pending_queue(struct adapter *adapter);
  
  signed int rtw_enqueue_recvbuf_to_head(struct recv_buf *precvbuf, struct __queue *queue);
  signed int rtw_enqueue_recvbuf(struct recv_buf *precvbuf, struct __queue *queue);
  struct recv_buf *rtw_dequeue_recvbuf(struct __queue *queue);
  
  void rtw_reordering_ctrl_timeout_handler(struct timer_list *t);
  
  static inline u8 *get_rxmem(union recv_frame *precvframe)
  {
  	/* always return rx_head... */
  	if (precvframe == NULL)
  		return NULL;
  
  	return precvframe->u.hdr.rx_head;
  }
  
  static inline u8 *recvframe_pull(union recv_frame *precvframe, signed int sz)
  {
  	/*  rx_data += sz; move rx_data sz bytes  hereafter */
  
  	/* used for extract sz bytes from rx_data, update rx_data and return the updated rx_data to the caller */
  
  
  	if (precvframe == NULL)
  		return NULL;
  
  
  	precvframe->u.hdr.rx_data += sz;
  
  	if (precvframe->u.hdr.rx_data > precvframe->u.hdr.rx_tail)
  	{
  		precvframe->u.hdr.rx_data -= sz;
  		return NULL;
  	}
  
  	precvframe->u.hdr.len -= sz;
  
  	return precvframe->u.hdr.rx_data;
  
  }
  
  static inline u8 *recvframe_put(union recv_frame *precvframe, signed int sz)
  {
  	/*  rx_tai += sz; move rx_tail sz bytes  hereafter */
  
  	/* used for append sz bytes from ptr to rx_tail, update rx_tail and return the updated rx_tail to the caller */
  	/* after putting, rx_tail must be still larger than rx_end. */
  	unsigned char *prev_rx_tail;
  
  	if (precvframe == NULL)
  		return NULL;
  
  	prev_rx_tail = precvframe->u.hdr.rx_tail;
  
  	precvframe->u.hdr.rx_tail += sz;
  
  	if (precvframe->u.hdr.rx_tail > precvframe->u.hdr.rx_end)
  	{
  		precvframe->u.hdr.rx_tail = prev_rx_tail;
  		return NULL;
  	}
  
  	precvframe->u.hdr.len += sz;
  
  	return precvframe->u.hdr.rx_tail;
  
  }
  
  
  
  static inline u8 *recvframe_pull_tail(union recv_frame *precvframe, signed int sz)
  {
  	/*  rmv data from rx_tail (by yitsen) */
  
  	/* used for extract sz bytes from rx_end, update rx_end and return the updated rx_end to the caller */
  	/* after pulling, rx_end must be still larger than rx_data. */
  
  	if (precvframe == NULL)
  		return NULL;
  
  	precvframe->u.hdr.rx_tail -= sz;
  
  	if (precvframe->u.hdr.rx_tail < precvframe->u.hdr.rx_data)
  	{
  		precvframe->u.hdr.rx_tail += sz;
  		return NULL;
  	}
  
  	precvframe->u.hdr.len -= sz;
  
  	return precvframe->u.hdr.rx_tail;
  
  }
  
  static inline union recv_frame *rxmem_to_recvframe(u8 *rxmem)
  {
  	/* due to the design of 2048 bytes alignment of recv_frame, we can reference the union recv_frame */
  	/* from any given member of recv_frame. */
  	/*  rxmem indicates the any member/address in recv_frame */
  
  	return (union recv_frame *)(((SIZE_PTR)rxmem >> RXFRAME_ALIGN) << RXFRAME_ALIGN);
  
  }
  
  static inline signed int get_recvframe_len(union recv_frame *precvframe)
  {
  	return precvframe->u.hdr.len;
  }
  
  
  static inline s32 translate_percentage_to_dbm(u32 SignalStrengthIndex)
  {
  	s32	SignalPower; /*  in dBm. */
  
  	/*  Translate to dBm (x = 0.5y-95). */
  	SignalPower = (s32)((SignalStrengthIndex + 1) >> 1);
  	SignalPower -= 95;
  
  	return SignalPower;
  }
  
  
  struct sta_info;
  
  extern void _rtw_init_sta_recv_priv(struct sta_recv_priv *psta_recvpriv);
  
  extern void  mgt_dispatcher(struct adapter *padapter, union recv_frame *precv_frame);
  
  #endif
  