1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2019-2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name * Copyright (c) 2022 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 #include "qdf_periodic_work.h"
21*5113495bSYour Name #include "qdf_status.h"
22*5113495bSYour Name #include "qdf_trace.h"
23*5113495bSYour Name #include "qdf_types.h"
24*5113495bSYour Name
25*5113495bSYour Name #ifdef WLAN_PERIODIC_WORK_DEBUG
26*5113495bSYour Name #include "qdf_tracker.h"
27*5113495bSYour Name
28*5113495bSYour Name #define qdf_pwork_tracker_bits 2 /* 4 buckets */
29*5113495bSYour Name static qdf_tracker_declare(qdf_pwork_tracker, qdf_pwork_tracker_bits,
30*5113495bSYour Name "periodic work leaks", "periodic work create",
31*5113495bSYour Name "periodic work destroy");
32*5113495bSYour Name
qdf_periodic_work_feature_init(void)33*5113495bSYour Name void qdf_periodic_work_feature_init(void)
34*5113495bSYour Name {
35*5113495bSYour Name qdf_tracker_init(&qdf_pwork_tracker);
36*5113495bSYour Name }
37*5113495bSYour Name
qdf_periodic_work_feature_deinit(void)38*5113495bSYour Name void qdf_periodic_work_feature_deinit(void)
39*5113495bSYour Name {
40*5113495bSYour Name qdf_tracker_deinit(&qdf_pwork_tracker);
41*5113495bSYour Name }
42*5113495bSYour Name
qdf_periodic_work_check_for_leaks(void)43*5113495bSYour Name void qdf_periodic_work_check_for_leaks(void)
44*5113495bSYour Name {
45*5113495bSYour Name qdf_tracker_check_for_leaks(&qdf_pwork_tracker);
46*5113495bSYour Name }
47*5113495bSYour Name
qdf_pwork_dbg_track(struct qdf_periodic_work * pwork,const char * func,uint32_t line)48*5113495bSYour Name static inline QDF_STATUS qdf_pwork_dbg_track(struct qdf_periodic_work *pwork,
49*5113495bSYour Name const char *func, uint32_t line)
50*5113495bSYour Name {
51*5113495bSYour Name return qdf_tracker_track(&qdf_pwork_tracker, pwork, func, line);
52*5113495bSYour Name }
53*5113495bSYour Name
qdf_pwork_dbg_untrack(struct qdf_periodic_work * pwork,const char * func,uint32_t line)54*5113495bSYour Name static inline void qdf_pwork_dbg_untrack(struct qdf_periodic_work *pwork,
55*5113495bSYour Name const char *func, uint32_t line)
56*5113495bSYour Name {
57*5113495bSYour Name qdf_tracker_untrack(&qdf_pwork_tracker, pwork, func, line);
58*5113495bSYour Name }
59*5113495bSYour Name #else
qdf_pwork_dbg_track(struct qdf_periodic_work * pwork,const char * func,uint32_t line)60*5113495bSYour Name static inline QDF_STATUS qdf_pwork_dbg_track(struct qdf_periodic_work *pwork,
61*5113495bSYour Name const char *func, uint32_t line)
62*5113495bSYour Name {
63*5113495bSYour Name return QDF_STATUS_SUCCESS;
64*5113495bSYour Name }
65*5113495bSYour Name
qdf_pwork_dbg_untrack(struct qdf_periodic_work * pwork,const char * func,uint32_t line)66*5113495bSYour Name static inline void qdf_pwork_dbg_untrack(struct qdf_periodic_work *pwork,
67*5113495bSYour Name const char *func, uint32_t line)
68*5113495bSYour Name { }
69*5113495bSYour Name #endif /* WLAN_PERIODIC_WORK_DEBUG */
70*5113495bSYour Name
__qdf_periodic_work_handler(struct work_struct * work)71*5113495bSYour Name static void __qdf_periodic_work_handler(struct work_struct *work)
72*5113495bSYour Name {
73*5113495bSYour Name struct qdf_periodic_work *pwork =
74*5113495bSYour Name container_of(work, struct qdf_periodic_work, dwork.work);
75*5113495bSYour Name uint32_t msec;
76*5113495bSYour Name
77*5113495bSYour Name pwork->callback(pwork->context);
78*5113495bSYour Name
79*5113495bSYour Name /* this is intentionally racy; see qdf_periodic_work_stop_sync() */
80*5113495bSYour Name msec = pwork->msec;
81*5113495bSYour Name if (msec)
82*5113495bSYour Name schedule_delayed_work(&pwork->dwork, msecs_to_jiffies(msec));
83*5113495bSYour Name }
84*5113495bSYour Name
__qdf_periodic_work_create(struct qdf_periodic_work * pwork,qdf_periodic_work_cb callback,void * context,const char * func,uint32_t line)85*5113495bSYour Name QDF_STATUS __qdf_periodic_work_create(struct qdf_periodic_work *pwork,
86*5113495bSYour Name qdf_periodic_work_cb callback,
87*5113495bSYour Name void *context,
88*5113495bSYour Name const char *func, uint32_t line)
89*5113495bSYour Name {
90*5113495bSYour Name QDF_STATUS status;
91*5113495bSYour Name
92*5113495bSYour Name QDF_BUG(pwork);
93*5113495bSYour Name QDF_BUG(callback);
94*5113495bSYour Name if (!pwork || !callback)
95*5113495bSYour Name return QDF_STATUS_E_INVAL;
96*5113495bSYour Name
97*5113495bSYour Name status = qdf_pwork_dbg_track(pwork, func, line);
98*5113495bSYour Name if (QDF_IS_STATUS_ERROR(status))
99*5113495bSYour Name return status;
100*5113495bSYour Name
101*5113495bSYour Name INIT_DEFERRABLE_WORK(&pwork->dwork, __qdf_periodic_work_handler);
102*5113495bSYour Name pwork->callback = callback;
103*5113495bSYour Name pwork->context = context;
104*5113495bSYour Name pwork->msec = 0;
105*5113495bSYour Name
106*5113495bSYour Name return QDF_STATUS_SUCCESS;
107*5113495bSYour Name }
108*5113495bSYour Name
__qdf_periodic_work_destroy(struct qdf_periodic_work * pwork,const char * func,uint32_t line)109*5113495bSYour Name void __qdf_periodic_work_destroy(struct qdf_periodic_work *pwork,
110*5113495bSYour Name const char *func, uint32_t line)
111*5113495bSYour Name {
112*5113495bSYour Name qdf_periodic_work_stop_sync(pwork);
113*5113495bSYour Name qdf_pwork_dbg_untrack(pwork, func, line);
114*5113495bSYour Name }
115*5113495bSYour Name
qdf_periodic_work_start(struct qdf_periodic_work * pwork,uint32_t msec)116*5113495bSYour Name bool qdf_periodic_work_start(struct qdf_periodic_work *pwork, uint32_t msec)
117*5113495bSYour Name {
118*5113495bSYour Name QDF_BUG(msec);
119*5113495bSYour Name if (!msec)
120*5113495bSYour Name return false;
121*5113495bSYour Name
122*5113495bSYour Name pwork->msec = msec;
123*5113495bSYour Name
124*5113495bSYour Name return schedule_delayed_work(&pwork->dwork, msecs_to_jiffies(msec));
125*5113495bSYour Name }
126*5113495bSYour Name
qdf_periodic_work_stop_async(struct qdf_periodic_work * pwork)127*5113495bSYour Name bool qdf_periodic_work_stop_async(struct qdf_periodic_work *pwork)
128*5113495bSYour Name {
129*5113495bSYour Name bool pending = pwork->msec != 0;
130*5113495bSYour Name
131*5113495bSYour Name pwork->msec = 0;
132*5113495bSYour Name cancel_delayed_work(&pwork->dwork);
133*5113495bSYour Name
134*5113495bSYour Name return pending;
135*5113495bSYour Name }
136*5113495bSYour Name
qdf_periodic_work_stop_sync(struct qdf_periodic_work * pwork)137*5113495bSYour Name bool qdf_periodic_work_stop_sync(struct qdf_periodic_work *pwork)
138*5113495bSYour Name {
139*5113495bSYour Name bool pending = pwork->msec != 0;
140*5113495bSYour Name
141*5113495bSYour Name /* To avoid using a lock, signal that the work shouldn't be restarted,
142*5113495bSYour Name * and cancel_sync in a loop. There is a very small race window, and
143*5113495bSYour Name * thus the work may occasionally need to be cancelled more than once.
144*5113495bSYour Name */
145*5113495bSYour Name pwork->msec = 0;
146*5113495bSYour Name while (cancel_delayed_work_sync(&pwork->dwork))
147*5113495bSYour Name ; /* no-op*/
148*5113495bSYour Name
149*5113495bSYour Name return pending;
150*5113495bSYour Name }
151*5113495bSYour Name
152