1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Clk driver for NXP LPC18xx/43xx Configuration Registers (CREG)
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2015 Joachim Eastwood <manabian@gmail.com>
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * This file is licensed under the terms of the GNU General Public
7*4882a593Smuzhiyun * License version 2. This program is licensed "as is" without any
8*4882a593Smuzhiyun * warranty of any kind, whether express or implied.
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/clk-provider.h>
12*4882a593Smuzhiyun #include <linux/delay.h>
13*4882a593Smuzhiyun #include <linux/kernel.h>
14*4882a593Smuzhiyun #include <linux/mfd/syscon.h>
15*4882a593Smuzhiyun #include <linux/of.h>
16*4882a593Smuzhiyun #include <linux/platform_device.h>
17*4882a593Smuzhiyun #include <linux/regmap.h>
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define LPC18XX_CREG_CREG0 0x004
20*4882a593Smuzhiyun #define LPC18XX_CREG_CREG0_EN1KHZ BIT(0)
21*4882a593Smuzhiyun #define LPC18XX_CREG_CREG0_EN32KHZ BIT(1)
22*4882a593Smuzhiyun #define LPC18XX_CREG_CREG0_RESET32KHZ BIT(2)
23*4882a593Smuzhiyun #define LPC18XX_CREG_CREG0_PD32KHZ BIT(3)
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun #define to_clk_creg(_hw) container_of(_hw, struct clk_creg_data, hw)
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun enum {
28*4882a593Smuzhiyun CREG_CLK_1KHZ,
29*4882a593Smuzhiyun CREG_CLK_32KHZ,
30*4882a593Smuzhiyun CREG_CLK_MAX,
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun struct clk_creg_data {
34*4882a593Smuzhiyun struct clk_hw hw;
35*4882a593Smuzhiyun const char *name;
36*4882a593Smuzhiyun struct regmap *reg;
37*4882a593Smuzhiyun unsigned int en_mask;
38*4882a593Smuzhiyun const struct clk_ops *ops;
39*4882a593Smuzhiyun };
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun #define CREG_CLK(_name, _emask, _ops) \
42*4882a593Smuzhiyun { \
43*4882a593Smuzhiyun .name = _name, \
44*4882a593Smuzhiyun .en_mask = LPC18XX_CREG_CREG0_##_emask, \
45*4882a593Smuzhiyun .ops = &_ops, \
46*4882a593Smuzhiyun }
47*4882a593Smuzhiyun
clk_creg_32k_prepare(struct clk_hw * hw)48*4882a593Smuzhiyun static int clk_creg_32k_prepare(struct clk_hw *hw)
49*4882a593Smuzhiyun {
50*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
51*4882a593Smuzhiyun int ret;
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun ret = regmap_update_bits(creg->reg, LPC18XX_CREG_CREG0,
54*4882a593Smuzhiyun LPC18XX_CREG_CREG0_PD32KHZ |
55*4882a593Smuzhiyun LPC18XX_CREG_CREG0_RESET32KHZ, 0);
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun /*
58*4882a593Smuzhiyun * Powering up the 32k oscillator takes a long while
59*4882a593Smuzhiyun * and sadly there aren't any status bit to poll.
60*4882a593Smuzhiyun */
61*4882a593Smuzhiyun msleep(2500);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun return ret;
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun
clk_creg_32k_unprepare(struct clk_hw * hw)66*4882a593Smuzhiyun static void clk_creg_32k_unprepare(struct clk_hw *hw)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun regmap_update_bits(creg->reg, LPC18XX_CREG_CREG0,
71*4882a593Smuzhiyun LPC18XX_CREG_CREG0_PD32KHZ,
72*4882a593Smuzhiyun LPC18XX_CREG_CREG0_PD32KHZ);
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun
clk_creg_32k_is_prepared(struct clk_hw * hw)75*4882a593Smuzhiyun static int clk_creg_32k_is_prepared(struct clk_hw *hw)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
78*4882a593Smuzhiyun u32 reg;
79*4882a593Smuzhiyun
80*4882a593Smuzhiyun regmap_read(creg->reg, LPC18XX_CREG_CREG0, ®);
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun return !(reg & LPC18XX_CREG_CREG0_PD32KHZ) &&
83*4882a593Smuzhiyun !(reg & LPC18XX_CREG_CREG0_RESET32KHZ);
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun
clk_creg_1k_recalc_rate(struct clk_hw * hw,unsigned long parent_rate)86*4882a593Smuzhiyun static unsigned long clk_creg_1k_recalc_rate(struct clk_hw *hw,
87*4882a593Smuzhiyun unsigned long parent_rate)
88*4882a593Smuzhiyun {
89*4882a593Smuzhiyun return parent_rate / 32;
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun
clk_creg_enable(struct clk_hw * hw)92*4882a593Smuzhiyun static int clk_creg_enable(struct clk_hw *hw)
93*4882a593Smuzhiyun {
94*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun return regmap_update_bits(creg->reg, LPC18XX_CREG_CREG0,
97*4882a593Smuzhiyun creg->en_mask, creg->en_mask);
98*4882a593Smuzhiyun }
99*4882a593Smuzhiyun
clk_creg_disable(struct clk_hw * hw)100*4882a593Smuzhiyun static void clk_creg_disable(struct clk_hw *hw)
101*4882a593Smuzhiyun {
102*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun regmap_update_bits(creg->reg, LPC18XX_CREG_CREG0,
105*4882a593Smuzhiyun creg->en_mask, 0);
106*4882a593Smuzhiyun }
107*4882a593Smuzhiyun
clk_creg_is_enabled(struct clk_hw * hw)108*4882a593Smuzhiyun static int clk_creg_is_enabled(struct clk_hw *hw)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun struct clk_creg_data *creg = to_clk_creg(hw);
111*4882a593Smuzhiyun u32 reg;
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun regmap_read(creg->reg, LPC18XX_CREG_CREG0, ®);
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun return !!(reg & creg->en_mask);
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun static const struct clk_ops clk_creg_32k = {
119*4882a593Smuzhiyun .enable = clk_creg_enable,
120*4882a593Smuzhiyun .disable = clk_creg_disable,
121*4882a593Smuzhiyun .is_enabled = clk_creg_is_enabled,
122*4882a593Smuzhiyun .prepare = clk_creg_32k_prepare,
123*4882a593Smuzhiyun .unprepare = clk_creg_32k_unprepare,
124*4882a593Smuzhiyun .is_prepared = clk_creg_32k_is_prepared,
125*4882a593Smuzhiyun };
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun static const struct clk_ops clk_creg_1k = {
128*4882a593Smuzhiyun .enable = clk_creg_enable,
129*4882a593Smuzhiyun .disable = clk_creg_disable,
130*4882a593Smuzhiyun .is_enabled = clk_creg_is_enabled,
131*4882a593Smuzhiyun .recalc_rate = clk_creg_1k_recalc_rate,
132*4882a593Smuzhiyun };
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun static struct clk_creg_data clk_creg_clocks[] = {
135*4882a593Smuzhiyun [CREG_CLK_1KHZ] = CREG_CLK("1khz_clk", EN1KHZ, clk_creg_1k),
136*4882a593Smuzhiyun [CREG_CLK_32KHZ] = CREG_CLK("32khz_clk", EN32KHZ, clk_creg_32k),
137*4882a593Smuzhiyun };
138*4882a593Smuzhiyun
clk_register_creg_clk(struct device * dev,struct clk_creg_data * creg_clk,const char ** parent_name,struct regmap * syscon)139*4882a593Smuzhiyun static struct clk *clk_register_creg_clk(struct device *dev,
140*4882a593Smuzhiyun struct clk_creg_data *creg_clk,
141*4882a593Smuzhiyun const char **parent_name,
142*4882a593Smuzhiyun struct regmap *syscon)
143*4882a593Smuzhiyun {
144*4882a593Smuzhiyun struct clk_init_data init;
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun init.ops = creg_clk->ops;
147*4882a593Smuzhiyun init.name = creg_clk->name;
148*4882a593Smuzhiyun init.parent_names = parent_name;
149*4882a593Smuzhiyun init.num_parents = 1;
150*4882a593Smuzhiyun init.flags = 0;
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun creg_clk->reg = syscon;
153*4882a593Smuzhiyun creg_clk->hw.init = &init;
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun if (dev)
156*4882a593Smuzhiyun return devm_clk_register(dev, &creg_clk->hw);
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun return clk_register(NULL, &creg_clk->hw);
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun static struct clk *clk_creg_early[CREG_CLK_MAX];
162*4882a593Smuzhiyun static struct clk_onecell_data clk_creg_early_data = {
163*4882a593Smuzhiyun .clks = clk_creg_early,
164*4882a593Smuzhiyun .clk_num = CREG_CLK_MAX,
165*4882a593Smuzhiyun };
166*4882a593Smuzhiyun
lpc18xx_creg_clk_init(struct device_node * np)167*4882a593Smuzhiyun static void __init lpc18xx_creg_clk_init(struct device_node *np)
168*4882a593Smuzhiyun {
169*4882a593Smuzhiyun const char *clk_32khz_parent;
170*4882a593Smuzhiyun struct regmap *syscon;
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun syscon = syscon_node_to_regmap(np->parent);
173*4882a593Smuzhiyun if (IS_ERR(syscon)) {
174*4882a593Smuzhiyun pr_err("%s: syscon lookup failed\n", __func__);
175*4882a593Smuzhiyun return;
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun
178*4882a593Smuzhiyun clk_32khz_parent = of_clk_get_parent_name(np, 0);
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun clk_creg_early[CREG_CLK_32KHZ] =
181*4882a593Smuzhiyun clk_register_creg_clk(NULL, &clk_creg_clocks[CREG_CLK_32KHZ],
182*4882a593Smuzhiyun &clk_32khz_parent, syscon);
183*4882a593Smuzhiyun clk_creg_early[CREG_CLK_1KHZ] = ERR_PTR(-EPROBE_DEFER);
184*4882a593Smuzhiyun
185*4882a593Smuzhiyun of_clk_add_provider(np, of_clk_src_onecell_get, &clk_creg_early_data);
186*4882a593Smuzhiyun }
187*4882a593Smuzhiyun CLK_OF_DECLARE_DRIVER(lpc18xx_creg_clk, "nxp,lpc1850-creg-clk",
188*4882a593Smuzhiyun lpc18xx_creg_clk_init);
189*4882a593Smuzhiyun
190*4882a593Smuzhiyun static struct clk *clk_creg[CREG_CLK_MAX];
191*4882a593Smuzhiyun static struct clk_onecell_data clk_creg_data = {
192*4882a593Smuzhiyun .clks = clk_creg,
193*4882a593Smuzhiyun .clk_num = CREG_CLK_MAX,
194*4882a593Smuzhiyun };
195*4882a593Smuzhiyun
lpc18xx_creg_clk_probe(struct platform_device * pdev)196*4882a593Smuzhiyun static int lpc18xx_creg_clk_probe(struct platform_device *pdev)
197*4882a593Smuzhiyun {
198*4882a593Smuzhiyun struct device_node *np = pdev->dev.of_node;
199*4882a593Smuzhiyun struct regmap *syscon;
200*4882a593Smuzhiyun
201*4882a593Smuzhiyun syscon = syscon_node_to_regmap(np->parent);
202*4882a593Smuzhiyun if (IS_ERR(syscon)) {
203*4882a593Smuzhiyun dev_err(&pdev->dev, "syscon lookup failed\n");
204*4882a593Smuzhiyun return PTR_ERR(syscon);
205*4882a593Smuzhiyun }
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun clk_creg[CREG_CLK_32KHZ] = clk_creg_early[CREG_CLK_32KHZ];
208*4882a593Smuzhiyun clk_creg[CREG_CLK_1KHZ] =
209*4882a593Smuzhiyun clk_register_creg_clk(NULL, &clk_creg_clocks[CREG_CLK_1KHZ],
210*4882a593Smuzhiyun &clk_creg_clocks[CREG_CLK_32KHZ].name,
211*4882a593Smuzhiyun syscon);
212*4882a593Smuzhiyun
213*4882a593Smuzhiyun return of_clk_add_provider(np, of_clk_src_onecell_get, &clk_creg_data);
214*4882a593Smuzhiyun }
215*4882a593Smuzhiyun
216*4882a593Smuzhiyun static const struct of_device_id lpc18xx_creg_clk_of_match[] = {
217*4882a593Smuzhiyun { .compatible = "nxp,lpc1850-creg-clk" },
218*4882a593Smuzhiyun {},
219*4882a593Smuzhiyun };
220*4882a593Smuzhiyun
221*4882a593Smuzhiyun static struct platform_driver lpc18xx_creg_clk_driver = {
222*4882a593Smuzhiyun .probe = lpc18xx_creg_clk_probe,
223*4882a593Smuzhiyun .driver = {
224*4882a593Smuzhiyun .name = "lpc18xx-creg-clk",
225*4882a593Smuzhiyun .of_match_table = lpc18xx_creg_clk_of_match,
226*4882a593Smuzhiyun },
227*4882a593Smuzhiyun };
228*4882a593Smuzhiyun builtin_platform_driver(lpc18xx_creg_clk_driver);
229