xref: /wlan-driver/qca-wifi-host-cmn/dp/wifi3.0/dp_rx_defrag.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2017-2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name #ifndef _DP_RX_DEFRAG_H
21*5113495bSYour Name #define _DP_RX_DEFRAG_H
22*5113495bSYour Name 
23*5113495bSYour Name #include "hal_rx.h"
24*5113495bSYour Name 
25*5113495bSYour Name #define DEFRAG_IEEE80211_KEY_LEN	8
26*5113495bSYour Name #define DEFRAG_IEEE80211_FCS_LEN	4
27*5113495bSYour Name 
28*5113495bSYour Name #define DP_RX_DEFRAG_IEEE80211_ADDR_COPY(dst, src) \
29*5113495bSYour Name 	qdf_mem_copy(dst, src, QDF_MAC_ADDR_SIZE)
30*5113495bSYour Name 
31*5113495bSYour Name #define DP_RX_DEFRAG_IEEE80211_QOS_HAS_SEQ(wh) \
32*5113495bSYour Name 	(((wh) & \
33*5113495bSYour Name 	(IEEE80211_FC0_TYPE_MASK | QDF_IEEE80211_FC0_SUBTYPE_QOS)) == \
34*5113495bSYour Name 	(IEEE80211_FC0_TYPE_DATA | QDF_IEEE80211_FC0_SUBTYPE_QOS))
35*5113495bSYour Name 
36*5113495bSYour Name #define UNI_DESC_OWNER_SW 0x1
37*5113495bSYour Name #define UNI_DESC_BUF_TYPE_RX_MSDU_LINK 0x6
38*5113495bSYour Name /**
39*5113495bSYour Name  * struct dp_rx_defrag_cipher: structure to indicate cipher header
40*5113495bSYour Name  * @ic_name: Name
41*5113495bSYour Name  * @ic_header: header length
42*5113495bSYour Name  * @ic_trailer: trail length
43*5113495bSYour Name  * @ic_miclen: MIC length
44*5113495bSYour Name  */
45*5113495bSYour Name struct dp_rx_defrag_cipher {
46*5113495bSYour Name 	const char *ic_name;
47*5113495bSYour Name 	uint16_t ic_header;
48*5113495bSYour Name 	uint8_t ic_trailer;
49*5113495bSYour Name 	uint8_t ic_miclen;
50*5113495bSYour Name };
51*5113495bSYour Name 
52*5113495bSYour Name #ifndef WLAN_SOFTUMAC_SUPPORT /* WLAN_SOFTUMAC_SUPPORT */
53*5113495bSYour Name /**
54*5113495bSYour Name  * dp_rx_frag_handle() - Handles fragmented Rx frames
55*5113495bSYour Name  *
56*5113495bSYour Name  * @soc: core txrx main context
57*5113495bSYour Name  * @ring_desc: opaque pointer to the REO error ring descriptor
58*5113495bSYour Name  * @mpdu_desc_info: MPDU descriptor information from ring descriptor
59*5113495bSYour Name  * @rx_desc:
60*5113495bSYour Name  * @mac_id:
61*5113495bSYour Name  * @quota: No. of units (packets) that can be serviced in one shot.
62*5113495bSYour Name  *
63*5113495bSYour Name  * This function implements RX 802.11 fragmentation handling
64*5113495bSYour Name  * The handling is mostly same as legacy fragmentation handling.
65*5113495bSYour Name  * If required, this function can re-inject the frames back to
66*5113495bSYour Name  * REO ring (with proper setting to by-pass fragmentation check
67*5113495bSYour Name  * but use duplicate detection / re-ordering and routing these frames
68*5113495bSYour Name  * to a different core.
69*5113495bSYour Name  *
70*5113495bSYour Name  * Return: uint32_t: No. of elements processed
71*5113495bSYour Name  */
72*5113495bSYour Name uint32_t dp_rx_frag_handle(struct dp_soc *soc, hal_ring_desc_t  ring_desc,
73*5113495bSYour Name 			   struct hal_rx_mpdu_desc_info *mpdu_desc_info,
74*5113495bSYour Name 			   struct dp_rx_desc *rx_desc,
75*5113495bSYour Name 			   uint8_t *mac_id,
76*5113495bSYour Name 			   uint32_t quota);
77*5113495bSYour Name #endif /* WLAN_SOFTUMAC_SUPPORT */
78*5113495bSYour Name 
79*5113495bSYour Name /**
80*5113495bSYour Name  * dp_rx_frag_get_mac_hdr() - Return pointer to the mac hdr
81*5113495bSYour Name  * @soc: DP SOC
82*5113495bSYour Name  * @rx_desc_info: Pointer to the pkt_tlvs in the
83*5113495bSYour Name  * nbuf (pkt_tlvs->mac_hdr->data)
84*5113495bSYour Name  *
85*5113495bSYour Name  * It is inefficient to peek into the packet for received
86*5113495bSYour Name  * frames but these APIs are required to get to some of
87*5113495bSYour Name  * 802.11 fields that hardware does not populate in the
88*5113495bSYour Name  * rx meta data.
89*5113495bSYour Name  *
90*5113495bSYour Name  * Return: pointer to ieee80211_frame
91*5113495bSYour Name  */
92*5113495bSYour Name static inline struct ieee80211_frame *
dp_rx_frag_get_mac_hdr(struct dp_soc * soc,uint8_t * rx_desc_info)93*5113495bSYour Name dp_rx_frag_get_mac_hdr(struct dp_soc *soc, uint8_t *rx_desc_info)
94*5113495bSYour Name {
95*5113495bSYour Name 	int rx_desc_len = soc->rx_pkt_tlv_size;
96*5113495bSYour Name 	return (struct ieee80211_frame *)(rx_desc_info + rx_desc_len);
97*5113495bSYour Name }
98*5113495bSYour Name 
99*5113495bSYour Name /**
100*5113495bSYour Name  * dp_rx_frag_get_mpdu_seq_number() - Get mpdu sequence number
101*5113495bSYour Name  * @soc: DP SOC
102*5113495bSYour Name  * @rx_desc_info: Pointer to the pkt_tlvs in the
103*5113495bSYour Name  * nbuf (pkt_tlvs->mac_hdr->data)
104*5113495bSYour Name  *
105*5113495bSYour Name  * Return: uint16_t, rx sequence number
106*5113495bSYour Name  */
107*5113495bSYour Name static inline uint16_t
dp_rx_frag_get_mpdu_seq_number(struct dp_soc * soc,int8_t * rx_desc_info)108*5113495bSYour Name dp_rx_frag_get_mpdu_seq_number(struct dp_soc *soc, int8_t *rx_desc_info)
109*5113495bSYour Name {
110*5113495bSYour Name 	struct ieee80211_frame *mac_hdr;
111*5113495bSYour Name 	mac_hdr = dp_rx_frag_get_mac_hdr(soc, rx_desc_info);
112*5113495bSYour Name 
113*5113495bSYour Name 	return qdf_le16_to_cpu(*(uint16_t *) mac_hdr->i_seq) >>
114*5113495bSYour Name 		IEEE80211_SEQ_SEQ_SHIFT;
115*5113495bSYour Name }
116*5113495bSYour Name 
117*5113495bSYour Name /**
118*5113495bSYour Name  * dp_rx_frag_get_mpdu_frag_number() - Get mpdu fragment number
119*5113495bSYour Name  * @soc: DP SOC
120*5113495bSYour Name  * @rx_desc_info: Pointer to the pkt_tlvs in the
121*5113495bSYour Name  * nbuf (pkt_tlvs->mac_hdr->data)
122*5113495bSYour Name  *
123*5113495bSYour Name  * Return: uint8_t, receive fragment number
124*5113495bSYour Name  */
125*5113495bSYour Name static inline uint8_t
dp_rx_frag_get_mpdu_frag_number(struct dp_soc * soc,uint8_t * rx_desc_info)126*5113495bSYour Name dp_rx_frag_get_mpdu_frag_number(struct dp_soc *soc, uint8_t *rx_desc_info)
127*5113495bSYour Name {
128*5113495bSYour Name 	struct ieee80211_frame *mac_hdr;
129*5113495bSYour Name 	mac_hdr = dp_rx_frag_get_mac_hdr(soc, rx_desc_info);
130*5113495bSYour Name 
131*5113495bSYour Name 	return qdf_le16_to_cpu(*(uint16_t *) mac_hdr->i_seq) &
132*5113495bSYour Name 		IEEE80211_SEQ_FRAG_MASK;
133*5113495bSYour Name }
134*5113495bSYour Name 
135*5113495bSYour Name /**
136*5113495bSYour Name  * dp_rx_frag_get_more_frag_bit() - Get more fragment bit
137*5113495bSYour Name  * @soc: DP SOC
138*5113495bSYour Name  * @rx_desc_info: Pointer to the pkt_tlvs in the
139*5113495bSYour Name  * nbuf (pkt_tlvs->mac_hdr->data)
140*5113495bSYour Name  *
141*5113495bSYour Name  * Return: uint8_t, get more fragment bit
142*5113495bSYour Name  */
143*5113495bSYour Name static inline
dp_rx_frag_get_more_frag_bit(struct dp_soc * soc,uint8_t * rx_desc_info)144*5113495bSYour Name uint8_t dp_rx_frag_get_more_frag_bit(struct dp_soc *soc, uint8_t *rx_desc_info)
145*5113495bSYour Name {
146*5113495bSYour Name 	struct ieee80211_frame *mac_hdr;
147*5113495bSYour Name 	mac_hdr = dp_rx_frag_get_mac_hdr(soc, rx_desc_info);
148*5113495bSYour Name 
149*5113495bSYour Name 	return (mac_hdr->i_fc[1] & IEEE80211_FC1_MORE_FRAG) >> 2;
150*5113495bSYour Name }
151*5113495bSYour Name 
152*5113495bSYour Name static inline
dp_rx_get_pkt_dir(struct dp_soc * soc,uint8_t * rx_desc_info)153*5113495bSYour Name uint8_t dp_rx_get_pkt_dir(struct dp_soc *soc, uint8_t *rx_desc_info)
154*5113495bSYour Name {
155*5113495bSYour Name 	struct ieee80211_frame *mac_hdr;
156*5113495bSYour Name 	mac_hdr = dp_rx_frag_get_mac_hdr(soc, rx_desc_info);
157*5113495bSYour Name 
158*5113495bSYour Name 	return mac_hdr->i_fc[1] & IEEE80211_FC1_DIR_MASK;
159*5113495bSYour Name }
160*5113495bSYour Name 
161*5113495bSYour Name /**
162*5113495bSYour Name  * dp_rx_defrag_fraglist_insert() - Create a per-sequence fragment list
163*5113495bSYour Name  * @txrx_peer: Pointer to the peer data structure
164*5113495bSYour Name  * @tid: Transmit ID (TID)
165*5113495bSYour Name  * @head_addr: Pointer to head list
166*5113495bSYour Name  * @tail_addr: Pointer to tail list
167*5113495bSYour Name  * @frag: Incoming fragment
168*5113495bSYour Name  * @all_frag_present: Flag to indicate whether all fragments are received
169*5113495bSYour Name  *
170*5113495bSYour Name  * Build a per-tid, per-sequence fragment list.
171*5113495bSYour Name  *
172*5113495bSYour Name  * Return: Success, if inserted
173*5113495bSYour Name  */
174*5113495bSYour Name QDF_STATUS
175*5113495bSYour Name dp_rx_defrag_fraglist_insert(struct dp_txrx_peer *txrx_peer, unsigned int tid,
176*5113495bSYour Name 			     qdf_nbuf_t *head_addr, qdf_nbuf_t *tail_addr,
177*5113495bSYour Name 			     qdf_nbuf_t frag, uint8_t *all_frag_present);
178*5113495bSYour Name 
179*5113495bSYour Name /**
180*5113495bSYour Name  * dp_rx_defrag_waitlist_add() - Update per-PDEV defrag wait list
181*5113495bSYour Name  * @txrx_peer: Pointer to the peer data structure
182*5113495bSYour Name  * @tid: Transmit ID (TID)
183*5113495bSYour Name  *
184*5113495bSYour Name  * Appends per-tid fragments to global fragment wait list
185*5113495bSYour Name  *
186*5113495bSYour Name  * Return: None
187*5113495bSYour Name  */
188*5113495bSYour Name void dp_rx_defrag_waitlist_add(struct dp_txrx_peer *txrx_peer,
189*5113495bSYour Name 			       unsigned int tid);
190*5113495bSYour Name 
191*5113495bSYour Name /**
192*5113495bSYour Name  * dp_rx_defrag() - Defragment the fragment chain
193*5113495bSYour Name  * @txrx_peer: Pointer to the peer
194*5113495bSYour Name  * @tid: Transmit Identifier
195*5113495bSYour Name  * @frag_list_head: Pointer to head list
196*5113495bSYour Name  * @frag_list_tail: Pointer to tail list
197*5113495bSYour Name  *
198*5113495bSYour Name  * Defragment the fragment chain
199*5113495bSYour Name  *
200*5113495bSYour Name  * Return: QDF_STATUS
201*5113495bSYour Name  */
202*5113495bSYour Name QDF_STATUS dp_rx_defrag(struct dp_txrx_peer *txrx_peer, unsigned int tid,
203*5113495bSYour Name 			qdf_nbuf_t frag_list_head,
204*5113495bSYour Name 			qdf_nbuf_t frag_list_tail);
205*5113495bSYour Name 
206*5113495bSYour Name /**
207*5113495bSYour Name  * dp_rx_defrag_waitlist_flush() - Flush SOC defrag wait list
208*5113495bSYour Name  * @soc: DP SOC
209*5113495bSYour Name  *
210*5113495bSYour Name  * Flush fragments of all waitlisted TID's
211*5113495bSYour Name  *
212*5113495bSYour Name  * Return: None
213*5113495bSYour Name  */
214*5113495bSYour Name void dp_rx_defrag_waitlist_flush(struct dp_soc *soc);
215*5113495bSYour Name 
216*5113495bSYour Name /**
217*5113495bSYour Name  * dp_rx_reorder_flush_frag() - Flush the frag list
218*5113495bSYour Name  * @txrx_peer: Pointer to the peer data structure
219*5113495bSYour Name  * @tid: Transmit ID (TID)
220*5113495bSYour Name  *
221*5113495bSYour Name  * Flush the per-TID frag list
222*5113495bSYour Name  *
223*5113495bSYour Name  * Return: None
224*5113495bSYour Name  */
225*5113495bSYour Name void dp_rx_reorder_flush_frag(struct dp_txrx_peer *txrx_peer,
226*5113495bSYour Name 			      unsigned int tid);
227*5113495bSYour Name 
228*5113495bSYour Name /**
229*5113495bSYour Name  * dp_rx_defrag_waitlist_remove() - Remove fragments from waitlist
230*5113495bSYour Name  * @txrx_peer: Pointer to the peer data structure
231*5113495bSYour Name  * @tid: Transmit ID (TID)
232*5113495bSYour Name  *
233*5113495bSYour Name  * Remove fragments from waitlist
234*5113495bSYour Name  *
235*5113495bSYour Name  * Return: None
236*5113495bSYour Name  */
237*5113495bSYour Name void dp_rx_defrag_waitlist_remove(struct dp_txrx_peer *txrx_peer,
238*5113495bSYour Name 				  unsigned int tid);
239*5113495bSYour Name 
240*5113495bSYour Name /**
241*5113495bSYour Name  * dp_rx_defrag_cleanup() - Clean up activities
242*5113495bSYour Name  * @txrx_peer: Pointer to the peer
243*5113495bSYour Name  * @tid: Transmit Identifier
244*5113495bSYour Name  *
245*5113495bSYour Name  * Return: None
246*5113495bSYour Name  */
247*5113495bSYour Name void dp_rx_defrag_cleanup(struct dp_txrx_peer *txrx_peer, unsigned int tid);
248*5113495bSYour Name 
249*5113495bSYour Name QDF_STATUS dp_rx_defrag_add_last_frag(struct dp_soc *soc,
250*5113495bSYour Name 				      struct dp_txrx_peer *peer, uint16_t tid,
251*5113495bSYour Name 				      uint16_t rxseq, qdf_nbuf_t nbuf);
252*5113495bSYour Name #endif /* _DP_RX_DEFRAG_H */
253