1/*
2 * Sysctrl clock implementation for ux500 platform.
3 *
4 * Copyright (C) 2013 ST-Ericsson SA
5 * Author: Ulf Hansson <ulf.hansson@linaro.org>
6 *
7 * License terms: GNU General Public License (GPL) version 2
8 */
9
10#include <linux/clk-provider.h>
11#include <linux/mfd/abx500/ab8500-sysctrl.h>
12#include <linux/device.h>
13#include <linux/slab.h>
14#include <linux/delay.h>
15#include <linux/io.h>
16#include <linux/err.h>
17#include "clk.h"
18
19#define SYSCTRL_MAX_NUM_PARENTS 4
20
21#define to_clk_sysctrl(_hw) container_of(_hw, struct clk_sysctrl, hw)
22
23struct clk_sysctrl {
24	struct clk_hw hw;
25	struct device *dev;
26	u8 parent_index;
27	u16 reg_sel[SYSCTRL_MAX_NUM_PARENTS];
28	u8 reg_mask[SYSCTRL_MAX_NUM_PARENTS];
29	u8 reg_bits[SYSCTRL_MAX_NUM_PARENTS];
30	unsigned long rate;
31	unsigned long enable_delay_us;
32};
33
34/* Sysctrl clock operations. */
35
36static int clk_sysctrl_prepare(struct clk_hw *hw)
37{
38	int ret;
39	struct clk_sysctrl *clk = to_clk_sysctrl(hw);
40
41	ret = ab8500_sysctrl_write(clk->reg_sel[0], clk->reg_mask[0],
42				clk->reg_bits[0]);
43
44	if (!ret && clk->enable_delay_us)
45		usleep_range(clk->enable_delay_us, clk->enable_delay_us);
46
47	return ret;
48}
49
50static void clk_sysctrl_unprepare(struct clk_hw *hw)
51{
52	struct clk_sysctrl *clk = to_clk_sysctrl(hw);
53	if (ab8500_sysctrl_clear(clk->reg_sel[0], clk->reg_mask[0]))
54		dev_err(clk->dev, "clk_sysctrl: %s fail to clear %s.\n",
55			__func__, clk_hw_get_name(hw));
56}
57
58static unsigned long clk_sysctrl_recalc_rate(struct clk_hw *hw,
59					unsigned long parent_rate)
60{
61	struct clk_sysctrl *clk = to_clk_sysctrl(hw);
62	return clk->rate;
63}
64
65static int clk_sysctrl_set_parent(struct clk_hw *hw, u8 index)
66{
67	struct clk_sysctrl *clk = to_clk_sysctrl(hw);
68	u8 old_index = clk->parent_index;
69	int ret = 0;
70
71	if (clk->reg_sel[old_index]) {
72		ret = ab8500_sysctrl_clear(clk->reg_sel[old_index],
73					clk->reg_mask[old_index]);
74		if (ret)
75			return ret;
76	}
77
78	if (clk->reg_sel[index]) {
79		ret = ab8500_sysctrl_write(clk->reg_sel[index],
80					clk->reg_mask[index],
81					clk->reg_bits[index]);
82		if (ret) {
83			if (clk->reg_sel[old_index])
84				ab8500_sysctrl_write(clk->reg_sel[old_index],
85						clk->reg_mask[old_index],
86						clk->reg_bits[old_index]);
87			return ret;
88		}
89	}
90	clk->parent_index = index;
91
92	return ret;
93}
94
95static u8 clk_sysctrl_get_parent(struct clk_hw *hw)
96{
97	struct clk_sysctrl *clk = to_clk_sysctrl(hw);
98	return clk->parent_index;
99}
100
101static struct clk_ops clk_sysctrl_gate_ops = {
102	.prepare = clk_sysctrl_prepare,
103	.unprepare = clk_sysctrl_unprepare,
104};
105
106static struct clk_ops clk_sysctrl_gate_fixed_rate_ops = {
107	.prepare = clk_sysctrl_prepare,
108	.unprepare = clk_sysctrl_unprepare,
109	.recalc_rate = clk_sysctrl_recalc_rate,
110};
111
112static struct clk_ops clk_sysctrl_set_parent_ops = {
113	.set_parent = clk_sysctrl_set_parent,
114	.get_parent = clk_sysctrl_get_parent,
115};
116
117static struct clk *clk_reg_sysctrl(struct device *dev,
118				const char *name,
119				const char **parent_names,
120				u8 num_parents,
121				u16 *reg_sel,
122				u8 *reg_mask,
123				u8 *reg_bits,
124				unsigned long rate,
125				unsigned long enable_delay_us,
126				unsigned long flags,
127				struct clk_ops *clk_sysctrl_ops)
128{
129	struct clk_sysctrl *clk;
130	struct clk_init_data clk_sysctrl_init;
131	struct clk *clk_reg;
132	int i;
133
134	if (!dev)
135		return ERR_PTR(-EINVAL);
136
137	if (!name || (num_parents > SYSCTRL_MAX_NUM_PARENTS)) {
138		dev_err(dev, "clk_sysctrl: invalid arguments passed\n");
139		return ERR_PTR(-EINVAL);
140	}
141
142	clk = devm_kzalloc(dev, sizeof(struct clk_sysctrl), GFP_KERNEL);
143	if (!clk) {
144		dev_err(dev, "clk_sysctrl: could not allocate clk\n");
145		return ERR_PTR(-ENOMEM);
146	}
147
148	/* set main clock registers */
149	clk->reg_sel[0] = reg_sel[0];
150	clk->reg_bits[0] = reg_bits[0];
151	clk->reg_mask[0] = reg_mask[0];
152
153	/* handle clocks with more than one parent */
154	for (i = 1; i < num_parents; i++) {
155		clk->reg_sel[i] = reg_sel[i];
156		clk->reg_bits[i] = reg_bits[i];
157		clk->reg_mask[i] = reg_mask[i];
158	}
159
160	clk->parent_index = 0;
161	clk->rate = rate;
162	clk->enable_delay_us = enable_delay_us;
163	clk->dev = dev;
164
165	clk_sysctrl_init.name = name;
166	clk_sysctrl_init.ops = clk_sysctrl_ops;
167	clk_sysctrl_init.flags = flags;
168	clk_sysctrl_init.parent_names = parent_names;
169	clk_sysctrl_init.num_parents = num_parents;
170	clk->hw.init = &clk_sysctrl_init;
171
172	clk_reg = devm_clk_register(clk->dev, &clk->hw);
173	if (IS_ERR(clk_reg))
174		dev_err(dev, "clk_sysctrl: clk_register failed\n");
175
176	return clk_reg;
177}
178
179struct clk *clk_reg_sysctrl_gate(struct device *dev,
180				const char *name,
181				const char *parent_name,
182				u16 reg_sel,
183				u8 reg_mask,
184				u8 reg_bits,
185				unsigned long enable_delay_us,
186				unsigned long flags)
187{
188	const char **parent_names = (parent_name ? &parent_name : NULL);
189	u8 num_parents = (parent_name ? 1 : 0);
190
191	return clk_reg_sysctrl(dev, name, parent_names, num_parents,
192			&reg_sel, &reg_mask, &reg_bits, 0, enable_delay_us,
193			flags, &clk_sysctrl_gate_ops);
194}
195
196struct clk *clk_reg_sysctrl_gate_fixed_rate(struct device *dev,
197					const char *name,
198					const char *parent_name,
199					u16 reg_sel,
200					u8 reg_mask,
201					u8 reg_bits,
202					unsigned long rate,
203					unsigned long enable_delay_us,
204					unsigned long flags)
205{
206	const char **parent_names = (parent_name ? &parent_name : NULL);
207	u8 num_parents = (parent_name ? 1 : 0);
208
209	return clk_reg_sysctrl(dev, name, parent_names, num_parents,
210			&reg_sel, &reg_mask, &reg_bits,
211			rate, enable_delay_us, flags,
212			&clk_sysctrl_gate_fixed_rate_ops);
213}
214
215struct clk *clk_reg_sysctrl_set_parent(struct device *dev,
216				const char *name,
217				const char **parent_names,
218				u8 num_parents,
219				u16 *reg_sel,
220				u8 *reg_mask,
221				u8 *reg_bits,
222				unsigned long flags)
223{
224	return clk_reg_sysctrl(dev, name, parent_names, num_parents,
225			reg_sel, reg_mask, reg_bits, 0, 0, flags,
226			&clk_sysctrl_set_parent_ops);
227}
228