xref: /wlan-dirver/qca-wifi-host-cmn/qdf/linux/src/qdf_delayed_work.c (revision dd4dc88b837a295134aa9869114a2efee0f4894b)
1 /*
2  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include "qdf_delayed_work.h"
20 #include "qdf_status.h"
21 #include "qdf_trace.h"
22 #include "qdf_types.h"
23 
24 #ifdef WLAN_DELAYED_WORK_DEBUG
25 #include "qdf_tracker.h"
26 
27 #define qdf_dwork_tracker_bits 2 /* 4 buckets */
28 static qdf_tracker_declare(qdf_dwork_tracker, qdf_dwork_tracker_bits,
29 			   "delayed work leaks", "delayed work create",
30 			   "delayed work destroy");
31 
32 void qdf_delayed_work_feature_init(void)
33 {
34 	qdf_tracker_init(&qdf_dwork_tracker);
35 }
36 
37 void qdf_delayed_work_feature_deinit(void)
38 {
39 	qdf_tracker_deinit(&qdf_dwork_tracker);
40 }
41 
42 void qdf_delayed_work_check_for_leaks(void)
43 {
44 	qdf_tracker_check_for_leaks(&qdf_dwork_tracker);
45 }
46 
47 static inline QDF_STATUS qdf_dwork_dbg_track(struct qdf_delayed_work *dwork,
48 					     const char *func, uint32_t line)
49 {
50 	return qdf_tracker_track(&qdf_dwork_tracker, dwork, func, line);
51 }
52 
53 static inline void qdf_dwork_dbg_untrack(struct qdf_delayed_work *dwork,
54 					 const char *func, uint32_t line)
55 {
56 	qdf_tracker_untrack(&qdf_dwork_tracker, dwork, func, line);
57 }
58 #else
59 static inline QDF_STATUS qdf_dwork_dbg_track(struct qdf_delayed_work *dwork,
60 					     const char *func, uint32_t line)
61 {
62 	return QDF_STATUS_SUCCESS;
63 }
64 
65 static inline void qdf_dwork_dbg_untrack(struct qdf_delayed_work *dwork,
66 					 const char *func, uint32_t line)
67 { }
68 #endif /* WLAN_DELAYED_WORK_DEBUG */
69 
70 static void __qdf_delayed_work_handler(struct work_struct *work)
71 {
72 	struct qdf_delayed_work *dwork =
73 		container_of(work, struct qdf_delayed_work, dwork.work);
74 
75 	dwork->callback(dwork->context);
76 }
77 
78 QDF_STATUS __qdf_delayed_work_create(struct qdf_delayed_work *dwork,
79 				     qdf_delayed_work_cb callback,
80 				     void *context,
81 				     const char *func, uint32_t line)
82 {
83 	QDF_STATUS status;
84 
85 	QDF_BUG(dwork);
86 	QDF_BUG(callback);
87 	if (!dwork || !callback)
88 		return QDF_STATUS_E_INVAL;
89 
90 	status = qdf_dwork_dbg_track(dwork, func, line);
91 	if (QDF_IS_STATUS_ERROR(status))
92 		return status;
93 
94 	INIT_DELAYED_WORK(&dwork->dwork, __qdf_delayed_work_handler);
95 	dwork->callback = callback;
96 	dwork->context = context;
97 
98 	return QDF_STATUS_SUCCESS;
99 }
100 
101 void __qdf_delayed_work_destroy(struct qdf_delayed_work *dwork,
102 				const char *func, uint32_t line)
103 {
104 	qdf_delayed_work_stop_sync(dwork);
105 	qdf_dwork_dbg_untrack(dwork, func, line);
106 }
107 
108 bool qdf_delayed_work_start(struct qdf_delayed_work *dwork, uint32_t msec)
109 {
110 	return schedule_delayed_work(&dwork->dwork, msecs_to_jiffies(msec));
111 }
112 
113 bool qdf_delayed_work_stop_sync(struct qdf_delayed_work *dwork)
114 {
115 	return cancel_delayed_work_sync(&dwork->dwork);
116 }
117 
118