1 /*
2  * Clock driver for the ARM Integrator/IM-PD1 board
3  * Copyright (C) 2012-2013 Linus Walleij
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 #include <linux/clk-provider.h>
10 #include <linux/clkdev.h>
11 #include <linux/err.h>
12 #include <linux/io.h>
13 #include <linux/platform_data/clk-integrator.h>
14 
15 #include "clk-icst.h"
16 
17 #define IMPD1_OSC1	0x00
18 #define IMPD1_OSC2	0x04
19 #define IMPD1_LOCK	0x08
20 
21 struct impd1_clk {
22 	char *pclkname;
23 	struct clk *pclk;
24 	char *vco1name;
25 	struct clk *vco1clk;
26 	char *vco2name;
27 	struct clk *vco2clk;
28 	struct clk *mmciclk;
29 	char *uartname;
30 	struct clk *uartclk;
31 	char *spiname;
32 	struct clk *spiclk;
33 	char *scname;
34 	struct clk *scclk;
35 	struct clk_lookup *clks[15];
36 };
37 
38 /* One entry for each connected IM-PD1 LM */
39 static struct impd1_clk impd1_clks[4];
40 
41 /*
42  * There are two VCO's on the IM-PD1
43  */
44 
45 static const struct icst_params impd1_vco1_params = {
46 	.ref		= 24000000,	/* 24 MHz */
47 	.vco_max	= ICST525_VCO_MAX_3V,
48 	.vco_min	= ICST525_VCO_MIN,
49 	.vd_min		= 12,
50 	.vd_max		= 519,
51 	.rd_min		= 3,
52 	.rd_max		= 120,
53 	.s2div		= icst525_s2div,
54 	.idx2s		= icst525_idx2s,
55 };
56 
57 static const struct clk_icst_desc impd1_icst1_desc = {
58 	.params = &impd1_vco1_params,
59 	.vco_offset = IMPD1_OSC1,
60 	.lock_offset = IMPD1_LOCK,
61 };
62 
63 static const struct icst_params impd1_vco2_params = {
64 	.ref		= 24000000,	/* 24 MHz */
65 	.vco_max	= ICST525_VCO_MAX_3V,
66 	.vco_min	= ICST525_VCO_MIN,
67 	.vd_min		= 12,
68 	.vd_max		= 519,
69 	.rd_min		= 3,
70 	.rd_max		= 120,
71 	.s2div		= icst525_s2div,
72 	.idx2s		= icst525_idx2s,
73 };
74 
75 static const struct clk_icst_desc impd1_icst2_desc = {
76 	.params = &impd1_vco2_params,
77 	.vco_offset = IMPD1_OSC2,
78 	.lock_offset = IMPD1_LOCK,
79 };
80 
81 /**
82  * integrator_impd1_clk_init() - set up the integrator clock tree
83  * @base: base address of the logic module (LM)
84  * @id: the ID of this LM
85  */
86 void integrator_impd1_clk_init(void __iomem *base, unsigned int id)
87 {
88 	struct impd1_clk *imc;
89 	struct clk *clk;
90 	struct clk *pclk;
91 	int i;
92 
93 	if (id > 3) {
94 		pr_crit("no more than 4 LMs can be attached\n");
95 		return;
96 	}
97 	imc = &impd1_clks[id];
98 
99 	/* Register the fixed rate PCLK */
100 	imc->pclkname = kasprintf(GFP_KERNEL, "lm%x-pclk", id);
101 	pclk = clk_register_fixed_rate(NULL, imc->pclkname, NULL,
102 				      CLK_IS_ROOT, 0);
103 	imc->pclk = pclk;
104 
105 	imc->vco1name = kasprintf(GFP_KERNEL, "lm%x-vco1", id);
106 	clk = icst_clk_register(NULL, &impd1_icst1_desc, imc->vco1name, NULL,
107 				base);
108 	imc->vco1clk = clk;
109 	imc->clks[0] = clkdev_alloc(pclk, "apb_pclk", "lm%x:01000", id);
110 	imc->clks[1] = clkdev_alloc(clk, NULL, "lm%x:01000", id);
111 
112 	/* VCO2 is also called "CLK2" */
113 	imc->vco2name = kasprintf(GFP_KERNEL, "lm%x-vco2", id);
114 	clk = icst_clk_register(NULL, &impd1_icst2_desc, imc->vco2name, NULL,
115 				base);
116 	imc->vco2clk = clk;
117 
118 	/* MMCI uses CLK2 right off */
119 	imc->clks[2] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00700", id);
120 	imc->clks[3] = clkdev_alloc(clk, NULL, "lm%x:00700", id);
121 
122 	/* UART reference clock divides CLK2 by a fixed factor 4 */
123 	imc->uartname = kasprintf(GFP_KERNEL, "lm%x-uartclk", id);
124 	clk = clk_register_fixed_factor(NULL, imc->uartname, imc->vco2name,
125 				   CLK_IGNORE_UNUSED, 1, 4);
126 	imc->uartclk = clk;
127 	imc->clks[4] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00100", id);
128 	imc->clks[5] = clkdev_alloc(clk, NULL, "lm%x:00100", id);
129 	imc->clks[6] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00200", id);
130 	imc->clks[7] = clkdev_alloc(clk, NULL, "lm%x:00200", id);
131 
132 	/* SPI PL022 clock divides CLK2 by a fixed factor 64 */
133 	imc->spiname = kasprintf(GFP_KERNEL, "lm%x-spiclk", id);
134 	clk = clk_register_fixed_factor(NULL, imc->spiname, imc->vco2name,
135 				   CLK_IGNORE_UNUSED, 1, 64);
136 	imc->clks[8] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00300", id);
137 	imc->clks[9] = clkdev_alloc(clk, NULL, "lm%x:00300", id);
138 
139 	/* The GPIO blocks and AACI have only PCLK */
140 	imc->clks[10] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00400", id);
141 	imc->clks[11] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00500", id);
142 	imc->clks[12] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00800", id);
143 
144 	/* Smart Card clock divides CLK2 by a fixed factor 4 */
145 	imc->scname = kasprintf(GFP_KERNEL, "lm%x-scclk", id);
146 	clk = clk_register_fixed_factor(NULL, imc->scname, imc->vco2name,
147 				   CLK_IGNORE_UNUSED, 1, 4);
148 	imc->scclk = clk;
149 	imc->clks[13] = clkdev_alloc(pclk, "apb_pclk", "lm%x:00600", id);
150 	imc->clks[14] = clkdev_alloc(clk, NULL, "lm%x:00600", id);
151 
152 	for (i = 0; i < ARRAY_SIZE(imc->clks); i++)
153 		clkdev_add(imc->clks[i]);
154 }
155 EXPORT_SYMBOL_GPL(integrator_impd1_clk_init);
156 
157 void integrator_impd1_clk_exit(unsigned int id)
158 {
159 	int i;
160 	struct impd1_clk *imc;
161 
162 	if (id > 3)
163 		return;
164 	imc = &impd1_clks[id];
165 
166 	for (i = 0; i < ARRAY_SIZE(imc->clks); i++)
167 		clkdev_drop(imc->clks[i]);
168 	clk_unregister(imc->spiclk);
169 	clk_unregister(imc->uartclk);
170 	clk_unregister(imc->vco2clk);
171 	clk_unregister(imc->vco1clk);
172 	clk_unregister(imc->pclk);
173 	kfree(imc->scname);
174 	kfree(imc->spiname);
175 	kfree(imc->uartname);
176 	kfree(imc->vco2name);
177 	kfree(imc->vco1name);
178 	kfree(imc->pclkname);
179 }
180 EXPORT_SYMBOL_GPL(integrator_impd1_clk_exit);
181