xref: /wlan-driver/qca-wifi-host-cmn/qdf/inc/qdf_dev.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 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: qdf_dev
22*5113495bSYour Name  * QCA driver framework (QDF) device management APIs
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #if !defined(__QDF_DEV_H)
26*5113495bSYour Name #define __QDF_DEV_H
27*5113495bSYour Name 
28*5113495bSYour Name /* Include Files */
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include "i_qdf_dev.h"
31*5113495bSYour Name 
32*5113495bSYour Name #define qdf_cpumask_pr_args(maskp) __qdf_cpumask_pr_args(maskp)
33*5113495bSYour Name #define qdf_for_each_possible_cpu(cpu) __qdf_for_each_possible_cpu(cpu)
34*5113495bSYour Name #define qdf_for_each_online_cpu(cpu) __qdf_for_each_online_cpu(cpu)
35*5113495bSYour Name #define qdf_for_each_cpu(cpu, maskp) __qdf_for_each_cpu(cpu, maskp)
36*5113495bSYour Name #define qdf_for_each_cpu_not(cpu, maskp) \
37*5113495bSYour Name __qdf_for_each_cpu_not(cpu, maskp)
38*5113495bSYour Name 
39*5113495bSYour Name #ifdef ENHANCED_OS_ABSTRACTION
40*5113495bSYour Name /**
41*5113495bSYour Name  * qdf_dev_alloc_mem() - allocate memory
42*5113495bSYour Name  * @qdfdev: Device handle
43*5113495bSYour Name  * @mrptr: Pointer to the allocated memory
44*5113495bSYour Name  * @reqsize: Allocation request in bytes
45*5113495bSYour Name  * @mask: Property mask to be associated to the allocated memory
46*5113495bSYour Name  *
47*5113495bSYour Name  * This function will acquire memory to be associated with a device
48*5113495bSYour Name  *
49*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
50*5113495bSYour Name  */
51*5113495bSYour Name QDF_STATUS
52*5113495bSYour Name qdf_dev_alloc_mem(struct qdf_dev *qdfdev, struct qdf_devm **mrptr,
53*5113495bSYour Name 		  uint32_t reqsize, uint32_t mask);
54*5113495bSYour Name 
55*5113495bSYour Name /**
56*5113495bSYour Name  * qdf_dev_release_mem() - release memory
57*5113495bSYour Name  * @qdfdev: Device handle
58*5113495bSYour Name  * @mrptr: Pointer to the allocated memory
59*5113495bSYour Name  *
60*5113495bSYour Name  * This function will acquire memory to be associated with a device
61*5113495bSYour Name  *
62*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
63*5113495bSYour Name  */
64*5113495bSYour Name QDF_STATUS
65*5113495bSYour Name qdf_dev_release_mem(struct qdf_dev *qdfdev, struct qdf_devm *mrptr);
66*5113495bSYour Name 
67*5113495bSYour Name /**
68*5113495bSYour Name  * qdf_dev_modify_irq_status() - modify irq
69*5113495bSYour Name  * @irnum: irq number
70*5113495bSYour Name  * @cmask: Bitmap to be cleared for the property mask
71*5113495bSYour Name  * @smask: Bitmap to be set for the property mask
72*5113495bSYour Name  *
73*5113495bSYour Name  * This function will acquire memory to be associated with a device
74*5113495bSYour Name  *
75*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
76*5113495bSYour Name  */
77*5113495bSYour Name QDF_STATUS
78*5113495bSYour Name qdf_dev_modify_irq_status(uint32_t irnum, unsigned long cmask,
79*5113495bSYour Name 			  unsigned long smask);
80*5113495bSYour Name 
81*5113495bSYour Name /**
82*5113495bSYour Name  * qdf_dev_set_irq_affinity() - set irq affinity
83*5113495bSYour Name  * @irnum: irq number
84*5113495bSYour Name  * @cpmask: cpu affinity bitmap
85*5113495bSYour Name  *
86*5113495bSYour Name  * This function will set the affinity level for an irq
87*5113495bSYour Name  *
88*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
89*5113495bSYour Name  */
90*5113495bSYour Name QDF_STATUS
91*5113495bSYour Name qdf_dev_set_irq_affinity(uint32_t irnum, struct qdf_cpu_mask *cpmask);
92*5113495bSYour Name 
93*5113495bSYour Name /**
94*5113495bSYour Name  * qdf_dev_set_irq_status_flags() - set irq status flags
95*5113495bSYour Name  * @irnum: irq number
96*5113495bSYour Name  * @set: status flag to set
97*5113495bSYour Name  *
98*5113495bSYour Name  * This function will set the status for an irq
99*5113495bSYour Name  *
100*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
101*5113495bSYour Name  */
102*5113495bSYour Name QDF_STATUS
103*5113495bSYour Name qdf_dev_set_irq_status_flags(unsigned int irnum, unsigned long set);
104*5113495bSYour Name 
105*5113495bSYour Name /**
106*5113495bSYour Name  * qdf_dev_clear_irq_status_flags() - clear irq status flags
107*5113495bSYour Name  * @irnum: irq number
108*5113495bSYour Name  * @clr: status flag to clear
109*5113495bSYour Name  *
110*5113495bSYour Name  * This function will clear the status for an irq
111*5113495bSYour Name  *
112*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
113*5113495bSYour Name  */
114*5113495bSYour Name QDF_STATUS
115*5113495bSYour Name qdf_dev_clear_irq_status_flags(unsigned int irnum, unsigned long clr);
116*5113495bSYour Name #else
117*5113495bSYour Name static inline QDF_STATUS
qdf_dev_alloc_mem(struct qdf_dev * qdfdev,struct qdf_devm ** mrptr,uint32_t reqsize,uint32_t mask)118*5113495bSYour Name qdf_dev_alloc_mem(struct qdf_dev *qdfdev, struct qdf_devm **mrptr,
119*5113495bSYour Name 		  uint32_t reqsize, uint32_t mask)
120*5113495bSYour Name {
121*5113495bSYour Name 	return __qdf_dev_alloc_mem(qdfdev, mrptr, reqsize, mask);
122*5113495bSYour Name }
123*5113495bSYour Name 
124*5113495bSYour Name static inline QDF_STATUS
qdf_dev_release_mem(struct qdf_dev * qdfdev,struct qdf_devm * mrptr)125*5113495bSYour Name qdf_dev_release_mem(struct qdf_dev *qdfdev, struct qdf_devm *mrptr)
126*5113495bSYour Name {
127*5113495bSYour Name 	return __qdf_dev_release_mem(qdfdev, mrptr);
128*5113495bSYour Name }
129*5113495bSYour Name 
130*5113495bSYour Name static inline QDF_STATUS
qdf_dev_modify_irq_status(uint32_t irnum,unsigned long cmask,unsigned long smask)131*5113495bSYour Name qdf_dev_modify_irq_status(uint32_t irnum, unsigned long cmask,
132*5113495bSYour Name 			  unsigned long smask)
133*5113495bSYour Name {
134*5113495bSYour Name 	return __qdf_dev_modify_irq_status(irnum, cmask, smask);
135*5113495bSYour Name }
136*5113495bSYour Name 
137*5113495bSYour Name static inline QDF_STATUS
qdf_dev_set_irq_affinity(uint32_t irnum,struct qdf_cpu_mask * cpmask)138*5113495bSYour Name qdf_dev_set_irq_affinity(uint32_t irnum, struct qdf_cpu_mask *cpmask)
139*5113495bSYour Name {
140*5113495bSYour Name 	return __qdf_dev_set_irq_affinity(irnum, cpmask);
141*5113495bSYour Name }
142*5113495bSYour Name 
143*5113495bSYour Name static inline QDF_STATUS
qdf_dev_set_irq_status_flags(unsigned int irnum,unsigned long set)144*5113495bSYour Name qdf_dev_set_irq_status_flags(unsigned int irnum, unsigned long set)
145*5113495bSYour Name {
146*5113495bSYour Name 	return __qdf_dev_set_irq_status_flags(irnum, set);
147*5113495bSYour Name }
148*5113495bSYour Name 
149*5113495bSYour Name static inline QDF_STATUS
qdf_dev_clear_irq_status_flags(unsigned int irnum,unsigned long clr)150*5113495bSYour Name qdf_dev_clear_irq_status_flags(unsigned int irnum, unsigned long clr)
151*5113495bSYour Name {
152*5113495bSYour Name 	return __qdf_dev_clear_irq_status_flags(irnum, clr);
153*5113495bSYour Name }
154*5113495bSYour Name #endif
155*5113495bSYour Name 
qdf_topology_physical_package_id(unsigned int cpu)156*5113495bSYour Name static inline int qdf_topology_physical_package_id(unsigned int cpu)
157*5113495bSYour Name {
158*5113495bSYour Name 	return __qdf_topology_physical_package_id(cpu);
159*5113495bSYour Name }
160*5113495bSYour Name 
qdf_cpumask_subset(qdf_cpu_mask * srcp1,const qdf_cpu_mask * srcp2)161*5113495bSYour Name static inline int qdf_cpumask_subset(qdf_cpu_mask *srcp1,
162*5113495bSYour Name 				     const qdf_cpu_mask *srcp2)
163*5113495bSYour Name {
164*5113495bSYour Name 	return __qdf_cpumask_subset(srcp1, srcp2);
165*5113495bSYour Name }
166*5113495bSYour Name 
qdf_cpumask_intersects(qdf_cpu_mask * srcp1,const qdf_cpu_mask * srcp2)167*5113495bSYour Name static inline int qdf_cpumask_intersects(qdf_cpu_mask *srcp1,
168*5113495bSYour Name 					 const qdf_cpu_mask *srcp2)
169*5113495bSYour Name {
170*5113495bSYour Name 	return __qdf_cpumask_intersects(srcp1, srcp2);
171*5113495bSYour Name }
172*5113495bSYour Name 
qdf_core_ctl_set_boost(bool boost)173*5113495bSYour Name static inline int qdf_core_ctl_set_boost(bool boost)
174*5113495bSYour Name {
175*5113495bSYour Name 	return __qdf_core_ctl_set_boost(boost);
176*5113495bSYour Name }
177*5113495bSYour Name #endif /* __QDF_DEV_H */
178