2 * Copyright (C) 2011 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * Standard functionality for the common clock API.
10 #include <linux/module.h>
11 #include <linux/clk-provider.h>
12 #include <linux/slab.h>
13 #include <linux/err.h>
17 * DOC: basic fixed multiplier and divider clock that cannot gate
19 * Traits of this clock:
20 * prepare - clk_prepare only ensures that parents are prepared
21 * enable - clk_enable only ensures that parents are enabled
22 * rate - rate is fixed. clk->rate = parent->rate / div * mult
23 * parent - fixed parent. No clk_set_parent support
26 static unsigned long clk_factor_recalc_rate(struct clk_hw *hw,
27 unsigned long parent_rate)
29 struct clk_fixed_factor *fix = to_clk_fixed_factor(hw);
30 unsigned long long int rate;
32 rate = (unsigned long long int)parent_rate * fix->mult;
33 do_div(rate, fix->div);
34 return (unsigned long)rate;
37 static long clk_factor_round_rate(struct clk_hw *hw, unsigned long rate,
40 struct clk_fixed_factor *fix = to_clk_fixed_factor(hw);
42 if (clk_hw_get_flags(hw) & CLK_SET_RATE_PARENT) {
43 unsigned long best_parent;
45 best_parent = (rate / fix->mult) * fix->div;
46 *prate = clk_hw_round_rate(clk_hw_get_parent(hw), best_parent);
49 return (*prate / fix->div) * fix->mult;
52 static int clk_factor_set_rate(struct clk_hw *hw, unsigned long rate,
53 unsigned long parent_rate)
56 * We must report success but we can do so unconditionally because
57 * clk_factor_round_rate returns values that ensure this call is a
64 const struct clk_ops clk_fixed_factor_ops = {
65 .round_rate = clk_factor_round_rate,
66 .set_rate = clk_factor_set_rate,
67 .recalc_rate = clk_factor_recalc_rate,
69 EXPORT_SYMBOL_GPL(clk_fixed_factor_ops);
71 struct clk_hw *clk_hw_register_fixed_factor(struct device *dev,
72 const char *name, const char *parent_name, unsigned long flags,
73 unsigned int mult, unsigned int div)
75 struct clk_fixed_factor *fix;
76 struct clk_init_data init;
80 fix = kmalloc(sizeof(*fix), GFP_KERNEL);
82 return ERR_PTR(-ENOMEM);
84 /* struct clk_fixed_factor assignments */
90 init.ops = &clk_fixed_factor_ops;
91 init.flags = flags | CLK_IS_BASIC;
92 init.parent_names = &parent_name;
96 ret = clk_hw_register(dev, hw);
104 EXPORT_SYMBOL_GPL(clk_hw_register_fixed_factor);
106 struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
107 const char *parent_name, unsigned long flags,
108 unsigned int mult, unsigned int div)
112 hw = clk_hw_register_fixed_factor(dev, name, parent_name, flags, mult,
118 EXPORT_SYMBOL_GPL(clk_register_fixed_factor);
120 void clk_unregister_fixed_factor(struct clk *clk)
124 hw = __clk_get_hw(clk);
129 kfree(to_clk_fixed_factor(hw));
131 EXPORT_SYMBOL_GPL(clk_unregister_fixed_factor);
133 void clk_hw_unregister_fixed_factor(struct clk_hw *hw)
135 struct clk_fixed_factor *fix;
137 fix = to_clk_fixed_factor(hw);
139 clk_hw_unregister(hw);
142 EXPORT_SYMBOL_GPL(clk_hw_unregister_fixed_factor);
145 static const struct of_device_id set_rate_parent_matches[] = {
146 { .compatible = "allwinner,sun4i-a10-pll3-2x-clk" },
151 * of_fixed_factor_clk_setup() - Setup function for simple fixed factor clock
153 void __init of_fixed_factor_clk_setup(struct device_node *node)
156 const char *clk_name = node->name;
157 const char *parent_name;
158 unsigned long flags = 0;
161 if (of_property_read_u32(node, "clock-div", &div)) {
162 pr_err("%s Fixed factor clock <%s> must have a clock-div property\n",
163 __func__, node->name);
167 if (of_property_read_u32(node, "clock-mult", &mult)) {
168 pr_err("%s Fixed factor clock <%s> must have a clock-mult property\n",
169 __func__, node->name);
173 of_property_read_string(node, "clock-output-names", &clk_name);
174 parent_name = of_clk_get_parent_name(node, 0);
176 if (of_match_node(set_rate_parent_matches, node))
177 flags |= CLK_SET_RATE_PARENT;
179 clk = clk_register_fixed_factor(NULL, clk_name, parent_name, flags,
182 of_clk_add_provider(node, of_clk_src_simple_get, clk);
184 EXPORT_SYMBOL_GPL(of_fixed_factor_clk_setup);
185 CLK_OF_DECLARE(fixed_factor_clk, "fixed-factor-clock",
186 of_fixed_factor_clk_setup);