1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2014-2020 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: i_qdf_atomic.h
22*5113495bSYour Name * This file provides OS dependent atomic APIs.
23*5113495bSYour Name */
24*5113495bSYour Name
25*5113495bSYour Name #ifndef I_QDF_ATOMIC_H
26*5113495bSYour Name #define I_QDF_ATOMIC_H
27*5113495bSYour Name
28*5113495bSYour Name #include <qdf_status.h> /* QDF_STATUS */
29*5113495bSYour Name #include <linux/atomic.h>
30*5113495bSYour Name #include <linux/bitops.h>
31*5113495bSYour Name
32*5113495bSYour Name typedef atomic_t __qdf_atomic_t;
33*5113495bSYour Name
34*5113495bSYour Name /**
35*5113495bSYour Name * __qdf_atomic_init() - initialize an atomic type variable
36*5113495bSYour Name * @v: A pointer to an opaque atomic variable
37*5113495bSYour Name *
38*5113495bSYour Name * Return: QDF_STATUS
39*5113495bSYour Name */
__qdf_atomic_init(__qdf_atomic_t * v)40*5113495bSYour Name static inline QDF_STATUS __qdf_atomic_init(__qdf_atomic_t *v)
41*5113495bSYour Name {
42*5113495bSYour Name atomic_set(v, 0);
43*5113495bSYour Name return QDF_STATUS_SUCCESS;
44*5113495bSYour Name }
45*5113495bSYour Name
46*5113495bSYour Name /**
47*5113495bSYour Name * __qdf_atomic_read() - read the value of an atomic variable
48*5113495bSYour Name * @v: A pointer to an opaque atomic variable
49*5113495bSYour Name *
50*5113495bSYour Name * Return: The current value of the variable
51*5113495bSYour Name */
__qdf_atomic_read(__qdf_atomic_t * v)52*5113495bSYour Name static inline int32_t __qdf_atomic_read(__qdf_atomic_t *v)
53*5113495bSYour Name {
54*5113495bSYour Name return atomic_read(v);
55*5113495bSYour Name }
56*5113495bSYour Name
57*5113495bSYour Name /**
58*5113495bSYour Name * __qdf_atomic_inc() - increment the value of an atomic variable
59*5113495bSYour Name * @v: A pointer to an opaque atomic variable
60*5113495bSYour Name *
61*5113495bSYour Name * Return: None
62*5113495bSYour Name */
__qdf_atomic_inc(__qdf_atomic_t * v)63*5113495bSYour Name static inline void __qdf_atomic_inc(__qdf_atomic_t *v)
64*5113495bSYour Name {
65*5113495bSYour Name atomic_inc(v);
66*5113495bSYour Name }
67*5113495bSYour Name
68*5113495bSYour Name /**
69*5113495bSYour Name * __qdf_atomic_dec() - decrement the value of an atomic variable
70*5113495bSYour Name * @v: A pointer to an opaque atomic variable
71*5113495bSYour Name *
72*5113495bSYour Name * Return: None
73*5113495bSYour Name */
__qdf_atomic_dec(__qdf_atomic_t * v)74*5113495bSYour Name static inline void __qdf_atomic_dec(__qdf_atomic_t *v)
75*5113495bSYour Name {
76*5113495bSYour Name atomic_dec(v);
77*5113495bSYour Name }
78*5113495bSYour Name
79*5113495bSYour Name /**
80*5113495bSYour Name * __qdf_atomic_add() - add a value to the value of an atomic variable
81*5113495bSYour Name * @i: The amount by which to increase the atomic counter
82*5113495bSYour Name * @v: A pointer to an opaque atomic variable
83*5113495bSYour Name *
84*5113495bSYour Name * Return: None
85*5113495bSYour Name */
__qdf_atomic_add(int i,__qdf_atomic_t * v)86*5113495bSYour Name static inline void __qdf_atomic_add(int i, __qdf_atomic_t *v)
87*5113495bSYour Name {
88*5113495bSYour Name atomic_add(i, v);
89*5113495bSYour Name }
90*5113495bSYour Name
91*5113495bSYour Name /**
92*5113495bSYour Name * __qdf_atomic_sub() - Subtract a value from an atomic variable
93*5113495bSYour Name * @i: the amount by which to decrease the atomic counter
94*5113495bSYour Name * @v: a pointer to an opaque atomic variable
95*5113495bSYour Name *
96*5113495bSYour Name * Return: none
97*5113495bSYour Name */
__qdf_atomic_sub(int i,__qdf_atomic_t * v)98*5113495bSYour Name static inline void __qdf_atomic_sub(int i, __qdf_atomic_t *v)
99*5113495bSYour Name {
100*5113495bSYour Name atomic_sub(i, v);
101*5113495bSYour Name }
102*5113495bSYour Name
103*5113495bSYour Name /**
104*5113495bSYour Name * __qdf_atomic_dec_and_test() - decrement an atomic variable and check if the
105*5113495bSYour Name * new value is zero
106*5113495bSYour Name * @v: A pointer to an opaque atomic variable
107*5113495bSYour Name *
108*5113495bSYour Name * Return:
109*5113495bSYour Name * true (non-zero) if the new value is zero,
110*5113495bSYour Name * false (0) if the new value is non-zero
111*5113495bSYour Name */
__qdf_atomic_dec_and_test(__qdf_atomic_t * v)112*5113495bSYour Name static inline int32_t __qdf_atomic_dec_and_test(__qdf_atomic_t *v)
113*5113495bSYour Name {
114*5113495bSYour Name return atomic_dec_and_test(v);
115*5113495bSYour Name }
116*5113495bSYour Name
117*5113495bSYour Name /**
118*5113495bSYour Name * __qdf_atomic_set() - set a value to the value of an atomic variable
119*5113495bSYour Name * @v: A pointer to an opaque atomic variable
120*5113495bSYour Name * @i: value to assign
121*5113495bSYour Name *
122*5113495bSYour Name * Return: None
123*5113495bSYour Name */
__qdf_atomic_set(__qdf_atomic_t * v,int i)124*5113495bSYour Name static inline void __qdf_atomic_set(__qdf_atomic_t *v, int i)
125*5113495bSYour Name {
126*5113495bSYour Name atomic_set(v, i);
127*5113495bSYour Name }
128*5113495bSYour Name
129*5113495bSYour Name /**
130*5113495bSYour Name * __qdf_atomic_inc_return() - return the incremented value of an atomic variable
131*5113495bSYour Name * @v: A pointer to an opaque atomic variable
132*5113495bSYour Name *
133*5113495bSYour Name * Return: The current value of the variable
134*5113495bSYour Name */
__qdf_atomic_inc_return(__qdf_atomic_t * v)135*5113495bSYour Name static inline int32_t __qdf_atomic_inc_return(__qdf_atomic_t *v)
136*5113495bSYour Name {
137*5113495bSYour Name return atomic_inc_return(v);
138*5113495bSYour Name }
139*5113495bSYour Name
140*5113495bSYour Name /**
141*5113495bSYour Name * __qdf_atomic_dec_return() - return the decremented value of an atomic
142*5113495bSYour Name * variable
143*5113495bSYour Name * @v: A pointer to an opaque atomic variable
144*5113495bSYour Name *
145*5113495bSYour Name * Return: The current value of the variable
146*5113495bSYour Name */
__qdf_atomic_dec_return(__qdf_atomic_t * v)147*5113495bSYour Name static inline int32_t __qdf_atomic_dec_return(__qdf_atomic_t *v)
148*5113495bSYour Name {
149*5113495bSYour Name return atomic_dec_return(v);
150*5113495bSYour Name }
151*5113495bSYour Name
152*5113495bSYour Name /**
153*5113495bSYour Name * __qdf_atomic_dec_if_positive() - Decrement an atomic variable if its
154*5113495bSYour Name * value is positive
155*5113495bSYour Name * @v: A pointer to an opaque atomic variable
156*5113495bSYour Name *
157*5113495bSYour Name * Return: The old value of the variable minus 1
158*5113495bSYour Name */
__qdf_atomic_dec_if_positive(__qdf_atomic_t * v)159*5113495bSYour Name static inline int32_t __qdf_atomic_dec_if_positive(__qdf_atomic_t *v)
160*5113495bSYour Name {
161*5113495bSYour Name return atomic_dec_if_positive(v);
162*5113495bSYour Name }
163*5113495bSYour Name
164*5113495bSYour Name /**
165*5113495bSYour Name * __qdf_atomic_inc_not_zero() - increment if not zero
166*5113495bSYour Name * @v: A pointer to an opaque atomic variable
167*5113495bSYour Name *
168*5113495bSYour Name * Return: Returns non-zero on successful increment and zero otherwise
169*5113495bSYour Name */
__qdf_atomic_inc_not_zero(__qdf_atomic_t * v)170*5113495bSYour Name static inline int32_t __qdf_atomic_inc_not_zero(__qdf_atomic_t *v)
171*5113495bSYour Name {
172*5113495bSYour Name return atomic_inc_not_zero(v);
173*5113495bSYour Name }
174*5113495bSYour Name
175*5113495bSYour Name /**
176*5113495bSYour Name * __qdf_atomic_set_bit - Atomically set a bit in memory
177*5113495bSYour Name * @nr: bit to set
178*5113495bSYour Name * @addr: the address to start counting from
179*5113495bSYour Name *
180*5113495bSYour Name * Return: none
181*5113495bSYour Name */
__qdf_atomic_set_bit(int nr,volatile unsigned long * addr)182*5113495bSYour Name static inline void __qdf_atomic_set_bit(int nr, volatile unsigned long *addr)
183*5113495bSYour Name {
184*5113495bSYour Name set_bit(nr, addr);
185*5113495bSYour Name }
186*5113495bSYour Name
187*5113495bSYour Name /**
188*5113495bSYour Name * __qdf_atomic_clear_bit - Atomically clear a bit in memory
189*5113495bSYour Name * @nr: bit to clear
190*5113495bSYour Name * @addr: the address to start counting from
191*5113495bSYour Name *
192*5113495bSYour Name * Return: none
193*5113495bSYour Name */
__qdf_atomic_clear_bit(int nr,volatile unsigned long * addr)194*5113495bSYour Name static inline void __qdf_atomic_clear_bit(int nr, volatile unsigned long *addr)
195*5113495bSYour Name {
196*5113495bSYour Name clear_bit(nr, addr);
197*5113495bSYour Name }
198*5113495bSYour Name
199*5113495bSYour Name /**
200*5113495bSYour Name * __qdf_atomic_change_bit - Atomically toggle a bit in memory
201*5113495bSYour Name * from addr
202*5113495bSYour Name * @nr: bit to change
203*5113495bSYour Name * @addr: the address to start counting from
204*5113495bSYour Name *
205*5113495bSYour Name * Return: none
206*5113495bSYour Name */
__qdf_atomic_change_bit(int nr,volatile unsigned long * addr)207*5113495bSYour Name static inline void __qdf_atomic_change_bit(int nr, volatile unsigned long *addr)
208*5113495bSYour Name {
209*5113495bSYour Name change_bit(nr, addr);
210*5113495bSYour Name }
211*5113495bSYour Name
212*5113495bSYour Name /**
213*5113495bSYour Name * __qdf_atomic_test_and_set_bit - Atomically set a bit and return its old value
214*5113495bSYour Name * @nr: Bit to set
215*5113495bSYour Name * @addr: the address to start counting from
216*5113495bSYour Name *
217*5113495bSYour Name * Return: return nr bit old value
218*5113495bSYour Name */
__qdf_atomic_test_and_set_bit(int nr,volatile unsigned long * addr)219*5113495bSYour Name static inline int __qdf_atomic_test_and_set_bit(int nr,
220*5113495bSYour Name volatile unsigned long *addr)
221*5113495bSYour Name {
222*5113495bSYour Name return test_and_set_bit(nr, addr);
223*5113495bSYour Name }
224*5113495bSYour Name
225*5113495bSYour Name /**
226*5113495bSYour Name * __qdf_atomic_test_and_clear_bit - Atomically clear a bit and return its old
227*5113495bSYour Name * value
228*5113495bSYour Name * @nr: bit to clear
229*5113495bSYour Name * @addr: the address to start counting from
230*5113495bSYour Name *
231*5113495bSYour Name * Return: return nr bit old value
232*5113495bSYour Name */
__qdf_atomic_test_and_clear_bit(int nr,volatile unsigned long * addr)233*5113495bSYour Name static inline int __qdf_atomic_test_and_clear_bit(int nr,
234*5113495bSYour Name volatile unsigned long *addr)
235*5113495bSYour Name {
236*5113495bSYour Name return test_and_clear_bit(nr, addr);
237*5113495bSYour Name }
238*5113495bSYour Name
239*5113495bSYour Name /**
240*5113495bSYour Name * __qdf_atomic_test_and_change_bit - Atomically toggle a bit and return its old
241*5113495bSYour Name * value
242*5113495bSYour Name * @nr: bit to change
243*5113495bSYour Name * @addr: the address to start counting from
244*5113495bSYour Name *
245*5113495bSYour Name * Return: return nr bit old value
246*5113495bSYour Name */
__qdf_atomic_test_and_change_bit(int nr,volatile unsigned long * addr)247*5113495bSYour Name static inline int __qdf_atomic_test_and_change_bit(int nr,
248*5113495bSYour Name volatile unsigned long *addr)
249*5113495bSYour Name {
250*5113495bSYour Name return test_and_change_bit(nr, addr);
251*5113495bSYour Name }
252*5113495bSYour Name
253*5113495bSYour Name /**
254*5113495bSYour Name * __qdf_atomic_test_bit - Atomically get the nr-th bit value starting from addr
255*5113495bSYour Name * @nr: bit to get
256*5113495bSYour Name * @addr: the address to start counting from
257*5113495bSYour Name *
258*5113495bSYour Name * Return: return nr bit value
259*5113495bSYour Name */
__qdf_atomic_test_bit(int nr,volatile unsigned long * addr)260*5113495bSYour Name static inline int __qdf_atomic_test_bit(int nr, volatile unsigned long *addr)
261*5113495bSYour Name {
262*5113495bSYour Name return test_bit(nr, addr);
263*5113495bSYour Name }
264*5113495bSYour Name
265*5113495bSYour Name #endif
266