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>
21 #include <linux/of_address.h>
22 #include <linux/clk/ti.h>
23 #include <linux/delay.h>
28 #define OMAP4_MODULEMODE_MASK 0x3
30 #define MODULEMODE_HWCTRL 0x1
31 #define MODULEMODE_SWCTRL 0x2
33 #define OMAP4_IDLEST_MASK (0x3 << 16)
34 #define OMAP4_IDLEST_SHIFT 16
36 #define CLKCTRL_IDLEST_FUNCTIONAL 0x0
37 #define CLKCTRL_IDLEST_INTERFACE_IDLE 0x2
38 #define CLKCTRL_IDLEST_DISABLED 0x3
40 /* These timeouts are in us */
41 #define OMAP4_MAX_MODULE_READY_TIME 2000
42 #define OMAP4_MAX_MODULE_DISABLE_TIME 5000
44 static bool _early_timeout = true;
46 struct omap_clkctrl_provider {
48 struct list_head clocks;
51 struct omap_clkctrl_clk {
55 struct list_head node;
63 static const struct omap_clkctrl_data default_clkctrl_data[] __initconst = {
67 static u32 _omap4_idlest(u32 val)
69 val &= OMAP4_IDLEST_MASK;
70 val >>= OMAP4_IDLEST_SHIFT;
75 static bool _omap4_is_idle(u32 val)
77 val = _omap4_idlest(val);
79 return val == CLKCTRL_IDLEST_DISABLED;
82 static bool _omap4_is_ready(u32 val)
84 val = _omap4_idlest(val);
86 return val == CLKCTRL_IDLEST_FUNCTIONAL ||
87 val == CLKCTRL_IDLEST_INTERFACE_IDLE;
90 static bool _omap4_is_timeout(union omap4_timeout *time, u32 timeout)
92 if (unlikely(_early_timeout)) {
93 if (time->cycles++ < timeout) {
98 if (!ktime_to_ns(time->start)) {
99 time->start = ktime_get();
103 if (ktime_us_delta(ktime_get(), time->start) < timeout) {
112 static int __init _omap4_disable_early_timeout(void)
114 _early_timeout = false;
118 arch_initcall(_omap4_disable_early_timeout);
120 static int _omap4_clkctrl_clk_enable(struct clk_hw *hw)
122 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
125 union omap4_timeout timeout = { 0 };
128 ret = ti_clk_ll_ops->clkdm_clk_enable(clk->clkdm, hw->clk);
131 "%s: could not enable %s's clockdomain %s: %d\n",
132 __func__, clk_hw_get_name(hw),
133 clk->clkdm_name, ret);
138 if (!clk->enable_bit)
141 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
143 val &= ~OMAP4_MODULEMODE_MASK;
144 val |= clk->enable_bit;
146 ti_clk_ll_ops->clk_writel(val, &clk->enable_reg);
148 if (clk->flags & NO_IDLEST)
151 /* Wait until module is enabled */
152 while (!_omap4_is_ready(ti_clk_ll_ops->clk_readl(&clk->enable_reg))) {
153 if (_omap4_is_timeout(&timeout, OMAP4_MAX_MODULE_READY_TIME)) {
154 pr_err("%s: failed to enable\n", clk_hw_get_name(hw));
162 static void _omap4_clkctrl_clk_disable(struct clk_hw *hw)
164 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
166 union omap4_timeout timeout = { 0 };
168 if (!clk->enable_bit)
171 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
173 val &= ~OMAP4_MODULEMODE_MASK;
175 ti_clk_ll_ops->clk_writel(val, &clk->enable_reg);
177 if (clk->flags & NO_IDLEST)
180 /* Wait until module is disabled */
181 while (!_omap4_is_idle(ti_clk_ll_ops->clk_readl(&clk->enable_reg))) {
182 if (_omap4_is_timeout(&timeout,
183 OMAP4_MAX_MODULE_DISABLE_TIME)) {
184 pr_err("%s: failed to disable\n", clk_hw_get_name(hw));
191 ti_clk_ll_ops->clkdm_clk_disable(clk->clkdm, hw->clk);
194 static int _omap4_clkctrl_clk_is_enabled(struct clk_hw *hw)
196 struct clk_hw_omap *clk = to_clk_hw_omap(hw);
199 val = ti_clk_ll_ops->clk_readl(&clk->enable_reg);
201 if (val & clk->enable_bit)
207 static const struct clk_ops omap4_clkctrl_clk_ops = {
208 .enable = _omap4_clkctrl_clk_enable,
209 .disable = _omap4_clkctrl_clk_disable,
210 .is_enabled = _omap4_clkctrl_clk_is_enabled,
213 static struct clk_hw *_ti_omap4_clkctrl_xlate(struct of_phandle_args *clkspec,
216 struct omap_clkctrl_provider *provider = data;
217 struct omap_clkctrl_clk *entry;
220 if (clkspec->args_count != 2)
221 return ERR_PTR(-EINVAL);
223 pr_debug("%s: looking for %x:%x\n", __func__,
224 clkspec->args[0], clkspec->args[1]);
226 list_for_each_entry(entry, &provider->clocks, node) {
227 if (entry->reg_offset == clkspec->args[0] &&
228 entry->bit_offset == clkspec->args[1]) {
235 return ERR_PTR(-EINVAL);
241 _ti_clkctrl_clk_register(struct omap_clkctrl_provider *provider,
242 struct device_node *node, struct clk_hw *clk_hw,
243 u16 offset, u8 bit, const char * const *parents,
244 int num_parents, const struct clk_ops *ops)
246 struct clk_init_data init = { NULL };
248 struct omap_clkctrl_clk *clkctrl_clk;
251 init.name = kasprintf(GFP_KERNEL, "%s:%s:%04x:%d", node->parent->name,
252 node->name, offset, bit);
253 clkctrl_clk = kzalloc(sizeof(*clkctrl_clk), GFP_KERNEL);
254 if (!init.name || !clkctrl_clk) {
259 clk_hw->init = &init;
260 init.parent_names = parents;
261 init.num_parents = num_parents;
263 init.flags = CLK_IS_BASIC;
265 clk = ti_clk_register(NULL, clk_hw, init.name);
266 if (IS_ERR_OR_NULL(clk)) {
271 clkctrl_clk->reg_offset = offset;
272 clkctrl_clk->bit_offset = bit;
273 clkctrl_clk->clk = clk_hw;
275 list_add(&clkctrl_clk->node, &provider->clocks);
286 _ti_clkctrl_setup_gate(struct omap_clkctrl_provider *provider,
287 struct device_node *node, u16 offset,
288 const struct omap_clkctrl_bit_data *data,
291 struct clk_hw_omap *clk_hw;
293 clk_hw = kzalloc(sizeof(*clk_hw), GFP_KERNEL);
297 clk_hw->enable_bit = data->bit;
298 clk_hw->enable_reg.ptr = reg;
300 if (_ti_clkctrl_clk_register(provider, node, &clk_hw->hw, offset,
301 data->bit, data->parents, 1,
307 _ti_clkctrl_setup_mux(struct omap_clkctrl_provider *provider,
308 struct device_node *node, u16 offset,
309 const struct omap_clkctrl_bit_data *data,
312 struct clk_omap_mux *mux;
314 const char * const *pname;
316 mux = kzalloc(sizeof(*mux), GFP_KERNEL);
320 pname = data->parents;
326 mux->mask = num_parents;
327 mux->mask = (1 << fls(mux->mask)) - 1;
329 mux->shift = data->bit;
332 if (_ti_clkctrl_clk_register(provider, node, &mux->hw, offset,
333 data->bit, data->parents, num_parents,
339 _ti_clkctrl_setup_div(struct omap_clkctrl_provider *provider,
340 struct device_node *node, u16 offset,
341 const struct omap_clkctrl_bit_data *data,
344 struct clk_omap_divider *div;
345 const struct omap_clkctrl_div_data *div_data = data->data;
347 div = kzalloc(sizeof(*div), GFP_KERNEL);
352 div->shift = data->bit;
354 if (ti_clk_parse_divider_data((int *)div_data->dividers,
355 div_data->max_div, 0, 0,
356 &div->width, &div->table)) {
357 pr_err("%s: Data parsing for %s:%04x:%d failed\n", __func__,
358 node->name, offset, data->bit);
363 if (_ti_clkctrl_clk_register(provider, node, &div->hw, offset,
364 data->bit, data->parents, 1,
365 &ti_clk_divider_ops))
370 _ti_clkctrl_setup_subclks(struct omap_clkctrl_provider *provider,
371 struct device_node *node,
372 const struct omap_clkctrl_reg_data *data,
375 const struct omap_clkctrl_bit_data *bits = data->bit_data;
381 switch (bits->type) {
383 _ti_clkctrl_setup_gate(provider, node, data->offset,
388 _ti_clkctrl_setup_div(provider, node, data->offset,
393 _ti_clkctrl_setup_mux(provider, node, data->offset,
398 pr_err("%s: bad subclk type: %d\n", __func__,
406 static void __init _ti_omap4_clkctrl_setup(struct device_node *node)
408 struct omap_clkctrl_provider *provider;
409 const struct omap_clkctrl_data *data = default_clkctrl_data;
410 const struct omap_clkctrl_reg_data *reg_data;
411 struct clk_init_data init = { NULL };
412 struct clk_hw_omap *hw;
414 struct omap_clkctrl_clk *clkctrl_clk;
418 addrp = of_get_address(node, 0, NULL, NULL);
419 addr = (u32)of_translate_address(node, addrp);
421 #ifdef CONFIG_ARCH_OMAP4
422 if (of_machine_is_compatible("ti,omap4"))
423 data = omap4_clkctrl_data;
427 if (addr == data->addr)
434 pr_err("%s not found from clkctrl data.\n", node->name);
438 provider = kzalloc(sizeof(*provider), GFP_KERNEL);
442 provider->base = of_iomap(node, 0);
444 INIT_LIST_HEAD(&provider->clocks);
446 /* Generate clocks */
447 reg_data = data->regs;
449 while (reg_data->parent) {
450 hw = kzalloc(sizeof(*hw), GFP_KERNEL);
454 hw->enable_reg.ptr = provider->base + reg_data->offset;
456 _ti_clkctrl_setup_subclks(provider, node, reg_data,
459 if (reg_data->flags & CLKF_SW_SUP)
460 hw->enable_bit = MODULEMODE_SWCTRL;
461 if (reg_data->flags & CLKF_HW_SUP)
462 hw->enable_bit = MODULEMODE_HWCTRL;
463 if (reg_data->flags & CLKF_NO_IDLEST)
464 hw->flags |= NO_IDLEST;
466 init.parent_names = ®_data->parent;
467 init.num_parents = 1;
469 init.name = kasprintf(GFP_KERNEL, "%s:%s:%04x:%d",
470 node->parent->name, node->name,
471 reg_data->offset, 0);
472 clkctrl_clk = kzalloc(sizeof(*clkctrl_clk), GFP_KERNEL);
473 if (!init.name || !clkctrl_clk)
476 init.ops = &omap4_clkctrl_clk_ops;
479 clk = ti_clk_register(NULL, &hw->hw, init.name);
480 if (IS_ERR_OR_NULL(clk))
483 clkctrl_clk->reg_offset = reg_data->offset;
484 clkctrl_clk->clk = &hw->hw;
486 list_add(&clkctrl_clk->node, &provider->clocks);
491 of_clk_add_hw_provider(node, _ti_omap4_clkctrl_xlate, provider);
499 CLK_OF_DECLARE(ti_omap4_clkctrl_clock, "ti,clkctrl",
500 _ti_omap4_clkctrl_setup);