clk.c revision 1.7 1 1.7 jmcneill /* $NetBSD: clk.c,v 1.7 2019/07/23 17:44:03 jmcneill Exp $ */
2 1.1 jmcneill
3 1.1 jmcneill /*-
4 1.1 jmcneill * Copyright (c) 2015 Jared D. McNeill <jmcneill (at) invisible.ca>
5 1.1 jmcneill * All rights reserved.
6 1.1 jmcneill *
7 1.1 jmcneill * Redistribution and use in source and binary forms, with or without
8 1.1 jmcneill * modification, are permitted provided that the following conditions
9 1.1 jmcneill * are met:
10 1.1 jmcneill * 1. Redistributions of source code must retain the above copyright
11 1.1 jmcneill * notice, this list of conditions and the following disclaimer.
12 1.1 jmcneill * 2. Redistributions in binary form must reproduce the above copyright
13 1.1 jmcneill * notice, this list of conditions and the following disclaimer in the
14 1.1 jmcneill * documentation and/or other materials provided with the distribution.
15 1.1 jmcneill *
16 1.1 jmcneill * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 1.1 jmcneill * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 1.1 jmcneill * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 1.1 jmcneill * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 1.1 jmcneill * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 1.1 jmcneill * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 1.1 jmcneill * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 1.1 jmcneill * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 1.1 jmcneill * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.1 jmcneill * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.1 jmcneill * SUCH DAMAGE.
27 1.1 jmcneill */
28 1.1 jmcneill
29 1.1 jmcneill #include <sys/cdefs.h>
30 1.7 jmcneill __KERNEL_RCSID(0, "$NetBSD: clk.c,v 1.7 2019/07/23 17:44:03 jmcneill Exp $");
31 1.1 jmcneill
32 1.1 jmcneill #include <sys/param.h>
33 1.4 jmcneill #include <sys/sysctl.h>
34 1.7 jmcneill #include <sys/kmem.h>
35 1.1 jmcneill
36 1.1 jmcneill #include <dev/clk/clk.h>
37 1.1 jmcneill #include <dev/clk/clk_backend.h>
38 1.1 jmcneill
39 1.4 jmcneill static struct sysctllog *clk_log;
40 1.4 jmcneill static const struct sysctlnode *clk_node;
41 1.4 jmcneill
42 1.4 jmcneill static int
43 1.4 jmcneill create_clk_node(void)
44 1.4 jmcneill {
45 1.4 jmcneill const struct sysctlnode *hw_node;
46 1.4 jmcneill int error;
47 1.4 jmcneill
48 1.4 jmcneill if (clk_node)
49 1.4 jmcneill return 0;
50 1.4 jmcneill
51 1.4 jmcneill error = sysctl_createv(&clk_log, 0, NULL, &hw_node,
52 1.4 jmcneill CTLFLAG_PERMANENT, CTLTYPE_NODE, "hw", NULL,
53 1.4 jmcneill NULL, 0, NULL, 0, CTL_HW, CTL_EOL);
54 1.4 jmcneill if (error)
55 1.4 jmcneill return error;
56 1.4 jmcneill
57 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &hw_node, &clk_node,
58 1.4 jmcneill CTLFLAG_PERMANENT, CTLTYPE_NODE, "clk", NULL,
59 1.4 jmcneill NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
60 1.4 jmcneill if (error)
61 1.4 jmcneill return error;
62 1.4 jmcneill
63 1.4 jmcneill return 0;
64 1.4 jmcneill }
65 1.4 jmcneill
66 1.4 jmcneill static int
67 1.4 jmcneill create_domain_node(struct clk_domain *domain)
68 1.4 jmcneill {
69 1.4 jmcneill int error;
70 1.4 jmcneill
71 1.4 jmcneill if (domain->node)
72 1.4 jmcneill return 0;
73 1.4 jmcneill
74 1.4 jmcneill error = create_clk_node();
75 1.4 jmcneill if (error)
76 1.4 jmcneill return error;
77 1.4 jmcneill
78 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &clk_node, &domain->node,
79 1.4 jmcneill 0, CTLTYPE_NODE, domain->name, NULL,
80 1.4 jmcneill NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
81 1.4 jmcneill if (error)
82 1.4 jmcneill return error;
83 1.4 jmcneill
84 1.4 jmcneill return 0;
85 1.4 jmcneill }
86 1.4 jmcneill
87 1.4 jmcneill static int
88 1.4 jmcneill clk_sysctl_rate_helper(SYSCTLFN_ARGS)
89 1.4 jmcneill {
90 1.4 jmcneill struct sysctlnode node;
91 1.4 jmcneill struct clk *clk;
92 1.4 jmcneill uint64_t rate;
93 1.4 jmcneill
94 1.4 jmcneill node = *rnode;
95 1.4 jmcneill clk = node.sysctl_data;
96 1.4 jmcneill node.sysctl_data = &rate;
97 1.4 jmcneill
98 1.4 jmcneill rate = clk_get_rate(clk);
99 1.4 jmcneill
100 1.4 jmcneill return sysctl_lookup(SYSCTLFN_CALL(&node));
101 1.4 jmcneill }
102 1.4 jmcneill
103 1.4 jmcneill static int
104 1.4 jmcneill clk_sysctl_parent_helper(SYSCTLFN_ARGS)
105 1.4 jmcneill {
106 1.4 jmcneill struct sysctlnode node;
107 1.4 jmcneill struct clk *clk, *clk_parent;
108 1.4 jmcneill
109 1.4 jmcneill node = *rnode;
110 1.4 jmcneill clk = node.sysctl_data;
111 1.4 jmcneill
112 1.4 jmcneill clk_parent = clk_get_parent(clk);
113 1.4 jmcneill if (clk_parent && clk_parent->name)
114 1.4 jmcneill node.sysctl_data = __UNCONST(clk_parent->name);
115 1.4 jmcneill else
116 1.4 jmcneill node.sysctl_data = __UNCONST("?");
117 1.4 jmcneill
118 1.4 jmcneill return sysctl_lookup(SYSCTLFN_CALL(&node));
119 1.4 jmcneill }
120 1.4 jmcneill
121 1.4 jmcneill static int
122 1.4 jmcneill clk_sysctl_parent_domain_helper(SYSCTLFN_ARGS)
123 1.4 jmcneill {
124 1.4 jmcneill struct sysctlnode node;
125 1.4 jmcneill struct clk *clk, *clk_parent;
126 1.4 jmcneill
127 1.4 jmcneill node = *rnode;
128 1.4 jmcneill clk = node.sysctl_data;
129 1.4 jmcneill
130 1.4 jmcneill clk_parent = clk_get_parent(clk);
131 1.4 jmcneill if (clk_parent && clk_parent->domain && clk_parent->domain->name)
132 1.4 jmcneill node.sysctl_data = __UNCONST(clk_parent->domain->name);
133 1.4 jmcneill else
134 1.4 jmcneill node.sysctl_data = __UNCONST("?");
135 1.4 jmcneill
136 1.4 jmcneill return sysctl_lookup(SYSCTLFN_CALL(&node));
137 1.4 jmcneill }
138 1.4 jmcneill
139 1.7 jmcneill static void
140 1.7 jmcneill clk_normalize_name(char *name)
141 1.7 jmcneill {
142 1.7 jmcneill unsigned char *p;
143 1.7 jmcneill
144 1.7 jmcneill for (p = (unsigned char *)name; *p; p++)
145 1.7 jmcneill if (!isalpha(*p) && !isdigit(*p) && *p != '-' && *p != '_')
146 1.7 jmcneill *p = '_';
147 1.7 jmcneill }
148 1.7 jmcneill
149 1.4 jmcneill int
150 1.4 jmcneill clk_attach(struct clk *clk)
151 1.4 jmcneill {
152 1.4 jmcneill const struct sysctlnode *node;
153 1.4 jmcneill struct clk_domain *domain = clk->domain;
154 1.7 jmcneill char *name;
155 1.7 jmcneill size_t namelen;
156 1.4 jmcneill int error;
157 1.4 jmcneill
158 1.4 jmcneill KASSERT(domain != NULL);
159 1.4 jmcneill
160 1.4 jmcneill if (!domain->name || !clk->name) {
161 1.4 jmcneill /* Names are required to create sysctl nodes */
162 1.4 jmcneill return 0;
163 1.4 jmcneill }
164 1.4 jmcneill
165 1.7 jmcneill namelen = strlen(clk->name) + 1;
166 1.7 jmcneill name = kmem_zalloc(namelen, KM_SLEEP);
167 1.7 jmcneill memcpy(name, clk->name, namelen);
168 1.7 jmcneill clk_normalize_name(name);
169 1.7 jmcneill
170 1.4 jmcneill error = create_domain_node(domain);
171 1.4 jmcneill if (error != 0)
172 1.4 jmcneill goto sysctl_failed;
173 1.4 jmcneill
174 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &domain->node, &node,
175 1.7 jmcneill CTLFLAG_PRIVATE, CTLTYPE_NODE, name, NULL,
176 1.4 jmcneill NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
177 1.4 jmcneill if (error)
178 1.4 jmcneill goto sysctl_failed;
179 1.4 jmcneill
180 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &node, NULL,
181 1.4 jmcneill CTLFLAG_PRIVATE, CTLTYPE_QUAD, "rate", NULL,
182 1.4 jmcneill clk_sysctl_rate_helper, 0, (void *)clk, 0,
183 1.4 jmcneill CTL_CREATE, CTL_EOL);
184 1.4 jmcneill if (error)
185 1.4 jmcneill goto sysctl_failed;
186 1.4 jmcneill
187 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &node, NULL,
188 1.4 jmcneill CTLFLAG_PRIVATE, CTLTYPE_STRING, "parent", NULL,
189 1.4 jmcneill clk_sysctl_parent_helper, 0, (void *)clk, 0,
190 1.4 jmcneill CTL_CREATE, CTL_EOL);
191 1.4 jmcneill if (error)
192 1.4 jmcneill goto sysctl_failed;
193 1.4 jmcneill
194 1.4 jmcneill error = sysctl_createv(&clk_log, 0, &node, NULL,
195 1.4 jmcneill CTLFLAG_PRIVATE, CTLTYPE_STRING, "parent_domain", NULL,
196 1.4 jmcneill clk_sysctl_parent_domain_helper, 0, (void *)clk, 0,
197 1.4 jmcneill CTL_CREATE, CTL_EOL);
198 1.4 jmcneill if (error)
199 1.4 jmcneill goto sysctl_failed;
200 1.4 jmcneill
201 1.4 jmcneill sysctl_failed:
202 1.4 jmcneill if (error)
203 1.7 jmcneill aprint_error("%s: failed to create sysctl node for %s (%s): %d\n",
204 1.7 jmcneill domain->name, clk->name, name, error);
205 1.7 jmcneill
206 1.7 jmcneill kmem_free(name, namelen);
207 1.4 jmcneill return error;
208 1.4 jmcneill }
209 1.4 jmcneill
210 1.1 jmcneill struct clk *
211 1.2 jmcneill clk_get(struct clk_domain *domain, const char *name)
212 1.1 jmcneill {
213 1.2 jmcneill return domain->funcs->get(domain->priv, name);
214 1.1 jmcneill }
215 1.1 jmcneill
216 1.1 jmcneill void
217 1.1 jmcneill clk_put(struct clk *clk)
218 1.1 jmcneill {
219 1.6 jmcneill if (clk->domain->funcs->put)
220 1.6 jmcneill clk->domain->funcs->put(clk->domain->priv, clk);
221 1.1 jmcneill }
222 1.1 jmcneill
223 1.1 jmcneill u_int
224 1.1 jmcneill clk_get_rate(struct clk *clk)
225 1.1 jmcneill {
226 1.2 jmcneill return clk->domain->funcs->get_rate(clk->domain->priv, clk);
227 1.1 jmcneill }
228 1.1 jmcneill
229 1.1 jmcneill int
230 1.1 jmcneill clk_set_rate(struct clk *clk, u_int rate)
231 1.1 jmcneill {
232 1.5 jmcneill if (clk->flags & CLK_SET_RATE_PARENT)
233 1.1 jmcneill return clk_set_rate(clk_get_parent(clk), rate);
234 1.5 jmcneill
235 1.5 jmcneill if (clk->domain->funcs->set_rate)
236 1.2 jmcneill return clk->domain->funcs->set_rate(clk->domain->priv,
237 1.2 jmcneill clk, rate);
238 1.5 jmcneill
239 1.5 jmcneill if (clk_get_rate(clk) == rate)
240 1.5 jmcneill return 0;
241 1.5 jmcneill
242 1.5 jmcneill return EINVAL;
243 1.1 jmcneill }
244 1.1 jmcneill
245 1.3 bouyer u_int
246 1.3 bouyer clk_round_rate(struct clk *clk, u_int rate)
247 1.3 bouyer {
248 1.3 bouyer if (clk->domain->funcs->round_rate) {
249 1.3 bouyer return clk->domain->funcs->round_rate(clk->domain->priv,
250 1.3 bouyer clk, rate);
251 1.3 bouyer }
252 1.3 bouyer return 0;
253 1.3 bouyer }
254 1.3 bouyer
255 1.1 jmcneill int
256 1.1 jmcneill clk_enable(struct clk *clk)
257 1.1 jmcneill {
258 1.2 jmcneill if (clk->domain->funcs->enable)
259 1.2 jmcneill return clk->domain->funcs->enable(clk->domain->priv, clk);
260 1.2 jmcneill else
261 1.2 jmcneill return 0;
262 1.1 jmcneill }
263 1.1 jmcneill
264 1.1 jmcneill int
265 1.1 jmcneill clk_disable(struct clk *clk)
266 1.1 jmcneill {
267 1.2 jmcneill if (clk->domain->funcs->disable)
268 1.2 jmcneill return clk->domain->funcs->disable(clk->domain->priv, clk);
269 1.2 jmcneill else
270 1.2 jmcneill return EINVAL;
271 1.1 jmcneill }
272 1.1 jmcneill
273 1.1 jmcneill int
274 1.1 jmcneill clk_set_parent(struct clk *clk, struct clk *parent_clk)
275 1.1 jmcneill {
276 1.2 jmcneill if (clk->domain->funcs->set_parent)
277 1.2 jmcneill return clk->domain->funcs->set_parent(clk->domain->priv,
278 1.2 jmcneill clk, parent_clk);
279 1.2 jmcneill else
280 1.2 jmcneill return EINVAL;
281 1.1 jmcneill }
282 1.1 jmcneill
283 1.1 jmcneill struct clk *
284 1.1 jmcneill clk_get_parent(struct clk *clk)
285 1.1 jmcneill {
286 1.4 jmcneill if (clk->domain->funcs->get_parent)
287 1.4 jmcneill return clk->domain->funcs->get_parent(clk->domain->priv, clk);
288 1.4 jmcneill else
289 1.4 jmcneill return NULL;
290 1.1 jmcneill }
291