4 * Copyright (C) 2013 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.h>
19 #include <linux/clk-provider.h>
20 #include <linux/clkdev.h>
21 #include <linux/clk/ti.h>
24 #include <linux/of_address.h>
25 #include <linux/list.h>
26 #include <linux/regmap.h>
27 #include <linux/memblock.h>
28 #include <linux/device.h>
33 #define pr_fmt(fmt) "%s: " fmt, __func__
35 static LIST_HEAD(clk_hw_omap_clocks);
36 struct ti_clk_ll_ops *ti_clk_ll_ops;
37 static struct device_node *clocks_node_ptr[CLK_MAX_MEMMAPS];
39 struct ti_clk_features ti_clk_features;
42 struct regmap *regmap;
46 static struct clk_iomap *clk_memmaps[CLK_MAX_MEMMAPS];
48 static void clk_memmap_writel(u32 val, const struct clk_omap_reg *reg)
50 struct clk_iomap *io = clk_memmaps[reg->index];
53 writel_relaxed(val, reg->ptr);
55 regmap_write(io->regmap, reg->offset, val);
57 writel_relaxed(val, io->mem + reg->offset);
60 static void _clk_rmw(u32 val, u32 mask, void __iomem *ptr)
64 v = readl_relaxed(ptr);
67 writel_relaxed(v, ptr);
70 static void clk_memmap_rmw(u32 val, u32 mask, const struct clk_omap_reg *reg)
72 struct clk_iomap *io = clk_memmaps[reg->index];
75 _clk_rmw(val, mask, reg->ptr);
76 } else if (io->regmap) {
77 regmap_update_bits(io->regmap, reg->offset, mask, val);
79 _clk_rmw(val, mask, io->mem + reg->offset);
83 static u32 clk_memmap_readl(const struct clk_omap_reg *reg)
86 struct clk_iomap *io = clk_memmaps[reg->index];
89 val = readl_relaxed(reg->ptr);
91 regmap_read(io->regmap, reg->offset, &val);
93 val = readl_relaxed(io->mem + reg->offset);
99 * ti_clk_setup_ll_ops - setup low level clock operations
100 * @ops: low level clock ops descriptor
102 * Sets up low level clock operations for TI clock driver. This is used
103 * to provide various callbacks for the clock driver towards platform
104 * specific code. Returns 0 on success, -EBUSY if ll_ops have been
105 * registered already.
107 int ti_clk_setup_ll_ops(struct ti_clk_ll_ops *ops)
110 pr_err("Attempt to register ll_ops multiple times.\n");
115 ops->clk_readl = clk_memmap_readl;
116 ops->clk_writel = clk_memmap_writel;
117 ops->clk_rmw = clk_memmap_rmw;
123 * ti_dt_clocks_register - register DT alias clocks during boot
124 * @oclks: list of clocks to register
126 * Register alias or non-standard DT clock entries during boot. By
127 * default, DT clocks are found based on their node name. If any
128 * additional con-id / dev-id -> clock mapping is required, use this
129 * function to list these.
131 void __init ti_dt_clocks_register(struct ti_dt_clk oclks[])
134 struct device_node *node, *parent, *child;
136 struct of_phandle_args clkspec;
143 static bool clkctrl_nodes_missing;
144 static bool has_clkctrl_data;
145 static bool compat_mode;
147 compat_mode = ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT;
149 for (c = oclks; c->node_name != NULL; c++) {
150 strcpy(buf, c->node_name);
152 for (i = 0; i < 2; i++)
158 pr_warn("Bad number of tags on %s\n",
162 tags[num_args++] = ptr + 1;
168 if (num_args && clkctrl_nodes_missing)
171 node = of_find_node_by_name(NULL, buf);
172 if (num_args && compat_mode) {
174 child = of_get_child_by_name(parent, "clock");
176 child = of_get_child_by_name(parent, "clk");
184 clkspec.args_count = num_args;
185 for (i = 0; i < num_args; i++) {
186 ret = kstrtoint(tags[i], i ? 10 : 16, clkspec.args + i);
188 pr_warn("Bad tag in %s at %d: %s\n",
189 c->node_name, i, tags[i]);
194 clk = of_clk_get_from_provider(&clkspec);
200 if (num_args && !has_clkctrl_data) {
201 struct device_node *np;
203 np = of_find_compatible_node(NULL, NULL,
206 has_clkctrl_data = true;
209 clkctrl_nodes_missing = true;
211 pr_warn("missing clkctrl nodes, please update your dts.\n");
216 pr_warn("failed to lookup clock node %s, ret=%ld\n",
217 c->node_name, PTR_ERR(clk));
222 struct clk_init_item {
223 struct device_node *node;
225 ti_of_clk_init_cb_t func;
226 struct list_head link;
229 static LIST_HEAD(retry_list);
232 * ti_clk_retry_init - retries a failed clock init at later phase
233 * @node: device not for the clock
234 * @user: user data pointer
235 * @func: init function to be called for the clock
237 * Adds a failed clock init to the retry list. The retry list is parsed
238 * once all the other clocks have been initialized.
240 int __init ti_clk_retry_init(struct device_node *node, void *user,
241 ti_of_clk_init_cb_t func)
243 struct clk_init_item *retry;
245 pr_debug("%pOFn: adding to retry list...\n", node);
246 retry = kzalloc(sizeof(*retry), GFP_KERNEL);
253 list_add(&retry->link, &retry_list);
259 * ti_clk_get_reg_addr - get register address for a clock register
260 * @node: device node for the clock
261 * @index: register index from the clock node
262 * @reg: pointer to target register struct
264 * Builds clock register address from device tree information, and returns
265 * the data via the provided output pointer @reg. Returns 0 on success,
266 * negative error value on failure.
268 int ti_clk_get_reg_addr(struct device_node *node, int index,
269 struct clk_omap_reg *reg)
274 for (i = 0; i < CLK_MAX_MEMMAPS; i++) {
275 if (clocks_node_ptr[i] == node->parent)
279 if (i == CLK_MAX_MEMMAPS) {
280 pr_err("clk-provider not found for %pOFn!\n", node);
286 if (of_property_read_u32_index(node, "reg", index, &val)) {
287 pr_err("%pOFn must have reg[%d]!\n", node, index);
297 void ti_clk_latch(struct clk_omap_reg *reg, s8 shift)
306 ti_clk_ll_ops->clk_rmw(latch, latch, reg);
307 ti_clk_ll_ops->clk_rmw(0, latch, reg);
308 ti_clk_ll_ops->clk_readl(reg); /* OCP barrier */
312 * omap2_clk_provider_init - init master clock provider
313 * @parent: master node
314 * @index: internal index for clk_reg_ops
315 * @syscon: syscon regmap pointer for accessing clock registers
316 * @mem: iomem pointer for the clock provider memory area, only used if
317 * syscon is not provided
319 * Initializes a master clock IP block. This basically sets up the
320 * mapping from clocks node to the memory map index. All the clocks
321 * are then initialized through the common of_clk_init call, and the
322 * clocks will access their memory maps based on the node layout.
323 * Returns 0 in success.
325 int __init omap2_clk_provider_init(struct device_node *parent, int index,
326 struct regmap *syscon, void __iomem *mem)
328 struct device_node *clocks;
329 struct clk_iomap *io;
331 /* get clocks for this parent */
332 clocks = of_get_child_by_name(parent, "clocks");
334 pr_err("%pOFn missing 'clocks' child node.\n", parent);
338 /* add clocks node info */
339 clocks_node_ptr[index] = clocks;
341 io = kzalloc(sizeof(*io), GFP_KERNEL);
348 clk_memmaps[index] = io;
354 * omap2_clk_legacy_provider_init - initialize a legacy clock provider
355 * @index: index for the clock provider
356 * @mem: iomem pointer for the clock provider memory area
358 * Initializes a legacy clock provider memory mapping.
360 void __init omap2_clk_legacy_provider_init(int index, void __iomem *mem)
362 struct clk_iomap *io;
364 io = memblock_alloc(sizeof(*io), SMP_CACHE_BYTES);
366 panic("%s: Failed to allocate %zu bytes\n", __func__,
371 clk_memmaps[index] = io;
375 * ti_dt_clk_init_retry_clks - init clocks from the retry list
377 * Initializes any clocks that have failed to initialize before,
378 * reasons being missing parent node(s) during earlier init. This
379 * typically happens only for DPLLs which need to have both of their
380 * parent clocks ready during init.
382 void ti_dt_clk_init_retry_clks(void)
384 struct clk_init_item *retry;
385 struct clk_init_item *tmp;
388 while (!list_empty(&retry_list) && retries) {
389 list_for_each_entry_safe(retry, tmp, &retry_list, link) {
390 pr_debug("retry-init: %pOFn\n", retry->node);
391 retry->func(retry->user, retry->node);
392 list_del(&retry->link);
399 static const struct of_device_id simple_clk_match_table[] __initconst = {
400 { .compatible = "fixed-clock" },
401 { .compatible = "fixed-factor-clock" },
406 * ti_clk_add_aliases - setup clock aliases
408 * Sets up any missing clock aliases. No return value.
410 void __init ti_clk_add_aliases(void)
412 struct device_node *np;
415 for_each_matching_node(np, simple_clk_match_table) {
416 struct of_phandle_args clkspec;
419 clk = of_clk_get_from_provider(&clkspec);
421 ti_clk_add_alias(NULL, clk, np->name);
426 * ti_clk_setup_features - setup clock features flags
427 * @features: features definition to use
429 * Initializes the clock driver features flags based on platform
430 * provided data. No return value.
432 void __init ti_clk_setup_features(struct ti_clk_features *features)
434 memcpy(&ti_clk_features, features, sizeof(*features));
438 * ti_clk_get_features - get clock driver features flags
440 * Get TI clock driver features description. Returns a pointer
441 * to the current feature setup.
443 const struct ti_clk_features *ti_clk_get_features(void)
445 return &ti_clk_features;
449 * omap2_clk_enable_init_clocks - prepare & enable a list of clocks
450 * @clk_names: ptr to an array of strings of clock names to enable
451 * @num_clocks: number of clock names in @clk_names
453 * Prepare and enable a list of clocks, named by @clk_names. No
454 * return value. XXX Deprecated; only needed until these clocks are
455 * properly claimed and enabled by the drivers or core code that uses
456 * them. XXX What code disables & calls clk_put on these clocks?
458 void omap2_clk_enable_init_clocks(const char **clk_names, u8 num_clocks)
460 struct clk *init_clk;
463 for (i = 0; i < num_clocks; i++) {
464 init_clk = clk_get(NULL, clk_names[i]);
465 if (WARN(IS_ERR(init_clk), "could not find init clock %s\n",
468 clk_prepare_enable(init_clk);
473 * ti_clk_add_alias - add a clock alias for a TI clock
474 * @dev: device alias for this clock
475 * @clk: clock handle to create alias for
476 * @con: connection ID for this clock
478 * Creates a clock alias for a TI clock. Allocates the clock lookup entry
479 * and assigns the data to it. Returns 0 if successful, negative error
482 int ti_clk_add_alias(struct device *dev, struct clk *clk, const char *con)
484 struct clk_lookup *cl;
492 cl = kzalloc(sizeof(*cl), GFP_KERNEL);
497 cl->dev_id = dev_name(dev);
507 * ti_clk_register - register a TI clock to the common clock framework
508 * @dev: device for this clock
509 * @hw: hardware clock handle
510 * @con: connection ID for this clock
512 * Registers a TI clock to the common clock framework, and adds a clock
513 * alias for it. Returns a handle to the registered clock if successful,
514 * ERR_PTR value in failure.
516 struct clk *ti_clk_register(struct device *dev, struct clk_hw *hw,
522 clk = clk_register(dev, hw);
526 ret = ti_clk_add_alias(dev, clk, con);
536 * ti_clk_register_omap_hw - register a clk_hw_omap to the clock framework
537 * @dev: device for this clock
538 * @hw: hardware clock handle
539 * @con: connection ID for this clock
541 * Registers a clk_hw_omap clock to the clock framewor, adds a clock alias
542 * for it, and adds the list to the available clk_hw_omap type clocks.
543 * Returns a handle to the registered clock if successful, ERR_PTR value
546 struct clk *ti_clk_register_omap_hw(struct device *dev, struct clk_hw *hw,
550 struct clk_hw_omap *oclk;
552 clk = ti_clk_register(dev, hw, con);
556 oclk = to_clk_hw_omap(hw);
558 list_add(&oclk->node, &clk_hw_omap_clocks);
564 * omap2_clk_for_each - call function for each registered clk_hw_omap
565 * @fn: pointer to a callback function
567 * Call @fn for each registered clk_hw_omap, passing @hw to each
568 * function. @fn must return 0 for success or any other value for
569 * failure. If @fn returns non-zero, the iteration across clocks
570 * will stop and the non-zero return value will be passed to the
571 * caller of omap2_clk_for_each().
573 int omap2_clk_for_each(int (*fn)(struct clk_hw_omap *hw))
576 struct clk_hw_omap *hw;
578 list_for_each_entry(hw, &clk_hw_omap_clocks, node) {
588 * omap2_clk_is_hw_omap - check if the provided clk_hw is OMAP clock
589 * @hw: clk_hw to check if it is an omap clock or not
591 * Checks if the provided clk_hw is OMAP clock or not. Returns true if
592 * it is, false otherwise.
594 bool omap2_clk_is_hw_omap(struct clk_hw *hw)
596 struct clk_hw_omap *oclk;
598 list_for_each_entry(oclk, &clk_hw_omap_clocks, node) {