blob: 8c4435c53f09c255f83adb10426e254bc3cf485b [file] [log] [blame]
Russell King0318e692008-11-09 16:32:46 +00001/*
Jean-Christop PLAGNIOL-VILLARD6d803ba2010-11-17 10:04:33 +01002 * drivers/clk/clkdev.c
Russell King0318e692008-11-09 16:32:46 +00003 *
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>
Hartley Sweetenc0c60c42009-08-04 23:38:06 +010020#include <linux/clk.h>
Jean-Christop PLAGNIOL-VILLARD6d803ba2010-11-17 10:04:33 +010021#include <linux/clkdev.h>
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010022#include <linux/clk-provider.h>
Grant Likely766e6a42012-04-09 14:50:06 -050023#include <linux/of.h>
Russell King0318e692008-11-09 16:32:46 +000024
Sylwester Nawrocki3a3d2b02013-08-23 17:03:44 +020025#include "clk.h"
26
Russell King0318e692008-11-09 16:32:46 +000027static LIST_HEAD(clocks);
28static DEFINE_MUTEX(clocks_mutex);
29
Russell King409dc362009-01-24 10:14:37 +000030/*
31 * Find the correct struct clk for the device and connection ID.
32 * We do slightly fuzzy matching here:
33 * An entry with a NULL ID is assumed to be a wildcard.
34 * If an entry has a device ID, it must match
35 * If an entry has a connection ID, it must match
36 * Then we take the most specific entry - with the following
Uwe Kleine-König659431f2010-01-18 16:02:48 +010037 * order of precedence: dev+con > dev only > con only.
Russell King409dc362009-01-24 10:14:37 +000038 */
Russell Kinge8bf8df2011-04-30 10:14:08 +010039static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
Russell King0318e692008-11-09 16:32:46 +000040{
Russell Kinge8bf8df2011-04-30 10:14:08 +010041 struct clk_lookup *p, *cl = NULL;
viresh kumar67b50872012-04-19 04:23:25 +010042 int match, best_found = 0, best_possible = 0;
43
44 if (dev_id)
45 best_possible += 2;
46 if (con_id)
47 best_possible += 1;
Russell King0318e692008-11-09 16:32:46 +000048
49 list_for_each_entry(p, &clocks, node) {
Russell King0318e692008-11-09 16:32:46 +000050 match = 0;
Russell King409dc362009-01-24 10:14:37 +000051 if (p->dev_id) {
52 if (!dev_id || strcmp(p->dev_id, dev_id))
53 continue;
54 match += 2;
55 }
56 if (p->con_id) {
57 if (!con_id || strcmp(p->con_id, con_id))
58 continue;
59 match += 1;
60 }
Russell King0318e692008-11-09 16:32:46 +000061
viresh kumar67b50872012-04-19 04:23:25 +010062 if (match > best_found) {
Russell Kinge8bf8df2011-04-30 10:14:08 +010063 cl = p;
viresh kumar67b50872012-04-19 04:23:25 +010064 if (match != best_possible)
65 best_found = match;
viresh kumare4bf5be2010-03-09 11:54:30 +010066 else
67 break;
Russell King0318e692008-11-09 16:32:46 +000068 }
69 }
Russell Kinge8bf8df2011-04-30 10:14:08 +010070 return cl;
Russell King0318e692008-11-09 16:32:46 +000071}
72
Stephen Boydefa85042018-12-11 08:34:16 -080073static struct clk *__clk_get_sys(struct device *dev, const char *dev_id,
74 const char *con_id)
Russell King0318e692008-11-09 16:32:46 +000075{
Russell Kinge8bf8df2011-04-30 10:14:08 +010076 struct clk_lookup *cl;
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010077 struct clk *clk = NULL;
Russell King0318e692008-11-09 16:32:46 +000078
79 mutex_lock(&clocks_mutex);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010080
Russell Kinge8bf8df2011-04-30 10:14:08 +010081 cl = clk_find(dev_id, con_id);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010082 if (!cl)
83 goto out;
84
Stephen Boydefa85042018-12-11 08:34:16 -080085 clk = clk_hw_create_clk(dev, cl->clk_hw, dev_id, con_id);
Stephen Boyd73e0e492015-02-06 11:42:43 -080086 if (IS_ERR(clk))
Russell Kinge8bf8df2011-04-30 10:14:08 +010087 cl = NULL;
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010088out:
Russell King0318e692008-11-09 16:32:46 +000089 mutex_unlock(&clocks_mutex);
90
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010091 return cl ? clk : ERR_PTR(-ENOENT);
Russell King0318e692008-11-09 16:32:46 +000092}
Stephen Boydefa85042018-12-11 08:34:16 -080093
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}
Sascha Hauer05fd8e732009-03-07 12:55:49 +010098EXPORT_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;
Stephen Boyd44722872018-12-19 10:59:55 -0800103 struct clk_hw *hw;
Grant Likely766e6a42012-04-09 14:50:06 -0500104
Bartosz Golaszewski53ccb222018-06-28 15:42:20 +0100105 if (dev && dev->of_node) {
Stephen Boyd44722872018-12-19 10:59:55 -0800106 hw = of_clk_get_hw(dev->of_node, 0, con_id);
107 if (!IS_ERR(hw) || PTR_ERR(hw) == -EPROBE_DEFER)
Stephen Boydefa85042018-12-11 08:34:16 -0800108 return clk_hw_create_clk(dev, hw, dev_id, con_id);
Grant Likely766e6a42012-04-09 14:50:06 -0500109 }
Sascha Hauer05fd8e732009-03-07 12:55:49 +0100110
Stephen Boydefa85042018-12-11 08:34:16 -0800111 return __clk_get_sys(dev, dev_id, con_id);
Sascha Hauer05fd8e732009-03-07 12:55:49 +0100112}
Russell King0318e692008-11-09 16:32:46 +0000113EXPORT_SYMBOL(clk_get);
114
115void clk_put(struct clk *clk)
116{
117 __clk_put(clk);
118}
119EXPORT_SYMBOL(clk_put);
120
Russell Kingd5622a92015-03-02 15:45:41 +0000121static void __clkdev_add(struct clk_lookup *cl)
Russell King0318e692008-11-09 16:32:46 +0000122{
123 mutex_lock(&clocks_mutex);
124 list_add_tail(&cl->node, &clocks);
125 mutex_unlock(&clocks_mutex);
126}
Russell Kingd5622a92015-03-02 15:45:41 +0000127
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}
Russell King0318e692008-11-09 16:32:46 +0000134EXPORT_SYMBOL(clkdev_add);
135
Russell Kingfba3acd2015-03-10 14:34:00 +0000136void clkdev_add_table(struct clk_lookup *cl, size_t num)
Russell King0a0300d2010-01-12 12:28:00 +0000137{
138 mutex_lock(&clocks_mutex);
139 while (num--) {
Russell Kingd5622a92015-03-02 15:45:41 +0000140 cl->clk_hw = __clk_get_hw(cl->clk);
Russell King0a0300d2010-01-12 12:28:00 +0000141 list_add_tail(&cl->node, &clocks);
142 cl++;
143 }
144 mutex_unlock(&clocks_mutex);
145}
146
Russell King0318e692008-11-09 16:32:46 +0000147#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
Fabian Frederickbd721ea2016-08-02 14:03:33 -0700156static struct clk_lookup * __ref
Russell Kingd5622a92015-03-02 15:45:41 +0000157vclkdev_alloc(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
Russell Kinge9d7f402012-05-02 09:30:32 +0100158 va_list ap)
Russell King0318e692008-11-09 16:32:46 +0000159{
160 struct clk_lookup_alloc *cla;
161
Stephen Boyd0d4e3d002018-01-02 15:47:07 -0800162 cla = kzalloc(sizeof(*cla), GFP_KERNEL);
Russell King0318e692008-11-09 16:32:46 +0000163 if (!cla)
164 return NULL;
165
Russell Kingd5622a92015-03-02 15:45:41 +0000166 cla->cl.clk_hw = hw;
Russell King0318e692008-11-09 16:32:46 +0000167 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) {
Russell King0318e692008-11-09 16:32:46 +0000173 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
174 cla->cl.dev_id = cla->dev_id;
Russell King0318e692008-11-09 16:32:46 +0000175 }
176
177 return &cla->cl;
178}
Russell Kinge9d7f402012-05-02 09:30:32 +0100179
Russell King25689992015-03-02 15:40:29 +0000180static 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
Fabian Frederickbd721ea2016-08-02 14:03:33 -0700193struct clk_lookup * __ref
Russell Kinge9d7f402012-05-02 09:30:32 +0100194clkdev_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);
Russell Kingd5622a92015-03-02 15:45:41 +0000200 cl = vclkdev_alloc(__clk_get_hw(clk), con_id, dev_fmt, ap);
Russell Kinge9d7f402012-05-02 09:30:32 +0100201 va_end(ap);
202
203 return cl;
204}
Russell King0318e692008-11-09 16:32:46 +0000205EXPORT_SYMBOL(clkdev_alloc);
206
Stephen Boyde4f1b492016-02-08 14:59:49 -0800207struct 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
Russell King25689992015-03-02 15:40:29 +0000221/**
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
Stephen Boyde4f1b492016-02-08 14:59:49 -0800244/**
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
Russell Kingb3d8d7e2015-03-09 10:43:04 +0000267int clk_add_alias(const char *alias, const char *alias_dev_name,
268 const char *con_id, struct device *dev)
Tony Lindgrenc0683032009-06-03 17:43:14 +0100269{
Russell Kingb3d8d7e2015-03-09 10:43:04 +0000270 struct clk *r = clk_get(dev, con_id);
Tony Lindgrenc0683032009-06-03 17:43:14 +0100271 struct clk_lookup *l;
272
273 if (IS_ERR(r))
274 return PTR_ERR(r);
275
Russell King625faa62015-10-20 11:49:44 +0100276 l = clkdev_create(r, alias, alias_dev_name ? "%s" : NULL,
277 alias_dev_name);
Tony Lindgrenc0683032009-06-03 17:43:14 +0100278 clk_put(r);
Russell King25689992015-03-02 15:40:29 +0000279
280 return l ? 0 : -ENODEV;
Tony Lindgrenc0683032009-06-03 17:43:14 +0100281}
282EXPORT_SYMBOL(clk_add_alias);
283
Russell King0318e692008-11-09 16:32:46 +0000284/*
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);
Russell Kinge9d7f402012-05-02 09:30:32 +0100295
Kees Cook416dd132016-01-26 01:21:26 +0100296static 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
Matti Vaittinen3eee6c72018-12-07 13:09:39 +0200310static 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
Russell Kinge9d7f402012-05-02 09:30:32 +0100327/**
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
Kees Cook416dd132016-01-26 01:21:26 +0100331 * @dev_id: string describing device name
Russell Kinge9d7f402012-05-02 09:30:32 +0100332 *
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,
Kees Cook416dd132016-01-26 01:21:26 +0100342 const char *dev_id)
Russell Kinge9d7f402012-05-02 09:30:32 +0100343{
344 struct clk_lookup *cl;
Russell Kinge9d7f402012-05-02 09:30:32 +0100345
346 if (IS_ERR(clk))
347 return PTR_ERR(clk);
348
Matti Vaittinen3eee6c72018-12-07 13:09:39 +0200349 return do_clk_register_clkdev(__clk_get_hw(clk), &cl, con_id,
350 dev_id);
Russell Kinge9d7f402012-05-02 09:30:32 +0100351}
Tomeu Vizosoa251361a2015-01-23 12:03:32 +0100352EXPORT_SYMBOL(clk_register_clkdev);
Stephen Boyde4f1b492016-02-08 14:59:49 -0800353
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.
Geert Uytterhoeven93880932016-11-22 12:33:11 +0100362 *
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_*().
Stephen Boyde4f1b492016-02-08 14:59:49 -0800367 */
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
Matti Vaittinen3eee6c72018-12-07 13:09:39 +0200373 return do_clk_register_clkdev(hw, &cl, con_id, dev_id);
Stephen Boyde4f1b492016-02-08 14:59:49 -0800374}
375EXPORT_SYMBOL(clk_hw_register_clkdev);
Matti Vaittinen3eee6c72018-12-07 13:09:39 +0200376
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 cl = clk_find(dev_id, con_id);
406 WARN_ON(!cl);
407 rval = devres_release(dev, devm_clkdev_release,
408 devm_clk_match_clkdev, cl);
409 WARN_ON(rval);
410}
411EXPORT_SYMBOL(devm_clk_release_clkdev);
412
413/**
414 * devm_clk_hw_register_clkdev - managed clk lookup registration for clk_hw
415 * @dev: device this lookup is bound
416 * @hw: struct clk_hw to associate with all clk_lookups
417 * @con_id: connection ID string on device
418 * @dev_id: format string describing device name
419 *
420 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
421 * clkdev.
422 *
423 * To make things easier for mass registration, we detect error clk_hws
424 * from a previous clk_hw_register_*() call, and return the error code for
425 * those. This is to permit this function to be called immediately
426 * after clk_hw_register_*().
427 */
428int devm_clk_hw_register_clkdev(struct device *dev, struct clk_hw *hw,
429 const char *con_id, const char *dev_id)
430{
431 int rval = -ENOMEM;
432 struct clk_lookup **cl;
433
434 cl = devres_alloc(devm_clkdev_release, sizeof(*cl), GFP_KERNEL);
435 if (cl) {
436 rval = do_clk_register_clkdev(hw, cl, con_id, dev_id);
437 if (!rval)
438 devres_add(dev, cl);
439 else
440 devres_free(cl);
441 }
442 return rval;
443}
444EXPORT_SYMBOL(devm_clk_hw_register_clkdev);