1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3 *
4 * (C) COPYRIGHT 2020-2022 ARM Limited. All rights reserved.
5 *
6 * This program is free software and is provided to you under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation, and any use by you of this program is subject to the terms
9 * of such GNU license.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you can access it online at
18 * http://www.gnu.org/licenses/gpl-2.0.html.
19 *
20 */
21
22 #ifndef _KBASE_CLK_RATE_TRACE_MGR_
23 #define _KBASE_CLK_RATE_TRACE_MGR_
24
25 /* The index of top clock domain in kbase_clk_rate_trace_manager:clks. */
26 #define KBASE_CLOCK_DOMAIN_TOP (0)
27
28 /* The index of shader-cores clock domain in
29 * kbase_clk_rate_trace_manager:clks.
30 */
31 #define KBASE_CLOCK_DOMAIN_SHADER_CORES (1)
32
33 /**
34 * struct kbase_clk_data - Data stored per enumerated GPU clock.
35 *
36 * @clk_rtm: Pointer to clock rate trace manager object.
37 * @gpu_clk_handle: Handle unique to the enumerated GPU clock.
38 * @plat_private: Private data for the platform to store into
39 * @clk_rate_change_nb: notifier block containing the pointer to callback
40 * function that is invoked whenever the rate of
41 * enumerated GPU clock changes.
42 * @clock_val: Current rate of the enumerated GPU clock.
43 * @index: Index at which the GPU clock was enumerated.
44 */
45 struct kbase_clk_data {
46 struct kbase_clk_rate_trace_manager *clk_rtm;
47 void *gpu_clk_handle;
48 void *plat_private;
49 struct notifier_block clk_rate_change_nb;
50 unsigned long clock_val;
51 u8 index;
52 };
53
54 /**
55 * kbase_clk_rate_trace_manager_init - Initialize GPU clock rate trace manager.
56 *
57 * @kbdev: Device pointer
58 *
59 * Return: 0 if success, or an error code on failure.
60 */
61 int kbase_clk_rate_trace_manager_init(struct kbase_device *kbdev);
62
63 /**
64 * kbase_clk_rate_trace_manager_term - Terminate GPU clock rate trace manager.
65 *
66 * @kbdev: Device pointer
67 */
68 void kbase_clk_rate_trace_manager_term(struct kbase_device *kbdev);
69
70 /**
71 * kbase_clk_rate_trace_manager_gpu_active - Inform GPU clock rate trace
72 * manager of GPU becoming active.
73 *
74 * @kbdev: Device pointer
75 */
76 void kbase_clk_rate_trace_manager_gpu_active(struct kbase_device *kbdev);
77
78 /**
79 * kbase_clk_rate_trace_manager_gpu_idle - Inform GPU clock rate trace
80 * manager of GPU becoming idle.
81 * @kbdev: Device pointer
82 */
83 void kbase_clk_rate_trace_manager_gpu_idle(struct kbase_device *kbdev);
84
85 /**
86 * kbase_clk_rate_trace_manager_subscribe_no_lock() - Add freq change listener.
87 *
88 * @clk_rtm: Clock rate manager instance.
89 * @listener: Listener handle
90 *
91 * kbase_clk_rate_trace_manager:lock must be held by the caller.
92 */
kbase_clk_rate_trace_manager_subscribe_no_lock(struct kbase_clk_rate_trace_manager * clk_rtm,struct kbase_clk_rate_listener * listener)93 static inline void kbase_clk_rate_trace_manager_subscribe_no_lock(
94 struct kbase_clk_rate_trace_manager *clk_rtm,
95 struct kbase_clk_rate_listener *listener)
96 {
97 lockdep_assert_held(&clk_rtm->lock);
98 list_add(&listener->node, &clk_rtm->listeners);
99 }
100
101 /**
102 * kbase_clk_rate_trace_manager_subscribe() - Add freq change listener.
103 *
104 * @clk_rtm: Clock rate manager instance.
105 * @listener: Listener handle
106 */
kbase_clk_rate_trace_manager_subscribe(struct kbase_clk_rate_trace_manager * clk_rtm,struct kbase_clk_rate_listener * listener)107 static inline void kbase_clk_rate_trace_manager_subscribe(
108 struct kbase_clk_rate_trace_manager *clk_rtm,
109 struct kbase_clk_rate_listener *listener)
110 {
111 unsigned long flags;
112
113 spin_lock_irqsave(&clk_rtm->lock, flags);
114 kbase_clk_rate_trace_manager_subscribe_no_lock(
115 clk_rtm, listener);
116 spin_unlock_irqrestore(&clk_rtm->lock, flags);
117 }
118
119 /**
120 * kbase_clk_rate_trace_manager_unsubscribe() - Remove freq change listener.
121 *
122 * @clk_rtm: Clock rate manager instance.
123 * @listener: Listener handle
124 */
kbase_clk_rate_trace_manager_unsubscribe(struct kbase_clk_rate_trace_manager * clk_rtm,struct kbase_clk_rate_listener * listener)125 static inline void kbase_clk_rate_trace_manager_unsubscribe(
126 struct kbase_clk_rate_trace_manager *clk_rtm,
127 struct kbase_clk_rate_listener *listener)
128 {
129 unsigned long flags;
130
131 spin_lock_irqsave(&clk_rtm->lock, flags);
132 list_del(&listener->node);
133 spin_unlock_irqrestore(&clk_rtm->lock, flags);
134 }
135
136 /**
137 * kbase_clk_rate_trace_manager_notify_all() - Notify all clock \
138 * rate listeners.
139 *
140 * @clk_rtm: Clock rate manager instance.
141 * @clock_index: Clock index.
142 * @new_rate: New clock frequency(Hz)
143 *
144 * kbase_clk_rate_trace_manager:lock must be locked.
145 * This function is exported to be used by clock rate trace test
146 * portal.
147 */
148 void kbase_clk_rate_trace_manager_notify_all(
149 struct kbase_clk_rate_trace_manager *clk_rtm,
150 u32 clock_index,
151 unsigned long new_rate);
152
153 #endif /* _KBASE_CLK_RATE_TRACE_MGR_ */
154
155