1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2014-2018, 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_lock.h
22*5113495bSYour Name * Linux-specific definitions for QDF Lock API's
23*5113495bSYour Name */
24*5113495bSYour Name
25*5113495bSYour Name #if !defined(__I_QDF_LOCK_H)
26*5113495bSYour Name #define __I_QDF_LOCK_H
27*5113495bSYour Name
28*5113495bSYour Name /* Include Files */
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include <qdf_status.h>
31*5113495bSYour Name #include <linux/mutex.h>
32*5113495bSYour Name #include <linux/spinlock.h>
33*5113495bSYour Name #include <linux/sched.h>
34*5113495bSYour Name #include <linux/device.h>
35*5113495bSYour Name #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 27)
36*5113495bSYour Name #include <asm/semaphore.h>
37*5113495bSYour Name #else
38*5113495bSYour Name #include <linux/semaphore.h>
39*5113495bSYour Name #endif
40*5113495bSYour Name #include <linux/interrupt.h>
41*5113495bSYour Name #include <linux/pm_wakeup.h>
42*5113495bSYour Name
43*5113495bSYour Name /* define for flag */
44*5113495bSYour Name #define QDF_LINUX_UNLOCK_BH 1
45*5113495bSYour Name
46*5113495bSYour Name #ifdef __cplusplus
47*5113495bSYour Name extern "C" {
48*5113495bSYour Name #endif /* __cplusplus */
49*5113495bSYour Name
50*5113495bSYour Name enum {
51*5113495bSYour Name LOCK_RELEASED = 0x11223344,
52*5113495bSYour Name LOCK_ACQUIRED,
53*5113495bSYour Name LOCK_DESTROYED
54*5113495bSYour Name };
55*5113495bSYour Name
56*5113495bSYour Name /**
57*5113495bSYour Name * struct qdf_lock_s - mutex abstraction
58*5113495bSYour Name * @m_lock: Mutex lock
59*5113495bSYour Name * @cookie: Lock cookie
60*5113495bSYour Name * @process_id: Process ID to track lock
61*5113495bSYour Name * @state: Lock status
62*5113495bSYour Name * @refcount: Reference count for recursive lock
63*5113495bSYour Name * @stats: a structure that contains usage statistics
64*5113495bSYour Name */
65*5113495bSYour Name struct qdf_lock_s {
66*5113495bSYour Name struct mutex m_lock;
67*5113495bSYour Name uint32_t cookie;
68*5113495bSYour Name int process_id;
69*5113495bSYour Name uint32_t state;
70*5113495bSYour Name uint8_t refcount;
71*5113495bSYour Name struct lock_stats stats;
72*5113495bSYour Name };
73*5113495bSYour Name
74*5113495bSYour Name /**
75*5113495bSYour Name * typedef __qdf_mutex_t - Mutex abstraction
76*5113495bSYour Name */
77*5113495bSYour Name typedef struct qdf_lock_s __qdf_mutex_t;
78*5113495bSYour Name
79*5113495bSYour Name /**
80*5113495bSYour Name * typedef __qdf_spinlock_t - spinlock abstraction
81*5113495bSYour Name * @spinlock: Spin lock
82*5113495bSYour Name * @flags: Lock flag
83*5113495bSYour Name */
84*5113495bSYour Name typedef struct __qdf_spinlock {
85*5113495bSYour Name spinlock_t spinlock;
86*5113495bSYour Name unsigned long flags;
87*5113495bSYour Name } __qdf_spinlock_t;
88*5113495bSYour Name
89*5113495bSYour Name /**
90*5113495bSYour Name * typedef __qdf_semaphore_t - semaphore abstraction
91*5113495bSYour Name */
92*5113495bSYour Name typedef struct semaphore __qdf_semaphore_t;
93*5113495bSYour Name
94*5113495bSYour Name /**
95*5113495bSYour Name * typedef qdf_wake_lock_t - wakelock abstraction
96*5113495bSYour Name * @lock: this lock needs to be used in kernel version < 5.4
97*5113495bSYour Name * @priv: this lock pointer needs to be used in kernel version >= 5.4
98*5113495bSYour Name */
99*5113495bSYour Name typedef struct qdf_wake_lock {
100*5113495bSYour Name struct wakeup_source lock;
101*5113495bSYour Name struct wakeup_source *priv;
102*5113495bSYour Name } qdf_wake_lock_t;
103*5113495bSYour Name
104*5113495bSYour Name struct hif_pm_runtime_lock;
105*5113495bSYour Name typedef struct qdf_runtime_lock {
106*5113495bSYour Name struct hif_pm_runtime_lock *lock;
107*5113495bSYour Name } qdf_runtime_lock_t;
108*5113495bSYour Name
109*5113495bSYour Name #define LINUX_LOCK_COOKIE 0x12345678
110*5113495bSYour Name
111*5113495bSYour Name /* Function declarations and documentation */
112*5113495bSYour Name
113*5113495bSYour Name #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 37)
114*5113495bSYour Name /**
115*5113495bSYour Name * __qdf_semaphore_init() - initialize the semaphore
116*5113495bSYour Name * @m: Semaphore object
117*5113495bSYour Name *
118*5113495bSYour Name * Return: QDF_STATUS_SUCCESS
119*5113495bSYour Name */
__qdf_semaphore_init(struct semaphore * m)120*5113495bSYour Name static inline QDF_STATUS __qdf_semaphore_init(struct semaphore *m)
121*5113495bSYour Name {
122*5113495bSYour Name init_MUTEX(m);
123*5113495bSYour Name return QDF_STATUS_SUCCESS;
124*5113495bSYour Name }
125*5113495bSYour Name #else
__qdf_semaphore_init(struct semaphore * m)126*5113495bSYour Name static inline QDF_STATUS __qdf_semaphore_init(struct semaphore *m)
127*5113495bSYour Name {
128*5113495bSYour Name sema_init(m, 1);
129*5113495bSYour Name return QDF_STATUS_SUCCESS;
130*5113495bSYour Name }
131*5113495bSYour Name #endif
132*5113495bSYour Name
133*5113495bSYour Name /**
134*5113495bSYour Name * __qdf_semaphore_acquire() - acquire semaphore
135*5113495bSYour Name * @m: Semaphore object
136*5113495bSYour Name *
137*5113495bSYour Name * Return: 0
138*5113495bSYour Name */
__qdf_semaphore_acquire(struct semaphore * m)139*5113495bSYour Name static inline int __qdf_semaphore_acquire(struct semaphore *m)
140*5113495bSYour Name {
141*5113495bSYour Name down(m);
142*5113495bSYour Name return 0;
143*5113495bSYour Name }
144*5113495bSYour Name
145*5113495bSYour Name /**
146*5113495bSYour Name * __qdf_semaphore_acquire_intr() - Take the semaphore, interruptible
147*5113495bSYour Name * @m: Semaphore object
148*5113495bSYour Name *
149*5113495bSYour Name * This function allows a user-space process that is waiting on a
150*5113495bSYour Name * semaphore to be interrupted by the user. If the operation is
151*5113495bSYour Name * interrupted, the function returns a nonzero value, and the caller
152*5113495bSYour Name * does not hold the semaphore. Always check the return value and
153*5113495bSYour Name * responding accordingly.
154*5113495bSYour Name *
155*5113495bSYour Name * Return: 0 if the semaphore was acquired, non-zero if not acquired
156*5113495bSYour Name */
__qdf_semaphore_acquire_intr(struct semaphore * m)157*5113495bSYour Name static inline int __qdf_semaphore_acquire_intr(struct semaphore *m)
158*5113495bSYour Name {
159*5113495bSYour Name return down_interruptible(m);
160*5113495bSYour Name }
161*5113495bSYour Name
162*5113495bSYour Name /**
163*5113495bSYour Name * __qdf_semaphore_release() - release semaphore
164*5113495bSYour Name * @m: Semaphore object
165*5113495bSYour Name *
166*5113495bSYour Name * Return: result of UP operation in integer
167*5113495bSYour Name */
__qdf_semaphore_release(struct semaphore * m)168*5113495bSYour Name static inline void __qdf_semaphore_release(struct semaphore *m)
169*5113495bSYour Name {
170*5113495bSYour Name up(m);
171*5113495bSYour Name }
172*5113495bSYour Name
173*5113495bSYour Name /**
174*5113495bSYour Name * __qdf_semaphore_acquire_timeout() - Take the semaphore before timeout
175*5113495bSYour Name * @m: semaphore to take
176*5113495bSYour Name * @timeout: maximum time to try to take the semaphore
177*5113495bSYour Name *
178*5113495bSYour Name * Return: int
179*5113495bSYour Name */
__qdf_semaphore_acquire_timeout(struct semaphore * m,unsigned long timeout)180*5113495bSYour Name static inline int __qdf_semaphore_acquire_timeout(struct semaphore *m,
181*5113495bSYour Name unsigned long timeout)
182*5113495bSYour Name {
183*5113495bSYour Name unsigned long jiffie_val = msecs_to_jiffies(timeout);
184*5113495bSYour Name
185*5113495bSYour Name return down_timeout(m, jiffie_val);
186*5113495bSYour Name }
187*5113495bSYour Name
188*5113495bSYour Name /**
189*5113495bSYour Name * __qdf_spinlock_create() - initialize spin lock
190*5113495bSYour Name * @lock: Spin lock object
191*5113495bSYour Name *
192*5113495bSYour Name * Return: QDF_STATUS_SUCCESS
193*5113495bSYour Name */
__qdf_spinlock_create(__qdf_spinlock_t * lock)194*5113495bSYour Name static inline QDF_STATUS __qdf_spinlock_create(__qdf_spinlock_t *lock)
195*5113495bSYour Name {
196*5113495bSYour Name spin_lock_init(&lock->spinlock);
197*5113495bSYour Name lock->flags = 0;
198*5113495bSYour Name return QDF_STATUS_SUCCESS;
199*5113495bSYour Name }
200*5113495bSYour Name
201*5113495bSYour Name #define __qdf_spinlock_destroy(lock)
202*5113495bSYour Name
203*5113495bSYour Name /**
204*5113495bSYour Name * __qdf_spin_lock() - Acquire a Spinlock(SMP) & disable Preemption (Preemptive)
205*5113495bSYour Name * @lock: Lock object
206*5113495bSYour Name *
207*5113495bSYour Name * Return: none
208*5113495bSYour Name */
__qdf_spin_lock(__qdf_spinlock_t * lock)209*5113495bSYour Name static inline void __qdf_spin_lock(__qdf_spinlock_t *lock)
210*5113495bSYour Name {
211*5113495bSYour Name spin_lock(&lock->spinlock);
212*5113495bSYour Name }
213*5113495bSYour Name
214*5113495bSYour Name /**
215*5113495bSYour Name * __qdf_spin_unlock() - Unlock the spinlock and enables the Preemption
216*5113495bSYour Name * @lock: Lock object
217*5113495bSYour Name *
218*5113495bSYour Name * Return: none
219*5113495bSYour Name */
__qdf_spin_unlock(__qdf_spinlock_t * lock)220*5113495bSYour Name static inline void __qdf_spin_unlock(__qdf_spinlock_t *lock)
221*5113495bSYour Name {
222*5113495bSYour Name spin_unlock(&lock->spinlock);
223*5113495bSYour Name }
224*5113495bSYour Name
225*5113495bSYour Name /**
226*5113495bSYour Name * __qdf_spin_lock_irqsave() - Acquire a Spinlock (SMP) & disable Preemption
227*5113495bSYour Name * (Preemptive) and disable IRQs
228*5113495bSYour Name * @lock: Lock object
229*5113495bSYour Name *
230*5113495bSYour Name * Return: none
231*5113495bSYour Name */
__qdf_spin_lock_irqsave(__qdf_spinlock_t * lock)232*5113495bSYour Name static inline void __qdf_spin_lock_irqsave(__qdf_spinlock_t *lock)
233*5113495bSYour Name {
234*5113495bSYour Name spin_lock_irqsave(&lock->spinlock, lock->flags);
235*5113495bSYour Name }
236*5113495bSYour Name
237*5113495bSYour Name /**
238*5113495bSYour Name * __qdf_spin_unlock_irqrestore() - Unlock the spinlock and enables the
239*5113495bSYour Name * Preemption and enable IRQ
240*5113495bSYour Name * @lock: Lock object
241*5113495bSYour Name *
242*5113495bSYour Name * Return: none
243*5113495bSYour Name */
__qdf_spin_unlock_irqrestore(__qdf_spinlock_t * lock)244*5113495bSYour Name static inline void __qdf_spin_unlock_irqrestore(__qdf_spinlock_t *lock)
245*5113495bSYour Name {
246*5113495bSYour Name spin_unlock_irqrestore(&lock->spinlock, lock->flags);
247*5113495bSYour Name }
248*5113495bSYour Name
249*5113495bSYour Name /*
250*5113495bSYour Name * Synchronous versions - only for OS' that have interrupt disable
251*5113495bSYour Name */
252*5113495bSYour Name #define __qdf_spin_lock_irq(_p_lock, _flags) spin_lock_irqsave(_p_lock, _flags)
253*5113495bSYour Name #define __qdf_spin_unlock_irq(_p_lock, _flags) \
254*5113495bSYour Name spin_unlock_irqrestore(_p_lock, _flags)
255*5113495bSYour Name
256*5113495bSYour Name /**
257*5113495bSYour Name * __qdf_spin_is_locked() - Test if spinlock is locked
258*5113495bSYour Name * @lock: spinlock object
259*5113495bSYour Name *
260*5113495bSYour Name * Return: nonzero if lock is held.
261*5113495bSYour Name */
__qdf_spin_is_locked(__qdf_spinlock_t * lock)262*5113495bSYour Name static inline int __qdf_spin_is_locked(__qdf_spinlock_t *lock)
263*5113495bSYour Name {
264*5113495bSYour Name return spin_is_locked(&lock->spinlock);
265*5113495bSYour Name }
266*5113495bSYour Name
267*5113495bSYour Name /**
268*5113495bSYour Name * __qdf_spin_trylock_bh() - spin trylock bottomhalf
269*5113495bSYour Name * @lock: spinlock object
270*5113495bSYour Name *
271*5113495bSYour Name * Return: nonzero if lock is acquired
272*5113495bSYour Name */
__qdf_spin_trylock_bh(__qdf_spinlock_t * lock)273*5113495bSYour Name static inline int __qdf_spin_trylock_bh(__qdf_spinlock_t *lock)
274*5113495bSYour Name {
275*5113495bSYour Name if (likely(irqs_disabled() || in_irq() || in_softirq()))
276*5113495bSYour Name return spin_trylock(&lock->spinlock);
277*5113495bSYour Name
278*5113495bSYour Name if (spin_trylock_bh(&lock->spinlock)) {
279*5113495bSYour Name lock->flags |= QDF_LINUX_UNLOCK_BH;
280*5113495bSYour Name return 1;
281*5113495bSYour Name }
282*5113495bSYour Name
283*5113495bSYour Name return 0;
284*5113495bSYour Name }
285*5113495bSYour Name
286*5113495bSYour Name /**
287*5113495bSYour Name * __qdf_spin_trylock() - spin trylock
288*5113495bSYour Name * @lock: spinlock object
289*5113495bSYour Name *
290*5113495bSYour Name * Return: int
291*5113495bSYour Name */
__qdf_spin_trylock(__qdf_spinlock_t * lock)292*5113495bSYour Name static inline int __qdf_spin_trylock(__qdf_spinlock_t *lock)
293*5113495bSYour Name {
294*5113495bSYour Name return spin_trylock(&lock->spinlock);
295*5113495bSYour Name }
296*5113495bSYour Name
297*5113495bSYour Name /**
298*5113495bSYour Name * __qdf_spin_lock_bh() - Acquire the spinlock and disable bottom halves
299*5113495bSYour Name * @lock: Lock object
300*5113495bSYour Name *
301*5113495bSYour Name * Return: none
302*5113495bSYour Name */
__qdf_spin_lock_bh(__qdf_spinlock_t * lock)303*5113495bSYour Name static inline void __qdf_spin_lock_bh(__qdf_spinlock_t *lock)
304*5113495bSYour Name {
305*5113495bSYour Name if (likely(irqs_disabled() || in_irq() || in_softirq())) {
306*5113495bSYour Name spin_lock(&lock->spinlock);
307*5113495bSYour Name } else {
308*5113495bSYour Name spin_lock_bh(&lock->spinlock);
309*5113495bSYour Name lock->flags |= QDF_LINUX_UNLOCK_BH;
310*5113495bSYour Name }
311*5113495bSYour Name }
312*5113495bSYour Name
313*5113495bSYour Name /**
314*5113495bSYour Name * __qdf_spin_unlock_bh() - Release the spinlock and enable bottom halves
315*5113495bSYour Name * @lock: Lock object
316*5113495bSYour Name *
317*5113495bSYour Name * Return: none
318*5113495bSYour Name */
__qdf_spin_unlock_bh(__qdf_spinlock_t * lock)319*5113495bSYour Name static inline void __qdf_spin_unlock_bh(__qdf_spinlock_t *lock)
320*5113495bSYour Name {
321*5113495bSYour Name if (unlikely(lock->flags & QDF_LINUX_UNLOCK_BH)) {
322*5113495bSYour Name lock->flags &= (unsigned long)~QDF_LINUX_UNLOCK_BH;
323*5113495bSYour Name spin_unlock_bh(&lock->spinlock);
324*5113495bSYour Name } else
325*5113495bSYour Name spin_unlock(&lock->spinlock);
326*5113495bSYour Name }
327*5113495bSYour Name
328*5113495bSYour Name /**
329*5113495bSYour Name * __qdf_spinlock_irq_exec() - Execute the input function with
330*5113495bSYour Name * spinlock held and interrupt disabled.
331*5113495bSYour Name * @hdl: OS handle
332*5113495bSYour Name * @lock: spinlock to be held for the critical region
333*5113495bSYour Name * @func: critical region function that to be executed
334*5113495bSYour Name * @arg: context of the critical region function
335*5113495bSYour Name *
336*5113495bSYour Name * Return: Boolean status returned by the critical region function
337*5113495bSYour Name */
__qdf_spinlock_irq_exec(qdf_handle_t hdl,__qdf_spinlock_t * lock,qdf_irqlocked_func_t func,void * arg)338*5113495bSYour Name static inline bool __qdf_spinlock_irq_exec(qdf_handle_t hdl,
339*5113495bSYour Name __qdf_spinlock_t *lock,
340*5113495bSYour Name qdf_irqlocked_func_t func,
341*5113495bSYour Name void *arg)
342*5113495bSYour Name {
343*5113495bSYour Name unsigned long flags;
344*5113495bSYour Name bool ret;
345*5113495bSYour Name
346*5113495bSYour Name spin_lock_irqsave(&lock->spinlock, flags);
347*5113495bSYour Name ret = func(arg);
348*5113495bSYour Name spin_unlock_irqrestore(&lock->spinlock, flags);
349*5113495bSYour Name
350*5113495bSYour Name return ret;
351*5113495bSYour Name }
352*5113495bSYour Name
353*5113495bSYour Name /**
354*5113495bSYour Name * __qdf_in_softirq() - in soft irq context
355*5113495bSYour Name *
356*5113495bSYour Name * Return: true if in softirs context else false
357*5113495bSYour Name */
__qdf_in_softirq(void)358*5113495bSYour Name static inline bool __qdf_in_softirq(void)
359*5113495bSYour Name {
360*5113495bSYour Name return in_softirq();
361*5113495bSYour Name }
362*5113495bSYour Name
363*5113495bSYour Name #ifdef __cplusplus
364*5113495bSYour Name }
365*5113495bSYour Name #endif /* __cplusplus */
366*5113495bSYour Name
367*5113495bSYour Name #endif /* __I_QDF_LOCK_H */
368