1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
5 * Copyright (c) 2016, NVIDIA CORPORATION.
6 * Copyright (c) 2018, Theobroma Systems Design und Consulting GmbH
11 #include <clk-uclass.h>
13 #include <dt-structs.h>
17 #include <dm/device-internal.h>
18 #include <dm/devres.h>
20 #include <linux/bug.h>
21 #include <linux/clk-provider.h>
22 #include <linux/err.h>
23 #include <asm/global_data.h>
25 static inline const struct clk_ops *clk_dev_ops(struct udevice *dev)
27 return (const struct clk_ops *)dev->driver->ops;
30 struct clk *dev_get_clk_ptr(struct udevice *dev)
32 return (struct clk *)dev_get_uclass_priv(dev);
35 #if CONFIG_IS_ENABLED(OF_CONTROL)
36 # if CONFIG_IS_ENABLED(OF_PLATDATA)
37 int clk_get_by_driver_info(struct udevice *dev, struct phandle_1_arg *cells,
42 ret = device_get_by_driver_info_idx(cells->idx, &clk->dev);
45 clk->id = cells->arg[0];
50 static int clk_of_xlate_default(struct clk *clk,
51 struct ofnode_phandle_args *args)
53 debug("%s(clk=%p)\n", __func__, clk);
55 if (args->args_count > 1) {
56 debug("Invaild args_count: %d\n", args->args_count);
61 clk->id = args->args[0];
70 static int clk_get_by_index_tail(int ret, ofnode node,
71 struct ofnode_phandle_args *args,
72 const char *list_name, int index,
75 struct udevice *dev_clk;
76 const struct clk_ops *ops;
83 ret = uclass_get_device_by_ofnode(UCLASS_CLK, args->node, &dev_clk);
85 debug("%s: uclass_get_device_by_of_offset failed: err=%d\n",
87 return log_msg_ret("get", ret);
92 ops = clk_dev_ops(dev_clk);
95 ret = ops->of_xlate(clk, args);
97 ret = clk_of_xlate_default(clk, args);
99 debug("of_xlate() failed: %d\n", ret);
100 return log_msg_ret("xlate", ret);
103 return clk_request(dev_clk, clk);
105 debug("%s: Node '%s', property '%s', failed to request CLK index %d: %d\n",
106 __func__, ofnode_get_name(node), list_name, index, ret);
108 return log_msg_ret("prop", ret);
111 static int clk_get_by_indexed_prop(struct udevice *dev, const char *prop_name,
112 int index, struct clk *clk)
115 struct ofnode_phandle_args args;
117 debug("%s(dev=%p, index=%d, clk=%p)\n", __func__, dev, index, clk);
122 ret = dev_read_phandle_with_args(dev, prop_name, "#clock-cells", 0,
125 debug("%s: fdtdec_parse_phandle_with_args failed: err=%d\n",
131 return clk_get_by_index_tail(ret, dev_ofnode(dev), &args, "clocks",
135 int clk_get_by_index(struct udevice *dev, int index, struct clk *clk)
137 struct ofnode_phandle_args args;
140 ret = dev_read_phandle_with_args(dev, "clocks", "#clock-cells", 0,
143 return clk_get_by_index_tail(ret, dev_ofnode(dev), &args, "clocks",
147 int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk)
149 struct ofnode_phandle_args args;
152 ret = ofnode_parse_phandle_with_args(node, "clocks", "#clock-cells", 0,
155 return clk_get_by_index_tail(ret, node, &args, "clocks",
159 int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
161 int i, ret, err, count;
165 count = dev_count_phandle_with_args(dev, "clocks", "#clock-cells", 0);
169 bulk->clks = devm_kcalloc(dev, count, sizeof(struct clk), GFP_KERNEL);
173 for (i = 0; i < count; i++) {
174 ret = clk_get_by_index(dev, i, &bulk->clks[i]);
184 err = clk_release_all(bulk->clks, bulk->count);
186 debug("%s: could release all clocks for %p\n",
192 static struct clk *clk_set_default_get_by_id(struct clk *clk)
196 if (CONFIG_IS_ENABLED(CLK_CCF)) {
197 int ret = clk_get_by_id(clk->id, &c);
200 debug("%s(): could not get parent clock pointer, id %lu\n",
209 static int clk_set_default_parents(struct udevice *dev, int stage)
211 struct clk clk, parent_clk, *c, *p;
216 num_parents = dev_count_phandle_with_args(dev, "assigned-clock-parents",
218 if (num_parents < 0) {
219 debug("%s: could not read assigned-clock-parents for %p\n",
224 for (index = 0; index < num_parents; index++) {
225 ret = clk_get_by_indexed_prop(dev, "assigned-clock-parents",
227 /* If -ENOENT, this is a no-op entry */
232 debug("%s: could not get parent clock %d for %s\n",
233 __func__, index, dev_read_name(dev));
237 p = clk_set_default_get_by_id(&parent_clk);
241 ret = clk_get_by_indexed_prop(dev, "assigned-clocks",
244 debug("%s: could not get assigned clock %d for %s\n",
245 __func__, index, dev_read_name(dev));
249 /* This is clk provider device trying to reparent itself
250 * It cannot be done right now but need to wait after the
253 if (stage == 0 && clk.dev == dev)
256 if (stage > 0 && clk.dev != dev)
257 /* do not setup twice the parent clocks */
260 c = clk_set_default_get_by_id(&clk);
264 ret = clk_set_parent(c, p);
266 * Not all drivers may support clock-reparenting (as of now).
267 * Ignore errors due to this.
273 debug("%s: failed to reparent clock %d for %s\n",
274 __func__, index, dev_read_name(dev));
282 static int clk_set_default_rates(struct udevice *dev, int stage)
291 size = dev_read_size(dev, "assigned-clock-rates");
295 num_rates = size / sizeof(u32);
296 rates = calloc(num_rates, sizeof(u32));
300 ret = dev_read_u32_array(dev, "assigned-clock-rates", rates, num_rates);
304 for (index = 0; index < num_rates; index++) {
305 /* If 0 is passed, this is a no-op */
309 ret = clk_get_by_indexed_prop(dev, "assigned-clocks",
312 debug("%s: could not get assigned clock %d for %s\n",
313 __func__, index, dev_read_name(dev));
317 /* This is clk provider device trying to program itself
318 * It cannot be done right now but need to wait after the
321 if (stage == 0 && clk.dev == dev)
324 if (stage > 0 && clk.dev != dev)
325 /* do not setup twice the parent clocks */
328 c = clk_set_default_get_by_id(&clk);
332 ret = clk_set_rate(c, rates[index]);
335 debug("%s: failed to set rate on clock index %d (%ld) for %s\n",
336 __func__, index, clk.id, dev_read_name(dev));
346 int clk_set_defaults(struct udevice *dev, int stage)
350 if (!dev_has_ofnode(dev))
353 /* If this not in SPL and pre-reloc state, don't take any action. */
354 if (!(IS_ENABLED(CONFIG_SPL_BUILD) || (gd->flags & GD_FLG_RELOC)))
357 debug("%s(%s)\n", __func__, dev_read_name(dev));
359 ret = clk_set_default_parents(dev, stage);
363 ret = clk_set_default_rates(dev, stage);
370 int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk)
374 debug("%s(dev=%p, name=%s, clk=%p)\n", __func__, dev, name, clk);
377 index = dev_read_stringlist_search(dev, "clock-names", name);
379 debug("fdt_stringlist_search() failed: %d\n", index);
383 return clk_get_by_index(dev, index, clk);
385 # endif /* OF_PLATDATA */
387 int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk)
391 debug("%s(node=%p, name=%s, clk=%p)\n", __func__,
392 ofnode_get_name(node), name, clk);
395 index = ofnode_stringlist_search(node, "clock-names", name);
397 debug("fdt_stringlist_search() failed: %d\n", index);
401 return clk_get_by_index_nodev(node, index, clk);
404 int clk_get_optional_nodev(ofnode node, const char *name, struct clk *clk)
408 ret = clk_get_by_name_nodev(node, name, clk);
415 int clk_release_all(struct clk *clk, int count)
419 for (i = 0; i < count; i++) {
420 debug("%s(clk[%d]=%p)\n", __func__, i, &clk[i]);
422 /* check if clock has been previously requested */
426 ret = clk_disable(&clk[i]);
427 if (ret && ret != -ENOSYS)
430 ret = clk_free(&clk[i]);
431 if (ret && ret != -ENOSYS)
438 #endif /* OF_CONTROL */
440 int clk_request(struct udevice *dev, struct clk *clk)
442 const struct clk_ops *ops;
444 debug("%s(dev=%p, clk=%p)\n", __func__, dev, clk);
447 ops = clk_dev_ops(dev);
454 return ops->request(clk);
457 int clk_free(struct clk *clk)
459 const struct clk_ops *ops;
461 debug("%s(clk=%p)\n", __func__, clk);
464 ops = clk_dev_ops(clk->dev);
469 return ops->rfree(clk);
472 ulong clk_get_rate(struct clk *clk)
474 const struct clk_ops *ops;
477 debug("%s(clk=%p)\n", __func__, clk);
480 ops = clk_dev_ops(clk->dev);
485 ret = ops->get_rate(clk);
492 struct clk *clk_get_parent(struct clk *clk)
494 struct udevice *pdev;
497 debug("%s(clk=%p)\n", __func__, clk);
501 pdev = dev_get_parent(clk->dev);
502 pclk = dev_get_clk_ptr(pdev);
504 return ERR_PTR(-ENODEV);
509 long long clk_get_parent_rate(struct clk *clk)
511 const struct clk_ops *ops;
514 debug("%s(clk=%p)\n", __func__, clk);
518 pclk = clk_get_parent(clk);
522 ops = clk_dev_ops(pclk->dev);
526 /* Read the 'rate' if not already set or if proper flag set*/
527 if (!pclk->rate || pclk->flags & CLK_GET_RATE_NOCACHE)
528 pclk->rate = clk_get_rate(pclk);
533 ulong clk_round_rate(struct clk *clk, ulong rate)
535 const struct clk_ops *ops;
537 debug("%s(clk=%p, rate=%lu)\n", __func__, clk, rate);
541 ops = clk_dev_ops(clk->dev);
542 if (!ops->round_rate)
545 return ops->round_rate(clk, rate);
548 ulong clk_set_rate(struct clk *clk, ulong rate)
550 const struct clk_ops *ops;
552 debug("%s(clk=%p, rate=%lu)\n", __func__, clk, rate);
555 ops = clk_dev_ops(clk->dev);
560 return ops->set_rate(clk, rate);
563 int clk_set_parent(struct clk *clk, struct clk *parent)
565 const struct clk_ops *ops;
568 debug("%s(clk=%p, parent=%p)\n", __func__, clk, parent);
571 ops = clk_dev_ops(clk->dev);
573 if (!ops->set_parent)
576 ret = ops->set_parent(clk, parent);
580 if (CONFIG_IS_ENABLED(CLK_CCF))
581 ret = device_reparent(clk->dev, parent->dev);
586 int clk_enable(struct clk *clk)
588 const struct clk_ops *ops;
589 struct clk *clkp = NULL;
592 debug("%s(clk=%p)\n", __func__, clk);
595 ops = clk_dev_ops(clk->dev);
597 if (CONFIG_IS_ENABLED(CLK_CCF)) {
598 /* Take id 0 as a non-valid clk, such as dummy */
599 if (clk->id && !clk_get_by_id(clk->id, &clkp)) {
600 if (clkp->enable_count) {
601 clkp->enable_count++;
604 if (clkp->dev->parent &&
605 device_get_uclass_id(clkp->dev) == UCLASS_CLK) {
606 ret = clk_enable(dev_get_clk_ptr(clkp->dev->parent));
608 printf("Enable %s failed\n",
609 clkp->dev->parent->name);
616 ret = ops->enable(clk);
618 printf("Enable %s failed\n", clk->dev->name);
623 clkp->enable_count++;
627 return ops->enable(clk);
633 int clk_enable_bulk(struct clk_bulk *bulk)
637 for (i = 0; i < bulk->count; i++) {
638 ret = clk_enable(&bulk->clks[i]);
639 if (ret < 0 && ret != -ENOSYS)
646 int clk_disable(struct clk *clk)
648 const struct clk_ops *ops;
649 struct clk *clkp = NULL;
652 debug("%s(clk=%p)\n", __func__, clk);
655 ops = clk_dev_ops(clk->dev);
657 if (CONFIG_IS_ENABLED(CLK_CCF)) {
658 if (clk->id && !clk_get_by_id(clk->id, &clkp)) {
659 if (clkp->flags & CLK_IS_CRITICAL)
662 if (clkp->enable_count == 0) {
663 printf("clk %s already disabled\n",
668 if (--clkp->enable_count > 0)
673 ret = ops->disable(clk);
678 if (clkp && clkp->dev->parent &&
679 device_get_uclass_id(clkp->dev) == UCLASS_CLK) {
680 ret = clk_disable(dev_get_clk_ptr(clkp->dev->parent));
682 printf("Disable %s failed\n",
683 clkp->dev->parent->name);
691 return ops->disable(clk);
697 int clk_disable_bulk(struct clk_bulk *bulk)
701 for (i = 0; i < bulk->count; i++) {
702 ret = clk_disable(&bulk->clks[i]);
703 if (ret < 0 && ret != -ENOSYS)
710 int clk_get_by_id(ulong id, struct clk **clkp)
716 ret = uclass_get(UCLASS_CLK, &uc);
720 uclass_foreach_dev(dev, uc) {
721 struct clk *clk = dev_get_clk_ptr(dev);
723 if (clk && clk->id == id) {
732 bool clk_is_match(const struct clk *p, const struct clk *q)
734 /* trivial case: identical struct clk's or both NULL */
738 /* trivial case #2: on the clk pointer is NULL */
742 /* same device, id and data */
743 if (p->dev == q->dev && p->id == q->id && p->data == q->data)
749 static void devm_clk_release(struct udevice *dev, void *res)
754 static int devm_clk_match(struct udevice *dev, void *res, void *data)
759 struct clk *devm_clk_get(struct udevice *dev, const char *id)
764 clk = devres_alloc(devm_clk_release, sizeof(struct clk), __GFP_ZERO);
766 return ERR_PTR(-ENOMEM);
768 rc = clk_get_by_name(dev, id, clk);
772 devres_add(dev, clk);
776 struct clk *devm_clk_get_optional(struct udevice *dev, const char *id)
778 struct clk *clk = devm_clk_get(dev, id);
780 if (PTR_ERR(clk) == -ENODATA)
786 void devm_clk_put(struct udevice *dev, struct clk *clk)
793 rc = devres_release(dev, devm_clk_release, devm_clk_match, clk);
797 int clk_uclass_post_probe(struct udevice *dev)
800 * when a clock provider is probed. Call clk_set_defaults()
801 * also after the device is probed. This takes care of cases
802 * where the DT is used to setup default parents and rates
803 * using assigned-clocks
805 clk_set_defaults(dev, 1);
810 UCLASS_DRIVER(clk) = {
813 .post_probe = clk_uclass_post_probe,