xref: /wlan-driver/qca-wifi-host-cmn/qdf/linux/src/i_qdf_nbuf_frag.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020 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 /**
21*5113495bSYour Name  * DOC: i_qdf_nbuf_frag.h
22*5113495bSYour Name  * This file provides OS dependent nbuf frag API's.
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef _I_QDF_NBUF_FRAG_H
26*5113495bSYour Name #define _I_QDF_NBUF_FRAG_H
27*5113495bSYour Name 
28*5113495bSYour Name #include <qdf_net_types.h>
29*5113495bSYour Name #include <qdf_mem.h>
30*5113495bSYour Name 
31*5113495bSYour Name #define QDF_NBUF_FRAG_DEBUG_COUNT_ZERO    0
32*5113495bSYour Name #define QDF_NBUF_FRAG_DEBUG_COUNT_ONE     1
33*5113495bSYour Name 
34*5113495bSYour Name /**
35*5113495bSYour Name  * typedef __qdf_frag_cache_t - Abstraction for void * for frag address
36*5113495bSYour Name  */
37*5113495bSYour Name typedef struct page_frag_cache __qdf_frag_cache_t;
38*5113495bSYour Name 
39*5113495bSYour Name /*
40*5113495bSYour Name  * typedef __qdf_frag_t - Abstraction for void * for frag address
41*5113495bSYour Name  */
42*5113495bSYour Name typedef void *__qdf_frag_t;
43*5113495bSYour Name 
44*5113495bSYour Name #ifdef QDF_NBUF_FRAG_GLOBAL_COUNT
45*5113495bSYour Name 
46*5113495bSYour Name /**
47*5113495bSYour Name  * __qdf_frag_count_get() - Get global frag count
48*5113495bSYour Name  *
49*5113495bSYour Name  * Return: Global frag gauge
50*5113495bSYour Name  */
51*5113495bSYour Name uint32_t __qdf_frag_count_get(void);
52*5113495bSYour Name 
53*5113495bSYour Name /**
54*5113495bSYour Name  * __qdf_frag_count_inc() - Increment frag global count
55*5113495bSYour Name  * @value: Increment value
56*5113495bSYour Name  *
57*5113495bSYour Name  * Return: none
58*5113495bSYour Name  */
59*5113495bSYour Name void __qdf_frag_count_inc(uint32_t value);
60*5113495bSYour Name 
61*5113495bSYour Name /**
62*5113495bSYour Name  * __qdf_frag_count_dec() - Decrement frag global count
63*5113495bSYour Name  * @value: Decrement value
64*5113495bSYour Name  *
65*5113495bSYour Name  * Return: none
66*5113495bSYour Name  */
67*5113495bSYour Name void __qdf_frag_count_dec(uint32_t value);
68*5113495bSYour Name 
69*5113495bSYour Name /*
70*5113495bSYour Name  * __qdf_frag_mod_init() - Initialization routine for qdf_frag
71*5113495bSYour Name  *
72*5113495bSYour Name  * Return: none
73*5113495bSYour Name  */
74*5113495bSYour Name void __qdf_frag_mod_init(void);
75*5113495bSYour Name 
76*5113495bSYour Name /**
77*5113495bSYour Name  * __qdf_frag_mod_exit() - Uninitialization routine for qdf_frag
78*5113495bSYour Name  *
79*5113495bSYour Name  * Return: none
80*5113495bSYour Name  */
81*5113495bSYour Name void __qdf_frag_mod_exit(void);
82*5113495bSYour Name 
83*5113495bSYour Name #else
__qdf_frag_count_get(void)84*5113495bSYour Name static inline uint32_t __qdf_frag_count_get(void)
85*5113495bSYour Name {
86*5113495bSYour Name 	return 0;
87*5113495bSYour Name }
88*5113495bSYour Name 
__qdf_frag_count_inc(uint32_t value)89*5113495bSYour Name static inline void __qdf_frag_count_inc(uint32_t value)
90*5113495bSYour Name {
91*5113495bSYour Name }
92*5113495bSYour Name 
__qdf_frag_count_dec(uint32_t value)93*5113495bSYour Name static inline void __qdf_frag_count_dec(uint32_t value)
94*5113495bSYour Name {
95*5113495bSYour Name }
96*5113495bSYour Name 
__qdf_frag_mod_init(void)97*5113495bSYour Name static inline void __qdf_frag_mod_init(void)
98*5113495bSYour Name {
99*5113495bSYour Name }
100*5113495bSYour Name 
__qdf_frag_mod_exit(void)101*5113495bSYour Name static inline void __qdf_frag_mod_exit(void)
102*5113495bSYour Name {
103*5113495bSYour Name }
104*5113495bSYour Name #endif /* QDF_NBUF_FRAG_GLOBAL_COUNT */
105*5113495bSYour Name 
106*5113495bSYour Name /*
107*5113495bSYour Name  * Maximum number of frags an SKB can hold
108*5113495bSYour Name  */
109*5113495bSYour Name #define __QDF_NBUF_MAX_FRAGS MAX_SKB_FRAGS
110*5113495bSYour Name 
111*5113495bSYour Name /**
112*5113495bSYour Name  * __qdf_mem_unmap_page() - Unmap frag memory
113*5113495bSYour Name  * @osdev: qdf_device_t
114*5113495bSYour Name  * @paddr: Address to be unmapped
115*5113495bSYour Name  * @nbytes: Number of bytes to be unmapped
116*5113495bSYour Name  * @dir: qdf_dma_dir_t
117*5113495bSYour Name  */
118*5113495bSYour Name void __qdf_mem_unmap_page(qdf_device_t osdev, qdf_dma_addr_t paddr,
119*5113495bSYour Name 			  size_t nbytes, qdf_dma_dir_t dir);
120*5113495bSYour Name 
121*5113495bSYour Name /**
122*5113495bSYour Name  * __qdf_mem_map_page() - Map frag memory
123*5113495bSYour Name  * @osdev: qdf_device_t
124*5113495bSYour Name  * @buf: Vaddr to be mapped
125*5113495bSYour Name  * @dir: qdf_dma_dir_t
126*5113495bSYour Name  * @nbytes: Number of bytes to be mapped
127*5113495bSYour Name  * @phy_addr: Mapped physical address
128*5113495bSYour Name  *
129*5113495bSYour Name  * Return: QDF_STATUS
130*5113495bSYour Name  */
131*5113495bSYour Name QDF_STATUS __qdf_mem_map_page(qdf_device_t osdev, __qdf_frag_t buf,
132*5113495bSYour Name 			      qdf_dma_dir_t dir, size_t nbytes,
133*5113495bSYour Name 			      qdf_dma_addr_t *phy_addr);
134*5113495bSYour Name 
135*5113495bSYour Name /**
136*5113495bSYour Name  * __qdf_frag_cache_drain() - Drain page frag cache
137*5113495bSYour Name  * @pf_cache: page frag cache
138*5113495bSYour Name  *
139*5113495bSYour Name  * Return: void
140*5113495bSYour Name  */
141*5113495bSYour Name void __qdf_frag_cache_drain(__qdf_frag_cache_t *pf_cache);
142*5113495bSYour Name 
143*5113495bSYour Name /**
144*5113495bSYour Name  * __qdf_frag_free() - Free allocated frag memory
145*5113495bSYour Name  * @vaddr: Frag address to be freed
146*5113495bSYour Name  *
147*5113495bSYour Name  * Return: none
148*5113495bSYour Name  */
__qdf_frag_free(__qdf_frag_t vaddr)149*5113495bSYour Name static inline void __qdf_frag_free(__qdf_frag_t vaddr)
150*5113495bSYour Name {
151*5113495bSYour Name 	if (qdf_likely(vaddr)) {
152*5113495bSYour Name 		skb_free_frag(vaddr);
153*5113495bSYour Name 		__qdf_frag_count_dec(QDF_NBUF_FRAG_DEBUG_COUNT_ONE);
154*5113495bSYour Name 	}
155*5113495bSYour Name }
156*5113495bSYour Name 
157*5113495bSYour Name /**
158*5113495bSYour Name  * __qdf_frag_alloc() - Allocate frag Memory
159*5113495bSYour Name  * @pf_cache: page frag cache
160*5113495bSYour Name  * @fragsz: Size of frag memory to be allocated
161*5113495bSYour Name  *
162*5113495bSYour Name  * Return: Allocated frag addr.
163*5113495bSYour Name  */
164*5113495bSYour Name #if defined(QDF_FRAG_CACHE_SUPPORT)
__qdf_frag_alloc(__qdf_frag_cache_t * pf_cache,unsigned int fragsz)165*5113495bSYour Name static inline __qdf_frag_t __qdf_frag_alloc(__qdf_frag_cache_t *pf_cache,
166*5113495bSYour Name 					    unsigned int fragsz)
167*5113495bSYour Name {
168*5113495bSYour Name 	__qdf_frag_t p_frag;
169*5113495bSYour Name 
170*5113495bSYour Name 	if (pf_cache) {
171*5113495bSYour Name 		unsigned int sz = SKB_DATA_ALIGN(fragsz);
172*5113495bSYour Name 
173*5113495bSYour Name 		p_frag =  page_frag_alloc(pf_cache, sz, GFP_ATOMIC);
174*5113495bSYour Name 	} else {
175*5113495bSYour Name 		p_frag = netdev_alloc_frag(fragsz);
176*5113495bSYour Name 	}
177*5113495bSYour Name 	if (p_frag)
178*5113495bSYour Name 		__qdf_frag_count_inc(QDF_NBUF_FRAG_DEBUG_COUNT_ONE);
179*5113495bSYour Name 	return p_frag;
180*5113495bSYour Name }
181*5113495bSYour Name #else
__qdf_frag_alloc(__qdf_frag_cache_t * pf_cache,unsigned int fragsz)182*5113495bSYour Name static inline __qdf_frag_t __qdf_frag_alloc(__qdf_frag_cache_t *pf_cache,
183*5113495bSYour Name 					    unsigned int fragsz)
184*5113495bSYour Name {
185*5113495bSYour Name 	__qdf_frag_t p_frag = netdev_alloc_frag(fragsz);
186*5113495bSYour Name 
187*5113495bSYour Name 	if (p_frag)
188*5113495bSYour Name 		__qdf_frag_count_inc(QDF_NBUF_FRAG_DEBUG_COUNT_ONE);
189*5113495bSYour Name 
190*5113495bSYour Name 	return p_frag;
191*5113495bSYour Name }
192*5113495bSYour Name #endif
193*5113495bSYour Name 
194*5113495bSYour Name #endif /* _I_QDF_NBUF_FRAG_H */
195