Loading...
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
23static LIST_HEAD(clocks);
24static DEFINE_MUTEX(clocks_mutex);
25
26/*
27 * Find the correct struct clk for the device and connection ID.
28 * We do slightly fuzzy matching here:
29 * An entry with a NULL ID is assumed to be a wildcard.
30 * If an entry has a device ID, it must match
31 * If an entry has a connection ID, it must match
32 * Then we take the most specific entry - with the following
33 * order of precedence: dev+con > dev only > con only.
34 */
35static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
36{
37 struct clk_lookup *p, *cl = NULL;
38 int match, best_found = 0, best_possible = 0;
39
40 if (dev_id)
41 best_possible += 2;
42 if (con_id)
43 best_possible += 1;
44
45 list_for_each_entry(p, &clocks, node) {
46 match = 0;
47 if (p->dev_id) {
48 if (!dev_id || strcmp(p->dev_id, dev_id))
49 continue;
50 match += 2;
51 }
52 if (p->con_id) {
53 if (!con_id || strcmp(p->con_id, con_id))
54 continue;
55 match += 1;
56 }
57
58 if (match > best_found) {
59 cl = p;
60 if (match != best_possible)
61 best_found = match;
62 else
63 break;
64 }
65 }
66 return cl;
67}
68
69struct clk *clk_get_sys(const char *dev_id, const char *con_id)
70{
71 struct clk_lookup *cl;
72
73 mutex_lock(&clocks_mutex);
74 cl = clk_find(dev_id, con_id);
75 if (cl && !__clk_get(cl->clk))
76 cl = NULL;
77 mutex_unlock(&clocks_mutex);
78
79 return cl ? cl->clk : ERR_PTR(-ENOENT);
80}
81EXPORT_SYMBOL(clk_get_sys);
82
83struct clk *clk_get(struct device *dev, const char *con_id)
84{
85 const char *dev_id = dev ? dev_name(dev) : NULL;
86
87 return clk_get_sys(dev_id, con_id);
88}
89EXPORT_SYMBOL(clk_get);
90
91void clk_put(struct clk *clk)
92{
93 __clk_put(clk);
94}
95EXPORT_SYMBOL(clk_put);
96
97static void devm_clk_release(struct device *dev, void *res)
98{
99 clk_put(*(struct clk **)res);
100}
101
102struct clk *devm_clk_get(struct device *dev, const char *id)
103{
104 struct clk **ptr, *clk;
105
106 ptr = devres_alloc(devm_clk_release, sizeof(*ptr), GFP_KERNEL);
107 if (!ptr)
108 return ERR_PTR(-ENOMEM);
109
110 clk = clk_get(dev, id);
111 if (!IS_ERR(clk)) {
112 *ptr = clk;
113 devres_add(dev, ptr);
114 } else {
115 devres_free(ptr);
116 }
117
118 return clk;
119}
120EXPORT_SYMBOL(devm_clk_get);
121
122static int devm_clk_match(struct device *dev, void *res, void *data)
123{
124 struct clk **c = res;
125 if (!c || !*c) {
126 WARN_ON(!c || !*c);
127 return 0;
128 }
129 return *c == data;
130}
131
132void devm_clk_put(struct device *dev, struct clk *clk)
133{
134 int ret;
135
136 ret = devres_destroy(dev, devm_clk_release, devm_clk_match, clk);
137
138 WARN_ON(ret);
139}
140EXPORT_SYMBOL(devm_clk_put);
141
142void clkdev_add(struct clk_lookup *cl)
143{
144 mutex_lock(&clocks_mutex);
145 list_add_tail(&cl->node, &clocks);
146 mutex_unlock(&clocks_mutex);
147}
148EXPORT_SYMBOL(clkdev_add);
149
150void __init clkdev_add_table(struct clk_lookup *cl, size_t num)
151{
152 mutex_lock(&clocks_mutex);
153 while (num--) {
154 list_add_tail(&cl->node, &clocks);
155 cl++;
156 }
157 mutex_unlock(&clocks_mutex);
158}
159
160#define MAX_DEV_ID 20
161#define MAX_CON_ID 16
162
163struct clk_lookup_alloc {
164 struct clk_lookup cl;
165 char dev_id[MAX_DEV_ID];
166 char con_id[MAX_CON_ID];
167};
168
169static struct clk_lookup * __init_refok
170vclkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt,
171 va_list ap)
172{
173 struct clk_lookup_alloc *cla;
174
175 cla = __clkdev_alloc(sizeof(*cla));
176 if (!cla)
177 return NULL;
178
179 cla->cl.clk = clk;
180 if (con_id) {
181 strlcpy(cla->con_id, con_id, sizeof(cla->con_id));
182 cla->cl.con_id = cla->con_id;
183 }
184
185 if (dev_fmt) {
186 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
187 cla->cl.dev_id = cla->dev_id;
188 }
189
190 return &cla->cl;
191}
192
193struct clk_lookup * __init_refok
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, con_id, dev_fmt, ap);
201 va_end(ap);
202
203 return cl;
204}
205EXPORT_SYMBOL(clkdev_alloc);
206
207int clk_add_alias(const char *alias, const char *alias_dev_name, char *id,
208 struct device *dev)
209{
210 struct clk *r = clk_get(dev, id);
211 struct clk_lookup *l;
212
213 if (IS_ERR(r))
214 return PTR_ERR(r);
215
216 l = clkdev_alloc(r, alias, alias_dev_name);
217 clk_put(r);
218 if (!l)
219 return -ENODEV;
220 clkdev_add(l);
221 return 0;
222}
223EXPORT_SYMBOL(clk_add_alias);
224
225/*
226 * clkdev_drop - remove a clock dynamically allocated
227 */
228void clkdev_drop(struct clk_lookup *cl)
229{
230 mutex_lock(&clocks_mutex);
231 list_del(&cl->node);
232 mutex_unlock(&clocks_mutex);
233 kfree(cl);
234}
235EXPORT_SYMBOL(clkdev_drop);
236
237/**
238 * clk_register_clkdev - register one clock lookup for a struct clk
239 * @clk: struct clk to associate with all clk_lookups
240 * @con_id: connection ID string on device
241 * @dev_id: format string describing device name
242 *
243 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
244 * clkdev.
245 *
246 * To make things easier for mass registration, we detect error clks
247 * from a previous clk_register() call, and return the error code for
248 * those. This is to permit this function to be called immediately
249 * after clk_register().
250 */
251int clk_register_clkdev(struct clk *clk, const char *con_id,
252 const char *dev_fmt, ...)
253{
254 struct clk_lookup *cl;
255 va_list ap;
256
257 if (IS_ERR(clk))
258 return PTR_ERR(clk);
259
260 va_start(ap, dev_fmt);
261 cl = vclkdev_alloc(clk, con_id, dev_fmt, ap);
262 va_end(ap);
263
264 if (!cl)
265 return -ENOMEM;
266
267 clkdev_add(cl);
268
269 return 0;
270}
271
272/**
273 * clk_register_clkdevs - register a set of clk_lookup for a struct clk
274 * @clk: struct clk to associate with all clk_lookups
275 * @cl: array of clk_lookup structures with con_id and dev_id pre-initialized
276 * @num: number of clk_lookup structures to register
277 *
278 * To make things easier for mass registration, we detect error clks
279 * from a previous clk_register() call, and return the error code for
280 * those. This is to permit this function to be called immediately
281 * after clk_register().
282 */
283int clk_register_clkdevs(struct clk *clk, struct clk_lookup *cl, size_t num)
284{
285 unsigned i;
286
287 if (IS_ERR(clk))
288 return PTR_ERR(clk);
289
290 for (i = 0; i < num; i++, cl++) {
291 cl->clk = clk;
292 clkdev_add(cl);
293 }
294
295 return 0;
296}
297EXPORT_SYMBOL(clk_register_clkdevs);
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 24
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 struct va_format vaf;
162 const char *failure;
163 va_list ap_copy;
164 size_t max_size;
165 ssize_t res;
166
167 cla = kzalloc(sizeof(*cla), GFP_KERNEL);
168 if (!cla)
169 return NULL;
170
171 va_copy(ap_copy, ap);
172
173 cla->cl.clk_hw = hw;
174 if (con_id) {
175 res = strscpy(cla->con_id, con_id, sizeof(cla->con_id));
176 if (res < 0) {
177 max_size = sizeof(cla->con_id);
178 failure = "connection";
179 goto fail;
180 }
181 cla->cl.con_id = cla->con_id;
182 }
183
184 if (dev_fmt) {
185 res = vsnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
186 if (res >= sizeof(cla->dev_id)) {
187 max_size = sizeof(cla->dev_id);
188 failure = "device";
189 goto fail;
190 }
191 cla->cl.dev_id = cla->dev_id;
192 }
193
194 va_end(ap_copy);
195
196 return &cla->cl;
197
198fail:
199 if (dev_fmt)
200 vaf.fmt = dev_fmt;
201 else
202 vaf.fmt = "null-device";
203 vaf.va = &ap_copy;
204 pr_err("%pV:%s: %s ID is greater than %zu\n",
205 &vaf, con_id, failure, max_size);
206 va_end(ap_copy);
207
208 /*
209 * Don't fail in this case, but as the entry won't ever match just
210 * fill it with something that also won't match.
211 */
212 strscpy(cla->con_id, "bad", sizeof(cla->con_id));
213 strscpy(cla->dev_id, "bad", sizeof(cla->dev_id));
214
215 return &cla->cl;
216}
217
218static struct clk_lookup *
219vclkdev_create(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
220 va_list ap)
221{
222 struct clk_lookup *cl;
223
224 cl = vclkdev_alloc(hw, con_id, dev_fmt, ap);
225 if (cl)
226 __clkdev_add(cl);
227
228 return cl;
229}
230
231/**
232 * clkdev_create - allocate and add a clkdev lookup structure
233 * @clk: struct clk to associate with all clk_lookups
234 * @con_id: connection ID string on device
235 * @dev_fmt: format string describing device name
236 *
237 * Returns a clk_lookup structure, which can be later unregistered and
238 * freed.
239 */
240struct clk_lookup *clkdev_create(struct clk *clk, const char *con_id,
241 const char *dev_fmt, ...)
242{
243 struct clk_lookup *cl;
244 va_list ap;
245
246 va_start(ap, dev_fmt);
247 cl = vclkdev_create(__clk_get_hw(clk), con_id, dev_fmt, ap);
248 va_end(ap);
249
250 return cl;
251}
252EXPORT_SYMBOL_GPL(clkdev_create);
253
254/**
255 * clkdev_hw_create - allocate and add a clkdev lookup structure
256 * @hw: struct clk_hw to associate with all clk_lookups
257 * @con_id: connection ID string on device
258 * @dev_fmt: format string describing device name
259 *
260 * Returns a clk_lookup structure, which can be later unregistered and
261 * freed.
262 */
263struct clk_lookup *clkdev_hw_create(struct clk_hw *hw, const char *con_id,
264 const char *dev_fmt, ...)
265{
266 struct clk_lookup *cl;
267 va_list ap;
268
269 va_start(ap, dev_fmt);
270 cl = vclkdev_create(hw, con_id, dev_fmt, ap);
271 va_end(ap);
272
273 return cl;
274}
275EXPORT_SYMBOL_GPL(clkdev_hw_create);
276
277int clk_add_alias(const char *alias, const char *alias_dev_name,
278 const char *con_id, struct device *dev)
279{
280 struct clk *r = clk_get(dev, con_id);
281 struct clk_lookup *l;
282
283 if (IS_ERR(r))
284 return PTR_ERR(r);
285
286 l = clkdev_create(r, alias, alias_dev_name ? "%s" : NULL,
287 alias_dev_name);
288 clk_put(r);
289
290 return l ? 0 : -ENODEV;
291}
292EXPORT_SYMBOL(clk_add_alias);
293
294/*
295 * clkdev_drop - remove a clock dynamically allocated
296 */
297void clkdev_drop(struct clk_lookup *cl)
298{
299 mutex_lock(&clocks_mutex);
300 list_del(&cl->node);
301 mutex_unlock(&clocks_mutex);
302 kfree(cl);
303}
304EXPORT_SYMBOL(clkdev_drop);
305
306static struct clk_lookup *__clk_register_clkdev(struct clk_hw *hw,
307 const char *con_id,
308 const char *dev_id, ...)
309{
310 struct clk_lookup *cl;
311 va_list ap;
312
313 va_start(ap, dev_id);
314 cl = vclkdev_create(hw, con_id, dev_id, ap);
315 va_end(ap);
316
317 return cl;
318}
319
320static int do_clk_register_clkdev(struct clk_hw *hw,
321 struct clk_lookup **cl, const char *con_id, const char *dev_id)
322{
323 if (IS_ERR(hw))
324 return PTR_ERR(hw);
325 /*
326 * Since dev_id can be NULL, and NULL is handled specially, we must
327 * pass it as either a NULL format string, or with "%s".
328 */
329 if (dev_id)
330 *cl = __clk_register_clkdev(hw, con_id, "%s", dev_id);
331 else
332 *cl = __clk_register_clkdev(hw, con_id, NULL);
333
334 return *cl ? 0 : -ENOMEM;
335}
336
337/**
338 * clk_register_clkdev - register one clock lookup for a struct clk
339 * @clk: struct clk to associate with all clk_lookups
340 * @con_id: connection ID string on device
341 * @dev_id: string describing device name
342 *
343 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
344 * clkdev.
345 *
346 * To make things easier for mass registration, we detect error clks
347 * from a previous clk_register() call, and return the error code for
348 * those. This is to permit this function to be called immediately
349 * after clk_register().
350 */
351int clk_register_clkdev(struct clk *clk, const char *con_id,
352 const char *dev_id)
353{
354 struct clk_lookup *cl;
355
356 if (IS_ERR(clk))
357 return PTR_ERR(clk);
358
359 return do_clk_register_clkdev(__clk_get_hw(clk), &cl, con_id,
360 dev_id);
361}
362EXPORT_SYMBOL(clk_register_clkdev);
363
364/**
365 * clk_hw_register_clkdev - register one clock lookup for a struct clk_hw
366 * @hw: struct clk_hw to associate with all clk_lookups
367 * @con_id: connection ID string on device
368 * @dev_id: format string describing device name
369 *
370 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
371 * clkdev.
372 *
373 * To make things easier for mass registration, we detect error clk_hws
374 * from a previous clk_hw_register_*() call, and return the error code for
375 * those. This is to permit this function to be called immediately
376 * after clk_hw_register_*().
377 */
378int clk_hw_register_clkdev(struct clk_hw *hw, const char *con_id,
379 const char *dev_id)
380{
381 struct clk_lookup *cl;
382
383 return do_clk_register_clkdev(hw, &cl, con_id, dev_id);
384}
385EXPORT_SYMBOL(clk_hw_register_clkdev);
386
387static void devm_clkdev_release(void *res)
388{
389 clkdev_drop(res);
390}
391
392/**
393 * devm_clk_hw_register_clkdev - managed clk lookup registration for clk_hw
394 * @dev: device this lookup is bound
395 * @hw: struct clk_hw to associate with all clk_lookups
396 * @con_id: connection ID string on device
397 * @dev_id: format string describing device name
398 *
399 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
400 * clkdev.
401 *
402 * To make things easier for mass registration, we detect error clk_hws
403 * from a previous clk_hw_register_*() call, and return the error code for
404 * those. This is to permit this function to be called immediately
405 * after clk_hw_register_*().
406 */
407int devm_clk_hw_register_clkdev(struct device *dev, struct clk_hw *hw,
408 const char *con_id, const char *dev_id)
409{
410 struct clk_lookup *cl;
411 int rval;
412
413 rval = do_clk_register_clkdev(hw, &cl, con_id, dev_id);
414 if (rval)
415 return rval;
416
417 return devm_add_action_or_reset(dev, devm_clkdev_release, cl);
418}
419EXPORT_SYMBOL(devm_clk_hw_register_clkdev);