Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * drivers/clk/clkdev.c
4 *
5 * Copyright (C) 2008 Russell King.
6 *
7 * Helper for the clk API to assist looking up a struct clk.
8 */
9#include <linux/module.h>
10#include <linux/kernel.h>
11#include <linux/device.h>
12#include <linux/list.h>
13#include <linux/errno.h>
14#include <linux/err.h>
15#include <linux/string.h>
16#include <linux/mutex.h>
17#include <linux/clk.h>
18#include <linux/clkdev.h>
19#include <linux/clk-provider.h>
20#include <linux/of.h>
21
22#include "clk.h"
23
24static LIST_HEAD(clocks);
25static DEFINE_MUTEX(clocks_mutex);
26
27/*
28 * Find the correct struct clk for the device and connection ID.
29 * We do slightly fuzzy matching here:
30 * An entry with a NULL ID is assumed to be a wildcard.
31 * If an entry has a device ID, it must match
32 * If an entry has a connection ID, it must match
33 * Then we take the most specific entry - with the following
34 * order of precedence: dev+con > dev only > con only.
35 */
36static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
37{
38 struct clk_lookup *p, *cl = NULL;
39 int match, best_found = 0, best_possible = 0;
40
41 if (dev_id)
42 best_possible += 2;
43 if (con_id)
44 best_possible += 1;
45
46 lockdep_assert_held(&clocks_mutex);
47
48 list_for_each_entry(p, &clocks, node) {
49 match = 0;
50 if (p->dev_id) {
51 if (!dev_id || strcmp(p->dev_id, dev_id))
52 continue;
53 match += 2;
54 }
55 if (p->con_id) {
56 if (!con_id || strcmp(p->con_id, con_id))
57 continue;
58 match += 1;
59 }
60
61 if (match > best_found) {
62 cl = p;
63 if (match != best_possible)
64 best_found = match;
65 else
66 break;
67 }
68 }
69 return cl;
70}
71
72struct clk_hw *clk_find_hw(const char *dev_id, const char *con_id)
73{
74 struct clk_lookup *cl;
75 struct clk_hw *hw = ERR_PTR(-ENOENT);
76
77 mutex_lock(&clocks_mutex);
78 cl = clk_find(dev_id, con_id);
79 if (cl)
80 hw = cl->clk_hw;
81 mutex_unlock(&clocks_mutex);
82
83 return hw;
84}
85
86static struct clk *__clk_get_sys(struct device *dev, const char *dev_id,
87 const char *con_id)
88{
89 struct clk_hw *hw = clk_find_hw(dev_id, con_id);
90
91 return clk_hw_create_clk(dev, hw, dev_id, con_id);
92}
93
94struct clk *clk_get_sys(const char *dev_id, const char *con_id)
95{
96 return __clk_get_sys(NULL, dev_id, con_id);
97}
98EXPORT_SYMBOL(clk_get_sys);
99
100struct clk *clk_get(struct device *dev, const char *con_id)
101{
102 const char *dev_id = dev ? dev_name(dev) : NULL;
103 struct clk_hw *hw;
104
105 if (dev && dev->of_node) {
106 hw = of_clk_get_hw(dev->of_node, 0, con_id);
107 if (!IS_ERR(hw) || PTR_ERR(hw) == -EPROBE_DEFER)
108 return clk_hw_create_clk(dev, hw, dev_id, con_id);
109 }
110
111 return __clk_get_sys(dev, dev_id, con_id);
112}
113EXPORT_SYMBOL(clk_get);
114
115void clk_put(struct clk *clk)
116{
117 __clk_put(clk);
118}
119EXPORT_SYMBOL(clk_put);
120
121static void __clkdev_add(struct clk_lookup *cl)
122{
123 mutex_lock(&clocks_mutex);
124 list_add_tail(&cl->node, &clocks);
125 mutex_unlock(&clocks_mutex);
126}
127
128void clkdev_add(struct clk_lookup *cl)
129{
130 if (!cl->clk_hw)
131 cl->clk_hw = __clk_get_hw(cl->clk);
132 __clkdev_add(cl);
133}
134EXPORT_SYMBOL(clkdev_add);
135
136void clkdev_add_table(struct clk_lookup *cl, size_t num)
137{
138 mutex_lock(&clocks_mutex);
139 while (num--) {
140 cl->clk_hw = __clk_get_hw(cl->clk);
141 list_add_tail(&cl->node, &clocks);
142 cl++;
143 }
144 mutex_unlock(&clocks_mutex);
145}
146
147#define MAX_DEV_ID 20
148#define MAX_CON_ID 16
149
150struct clk_lookup_alloc {
151 struct clk_lookup cl;
152 char dev_id[MAX_DEV_ID];
153 char con_id[MAX_CON_ID];
154};
155
156static struct clk_lookup * __ref
157vclkdev_alloc(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
158 va_list ap)
159{
160 struct clk_lookup_alloc *cla;
161
162 cla = kzalloc(sizeof(*cla), GFP_KERNEL);
163 if (!cla)
164 return NULL;
165
166 cla->cl.clk_hw = hw;
167 if (con_id) {
168 strlcpy(cla->con_id, con_id, sizeof(cla->con_id));
169 cla->cl.con_id = cla->con_id;
170 }
171
172 if (dev_fmt) {
173 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
174 cla->cl.dev_id = cla->dev_id;
175 }
176
177 return &cla->cl;
178}
179
180static struct clk_lookup *
181vclkdev_create(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
182 va_list ap)
183{
184 struct clk_lookup *cl;
185
186 cl = vclkdev_alloc(hw, con_id, dev_fmt, ap);
187 if (cl)
188 __clkdev_add(cl);
189
190 return cl;
191}
192
193struct clk_lookup * __ref
194clkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt, ...)
195{
196 struct clk_lookup *cl;
197 va_list ap;
198
199 va_start(ap, dev_fmt);
200 cl = vclkdev_alloc(__clk_get_hw(clk), con_id, dev_fmt, ap);
201 va_end(ap);
202
203 return cl;
204}
205EXPORT_SYMBOL(clkdev_alloc);
206
207struct clk_lookup *
208clkdev_hw_alloc(struct clk_hw *hw, const char *con_id, const char *dev_fmt, ...)
209{
210 struct clk_lookup *cl;
211 va_list ap;
212
213 va_start(ap, dev_fmt);
214 cl = vclkdev_alloc(hw, con_id, dev_fmt, ap);
215 va_end(ap);
216
217 return cl;
218}
219EXPORT_SYMBOL(clkdev_hw_alloc);
220
221/**
222 * clkdev_create - allocate and add a clkdev lookup structure
223 * @clk: struct clk to associate with all clk_lookups
224 * @con_id: connection ID string on device
225 * @dev_fmt: format string describing device name
226 *
227 * Returns a clk_lookup structure, which can be later unregistered and
228 * freed.
229 */
230struct clk_lookup *clkdev_create(struct clk *clk, const char *con_id,
231 const char *dev_fmt, ...)
232{
233 struct clk_lookup *cl;
234 va_list ap;
235
236 va_start(ap, dev_fmt);
237 cl = vclkdev_create(__clk_get_hw(clk), con_id, dev_fmt, ap);
238 va_end(ap);
239
240 return cl;
241}
242EXPORT_SYMBOL_GPL(clkdev_create);
243
244/**
245 * clkdev_hw_create - allocate and add a clkdev lookup structure
246 * @hw: struct clk_hw to associate with all clk_lookups
247 * @con_id: connection ID string on device
248 * @dev_fmt: format string describing device name
249 *
250 * Returns a clk_lookup structure, which can be later unregistered and
251 * freed.
252 */
253struct clk_lookup *clkdev_hw_create(struct clk_hw *hw, const char *con_id,
254 const char *dev_fmt, ...)
255{
256 struct clk_lookup *cl;
257 va_list ap;
258
259 va_start(ap, dev_fmt);
260 cl = vclkdev_create(hw, con_id, dev_fmt, ap);
261 va_end(ap);
262
263 return cl;
264}
265EXPORT_SYMBOL_GPL(clkdev_hw_create);
266
267int clk_add_alias(const char *alias, const char *alias_dev_name,
268 const char *con_id, struct device *dev)
269{
270 struct clk *r = clk_get(dev, con_id);
271 struct clk_lookup *l;
272
273 if (IS_ERR(r))
274 return PTR_ERR(r);
275
276 l = clkdev_create(r, alias, alias_dev_name ? "%s" : NULL,
277 alias_dev_name);
278 clk_put(r);
279
280 return l ? 0 : -ENODEV;
281}
282EXPORT_SYMBOL(clk_add_alias);
283
284/*
285 * clkdev_drop - remove a clock dynamically allocated
286 */
287void clkdev_drop(struct clk_lookup *cl)
288{
289 mutex_lock(&clocks_mutex);
290 list_del(&cl->node);
291 mutex_unlock(&clocks_mutex);
292 kfree(cl);
293}
294EXPORT_SYMBOL(clkdev_drop);
295
296static struct clk_lookup *__clk_register_clkdev(struct clk_hw *hw,
297 const char *con_id,
298 const char *dev_id, ...)
299{
300 struct clk_lookup *cl;
301 va_list ap;
302
303 va_start(ap, dev_id);
304 cl = vclkdev_create(hw, con_id, dev_id, ap);
305 va_end(ap);
306
307 return cl;
308}
309
310static int do_clk_register_clkdev(struct clk_hw *hw,
311 struct clk_lookup **cl, const char *con_id, const char *dev_id)
312{
313 if (IS_ERR(hw))
314 return PTR_ERR(hw);
315 /*
316 * Since dev_id can be NULL, and NULL is handled specially, we must
317 * pass it as either a NULL format string, or with "%s".
318 */
319 if (dev_id)
320 *cl = __clk_register_clkdev(hw, con_id, "%s", dev_id);
321 else
322 *cl = __clk_register_clkdev(hw, con_id, NULL);
323
324 return *cl ? 0 : -ENOMEM;
325}
326
327/**
328 * clk_register_clkdev - register one clock lookup for a struct clk
329 * @clk: struct clk to associate with all clk_lookups
330 * @con_id: connection ID string on device
331 * @dev_id: string describing device name
332 *
333 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
334 * clkdev.
335 *
336 * To make things easier for mass registration, we detect error clks
337 * from a previous clk_register() call, and return the error code for
338 * those. This is to permit this function to be called immediately
339 * after clk_register().
340 */
341int clk_register_clkdev(struct clk *clk, const char *con_id,
342 const char *dev_id)
343{
344 struct clk_lookup *cl;
345
346 if (IS_ERR(clk))
347 return PTR_ERR(clk);
348
349 return do_clk_register_clkdev(__clk_get_hw(clk), &cl, con_id,
350 dev_id);
351}
352EXPORT_SYMBOL(clk_register_clkdev);
353
354/**
355 * clk_hw_register_clkdev - register one clock lookup for a struct clk_hw
356 * @hw: struct clk_hw to associate with all clk_lookups
357 * @con_id: connection ID string on device
358 * @dev_id: format string describing device name
359 *
360 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
361 * clkdev.
362 *
363 * To make things easier for mass registration, we detect error clk_hws
364 * from a previous clk_hw_register_*() call, and return the error code for
365 * those. This is to permit this function to be called immediately
366 * after clk_hw_register_*().
367 */
368int clk_hw_register_clkdev(struct clk_hw *hw, const char *con_id,
369 const char *dev_id)
370{
371 struct clk_lookup *cl;
372
373 return do_clk_register_clkdev(hw, &cl, con_id, dev_id);
374}
375EXPORT_SYMBOL(clk_hw_register_clkdev);
376
377static void devm_clkdev_release(struct device *dev, void *res)
378{
379 clkdev_drop(*(struct clk_lookup **)res);
380}
381
382static int devm_clk_match_clkdev(struct device *dev, void *res, void *data)
383{
384 struct clk_lookup **l = res;
385
386 return *l == data;
387}
388
389/**
390 * devm_clk_release_clkdev - Resource managed clkdev lookup release
391 * @dev: device this lookup is bound
392 * @con_id: connection ID string on device
393 * @dev_id: format string describing device name
394 *
395 * Drop the clkdev lookup created with devm_clk_hw_register_clkdev.
396 * Normally this function will not need to be called and the resource
397 * management code will ensure that the resource is freed.
398 */
399void devm_clk_release_clkdev(struct device *dev, const char *con_id,
400 const char *dev_id)
401{
402 struct clk_lookup *cl;
403 int rval;
404
405 mutex_lock(&clocks_mutex);
406 cl = clk_find(dev_id, con_id);
407 mutex_unlock(&clocks_mutex);
408
409 WARN_ON(!cl);
410 rval = devres_release(dev, devm_clkdev_release,
411 devm_clk_match_clkdev, cl);
412 WARN_ON(rval);
413}
414EXPORT_SYMBOL(devm_clk_release_clkdev);
415
416/**
417 * devm_clk_hw_register_clkdev - managed clk lookup registration for clk_hw
418 * @dev: device this lookup is bound
419 * @hw: struct clk_hw to associate with all clk_lookups
420 * @con_id: connection ID string on device
421 * @dev_id: format string describing device name
422 *
423 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
424 * clkdev.
425 *
426 * To make things easier for mass registration, we detect error clk_hws
427 * from a previous clk_hw_register_*() call, and return the error code for
428 * those. This is to permit this function to be called immediately
429 * after clk_hw_register_*().
430 */
431int devm_clk_hw_register_clkdev(struct device *dev, struct clk_hw *hw,
432 const char *con_id, const char *dev_id)
433{
434 int rval = -ENOMEM;
435 struct clk_lookup **cl;
436
437 cl = devres_alloc(devm_clkdev_release, sizeof(*cl), GFP_KERNEL);
438 if (cl) {
439 rval = do_clk_register_clkdev(hw, cl, con_id, dev_id);
440 if (!rval)
441 devres_add(dev, cl);
442 else
443 devres_free(cl);
444 }
445 return rval;
446}
447EXPORT_SYMBOL(devm_clk_hw_register_clkdev);
1/*
2 * drivers/clk/clkdev.c
3 *
4 * Copyright (C) 2008 Russell King.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * Helper for the clk API to assist looking up a struct clk.
11 */
12#include <linux/module.h>
13#include <linux/kernel.h>
14#include <linux/device.h>
15#include <linux/list.h>
16#include <linux/errno.h>
17#include <linux/err.h>
18#include <linux/string.h>
19#include <linux/mutex.h>
20#include <linux/clk.h>
21#include <linux/clkdev.h>
22#include <linux/of.h>
23
24#include "clk.h"
25
26static LIST_HEAD(clocks);
27static DEFINE_MUTEX(clocks_mutex);
28
29#if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
30struct clk *of_clk_get(struct device_node *np, int index)
31{
32 struct of_phandle_args clkspec;
33 struct clk *clk;
34 int rc;
35
36 if (index < 0)
37 return ERR_PTR(-EINVAL);
38
39 rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index,
40 &clkspec);
41 if (rc)
42 return ERR_PTR(rc);
43
44 of_clk_lock();
45 clk = __of_clk_get_from_provider(&clkspec);
46
47 if (!IS_ERR(clk) && !__clk_get(clk))
48 clk = ERR_PTR(-ENOENT);
49
50 of_clk_unlock();
51 of_node_put(clkspec.np);
52 return clk;
53}
54EXPORT_SYMBOL(of_clk_get);
55
56/**
57 * of_clk_get_by_name() - Parse and lookup a clock referenced by a device node
58 * @np: pointer to clock consumer node
59 * @name: name of consumer's clock input, or NULL for the first clock reference
60 *
61 * This function parses the clocks and clock-names properties,
62 * and uses them to look up the struct clk from the registered list of clock
63 * providers.
64 */
65struct clk *of_clk_get_by_name(struct device_node *np, const char *name)
66{
67 struct clk *clk = ERR_PTR(-ENOENT);
68
69 /* Walk up the tree of devices looking for a clock that matches */
70 while (np) {
71 int index = 0;
72
73 /*
74 * For named clocks, first look up the name in the
75 * "clock-names" property. If it cannot be found, then
76 * index will be an error code, and of_clk_get() will fail.
77 */
78 if (name)
79 index = of_property_match_string(np, "clock-names", name);
80 clk = of_clk_get(np, index);
81 if (!IS_ERR(clk))
82 break;
83 else if (name && index >= 0) {
84 pr_err("ERROR: could not get clock %s:%s(%i)\n",
85 np->full_name, name ? name : "", index);
86 return clk;
87 }
88
89 /*
90 * No matching clock found on this node. If the parent node
91 * has a "clock-ranges" property, then we can try one of its
92 * clocks.
93 */
94 np = np->parent;
95 if (np && !of_get_property(np, "clock-ranges", NULL))
96 break;
97 }
98
99 return clk;
100}
101EXPORT_SYMBOL(of_clk_get_by_name);
102#endif
103
104/*
105 * Find the correct struct clk for the device and connection ID.
106 * We do slightly fuzzy matching here:
107 * An entry with a NULL ID is assumed to be a wildcard.
108 * If an entry has a device ID, it must match
109 * If an entry has a connection ID, it must match
110 * Then we take the most specific entry - with the following
111 * order of precedence: dev+con > dev only > con only.
112 */
113static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
114{
115 struct clk_lookup *p, *cl = NULL;
116 int match, best_found = 0, best_possible = 0;
117
118 if (dev_id)
119 best_possible += 2;
120 if (con_id)
121 best_possible += 1;
122
123 list_for_each_entry(p, &clocks, node) {
124 match = 0;
125 if (p->dev_id) {
126 if (!dev_id || strcmp(p->dev_id, dev_id))
127 continue;
128 match += 2;
129 }
130 if (p->con_id) {
131 if (!con_id || strcmp(p->con_id, con_id))
132 continue;
133 match += 1;
134 }
135
136 if (match > best_found) {
137 cl = p;
138 if (match != best_possible)
139 best_found = match;
140 else
141 break;
142 }
143 }
144 return cl;
145}
146
147struct clk *clk_get_sys(const char *dev_id, const char *con_id)
148{
149 struct clk_lookup *cl;
150
151 mutex_lock(&clocks_mutex);
152 cl = clk_find(dev_id, con_id);
153 if (cl && !__clk_get(cl->clk))
154 cl = NULL;
155 mutex_unlock(&clocks_mutex);
156
157 return cl ? cl->clk : ERR_PTR(-ENOENT);
158}
159EXPORT_SYMBOL(clk_get_sys);
160
161struct clk *clk_get(struct device *dev, const char *con_id)
162{
163 const char *dev_id = dev ? dev_name(dev) : NULL;
164 struct clk *clk;
165
166 if (dev) {
167 clk = of_clk_get_by_name(dev->of_node, con_id);
168 if (!IS_ERR(clk))
169 return clk;
170 if (PTR_ERR(clk) == -EPROBE_DEFER)
171 return clk;
172 }
173
174 return clk_get_sys(dev_id, con_id);
175}
176EXPORT_SYMBOL(clk_get);
177
178void clk_put(struct clk *clk)
179{
180 __clk_put(clk);
181}
182EXPORT_SYMBOL(clk_put);
183
184void clkdev_add(struct clk_lookup *cl)
185{
186 mutex_lock(&clocks_mutex);
187 list_add_tail(&cl->node, &clocks);
188 mutex_unlock(&clocks_mutex);
189}
190EXPORT_SYMBOL(clkdev_add);
191
192void __init clkdev_add_table(struct clk_lookup *cl, size_t num)
193{
194 mutex_lock(&clocks_mutex);
195 while (num--) {
196 list_add_tail(&cl->node, &clocks);
197 cl++;
198 }
199 mutex_unlock(&clocks_mutex);
200}
201
202#define MAX_DEV_ID 20
203#define MAX_CON_ID 16
204
205struct clk_lookup_alloc {
206 struct clk_lookup cl;
207 char dev_id[MAX_DEV_ID];
208 char con_id[MAX_CON_ID];
209};
210
211static struct clk_lookup * __init_refok
212vclkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt,
213 va_list ap)
214{
215 struct clk_lookup_alloc *cla;
216
217 cla = __clkdev_alloc(sizeof(*cla));
218 if (!cla)
219 return NULL;
220
221 cla->cl.clk = clk;
222 if (con_id) {
223 strlcpy(cla->con_id, con_id, sizeof(cla->con_id));
224 cla->cl.con_id = cla->con_id;
225 }
226
227 if (dev_fmt) {
228 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
229 cla->cl.dev_id = cla->dev_id;
230 }
231
232 return &cla->cl;
233}
234
235struct clk_lookup * __init_refok
236clkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt, ...)
237{
238 struct clk_lookup *cl;
239 va_list ap;
240
241 va_start(ap, dev_fmt);
242 cl = vclkdev_alloc(clk, con_id, dev_fmt, ap);
243 va_end(ap);
244
245 return cl;
246}
247EXPORT_SYMBOL(clkdev_alloc);
248
249int clk_add_alias(const char *alias, const char *alias_dev_name, char *id,
250 struct device *dev)
251{
252 struct clk *r = clk_get(dev, id);
253 struct clk_lookup *l;
254
255 if (IS_ERR(r))
256 return PTR_ERR(r);
257
258 l = clkdev_alloc(r, alias, alias_dev_name);
259 clk_put(r);
260 if (!l)
261 return -ENODEV;
262 clkdev_add(l);
263 return 0;
264}
265EXPORT_SYMBOL(clk_add_alias);
266
267/*
268 * clkdev_drop - remove a clock dynamically allocated
269 */
270void clkdev_drop(struct clk_lookup *cl)
271{
272 mutex_lock(&clocks_mutex);
273 list_del(&cl->node);
274 mutex_unlock(&clocks_mutex);
275 kfree(cl);
276}
277EXPORT_SYMBOL(clkdev_drop);
278
279/**
280 * clk_register_clkdev - register one clock lookup for a struct clk
281 * @clk: struct clk to associate with all clk_lookups
282 * @con_id: connection ID string on device
283 * @dev_id: format string describing device name
284 *
285 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
286 * clkdev.
287 *
288 * To make things easier for mass registration, we detect error clks
289 * from a previous clk_register() call, and return the error code for
290 * those. This is to permit this function to be called immediately
291 * after clk_register().
292 */
293int clk_register_clkdev(struct clk *clk, const char *con_id,
294 const char *dev_fmt, ...)
295{
296 struct clk_lookup *cl;
297 va_list ap;
298
299 if (IS_ERR(clk))
300 return PTR_ERR(clk);
301
302 va_start(ap, dev_fmt);
303 cl = vclkdev_alloc(clk, con_id, dev_fmt, ap);
304 va_end(ap);
305
306 if (!cl)
307 return -ENOMEM;
308
309 clkdev_add(cl);
310
311 return 0;
312}
313
314/**
315 * clk_register_clkdevs - register a set of clk_lookup for a struct clk
316 * @clk: struct clk to associate with all clk_lookups
317 * @cl: array of clk_lookup structures with con_id and dev_id pre-initialized
318 * @num: number of clk_lookup structures to register
319 *
320 * To make things easier for mass registration, we detect error clks
321 * from a previous clk_register() call, and return the error code for
322 * those. This is to permit this function to be called immediately
323 * after clk_register().
324 */
325int clk_register_clkdevs(struct clk *clk, struct clk_lookup *cl, size_t num)
326{
327 unsigned i;
328
329 if (IS_ERR(clk))
330 return PTR_ERR(clk);
331
332 for (i = 0; i < num; i++, cl++) {
333 cl->clk = clk;
334 clkdev_add(cl);
335 }
336
337 return 0;
338}
339EXPORT_SYMBOL(clk_register_clkdevs);