gpio: rcar: Fix runtime PM imbalance on error
[linux/fpc-iii.git] / drivers / clk / ti / clkctrl.c
blob062266034d84669a40455020c91374c59c492996
1 /*
2 * OMAP clkctrl clock support
4 * Copyright (C) 2017 Texas Instruments, Inc.
6 * Tero Kristo <t-kristo@ti.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
13 * kind, whether express or implied; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/clk-provider.h>
19 #include <linux/slab.h>
20 #include <linux/of.h>
21 #include <linux/of_address.h>
22 #include <linux/clk/ti.h>
23 #include <linux/delay.h>
24 #include <linux/timekeeping.h>
25 #include "clock.h"
27 #define NO_IDLEST 0
29 #define OMAP4_MODULEMODE_MASK 0x3
31 #define MODULEMODE_HWCTRL 0x1
32 #define MODULEMODE_SWCTRL 0x2
34 #define OMAP4_IDLEST_MASK (0x3 << 16)
35 #define OMAP4_IDLEST_SHIFT 16
37 #define OMAP4_STBYST_MASK BIT(18)
38 #define OMAP4_STBYST_SHIFT 18
40 #define CLKCTRL_IDLEST_FUNCTIONAL 0x0
41 #define CLKCTRL_IDLEST_INTERFACE_IDLE 0x2
42 #define CLKCTRL_IDLEST_DISABLED 0x3
44 /* These timeouts are in us */
45 #define OMAP4_MAX_MODULE_READY_TIME 2000
46 #define OMAP4_MAX_MODULE_DISABLE_TIME 5000
48 static bool _early_timeout = true;
50 struct omap_clkctrl_provider {
51 void __iomem *base;
52 struct list_head clocks;
53 char *clkdm_name;
56 struct omap_clkctrl_clk {
57 struct clk_hw *clk;
58 u16 reg_offset;
59 int bit_offset;
60 struct list_head node;
63 union omap4_timeout {
64 u32 cycles;
65 ktime_t start;
68 static const struct omap_clkctrl_data default_clkctrl_data[] __initconst = {
69 { 0 },
72 static u32 _omap4_idlest(u32 val)
74 val &= OMAP4_IDLEST_MASK;
75 val >>= OMAP4_IDLEST_SHIFT;
77 return val;
80 static bool _omap4_is_idle(u32 val)
82 val = _omap4_idlest(val);
84 return val == CLKCTRL_IDLEST_DISABLED;
87 static bool _omap4_is_ready(u32 val)
89 val = _omap4_idlest(val);
91 return val == CLKCTRL_IDLEST_FUNCTIONAL ||
92 val == CLKCTRL_IDLEST_INTERFACE_IDLE;
95 static bool _omap4_is_timeout(union omap4_timeout *time, u32 timeout)
98 * There are two special cases where ktime_to_ns() can't be
99 * used to track the timeouts. First one is during early boot
100 * when the timers haven't been initialized yet. The second
101 * one is during suspend-resume cycle while timekeeping is
102 * being suspended / resumed. Clocksource for the system
103 * can be from a timer that requires pm_runtime access, which
104 * will eventually bring us here with timekeeping_suspended,
105 * during both suspend entry and resume paths. This happens
106 * at least on am43xx platform. Account for flakeyness
107 * with udelay() by multiplying the timeout value by 2.
109 if (unlikely(_early_timeout || timekeeping_suspended)) {
110 if (time->cycles++ < timeout) {
111 udelay(1 * 2);
112 return false;
114 } else {
115 if (!ktime_to_ns(time->start)) {
116 time->start = ktime_get();
117 return false;
120 if (ktime_us_delta(ktime_get(), time->start) < timeout) {
121 cpu_relax();
122 return false;
126 return true;
129 static int __init _omap4_disable_early_timeout(void)
131 _early_timeout = false;
133 return 0;
135 arch_initcall(_omap4_disable_early_timeout);
137 static int _omap4_clkctrl_clk_enable(struct clk_hw *hw)
139 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
140 u32 val;
141 int ret;
142 union omap4_timeout timeout = { 0 };
144 if (clk->clkdm) {
145 ret = ti_clk_ll_ops->clkdm_clk_enable(clk->clkdm, hw->clk);
146 if (ret) {
147 WARN(1,
148 "%s: could not enable %s's clockdomain %s: %d\n",
149 __func__, clk_hw_get_name(hw),
150 clk->clkdm_name, ret);
151 return ret;
155 if (!clk->enable_bit)
156 return 0;
158 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
160 val &= ~OMAP4_MODULEMODE_MASK;
161 val |= clk->enable_bit;
163 ti_clk_ll_ops->clk_writel(val, &clk->enable_reg);
165 if (test_bit(NO_IDLEST, &clk->flags))
166 return 0;
168 /* Wait until module is enabled */
169 while (!_omap4_is_ready(ti_clk_ll_ops->clk_readl(&clk->enable_reg))) {
170 if (_omap4_is_timeout(&timeout, OMAP4_MAX_MODULE_READY_TIME)) {
171 pr_err("%s: failed to enable\n", clk_hw_get_name(hw));
172 return -EBUSY;
176 return 0;
179 static void _omap4_clkctrl_clk_disable(struct clk_hw *hw)
181 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
182 u32 val;
183 union omap4_timeout timeout = { 0 };
185 if (!clk->enable_bit)
186 goto exit;
188 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
190 val &= ~OMAP4_MODULEMODE_MASK;
192 ti_clk_ll_ops->clk_writel(val, &clk->enable_reg);
194 if (test_bit(NO_IDLEST, &clk->flags))
195 goto exit;
197 /* Wait until module is disabled */
198 while (!_omap4_is_idle(ti_clk_ll_ops->clk_readl(&clk->enable_reg))) {
199 if (_omap4_is_timeout(&timeout,
200 OMAP4_MAX_MODULE_DISABLE_TIME)) {
201 pr_err("%s: failed to disable\n", clk_hw_get_name(hw));
202 break;
206 exit:
207 if (clk->clkdm)
208 ti_clk_ll_ops->clkdm_clk_disable(clk->clkdm, hw->clk);
211 static int _omap4_clkctrl_clk_is_enabled(struct clk_hw *hw)
213 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
214 u32 val;
216 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
218 if (val & clk->enable_bit)
219 return 1;
221 return 0;
224 static const struct clk_ops omap4_clkctrl_clk_ops = {
225 .enable = _omap4_clkctrl_clk_enable,
226 .disable = _omap4_clkctrl_clk_disable,
227 .is_enabled = _omap4_clkctrl_clk_is_enabled,
228 .init = omap2_init_clk_clkdm,
231 static struct clk_hw *_ti_omap4_clkctrl_xlate(struct of_phandle_args *clkspec,
232 void *data)
234 struct omap_clkctrl_provider *provider = data;
235 struct omap_clkctrl_clk *entry;
236 bool found = false;
238 if (clkspec->args_count != 2)
239 return ERR_PTR(-EINVAL);
241 pr_debug("%s: looking for %x:%x\n", __func__,
242 clkspec->args[0], clkspec->args[1]);
244 list_for_each_entry(entry, &provider->clocks, node) {
245 if (entry->reg_offset == clkspec->args[0] &&
246 entry->bit_offset == clkspec->args[1]) {
247 found = true;
248 break;
252 if (!found)
253 return ERR_PTR(-EINVAL);
255 return entry->clk;
258 static int __init
259 _ti_clkctrl_clk_register(struct omap_clkctrl_provider *provider,
260 struct device_node *node, struct clk_hw *clk_hw,
261 u16 offset, u8 bit, const char * const *parents,
262 int num_parents, const struct clk_ops *ops)
264 struct clk_init_data init = { NULL };
265 struct clk *clk;
266 struct omap_clkctrl_clk *clkctrl_clk;
267 int ret = 0;
269 if (ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT)
270 init.name = kasprintf(GFP_KERNEL, "%pOFn:%pOFn:%04x:%d",
271 node->parent, node, offset,
272 bit);
273 else
274 init.name = kasprintf(GFP_KERNEL, "%pOFn:%04x:%d", node,
275 offset, bit);
276 clkctrl_clk = kzalloc(sizeof(*clkctrl_clk), GFP_KERNEL);
277 if (!init.name || !clkctrl_clk) {
278 ret = -ENOMEM;
279 goto cleanup;
282 clk_hw->init = &init;
283 init.parent_names = parents;
284 init.num_parents = num_parents;
285 init.ops = ops;
286 init.flags = 0;
288 clk = ti_clk_register(NULL, clk_hw, init.name);
289 if (IS_ERR_OR_NULL(clk)) {
290 ret = -EINVAL;
291 goto cleanup;
294 clkctrl_clk->reg_offset = offset;
295 clkctrl_clk->bit_offset = bit;
296 clkctrl_clk->clk = clk_hw;
298 list_add(&clkctrl_clk->node, &provider->clocks);
300 return 0;
302 cleanup:
303 kfree(init.name);
304 kfree(clkctrl_clk);
305 return ret;
308 static void __init
309 _ti_clkctrl_setup_gate(struct omap_clkctrl_provider *provider,
310 struct device_node *node, u16 offset,
311 const struct omap_clkctrl_bit_data *data,
312 void __iomem *reg)
314 struct clk_hw_omap *clk_hw;
316 clk_hw = kzalloc(sizeof(*clk_hw), GFP_KERNEL);
317 if (!clk_hw)
318 return;
320 clk_hw->enable_bit = data->bit;
321 clk_hw->enable_reg.ptr = reg;
323 if (_ti_clkctrl_clk_register(provider, node, &clk_hw->hw, offset,
324 data->bit, data->parents, 1,
325 &omap_gate_clk_ops))
326 kfree(clk_hw);
329 static void __init
330 _ti_clkctrl_setup_mux(struct omap_clkctrl_provider *provider,
331 struct device_node *node, u16 offset,
332 const struct omap_clkctrl_bit_data *data,
333 void __iomem *reg)
335 struct clk_omap_mux *mux;
336 int num_parents = 0;
337 const char * const *pname;
339 mux = kzalloc(sizeof(*mux), GFP_KERNEL);
340 if (!mux)
341 return;
343 pname = data->parents;
344 while (*pname) {
345 num_parents++;
346 pname++;
349 mux->mask = num_parents;
350 if (!(mux->flags & CLK_MUX_INDEX_ONE))
351 mux->mask--;
353 mux->mask = (1 << fls(mux->mask)) - 1;
355 mux->shift = data->bit;
356 mux->reg.ptr = reg;
358 if (_ti_clkctrl_clk_register(provider, node, &mux->hw, offset,
359 data->bit, data->parents, num_parents,
360 &ti_clk_mux_ops))
361 kfree(mux);
364 static void __init
365 _ti_clkctrl_setup_div(struct omap_clkctrl_provider *provider,
366 struct device_node *node, u16 offset,
367 const struct omap_clkctrl_bit_data *data,
368 void __iomem *reg)
370 struct clk_omap_divider *div;
371 const struct omap_clkctrl_div_data *div_data = data->data;
372 u8 div_flags = 0;
374 div = kzalloc(sizeof(*div), GFP_KERNEL);
375 if (!div)
376 return;
378 div->reg.ptr = reg;
379 div->shift = data->bit;
380 div->flags = div_data->flags;
382 if (div->flags & CLK_DIVIDER_POWER_OF_TWO)
383 div_flags |= CLKF_INDEX_POWER_OF_TWO;
385 if (ti_clk_parse_divider_data((int *)div_data->dividers, 0,
386 div_data->max_div, div_flags,
387 div)) {
388 pr_err("%s: Data parsing for %pOF:%04x:%d failed\n", __func__,
389 node, offset, data->bit);
390 kfree(div);
391 return;
394 if (_ti_clkctrl_clk_register(provider, node, &div->hw, offset,
395 data->bit, data->parents, 1,
396 &ti_clk_divider_ops))
397 kfree(div);
400 static void __init
401 _ti_clkctrl_setup_subclks(struct omap_clkctrl_provider *provider,
402 struct device_node *node,
403 const struct omap_clkctrl_reg_data *data,
404 void __iomem *reg)
406 const struct omap_clkctrl_bit_data *bits = data->bit_data;
408 if (!bits)
409 return;
411 while (bits->bit) {
412 switch (bits->type) {
413 case TI_CLK_GATE:
414 _ti_clkctrl_setup_gate(provider, node, data->offset,
415 bits, reg);
416 break;
418 case TI_CLK_DIVIDER:
419 _ti_clkctrl_setup_div(provider, node, data->offset,
420 bits, reg);
421 break;
423 case TI_CLK_MUX:
424 _ti_clkctrl_setup_mux(provider, node, data->offset,
425 bits, reg);
426 break;
428 default:
429 pr_err("%s: bad subclk type: %d\n", __func__,
430 bits->type);
431 return;
433 bits++;
437 static void __init _clkctrl_add_provider(void *data,
438 struct device_node *np)
440 of_clk_add_hw_provider(np, _ti_omap4_clkctrl_xlate, data);
443 /* Get clock name based on compatible string for clkctrl */
444 static char * __init clkctrl_get_name(struct device_node *np)
446 struct property *prop;
447 const int prefix_len = 11;
448 const char *compat;
449 char *name;
451 of_property_for_each_string(np, "compatible", prop, compat) {
452 if (!strncmp("ti,clkctrl-", compat, prefix_len)) {
453 /* Two letter minimum name length for l3, l4 etc */
454 if (strnlen(compat + prefix_len, 16) < 2)
455 continue;
456 name = kasprintf(GFP_KERNEL, "%s", compat + prefix_len);
457 if (!name)
458 continue;
459 strreplace(name, '-', '_');
461 return name;
464 of_node_put(np);
466 return NULL;
469 /* Get clkctrl clock base name based on clkctrl_name or dts node */
470 static const char * __init clkctrl_get_clock_name(struct device_node *np,
471 const char *clkctrl_name,
472 int offset, int index,
473 bool legacy_naming)
475 char *clock_name;
477 /* l4per-clkctrl:1234:0 style naming based on clkctrl_name */
478 if (clkctrl_name && !legacy_naming) {
479 clock_name = kasprintf(GFP_KERNEL, "%s-clkctrl:%04x:%d",
480 clkctrl_name, offset, index);
481 strreplace(clock_name, '_', '-');
483 return clock_name;
486 /* l4per:1234:0 old style naming based on clkctrl_name */
487 if (clkctrl_name)
488 return kasprintf(GFP_KERNEL, "%s_cm:clk:%04x:%d",
489 clkctrl_name, offset, index);
491 /* l4per_cm:1234:0 old style naming based on parent node name */
492 if (legacy_naming)
493 return kasprintf(GFP_KERNEL, "%pOFn:clk:%04x:%d",
494 np->parent, offset, index);
496 /* l4per-clkctrl:1234:0 style naming based on node name */
497 return kasprintf(GFP_KERNEL, "%pOFn:%04x:%d", np, offset, index);
500 static void __init _ti_omap4_clkctrl_setup(struct device_node *node)
502 struct omap_clkctrl_provider *provider;
503 const struct omap_clkctrl_data *data = default_clkctrl_data;
504 const struct omap_clkctrl_reg_data *reg_data;
505 struct clk_init_data init = { NULL };
506 struct clk_hw_omap *hw;
507 struct clk *clk;
508 struct omap_clkctrl_clk *clkctrl_clk = NULL;
509 const __be32 *addrp;
510 bool legacy_naming;
511 char *clkctrl_name;
512 u32 addr;
513 int ret;
514 char *c;
515 u16 soc_mask = 0;
517 if (!(ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT) &&
518 of_node_name_eq(node, "clk"))
519 ti_clk_features.flags |= TI_CLK_CLKCTRL_COMPAT;
521 addrp = of_get_address(node, 0, NULL, NULL);
522 addr = (u32)of_translate_address(node, addrp);
524 #ifdef CONFIG_ARCH_OMAP4
525 if (of_machine_is_compatible("ti,omap4"))
526 data = omap4_clkctrl_data;
527 #endif
528 #ifdef CONFIG_SOC_OMAP5
529 if (of_machine_is_compatible("ti,omap5"))
530 data = omap5_clkctrl_data;
531 #endif
532 #ifdef CONFIG_SOC_DRA7XX
533 if (of_machine_is_compatible("ti,dra7")) {
534 if (ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT)
535 data = dra7_clkctrl_compat_data;
536 else
537 data = dra7_clkctrl_data;
540 if (of_machine_is_compatible("ti,dra72"))
541 soc_mask = CLKF_SOC_DRA72;
542 if (of_machine_is_compatible("ti,dra74"))
543 soc_mask = CLKF_SOC_DRA74;
544 if (of_machine_is_compatible("ti,dra76"))
545 soc_mask = CLKF_SOC_DRA76;
546 #endif
547 #ifdef CONFIG_SOC_AM33XX
548 if (of_machine_is_compatible("ti,am33xx")) {
549 if (ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT)
550 data = am3_clkctrl_compat_data;
551 else
552 data = am3_clkctrl_data;
554 #endif
555 #ifdef CONFIG_SOC_AM43XX
556 if (of_machine_is_compatible("ti,am4372")) {
557 if (ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT)
558 data = am4_clkctrl_compat_data;
559 else
560 data = am4_clkctrl_data;
563 if (of_machine_is_compatible("ti,am438x")) {
564 if (ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT)
565 data = am438x_clkctrl_compat_data;
566 else
567 data = am438x_clkctrl_data;
569 #endif
570 #ifdef CONFIG_SOC_TI81XX
571 if (of_machine_is_compatible("ti,dm814"))
572 data = dm814_clkctrl_data;
574 if (of_machine_is_compatible("ti,dm816"))
575 data = dm816_clkctrl_data;
576 #endif
578 if (ti_clk_get_features()->flags & TI_CLK_DEVICE_TYPE_GP)
579 soc_mask |= CLKF_SOC_NONSEC;
581 while (data->addr) {
582 if (addr == data->addr)
583 break;
585 data++;
588 if (!data->addr) {
589 pr_err("%pOF not found from clkctrl data.\n", node);
590 return;
593 provider = kzalloc(sizeof(*provider), GFP_KERNEL);
594 if (!provider)
595 return;
597 provider->base = of_iomap(node, 0);
599 legacy_naming = ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT;
600 clkctrl_name = clkctrl_get_name(node);
601 if (clkctrl_name) {
602 provider->clkdm_name = kasprintf(GFP_KERNEL,
603 "%s_clkdm", clkctrl_name);
604 goto clkdm_found;
608 * The code below can be removed when all clkctrl nodes use domain
609 * specific compatible proprerty and standard clock node naming
611 if (legacy_naming) {
612 provider->clkdm_name = kasprintf(GFP_KERNEL, "%pOFnxxx", node->parent);
613 if (!provider->clkdm_name) {
614 kfree(provider);
615 return;
619 * Create default clkdm name, replace _cm from end of parent
620 * node name with _clkdm
622 provider->clkdm_name[strlen(provider->clkdm_name) - 2] = 0;
623 } else {
624 provider->clkdm_name = kasprintf(GFP_KERNEL, "%pOFn", node);
625 if (!provider->clkdm_name) {
626 kfree(provider);
627 return;
631 * Create default clkdm name, replace _clkctrl from end of
632 * node name with _clkdm
634 provider->clkdm_name[strlen(provider->clkdm_name) - 7] = 0;
637 strcat(provider->clkdm_name, "clkdm");
639 /* Replace any dash from the clkdm name with underscore */
640 c = provider->clkdm_name;
642 while (*c) {
643 if (*c == '-')
644 *c = '_';
645 c++;
647 clkdm_found:
648 INIT_LIST_HEAD(&provider->clocks);
650 /* Generate clocks */
651 reg_data = data->regs;
653 while (reg_data->parent) {
654 if ((reg_data->flags & CLKF_SOC_MASK) &&
655 (reg_data->flags & soc_mask) == 0) {
656 reg_data++;
657 continue;
660 hw = kzalloc(sizeof(*hw), GFP_KERNEL);
661 if (!hw)
662 return;
664 hw->enable_reg.ptr = provider->base + reg_data->offset;
666 _ti_clkctrl_setup_subclks(provider, node, reg_data,
667 hw->enable_reg.ptr);
669 if (reg_data->flags & CLKF_SW_SUP)
670 hw->enable_bit = MODULEMODE_SWCTRL;
671 if (reg_data->flags & CLKF_HW_SUP)
672 hw->enable_bit = MODULEMODE_HWCTRL;
673 if (reg_data->flags & CLKF_NO_IDLEST)
674 set_bit(NO_IDLEST, &hw->flags);
676 if (reg_data->clkdm_name)
677 hw->clkdm_name = reg_data->clkdm_name;
678 else
679 hw->clkdm_name = provider->clkdm_name;
681 init.parent_names = &reg_data->parent;
682 init.num_parents = 1;
683 init.flags = 0;
684 if (reg_data->flags & CLKF_SET_RATE_PARENT)
685 init.flags |= CLK_SET_RATE_PARENT;
687 init.name = clkctrl_get_clock_name(node, clkctrl_name,
688 reg_data->offset, 0,
689 legacy_naming);
690 if (!init.name)
691 goto cleanup;
693 clkctrl_clk = kzalloc(sizeof(*clkctrl_clk), GFP_KERNEL);
694 if (!clkctrl_clk)
695 goto cleanup;
697 init.ops = &omap4_clkctrl_clk_ops;
698 hw->hw.init = &init;
700 clk = ti_clk_register_omap_hw(NULL, &hw->hw, init.name);
701 if (IS_ERR_OR_NULL(clk))
702 goto cleanup;
704 clkctrl_clk->reg_offset = reg_data->offset;
705 clkctrl_clk->clk = &hw->hw;
707 list_add(&clkctrl_clk->node, &provider->clocks);
709 reg_data++;
712 ret = of_clk_add_hw_provider(node, _ti_omap4_clkctrl_xlate, provider);
713 if (ret == -EPROBE_DEFER)
714 ti_clk_retry_init(node, provider, _clkctrl_add_provider);
716 kfree(clkctrl_name);
718 return;
720 cleanup:
721 kfree(hw);
722 kfree(init.name);
723 kfree(clkctrl_name);
724 kfree(clkctrl_clk);
726 CLK_OF_DECLARE(ti_omap4_clkctrl_clock, "ti,clkctrl",
727 _ti_omap4_clkctrl_setup);
730 * ti_clk_is_in_standby - Check if clkctrl clock is in standby or not
731 * @clk: clock to check standby status for
733 * Finds whether the provided clock is in standby mode or not. Returns
734 * true if the provided clock is a clkctrl type clock and it is in standby,
735 * false otherwise.
737 bool ti_clk_is_in_standby(struct clk *clk)
739 struct clk_hw *hw;
740 struct clk_hw_omap *hwclk;
741 u32 val;
743 hw = __clk_get_hw(clk);
745 if (!omap2_clk_is_hw_omap(hw))
746 return false;
748 hwclk = to_clk_hw_omap(hw);
750 val = ti_clk_ll_ops->clk_readl(&hwclk->enable_reg);
752 if (val & OMAP4_STBYST_MASK)
753 return true;
755 return false;
757 EXPORT_SYMBOL_GPL(ti_clk_is_in_standby);