blob: bb8a77a5985f8627e6ea396298745c9b6c7eaf77 [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
Rob Herring137f8a72012-07-18 11:52:23 +080030#if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
Stephen Boyd73e0e492015-02-06 11:42:43 -080031static struct clk *__of_clk_get(struct device_node *np, int index,
32 const char *dev_id, const char *con_id)
Grant Likely766e6a42012-04-09 14:50:06 -050033{
34 struct of_phandle_args clkspec;
35 struct clk *clk;
36 int rc;
37
38 if (index < 0)
39 return ERR_PTR(-EINVAL);
40
41 rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index,
42 &clkspec);
43 if (rc)
44 return ERR_PTR(rc);
45
Stephen Boyd306c3422015-02-05 15:39:11 -080046 clk = __of_clk_get_from_provider(&clkspec, dev_id, con_id);
Grant Likely766e6a42012-04-09 14:50:06 -050047 of_node_put(clkspec.np);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010048
49 return clk;
50}
51
52struct clk *of_clk_get(struct device_node *np, int index)
53{
Stephen Boyd73e0e492015-02-06 11:42:43 -080054 return __of_clk_get(np, index, np->full_name, NULL);
Grant Likely766e6a42012-04-09 14:50:06 -050055}
56EXPORT_SYMBOL(of_clk_get);
57
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010058static struct clk *__of_clk_get_by_name(struct device_node *np,
59 const char *dev_id,
60 const char *name)
Grant Likely766e6a42012-04-09 14:50:06 -050061{
62 struct clk *clk = ERR_PTR(-ENOENT);
63
64 /* Walk up the tree of devices looking for a clock that matches */
65 while (np) {
66 int index = 0;
67
68 /*
69 * For named clocks, first look up the name in the
70 * "clock-names" property. If it cannot be found, then
71 * index will be an error code, and of_clk_get() will fail.
72 */
73 if (name)
74 index = of_property_match_string(np, "clock-names", name);
Stephen Boyd73e0e492015-02-06 11:42:43 -080075 clk = __of_clk_get(np, index, dev_id, name);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010076 if (!IS_ERR(clk)) {
Grant Likely766e6a42012-04-09 14:50:06 -050077 break;
Stephen Boyd73e0e492015-02-06 11:42:43 -080078 } else if (name && index >= 0) {
Stephen Boydd8e53c32014-06-13 16:36:31 -070079 if (PTR_ERR(clk) != -EPROBE_DEFER)
80 pr_err("ERROR: could not get clock %s:%s(%i)\n",
81 np->full_name, name ? name : "", index);
Grant Likely766e6a42012-04-09 14:50:06 -050082 return clk;
83 }
84
85 /*
86 * No matching clock found on this node. If the parent node
87 * has a "clock-ranges" property, then we can try one of its
88 * clocks.
89 */
90 np = np->parent;
91 if (np && !of_get_property(np, "clock-ranges", NULL))
92 break;
93 }
94
95 return clk;
96}
Tomeu Vizoso035a61c2015-01-23 12:03:30 +010097
98/**
99 * of_clk_get_by_name() - Parse and lookup a clock referenced by a device node
100 * @np: pointer to clock consumer node
101 * @name: name of consumer's clock input, or NULL for the first clock reference
102 *
103 * This function parses the clocks and clock-names properties,
104 * and uses them to look up the struct clk from the registered list of clock
105 * providers.
106 */
107struct clk *of_clk_get_by_name(struct device_node *np, const char *name)
108{
109 if (!np)
110 return ERR_PTR(-ENOENT);
111
112 return __of_clk_get_by_name(np, np->full_name, name);
113}
Grant Likely766e6a42012-04-09 14:50:06 -0500114EXPORT_SYMBOL(of_clk_get_by_name);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100115
116#else /* defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK) */
117
118static struct clk *__of_clk_get_by_name(struct device_node *np,
119 const char *dev_id,
120 const char *name)
121{
122 return ERR_PTR(-ENOENT);
123}
Grant Likely766e6a42012-04-09 14:50:06 -0500124#endif
125
Russell King409dc362009-01-24 10:14:37 +0000126/*
127 * Find the correct struct clk for the device and connection ID.
128 * We do slightly fuzzy matching here:
129 * An entry with a NULL ID is assumed to be a wildcard.
130 * If an entry has a device ID, it must match
131 * If an entry has a connection ID, it must match
132 * Then we take the most specific entry - with the following
Uwe Kleine-König659431f2010-01-18 16:02:48 +0100133 * order of precedence: dev+con > dev only > con only.
Russell King409dc362009-01-24 10:14:37 +0000134 */
Russell Kinge8bf8df2011-04-30 10:14:08 +0100135static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
Russell King0318e692008-11-09 16:32:46 +0000136{
Russell Kinge8bf8df2011-04-30 10:14:08 +0100137 struct clk_lookup *p, *cl = NULL;
viresh kumar67b50872012-04-19 04:23:25 +0100138 int match, best_found = 0, best_possible = 0;
139
140 if (dev_id)
141 best_possible += 2;
142 if (con_id)
143 best_possible += 1;
Russell King0318e692008-11-09 16:32:46 +0000144
145 list_for_each_entry(p, &clocks, node) {
Russell King0318e692008-11-09 16:32:46 +0000146 match = 0;
Russell King409dc362009-01-24 10:14:37 +0000147 if (p->dev_id) {
148 if (!dev_id || strcmp(p->dev_id, dev_id))
149 continue;
150 match += 2;
151 }
152 if (p->con_id) {
153 if (!con_id || strcmp(p->con_id, con_id))
154 continue;
155 match += 1;
156 }
Russell King0318e692008-11-09 16:32:46 +0000157
viresh kumar67b50872012-04-19 04:23:25 +0100158 if (match > best_found) {
Russell Kinge8bf8df2011-04-30 10:14:08 +0100159 cl = p;
viresh kumar67b50872012-04-19 04:23:25 +0100160 if (match != best_possible)
161 best_found = match;
viresh kumare4bf5be2010-03-09 11:54:30 +0100162 else
163 break;
Russell King0318e692008-11-09 16:32:46 +0000164 }
165 }
Russell Kinge8bf8df2011-04-30 10:14:08 +0100166 return cl;
Russell King0318e692008-11-09 16:32:46 +0000167}
168
Sascha Hauer05fd8e72009-03-07 12:55:49 +0100169struct clk *clk_get_sys(const char *dev_id, const char *con_id)
Russell King0318e692008-11-09 16:32:46 +0000170{
Russell Kinge8bf8df2011-04-30 10:14:08 +0100171 struct clk_lookup *cl;
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100172 struct clk *clk = NULL;
Russell King0318e692008-11-09 16:32:46 +0000173
174 mutex_lock(&clocks_mutex);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100175
Russell Kinge8bf8df2011-04-30 10:14:08 +0100176 cl = clk_find(dev_id, con_id);
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100177 if (!cl)
178 goto out;
179
Russell Kingd5622a92015-03-02 15:45:41 +0000180 clk = __clk_create_clk(cl->clk_hw, dev_id, con_id);
Stephen Boyd73e0e492015-02-06 11:42:43 -0800181 if (IS_ERR(clk))
182 goto out;
183
184 if (!__clk_get(clk)) {
185 __clk_free_clk(clk);
Russell Kinge8bf8df2011-04-30 10:14:08 +0100186 cl = NULL;
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100187 goto out;
188 }
189
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100190out:
Russell King0318e692008-11-09 16:32:46 +0000191 mutex_unlock(&clocks_mutex);
192
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100193 return cl ? clk : ERR_PTR(-ENOENT);
Russell King0318e692008-11-09 16:32:46 +0000194}
Sascha Hauer05fd8e72009-03-07 12:55:49 +0100195EXPORT_SYMBOL(clk_get_sys);
196
197struct clk *clk_get(struct device *dev, const char *con_id)
198{
199 const char *dev_id = dev ? dev_name(dev) : NULL;
Grant Likely766e6a42012-04-09 14:50:06 -0500200 struct clk *clk;
201
202 if (dev) {
Tomeu Vizoso035a61c2015-01-23 12:03:30 +0100203 clk = __of_clk_get_by_name(dev->of_node, dev_id, con_id);
204 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
Jean-Francois Moinea34cd462013-11-25 19:47:04 +0100205 return clk;
Grant Likely766e6a42012-04-09 14:50:06 -0500206 }
Sascha Hauer05fd8e72009-03-07 12:55:49 +0100207
208 return clk_get_sys(dev_id, con_id);
209}
Russell King0318e692008-11-09 16:32:46 +0000210EXPORT_SYMBOL(clk_get);
211
212void clk_put(struct clk *clk)
213{
214 __clk_put(clk);
215}
216EXPORT_SYMBOL(clk_put);
217
Russell Kingd5622a92015-03-02 15:45:41 +0000218static void __clkdev_add(struct clk_lookup *cl)
Russell King0318e692008-11-09 16:32:46 +0000219{
220 mutex_lock(&clocks_mutex);
221 list_add_tail(&cl->node, &clocks);
222 mutex_unlock(&clocks_mutex);
223}
Russell Kingd5622a92015-03-02 15:45:41 +0000224
225void clkdev_add(struct clk_lookup *cl)
226{
227 if (!cl->clk_hw)
228 cl->clk_hw = __clk_get_hw(cl->clk);
229 __clkdev_add(cl);
230}
Russell King0318e692008-11-09 16:32:46 +0000231EXPORT_SYMBOL(clkdev_add);
232
Russell Kingfba3acd2015-03-10 14:34:00 +0000233void clkdev_add_table(struct clk_lookup *cl, size_t num)
Russell King0a0300d2010-01-12 12:28:00 +0000234{
235 mutex_lock(&clocks_mutex);
236 while (num--) {
Russell Kingd5622a92015-03-02 15:45:41 +0000237 cl->clk_hw = __clk_get_hw(cl->clk);
Russell King0a0300d2010-01-12 12:28:00 +0000238 list_add_tail(&cl->node, &clocks);
239 cl++;
240 }
241 mutex_unlock(&clocks_mutex);
242}
243
Russell King0318e692008-11-09 16:32:46 +0000244#define MAX_DEV_ID 20
245#define MAX_CON_ID 16
246
247struct clk_lookup_alloc {
248 struct clk_lookup cl;
249 char dev_id[MAX_DEV_ID];
250 char con_id[MAX_CON_ID];
251};
252
Fabian Frederickbd721ea2016-08-02 14:03:33 -0700253static struct clk_lookup * __ref
Russell Kingd5622a92015-03-02 15:45:41 +0000254vclkdev_alloc(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
Russell Kinge9d7f402012-05-02 09:30:32 +0100255 va_list ap)
Russell King0318e692008-11-09 16:32:46 +0000256{
257 struct clk_lookup_alloc *cla;
258
Jean-Christop PLAGNIOL-VILLARD6d803ba2010-11-17 10:04:33 +0100259 cla = __clkdev_alloc(sizeof(*cla));
Russell King0318e692008-11-09 16:32:46 +0000260 if (!cla)
261 return NULL;
262
Russell Kingd5622a92015-03-02 15:45:41 +0000263 cla->cl.clk_hw = hw;
Russell King0318e692008-11-09 16:32:46 +0000264 if (con_id) {
265 strlcpy(cla->con_id, con_id, sizeof(cla->con_id));
266 cla->cl.con_id = cla->con_id;
267 }
268
269 if (dev_fmt) {
Russell King0318e692008-11-09 16:32:46 +0000270 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
271 cla->cl.dev_id = cla->dev_id;
Russell King0318e692008-11-09 16:32:46 +0000272 }
273
274 return &cla->cl;
275}
Russell Kinge9d7f402012-05-02 09:30:32 +0100276
Russell King25689992015-03-02 15:40:29 +0000277static struct clk_lookup *
278vclkdev_create(struct clk_hw *hw, const char *con_id, const char *dev_fmt,
279 va_list ap)
280{
281 struct clk_lookup *cl;
282
283 cl = vclkdev_alloc(hw, con_id, dev_fmt, ap);
284 if (cl)
285 __clkdev_add(cl);
286
287 return cl;
288}
289
Fabian Frederickbd721ea2016-08-02 14:03:33 -0700290struct clk_lookup * __ref
Russell Kinge9d7f402012-05-02 09:30:32 +0100291clkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt, ...)
292{
293 struct clk_lookup *cl;
294 va_list ap;
295
296 va_start(ap, dev_fmt);
Russell Kingd5622a92015-03-02 15:45:41 +0000297 cl = vclkdev_alloc(__clk_get_hw(clk), con_id, dev_fmt, ap);
Russell Kinge9d7f402012-05-02 09:30:32 +0100298 va_end(ap);
299
300 return cl;
301}
Russell King0318e692008-11-09 16:32:46 +0000302EXPORT_SYMBOL(clkdev_alloc);
303
Stephen Boyde4f1b492016-02-08 14:59:49 -0800304struct clk_lookup *
305clkdev_hw_alloc(struct clk_hw *hw, const char *con_id, const char *dev_fmt, ...)
306{
307 struct clk_lookup *cl;
308 va_list ap;
309
310 va_start(ap, dev_fmt);
311 cl = vclkdev_alloc(hw, con_id, dev_fmt, ap);
312 va_end(ap);
313
314 return cl;
315}
316EXPORT_SYMBOL(clkdev_hw_alloc);
317
Russell King25689992015-03-02 15:40:29 +0000318/**
319 * clkdev_create - allocate and add a clkdev lookup structure
320 * @clk: struct clk to associate with all clk_lookups
321 * @con_id: connection ID string on device
322 * @dev_fmt: format string describing device name
323 *
324 * Returns a clk_lookup structure, which can be later unregistered and
325 * freed.
326 */
327struct clk_lookup *clkdev_create(struct clk *clk, const char *con_id,
328 const char *dev_fmt, ...)
329{
330 struct clk_lookup *cl;
331 va_list ap;
332
333 va_start(ap, dev_fmt);
334 cl = vclkdev_create(__clk_get_hw(clk), con_id, dev_fmt, ap);
335 va_end(ap);
336
337 return cl;
338}
339EXPORT_SYMBOL_GPL(clkdev_create);
340
Stephen Boyde4f1b492016-02-08 14:59:49 -0800341/**
342 * clkdev_hw_create - allocate and add a clkdev lookup structure
343 * @hw: struct clk_hw to associate with all clk_lookups
344 * @con_id: connection ID string on device
345 * @dev_fmt: format string describing device name
346 *
347 * Returns a clk_lookup structure, which can be later unregistered and
348 * freed.
349 */
350struct clk_lookup *clkdev_hw_create(struct clk_hw *hw, const char *con_id,
351 const char *dev_fmt, ...)
352{
353 struct clk_lookup *cl;
354 va_list ap;
355
356 va_start(ap, dev_fmt);
357 cl = vclkdev_create(hw, con_id, dev_fmt, ap);
358 va_end(ap);
359
360 return cl;
361}
362EXPORT_SYMBOL_GPL(clkdev_hw_create);
363
Russell Kingb3d8d7e2015-03-09 10:43:04 +0000364int clk_add_alias(const char *alias, const char *alias_dev_name,
365 const char *con_id, struct device *dev)
Tony Lindgrenc0683032009-06-03 17:43:14 +0100366{
Russell Kingb3d8d7e2015-03-09 10:43:04 +0000367 struct clk *r = clk_get(dev, con_id);
Tony Lindgrenc0683032009-06-03 17:43:14 +0100368 struct clk_lookup *l;
369
370 if (IS_ERR(r))
371 return PTR_ERR(r);
372
Russell King625faa62015-10-20 11:49:44 +0100373 l = clkdev_create(r, alias, alias_dev_name ? "%s" : NULL,
374 alias_dev_name);
Tony Lindgrenc0683032009-06-03 17:43:14 +0100375 clk_put(r);
Russell King25689992015-03-02 15:40:29 +0000376
377 return l ? 0 : -ENODEV;
Tony Lindgrenc0683032009-06-03 17:43:14 +0100378}
379EXPORT_SYMBOL(clk_add_alias);
380
Russell King0318e692008-11-09 16:32:46 +0000381/*
382 * clkdev_drop - remove a clock dynamically allocated
383 */
384void clkdev_drop(struct clk_lookup *cl)
385{
386 mutex_lock(&clocks_mutex);
387 list_del(&cl->node);
388 mutex_unlock(&clocks_mutex);
389 kfree(cl);
390}
391EXPORT_SYMBOL(clkdev_drop);
Russell Kinge9d7f402012-05-02 09:30:32 +0100392
Kees Cook416dd132016-01-26 01:21:26 +0100393static struct clk_lookup *__clk_register_clkdev(struct clk_hw *hw,
394 const char *con_id,
395 const char *dev_id, ...)
396{
397 struct clk_lookup *cl;
398 va_list ap;
399
400 va_start(ap, dev_id);
401 cl = vclkdev_create(hw, con_id, dev_id, ap);
402 va_end(ap);
403
404 return cl;
405}
406
Russell Kinge9d7f402012-05-02 09:30:32 +0100407/**
408 * clk_register_clkdev - register one clock lookup for a struct clk
409 * @clk: struct clk to associate with all clk_lookups
410 * @con_id: connection ID string on device
Kees Cook416dd132016-01-26 01:21:26 +0100411 * @dev_id: string describing device name
Russell Kinge9d7f402012-05-02 09:30:32 +0100412 *
413 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
414 * clkdev.
415 *
416 * To make things easier for mass registration, we detect error clks
417 * from a previous clk_register() call, and return the error code for
418 * those. This is to permit this function to be called immediately
419 * after clk_register().
420 */
421int clk_register_clkdev(struct clk *clk, const char *con_id,
Kees Cook416dd132016-01-26 01:21:26 +0100422 const char *dev_id)
Russell Kinge9d7f402012-05-02 09:30:32 +0100423{
424 struct clk_lookup *cl;
Russell Kinge9d7f402012-05-02 09:30:32 +0100425
426 if (IS_ERR(clk))
427 return PTR_ERR(clk);
428
Kees Cook416dd132016-01-26 01:21:26 +0100429 /*
430 * Since dev_id can be NULL, and NULL is handled specially, we must
431 * pass it as either a NULL format string, or with "%s".
432 */
433 if (dev_id)
434 cl = __clk_register_clkdev(__clk_get_hw(clk), con_id, "%s",
435 dev_id);
436 else
437 cl = __clk_register_clkdev(__clk_get_hw(clk), con_id, NULL);
Russell Kinge9d7f402012-05-02 09:30:32 +0100438
Russell King25689992015-03-02 15:40:29 +0000439 return cl ? 0 : -ENOMEM;
Russell Kinge9d7f402012-05-02 09:30:32 +0100440}
Tomeu Vizosoa251361a2015-01-23 12:03:32 +0100441EXPORT_SYMBOL(clk_register_clkdev);
Stephen Boyde4f1b492016-02-08 14:59:49 -0800442
443/**
444 * clk_hw_register_clkdev - register one clock lookup for a struct clk_hw
445 * @hw: struct clk_hw to associate with all clk_lookups
446 * @con_id: connection ID string on device
447 * @dev_id: format string describing device name
448 *
449 * con_id or dev_id may be NULL as a wildcard, just as in the rest of
450 * clkdev.
Geert Uytterhoevenb8ba5fa2016-11-22 12:33:11 +0100451 *
452 * To make things easier for mass registration, we detect error clk_hws
453 * from a previous clk_hw_register_*() call, and return the error code for
454 * those. This is to permit this function to be called immediately
455 * after clk_hw_register_*().
Stephen Boyde4f1b492016-02-08 14:59:49 -0800456 */
457int clk_hw_register_clkdev(struct clk_hw *hw, const char *con_id,
458 const char *dev_id)
459{
460 struct clk_lookup *cl;
461
Geert Uytterhoevenb8ba5fa2016-11-22 12:33:11 +0100462 if (IS_ERR(hw))
463 return PTR_ERR(hw);
464
Stephen Boyde4f1b492016-02-08 14:59:49 -0800465 /*
466 * Since dev_id can be NULL, and NULL is handled specially, we must
467 * pass it as either a NULL format string, or with "%s".
468 */
469 if (dev_id)
470 cl = __clk_register_clkdev(hw, con_id, "%s", dev_id);
471 else
472 cl = __clk_register_clkdev(hw, con_id, NULL);
473
474 return cl ? 0 : -ENOMEM;
475}
476EXPORT_SYMBOL(clk_hw_register_clkdev);