Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0
2 : : /*
3 : : * Copyright (C) 2010-2011 Canonical Ltd <jeremy.kerr@canonical.com>
4 : : * Copyright (C) 2011-2012 Mike Turquette, Linaro Ltd <mturquette@linaro.org>
5 : : *
6 : : * Gated clock implementation
7 : : */
8 : :
9 : : #include <linux/clk-provider.h>
10 : : #include <linux/module.h>
11 : : #include <linux/slab.h>
12 : : #include <linux/io.h>
13 : : #include <linux/err.h>
14 : : #include <linux/string.h>
15 : :
16 : : /**
17 : : * DOC: basic gatable clock which can gate and ungate it's ouput
18 : : *
19 : : * Traits of this clock:
20 : : * prepare - clk_(un)prepare only ensures parent is (un)prepared
21 : : * enable - clk_enable and clk_disable are functional & control gating
22 : : * rate - inherits rate from parent. No clk_set_rate support
23 : : * parent - fixed parent. No clk_set_parent support
24 : : */
25 : :
26 : 0 : static inline u32 clk_gate_readl(struct clk_gate *gate)
27 : : {
28 : 0 : if (gate->flags & CLK_GATE_BIG_ENDIAN)
29 : 0 : return ioread32be(gate->reg);
30 : :
31 : 0 : return readl(gate->reg);
32 : : }
33 : :
34 : 0 : static inline void clk_gate_writel(struct clk_gate *gate, u32 val)
35 : : {
36 : 0 : if (gate->flags & CLK_GATE_BIG_ENDIAN)
37 : 0 : iowrite32be(val, gate->reg);
38 : : else
39 : 0 : writel(val, gate->reg);
40 : : }
41 : :
42 : : /*
43 : : * It works on following logic:
44 : : *
45 : : * For enabling clock, enable = 1
46 : : * set2dis = 1 -> clear bit -> set = 0
47 : : * set2dis = 0 -> set bit -> set = 1
48 : : *
49 : : * For disabling clock, enable = 0
50 : : * set2dis = 1 -> set bit -> set = 1
51 : : * set2dis = 0 -> clear bit -> set = 0
52 : : *
53 : : * So, result is always: enable xor set2dis.
54 : : */
55 : 0 : static void clk_gate_endisable(struct clk_hw *hw, int enable)
56 : : {
57 : 0 : struct clk_gate *gate = to_clk_gate(hw);
58 : 0 : int set = gate->flags & CLK_GATE_SET_TO_DISABLE ? 1 : 0;
59 : 0 : unsigned long uninitialized_var(flags);
60 : 0 : u32 reg;
61 : :
62 : 0 : set ^= enable;
63 : :
64 [ # # ]: 0 : if (gate->lock)
65 : 0 : spin_lock_irqsave(gate->lock, flags);
66 : : else
67 : 0 : __acquire(gate->lock);
68 : :
69 [ # # ]: 0 : if (gate->flags & CLK_GATE_HIWORD_MASK) {
70 : 0 : reg = BIT(gate->bit_idx + 16);
71 [ # # ]: 0 : if (set)
72 : 0 : reg |= BIT(gate->bit_idx);
73 : : } else {
74 [ # # ]: 0 : reg = clk_gate_readl(gate);
75 : :
76 [ # # ]: 0 : if (set)
77 : 0 : reg |= BIT(gate->bit_idx);
78 : : else
79 : 0 : reg &= ~BIT(gate->bit_idx);
80 : : }
81 : :
82 [ # # ]: 0 : clk_gate_writel(gate, reg);
83 : :
84 [ # # ]: 0 : if (gate->lock)
85 : 0 : spin_unlock_irqrestore(gate->lock, flags);
86 : : else
87 : 0 : __release(gate->lock);
88 : 0 : }
89 : :
90 : 0 : static int clk_gate_enable(struct clk_hw *hw)
91 : : {
92 : 0 : clk_gate_endisable(hw, 1);
93 : :
94 : 0 : return 0;
95 : : }
96 : :
97 : 0 : static void clk_gate_disable(struct clk_hw *hw)
98 : : {
99 : 0 : clk_gate_endisable(hw, 0);
100 : 0 : }
101 : :
102 : 0 : int clk_gate_is_enabled(struct clk_hw *hw)
103 : : {
104 : 0 : u32 reg;
105 : 0 : struct clk_gate *gate = to_clk_gate(hw);
106 : :
107 [ # # ]: 0 : reg = clk_gate_readl(gate);
108 : :
109 : : /* if a set bit disables this clk, flip it before masking */
110 [ # # ]: 0 : if (gate->flags & CLK_GATE_SET_TO_DISABLE)
111 : 0 : reg ^= BIT(gate->bit_idx);
112 : :
113 : 0 : reg &= BIT(gate->bit_idx);
114 : :
115 : 0 : return reg ? 1 : 0;
116 : : }
117 : : EXPORT_SYMBOL_GPL(clk_gate_is_enabled);
118 : :
119 : : const struct clk_ops clk_gate_ops = {
120 : : .enable = clk_gate_enable,
121 : : .disable = clk_gate_disable,
122 : : .is_enabled = clk_gate_is_enabled,
123 : : };
124 : : EXPORT_SYMBOL_GPL(clk_gate_ops);
125 : :
126 : 0 : struct clk_hw *__clk_hw_register_gate(struct device *dev,
127 : : struct device_node *np, const char *name,
128 : : const char *parent_name, const struct clk_hw *parent_hw,
129 : : const struct clk_parent_data *parent_data,
130 : : unsigned long flags,
131 : : void __iomem *reg, u8 bit_idx,
132 : : u8 clk_gate_flags, spinlock_t *lock)
133 : : {
134 : 0 : struct clk_gate *gate;
135 : 0 : struct clk_hw *hw;
136 : 0 : struct clk_init_data init = {};
137 : 0 : int ret = -EINVAL;
138 : :
139 [ # # ]: 0 : if (clk_gate_flags & CLK_GATE_HIWORD_MASK) {
140 [ # # ]: 0 : if (bit_idx > 15) {
141 : 0 : pr_err("gate bit exceeds LOWORD field\n");
142 : 0 : return ERR_PTR(-EINVAL);
143 : : }
144 : : }
145 : :
146 : : /* allocate the gate */
147 : 0 : gate = kzalloc(sizeof(*gate), GFP_KERNEL);
148 [ # # ]: 0 : if (!gate)
149 : : return ERR_PTR(-ENOMEM);
150 : :
151 : 0 : init.name = name;
152 : 0 : init.ops = &clk_gate_ops;
153 : 0 : init.flags = flags;
154 [ # # ]: 0 : init.parent_names = parent_name ? &parent_name : NULL;
155 [ # # ]: 0 : init.parent_hws = parent_hw ? &parent_hw : NULL;
156 : 0 : init.parent_data = parent_data;
157 [ # # # # : 0 : if (parent_name || parent_hw || parent_data)
# # ]
158 : 0 : init.num_parents = 1;
159 : : else
160 : 0 : init.num_parents = 0;
161 : :
162 : : /* struct clk_gate assignments */
163 : 0 : gate->reg = reg;
164 : 0 : gate->bit_idx = bit_idx;
165 : 0 : gate->flags = clk_gate_flags;
166 : 0 : gate->lock = lock;
167 : 0 : gate->hw.init = &init;
168 : :
169 : 0 : hw = &gate->hw;
170 [ # # ]: 0 : if (dev || !np)
171 : 0 : ret = clk_hw_register(dev, hw);
172 : 0 : else if (np)
173 : 0 : ret = of_clk_hw_register(np, hw);
174 [ # # ]: 0 : if (ret) {
175 : 0 : kfree(gate);
176 : 0 : hw = ERR_PTR(ret);
177 : : }
178 : :
179 : : return hw;
180 : :
181 : : }
182 : : EXPORT_SYMBOL_GPL(__clk_hw_register_gate);
183 : :
184 : 0 : struct clk *clk_register_gate(struct device *dev, const char *name,
185 : : const char *parent_name, unsigned long flags,
186 : : void __iomem *reg, u8 bit_idx,
187 : : u8 clk_gate_flags, spinlock_t *lock)
188 : : {
189 : 0 : struct clk_hw *hw;
190 : :
191 : 0 : hw = clk_hw_register_gate(dev, name, parent_name, flags, reg,
192 : : bit_idx, clk_gate_flags, lock);
193 [ # # ]: 0 : if (IS_ERR(hw))
194 : : return ERR_CAST(hw);
195 : 0 : return hw->clk;
196 : : }
197 : : EXPORT_SYMBOL_GPL(clk_register_gate);
198 : :
199 : 0 : void clk_unregister_gate(struct clk *clk)
200 : : {
201 : 0 : struct clk_gate *gate;
202 : 0 : struct clk_hw *hw;
203 : :
204 : 0 : hw = __clk_get_hw(clk);
205 [ # # ]: 0 : if (!hw)
206 : : return;
207 : :
208 : 0 : gate = to_clk_gate(hw);
209 : :
210 : 0 : clk_unregister(clk);
211 : 0 : kfree(gate);
212 : : }
213 : : EXPORT_SYMBOL_GPL(clk_unregister_gate);
214 : :
215 : 0 : void clk_hw_unregister_gate(struct clk_hw *hw)
216 : : {
217 : 0 : struct clk_gate *gate;
218 : :
219 : 0 : gate = to_clk_gate(hw);
220 : :
221 : 0 : clk_hw_unregister(hw);
222 : 0 : kfree(gate);
223 : 0 : }
224 : : EXPORT_SYMBOL_GPL(clk_hw_unregister_gate);
|