]>
Commit | Line | Data |
---|---|---|
9d9f78ed MT |
1 | /* |
2 | * Copyright (C) 2010-2011 Canonical Ltd <[email protected]> | |
3 | * Copyright (C) 2011-2012 Mike Turquette, Linaro Ltd <[email protected]> | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License version 2 as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * Gated clock implementation | |
10 | */ | |
11 | ||
12 | #include <linux/clk-provider.h> | |
13 | #include <linux/module.h> | |
14 | #include <linux/slab.h> | |
15 | #include <linux/io.h> | |
16 | #include <linux/err.h> | |
17 | #include <linux/string.h> | |
18 | ||
19 | /** | |
20 | * DOC: basic gatable clock which can gate and ungate it's ouput | |
21 | * | |
22 | * Traits of this clock: | |
23 | * prepare - clk_(un)prepare only ensures parent is (un)prepared | |
24 | * enable - clk_enable and clk_disable are functional & control gating | |
25 | * rate - inherits rate from parent. No clk_set_rate support | |
26 | * parent - fixed parent. No clk_set_parent support | |
27 | */ | |
28 | ||
fbc42aab VK |
29 | /* |
30 | * It works on following logic: | |
31 | * | |
32 | * For enabling clock, enable = 1 | |
33 | * set2dis = 1 -> clear bit -> set = 0 | |
34 | * set2dis = 0 -> set bit -> set = 1 | |
35 | * | |
36 | * For disabling clock, enable = 0 | |
37 | * set2dis = 1 -> set bit -> set = 1 | |
38 | * set2dis = 0 -> clear bit -> set = 0 | |
39 | * | |
40 | * So, result is always: enable xor set2dis. | |
41 | */ | |
42 | static void clk_gate_endisable(struct clk_hw *hw, int enable) | |
9d9f78ed | 43 | { |
fbc42aab VK |
44 | struct clk_gate *gate = to_clk_gate(hw); |
45 | int set = gate->flags & CLK_GATE_SET_TO_DISABLE ? 1 : 0; | |
7af47248 | 46 | unsigned long uninitialized_var(flags); |
fbc42aab VK |
47 | u32 reg; |
48 | ||
49 | set ^= enable; | |
9d9f78ed MT |
50 | |
51 | if (gate->lock) | |
52 | spin_lock_irqsave(gate->lock, flags); | |
661e2180 SB |
53 | else |
54 | __acquire(gate->lock); | |
9d9f78ed | 55 | |
04577994 HZ |
56 | if (gate->flags & CLK_GATE_HIWORD_MASK) { |
57 | reg = BIT(gate->bit_idx + 16); | |
58 | if (set) | |
59 | reg |= BIT(gate->bit_idx); | |
60 | } else { | |
aa514ce3 | 61 | reg = clk_readl(gate->reg); |
04577994 HZ |
62 | |
63 | if (set) | |
64 | reg |= BIT(gate->bit_idx); | |
65 | else | |
66 | reg &= ~BIT(gate->bit_idx); | |
67 | } | |
9d9f78ed | 68 | |
aa514ce3 | 69 | clk_writel(reg, gate->reg); |
9d9f78ed MT |
70 | |
71 | if (gate->lock) | |
72 | spin_unlock_irqrestore(gate->lock, flags); | |
661e2180 SB |
73 | else |
74 | __release(gate->lock); | |
9d9f78ed MT |
75 | } |
76 | ||
77 | static int clk_gate_enable(struct clk_hw *hw) | |
78 | { | |
fbc42aab | 79 | clk_gate_endisable(hw, 1); |
9d9f78ed MT |
80 | |
81 | return 0; | |
82 | } | |
9d9f78ed MT |
83 | |
84 | static void clk_gate_disable(struct clk_hw *hw) | |
85 | { | |
fbc42aab | 86 | clk_gate_endisable(hw, 0); |
9d9f78ed | 87 | } |
9d9f78ed MT |
88 | |
89 | static int clk_gate_is_enabled(struct clk_hw *hw) | |
90 | { | |
91 | u32 reg; | |
92 | struct clk_gate *gate = to_clk_gate(hw); | |
93 | ||
aa514ce3 | 94 | reg = clk_readl(gate->reg); |
9d9f78ed MT |
95 | |
96 | /* if a set bit disables this clk, flip it before masking */ | |
97 | if (gate->flags & CLK_GATE_SET_TO_DISABLE) | |
98 | reg ^= BIT(gate->bit_idx); | |
99 | ||
100 | reg &= BIT(gate->bit_idx); | |
101 | ||
102 | return reg ? 1 : 0; | |
103 | } | |
9d9f78ed | 104 | |
822c250e | 105 | const struct clk_ops clk_gate_ops = { |
9d9f78ed MT |
106 | .enable = clk_gate_enable, |
107 | .disable = clk_gate_disable, | |
108 | .is_enabled = clk_gate_is_enabled, | |
109 | }; | |
110 | EXPORT_SYMBOL_GPL(clk_gate_ops); | |
111 | ||
27d54591 | 112 | /** |
e270d8cb | 113 | * clk_hw_register_gate - register a gate clock with the clock framework |
27d54591 MT |
114 | * @dev: device that is registering this clock |
115 | * @name: name of this clock | |
116 | * @parent_name: name of this clock's parent | |
117 | * @flags: framework-specific flags for this clock | |
118 | * @reg: register address to control gating of this clock | |
119 | * @bit_idx: which bit in the register controls gating of this clock | |
120 | * @clk_gate_flags: gate-specific flags for this clock | |
121 | * @lock: shared register lock for this clock | |
122 | */ | |
e270d8cb | 123 | struct clk_hw *clk_hw_register_gate(struct device *dev, const char *name, |
9d9f78ed MT |
124 | const char *parent_name, unsigned long flags, |
125 | void __iomem *reg, u8 bit_idx, | |
126 | u8 clk_gate_flags, spinlock_t *lock) | |
127 | { | |
128 | struct clk_gate *gate; | |
e270d8cb | 129 | struct clk_hw *hw; |
0197b3ea | 130 | struct clk_init_data init; |
e270d8cb | 131 | int ret; |
9d9f78ed | 132 | |
04577994 | 133 | if (clk_gate_flags & CLK_GATE_HIWORD_MASK) { |
2e9dcdae | 134 | if (bit_idx > 15) { |
04577994 HZ |
135 | pr_err("gate bit exceeds LOWORD field\n"); |
136 | return ERR_PTR(-EINVAL); | |
137 | } | |
138 | } | |
139 | ||
27d54591 | 140 | /* allocate the gate */ |
d122db7e SB |
141 | gate = kzalloc(sizeof(*gate), GFP_KERNEL); |
142 | if (!gate) | |
27d54591 | 143 | return ERR_PTR(-ENOMEM); |
9d9f78ed | 144 | |
0197b3ea SK |
145 | init.name = name; |
146 | init.ops = &clk_gate_ops; | |
f7d8caad | 147 | init.flags = flags | CLK_IS_BASIC; |
295face9 UKK |
148 | init.parent_names = parent_name ? &parent_name : NULL; |
149 | init.num_parents = parent_name ? 1 : 0; | |
0197b3ea | 150 | |
9d9f78ed MT |
151 | /* struct clk_gate assignments */ |
152 | gate->reg = reg; | |
153 | gate->bit_idx = bit_idx; | |
154 | gate->flags = clk_gate_flags; | |
155 | gate->lock = lock; | |
0197b3ea | 156 | gate->hw.init = &init; |
9d9f78ed | 157 | |
e270d8cb SB |
158 | hw = &gate->hw; |
159 | ret = clk_hw_register(dev, hw); | |
160 | if (ret) { | |
27d54591 | 161 | kfree(gate); |
e270d8cb SB |
162 | hw = ERR_PTR(ret); |
163 | } | |
27d54591 | 164 | |
e270d8cb SB |
165 | return hw; |
166 | } | |
167 | EXPORT_SYMBOL_GPL(clk_hw_register_gate); | |
168 | ||
169 | struct clk *clk_register_gate(struct device *dev, const char *name, | |
170 | const char *parent_name, unsigned long flags, | |
171 | void __iomem *reg, u8 bit_idx, | |
172 | u8 clk_gate_flags, spinlock_t *lock) | |
173 | { | |
174 | struct clk_hw *hw; | |
175 | ||
176 | hw = clk_hw_register_gate(dev, name, parent_name, flags, reg, | |
177 | bit_idx, clk_gate_flags, lock); | |
178 | if (IS_ERR(hw)) | |
179 | return ERR_CAST(hw); | |
180 | return hw->clk; | |
9d9f78ed | 181 | } |
5cfe10bb | 182 | EXPORT_SYMBOL_GPL(clk_register_gate); |
4e3c021f KK |
183 | |
184 | void clk_unregister_gate(struct clk *clk) | |
185 | { | |
186 | struct clk_gate *gate; | |
187 | struct clk_hw *hw; | |
188 | ||
189 | hw = __clk_get_hw(clk); | |
190 | if (!hw) | |
191 | return; | |
192 | ||
193 | gate = to_clk_gate(hw); | |
194 | ||
195 | clk_unregister(clk); | |
196 | kfree(gate); | |
197 | } | |
198 | EXPORT_SYMBOL_GPL(clk_unregister_gate); | |
e270d8cb SB |
199 | |
200 | void clk_hw_unregister_gate(struct clk_hw *hw) | |
201 | { | |
202 | struct clk_gate *gate; | |
203 | ||
204 | gate = to_clk_gate(hw); | |
205 | ||
206 | clk_hw_unregister(hw); | |
207 | kfree(gate); | |
208 | } | |
209 | EXPORT_SYMBOL_GPL(clk_hw_unregister_gate); |