Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
  1/*
  2 * Clk driver for NXP LPC18xx/LPC43xx Clock Generation Unit (CGU)
  3 *
  4 * Copyright (C) 2015 Joachim Eastwood <manabian@gmail.com>
  5 *
  6 * This file is licensed under the terms of the GNU General Public
  7 * License version 2. This program is licensed "as is" without any
  8 * warranty of any kind, whether express or implied.
  9 */
 10
 11#include <linux/clk-provider.h>
 12#include <linux/delay.h>
 13#include <linux/io.h>
 14#include <linux/kernel.h>
 15#include <linux/of.h>
 16#include <linux/of_address.h>
 17
 18#include <dt-bindings/clock/lpc18xx-cgu.h>
 19
 20/* Clock Generation Unit (CGU) registers */
 21#define LPC18XX_CGU_XTAL_OSC_CTRL	0x018
 22#define LPC18XX_CGU_PLL0USB_STAT	0x01c
 23#define LPC18XX_CGU_PLL0USB_CTRL	0x020
 24#define LPC18XX_CGU_PLL0USB_MDIV	0x024
 25#define LPC18XX_CGU_PLL0USB_NP_DIV	0x028
 26#define LPC18XX_CGU_PLL0AUDIO_STAT	0x02c
 27#define LPC18XX_CGU_PLL0AUDIO_CTRL	0x030
 28#define LPC18XX_CGU_PLL0AUDIO_MDIV	0x034
 29#define LPC18XX_CGU_PLL0AUDIO_NP_DIV	0x038
 30#define LPC18XX_CGU_PLL0AUDIO_FRAC	0x03c
 31#define LPC18XX_CGU_PLL1_STAT		0x040
 32#define LPC18XX_CGU_PLL1_CTRL		0x044
 33#define  LPC18XX_PLL1_CTRL_FBSEL	BIT(6)
 34#define  LPC18XX_PLL1_CTRL_DIRECT	BIT(7)
 35#define LPC18XX_CGU_IDIV_CTRL(n)	(0x048 + (n) * sizeof(u32))
 36#define LPC18XX_CGU_BASE_CLK(id)	(0x05c + (id) * sizeof(u32))
 37#define LPC18XX_CGU_PLL_CTRL_OFFSET	0x4
 38
 39/* PLL0 bits common to both audio and USB PLL */
 40#define LPC18XX_PLL0_STAT_LOCK		BIT(0)
 41#define LPC18XX_PLL0_CTRL_PD		BIT(0)
 42#define LPC18XX_PLL0_CTRL_BYPASS	BIT(1)
 43#define LPC18XX_PLL0_CTRL_DIRECTI	BIT(2)
 44#define LPC18XX_PLL0_CTRL_DIRECTO	BIT(3)
 45#define LPC18XX_PLL0_CTRL_CLKEN		BIT(4)
 46#define LPC18XX_PLL0_MDIV_MDEC_MASK	0x1ffff
 47#define LPC18XX_PLL0_MDIV_SELP_SHIFT	17
 48#define LPC18XX_PLL0_MDIV_SELI_SHIFT	22
 49#define LPC18XX_PLL0_MSEL_MAX		BIT(15)
 50
 51/* Register value that gives PLL0 post/pre dividers equal to 1 */
 52#define LPC18XX_PLL0_NP_DIVS_1		0x00302062
 53
 54enum {
 55	CLK_SRC_OSC32,
 56	CLK_SRC_IRC,
 57	CLK_SRC_ENET_RX_CLK,
 58	CLK_SRC_ENET_TX_CLK,
 59	CLK_SRC_GP_CLKIN,
 60	CLK_SRC_RESERVED1,
 61	CLK_SRC_OSC,
 62	CLK_SRC_PLL0USB,
 63	CLK_SRC_PLL0AUDIO,
 64	CLK_SRC_PLL1,
 65	CLK_SRC_RESERVED2,
 66	CLK_SRC_RESERVED3,
 67	CLK_SRC_IDIVA,
 68	CLK_SRC_IDIVB,
 69	CLK_SRC_IDIVC,
 70	CLK_SRC_IDIVD,
 71	CLK_SRC_IDIVE,
 72	CLK_SRC_MAX
 73};
 74
 75static const char *clk_src_names[CLK_SRC_MAX] = {
 76	[CLK_SRC_OSC32]		= "osc32",
 77	[CLK_SRC_IRC]		= "irc",
 78	[CLK_SRC_ENET_RX_CLK]	= "enet_rx_clk",
 79	[CLK_SRC_ENET_TX_CLK]	= "enet_tx_clk",
 80	[CLK_SRC_GP_CLKIN]	= "gp_clkin",
 81	[CLK_SRC_OSC]		= "osc",
 82	[CLK_SRC_PLL0USB]	= "pll0usb",
 83	[CLK_SRC_PLL0AUDIO]	= "pll0audio",
 84	[CLK_SRC_PLL1]		= "pll1",
 85	[CLK_SRC_IDIVA]		= "idiva",
 86	[CLK_SRC_IDIVB]		= "idivb",
 87	[CLK_SRC_IDIVC]		= "idivc",
 88	[CLK_SRC_IDIVD]		= "idivd",
 89	[CLK_SRC_IDIVE]		= "idive",
 90};
 91
 92static const char *clk_base_names[BASE_CLK_MAX] = {
 93	[BASE_SAFE_CLK]		= "base_safe_clk",
 94	[BASE_USB0_CLK]		= "base_usb0_clk",
 95	[BASE_PERIPH_CLK]	= "base_periph_clk",
 96	[BASE_USB1_CLK]		= "base_usb1_clk",
 97	[BASE_CPU_CLK]		= "base_cpu_clk",
 98	[BASE_SPIFI_CLK]	= "base_spifi_clk",
 99	[BASE_SPI_CLK]		= "base_spi_clk",
100	[BASE_PHY_RX_CLK]	= "base_phy_rx_clk",
101	[BASE_PHY_TX_CLK]	= "base_phy_tx_clk",
102	[BASE_APB1_CLK]		= "base_apb1_clk",
103	[BASE_APB3_CLK]		= "base_apb3_clk",
104	[BASE_LCD_CLK]		= "base_lcd_clk",
105	[BASE_ADCHS_CLK]	= "base_adchs_clk",
106	[BASE_SDIO_CLK]		= "base_sdio_clk",
107	[BASE_SSP0_CLK]		= "base_ssp0_clk",
108	[BASE_SSP1_CLK]		= "base_ssp1_clk",
109	[BASE_UART0_CLK]	= "base_uart0_clk",
110	[BASE_UART1_CLK]	= "base_uart1_clk",
111	[BASE_UART2_CLK]	= "base_uart2_clk",
112	[BASE_UART3_CLK]	= "base_uart3_clk",
113	[BASE_OUT_CLK]		= "base_out_clk",
114	[BASE_AUDIO_CLK]	= "base_audio_clk",
115	[BASE_CGU_OUT0_CLK]	= "base_cgu_out0_clk",
116	[BASE_CGU_OUT1_CLK]	= "base_cgu_out1_clk",
117};
118
119static u32 lpc18xx_cgu_pll0_src_ids[] = {
120	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
121	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
122	CLK_SRC_PLL1, CLK_SRC_IDIVA, CLK_SRC_IDIVB, CLK_SRC_IDIVC,
123	CLK_SRC_IDIVD, CLK_SRC_IDIVE,
124};
125
126static u32 lpc18xx_cgu_pll1_src_ids[] = {
127	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
128	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
129	CLK_SRC_PLL0USB, CLK_SRC_PLL0AUDIO, CLK_SRC_IDIVA,
130	CLK_SRC_IDIVB, CLK_SRC_IDIVC, CLK_SRC_IDIVD, CLK_SRC_IDIVE,
131};
132
133static u32 lpc18xx_cgu_idiva_src_ids[] = {
134	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
135	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
136	CLK_SRC_PLL0USB, CLK_SRC_PLL0AUDIO, CLK_SRC_PLL1
137};
138
139static u32 lpc18xx_cgu_idivbcde_src_ids[] = {
140	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
141	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
142	CLK_SRC_PLL0AUDIO, CLK_SRC_PLL1, CLK_SRC_IDIVA,
143};
144
145static u32 lpc18xx_cgu_base_irc_src_ids[] = {CLK_SRC_IRC};
146
147static u32 lpc18xx_cgu_base_usb0_src_ids[] = {CLK_SRC_PLL0USB};
148
149static u32 lpc18xx_cgu_base_common_src_ids[] = {
150	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
151	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
152	CLK_SRC_PLL0AUDIO, CLK_SRC_PLL1, CLK_SRC_IDIVA,
153	CLK_SRC_IDIVB, CLK_SRC_IDIVC, CLK_SRC_IDIVD, CLK_SRC_IDIVE,
154};
155
156static u32 lpc18xx_cgu_base_all_src_ids[] = {
157	CLK_SRC_OSC32, CLK_SRC_IRC, CLK_SRC_ENET_RX_CLK,
158	CLK_SRC_ENET_TX_CLK, CLK_SRC_GP_CLKIN, CLK_SRC_OSC,
159	CLK_SRC_PLL0USB, CLK_SRC_PLL0AUDIO, CLK_SRC_PLL1,
160	CLK_SRC_IDIVA, CLK_SRC_IDIVB, CLK_SRC_IDIVC,
161	CLK_SRC_IDIVD, CLK_SRC_IDIVE,
162};
163
164struct lpc18xx_cgu_src_clk_div {
165	u8 clk_id;
166	u8 n_parents;
167	struct clk_divider	div;
168	struct clk_mux		mux;
169	struct clk_gate		gate;
170};
171
172#define LPC1XX_CGU_SRC_CLK_DIV(_id, _width, _table)	\
173{							\
174	.clk_id = CLK_SRC_ ##_id,			\
175	.n_parents = ARRAY_SIZE(lpc18xx_cgu_ ##_table),	\
176	.div = {					\
177		.shift = 2,				\
178		.width = _width,			\
179	},						\
180	.mux = {					\
181		.mask = 0x1f,				\
182		.shift = 24,				\
183		.table = lpc18xx_cgu_ ##_table,		\
184	},						\
185	.gate = {					\
186		.bit_idx = 0,				\
187		.flags = CLK_GATE_SET_TO_DISABLE,	\
188	},						\
189}
190
191static struct lpc18xx_cgu_src_clk_div lpc18xx_cgu_src_clk_divs[] = {
192	LPC1XX_CGU_SRC_CLK_DIV(IDIVA, 2, idiva_src_ids),
193	LPC1XX_CGU_SRC_CLK_DIV(IDIVB, 4, idivbcde_src_ids),
194	LPC1XX_CGU_SRC_CLK_DIV(IDIVC, 4, idivbcde_src_ids),
195	LPC1XX_CGU_SRC_CLK_DIV(IDIVD, 4, idivbcde_src_ids),
196	LPC1XX_CGU_SRC_CLK_DIV(IDIVE, 8, idivbcde_src_ids),
197};
198
199struct lpc18xx_cgu_base_clk {
200	u8 clk_id;
201	u8 n_parents;
202	struct clk_mux mux;
203	struct clk_gate gate;
204};
205
206#define LPC1XX_CGU_BASE_CLK(_id, _table, _flags)	\
207{							\
208	.clk_id = BASE_ ##_id ##_CLK,			\
209	.n_parents = ARRAY_SIZE(lpc18xx_cgu_ ##_table),	\
210	.mux = {					\
211		.mask = 0x1f,				\
212		.shift = 24,				\
213		.table = lpc18xx_cgu_ ##_table,		\
214		.flags = _flags,			\
215	},						\
216	.gate = {					\
217		.bit_idx = 0,				\
218		.flags = CLK_GATE_SET_TO_DISABLE,	\
219	},						\
220}
221
222static struct lpc18xx_cgu_base_clk lpc18xx_cgu_base_clks[] = {
223	LPC1XX_CGU_BASE_CLK(SAFE,	base_irc_src_ids, CLK_MUX_READ_ONLY),
224	LPC1XX_CGU_BASE_CLK(USB0,	base_usb0_src_ids,   0),
225	LPC1XX_CGU_BASE_CLK(PERIPH,	base_common_src_ids, 0),
226	LPC1XX_CGU_BASE_CLK(USB1,	base_all_src_ids,    0),
227	LPC1XX_CGU_BASE_CLK(CPU,	base_common_src_ids, 0),
228	LPC1XX_CGU_BASE_CLK(SPIFI,	base_common_src_ids, 0),
229	LPC1XX_CGU_BASE_CLK(SPI,	base_common_src_ids, 0),
230	LPC1XX_CGU_BASE_CLK(PHY_RX,	base_common_src_ids, 0),
231	LPC1XX_CGU_BASE_CLK(PHY_TX,	base_common_src_ids, 0),
232	LPC1XX_CGU_BASE_CLK(APB1,	base_common_src_ids, 0),
233	LPC1XX_CGU_BASE_CLK(APB3,	base_common_src_ids, 0),
234	LPC1XX_CGU_BASE_CLK(LCD,	base_common_src_ids, 0),
235	LPC1XX_CGU_BASE_CLK(ADCHS,	base_common_src_ids, 0),
236	LPC1XX_CGU_BASE_CLK(SDIO,	base_common_src_ids, 0),
237	LPC1XX_CGU_BASE_CLK(SSP0,	base_common_src_ids, 0),
238	LPC1XX_CGU_BASE_CLK(SSP1,	base_common_src_ids, 0),
239	LPC1XX_CGU_BASE_CLK(UART0,	base_common_src_ids, 0),
240	LPC1XX_CGU_BASE_CLK(UART1,	base_common_src_ids, 0),
241	LPC1XX_CGU_BASE_CLK(UART2,	base_common_src_ids, 0),
242	LPC1XX_CGU_BASE_CLK(UART3,	base_common_src_ids, 0),
243	LPC1XX_CGU_BASE_CLK(OUT,	base_all_src_ids,    0),
244	{ /* 21 reserved */ },
245	{ /* 22 reserved */ },
246	{ /* 23 reserved */ },
247	{ /* 24 reserved */ },
248	LPC1XX_CGU_BASE_CLK(AUDIO,	base_common_src_ids, 0),
249	LPC1XX_CGU_BASE_CLK(CGU_OUT0,	base_all_src_ids,    0),
250	LPC1XX_CGU_BASE_CLK(CGU_OUT1,	base_all_src_ids,    0),
251};
252
253struct lpc18xx_pll {
254	struct		clk_hw hw;
255	void __iomem	*reg;
256	spinlock_t	*lock;
257	u8		flags;
258};
259
260#define to_lpc_pll(hw) container_of(hw, struct lpc18xx_pll, hw)
261
262struct lpc18xx_cgu_pll_clk {
263	u8 clk_id;
264	u8 n_parents;
265	u8 reg_offset;
266	struct clk_mux mux;
267	struct clk_gate gate;
268	struct lpc18xx_pll pll;
269	const struct clk_ops *pll_ops;
270};
271
272#define LPC1XX_CGU_CLK_PLL(_id, _table, _pll_ops)	\
273{							\
274	.clk_id = CLK_SRC_ ##_id,			\
275	.n_parents = ARRAY_SIZE(lpc18xx_cgu_ ##_table),	\
276	.reg_offset = LPC18XX_CGU_ ##_id ##_STAT,	\
277	.mux = {					\
278		.mask = 0x1f,				\
279		.shift = 24,				\
280		.table = lpc18xx_cgu_ ##_table,		\
281	},						\
282	.gate = {					\
283		.bit_idx = 0,				\
284		.flags = CLK_GATE_SET_TO_DISABLE,	\
285	},						\
286	.pll_ops = &lpc18xx_ ##_pll_ops,		\
287}
288
289/*
290 * PLL0 uses a special register value encoding. The compute functions below
291 * are taken or derived from the LPC1850 user manual (section 12.6.3.3).
292 */
293
294/* Compute PLL0 multiplier from decoded version */
295static u32 lpc18xx_pll0_mdec2msel(u32 x)
296{
297	int i;
298
299	switch (x) {
300	case 0x18003: return 1;
301	case 0x10003: return 2;
302	default:
303		for (i = LPC18XX_PLL0_MSEL_MAX + 1; x != 0x4000 && i > 0; i--)
304			x = ((x ^ x >> 14) & 1) | (x << 1 & 0x7fff);
305		return i;
306	}
307}
308/* Compute PLL0 decoded multiplier from binary version */
309static u32 lpc18xx_pll0_msel2mdec(u32 msel)
310{
311	u32 i, x = 0x4000;
312
313	switch (msel) {
314	case 0: return 0;
315	case 1: return 0x18003;
316	case 2: return 0x10003;
317	default:
318		for (i = msel; i <= LPC18XX_PLL0_MSEL_MAX; i++)
319			x = ((x ^ x >> 1) & 1) << 14 | (x >> 1 & 0xffff);
320		return x;
321	}
322}
323
324/* Compute PLL0 bandwidth SELI reg from multiplier */
325static u32 lpc18xx_pll0_msel2seli(u32 msel)
326{
327	u32 tmp;
328
329	if (msel > 16384) return 1;
330	if (msel >  8192) return 2;
331	if (msel >  2048) return 4;
332	if (msel >=  501) return 8;
333	if (msel >=   60) {
334		tmp = 1024 / (msel + 9);
335		return ((1024 == (tmp * (msel + 9))) == 0) ? tmp * 4 : (tmp + 1) * 4;
336	}
337
338	return (msel & 0x3c) + 4;
339}
340
341/* Compute PLL0 bandwidth SELP reg from multiplier */
342static u32 lpc18xx_pll0_msel2selp(u32 msel)
343{
344	if (msel < 60)
345		return (msel >> 1) + 1;
346
347	return 31;
348}
349
350static unsigned long lpc18xx_pll0_recalc_rate(struct clk_hw *hw,
351					      unsigned long parent_rate)
352{
353	struct lpc18xx_pll *pll = to_lpc_pll(hw);
354	u32 ctrl, mdiv, msel, npdiv;
355
356	ctrl = readl(pll->reg + LPC18XX_CGU_PLL0USB_CTRL);
357	mdiv = readl(pll->reg + LPC18XX_CGU_PLL0USB_MDIV);
358	npdiv = readl(pll->reg + LPC18XX_CGU_PLL0USB_NP_DIV);
359
360	if (ctrl & LPC18XX_PLL0_CTRL_BYPASS)
361		return parent_rate;
362
363	if (npdiv != LPC18XX_PLL0_NP_DIVS_1) {
364		pr_warn("%s: pre/post dividers not supported\n", __func__);
365		return 0;
366	}
367
368	msel = lpc18xx_pll0_mdec2msel(mdiv & LPC18XX_PLL0_MDIV_MDEC_MASK);
369	if (msel)
370		return 2 * msel * parent_rate;
371
372	pr_warn("%s: unable to calculate rate\n", __func__);
373
374	return 0;
375}
376
377static long lpc18xx_pll0_round_rate(struct clk_hw *hw, unsigned long rate,
378				    unsigned long *prate)
379{
380	unsigned long m;
381
382	if (*prate < rate) {
383		pr_warn("%s: pll dividers not supported\n", __func__);
384		return -EINVAL;
385	}
386
387	m = DIV_ROUND_UP_ULL(*prate, rate * 2);
388	if (m <= 0 && m > LPC18XX_PLL0_MSEL_MAX) {
389		pr_warn("%s: unable to support rate %lu\n", __func__, rate);
390		return -EINVAL;
391	}
392
393	return 2 * *prate * m;
394}
395
396static int lpc18xx_pll0_set_rate(struct clk_hw *hw, unsigned long rate,
397				 unsigned long parent_rate)
398{
399	struct lpc18xx_pll *pll = to_lpc_pll(hw);
400	u32 ctrl, stat, m;
401	int retry = 3;
402
403	if (parent_rate < rate) {
404		pr_warn("%s: pll dividers not supported\n", __func__);
405		return -EINVAL;
406	}
407
408	m = DIV_ROUND_UP_ULL(parent_rate, rate * 2);
409	if (m <= 0 && m > LPC18XX_PLL0_MSEL_MAX) {
410		pr_warn("%s: unable to support rate %lu\n", __func__, rate);
411		return -EINVAL;
412	}
413
414	m  = lpc18xx_pll0_msel2mdec(m);
415	m |= lpc18xx_pll0_msel2selp(m) << LPC18XX_PLL0_MDIV_SELP_SHIFT;
416	m |= lpc18xx_pll0_msel2seli(m) << LPC18XX_PLL0_MDIV_SELI_SHIFT;
417
418	/* Power down PLL, disable clk output and dividers */
419	ctrl = readl(pll->reg + LPC18XX_CGU_PLL0USB_CTRL);
420	ctrl |= LPC18XX_PLL0_CTRL_PD;
421	ctrl &= ~(LPC18XX_PLL0_CTRL_BYPASS | LPC18XX_PLL0_CTRL_DIRECTI |
422		  LPC18XX_PLL0_CTRL_DIRECTO | LPC18XX_PLL0_CTRL_CLKEN);
423	writel(ctrl, pll->reg + LPC18XX_CGU_PLL0USB_CTRL);
424
425	/* Configure new PLL settings */
426	writel(m, pll->reg + LPC18XX_CGU_PLL0USB_MDIV);
427	writel(LPC18XX_PLL0_NP_DIVS_1, pll->reg + LPC18XX_CGU_PLL0USB_NP_DIV);
428
429	/* Power up PLL and wait for lock */
430	ctrl &= ~LPC18XX_PLL0_CTRL_PD;
431	writel(ctrl, pll->reg + LPC18XX_CGU_PLL0USB_CTRL);
432	do {
433		udelay(10);
434		stat = readl(pll->reg + LPC18XX_CGU_PLL0USB_STAT);
435		if (stat & LPC18XX_PLL0_STAT_LOCK) {
436			ctrl |= LPC18XX_PLL0_CTRL_CLKEN;
437			writel(ctrl, pll->reg + LPC18XX_CGU_PLL0USB_CTRL);
438
439			return 0;
440		}
441	} while (retry--);
442
443	pr_warn("%s: unable to lock pll\n", __func__);
444
445	return -EINVAL;
446}
447
448static const struct clk_ops lpc18xx_pll0_ops = {
449	.recalc_rate	= lpc18xx_pll0_recalc_rate,
450	.round_rate	= lpc18xx_pll0_round_rate,
451	.set_rate	= lpc18xx_pll0_set_rate,
452};
453
454static unsigned long lpc18xx_pll1_recalc_rate(struct clk_hw *hw,
455					      unsigned long parent_rate)
456{
457	struct lpc18xx_pll *pll = to_lpc_pll(hw);
458	u16 msel, nsel, psel;
459	bool direct, fbsel;
460	u32 stat, ctrl;
461
462	stat = readl(pll->reg + LPC18XX_CGU_PLL1_STAT);
463	ctrl = readl(pll->reg + LPC18XX_CGU_PLL1_CTRL);
464
465	direct = (ctrl & LPC18XX_PLL1_CTRL_DIRECT) ? true : false;
466	fbsel = (ctrl & LPC18XX_PLL1_CTRL_FBSEL) ? true : false;
467
468	msel = ((ctrl >> 16) & 0xff) + 1;
469	nsel = ((ctrl >> 12) & 0x3) + 1;
470
471	if (direct || fbsel)
472		return msel * (parent_rate / nsel);
473
474	psel = (ctrl >>  8) & 0x3;
475	psel = 1 << psel;
476
477	return (msel / (2 * psel)) * (parent_rate / nsel);
478}
479
480static const struct clk_ops lpc18xx_pll1_ops = {
481	.recalc_rate = lpc18xx_pll1_recalc_rate,
482};
483
484static int lpc18xx_cgu_gate_enable(struct clk_hw *hw)
485{
486	return clk_gate_ops.enable(hw);
487}
488
489static void lpc18xx_cgu_gate_disable(struct clk_hw *hw)
490{
491	clk_gate_ops.disable(hw);
492}
493
494static int lpc18xx_cgu_gate_is_enabled(struct clk_hw *hw)
495{
496	const struct clk_hw *parent;
497
498	/*
499	 * The consumer of base clocks needs know if the
500	 * base clock is really enabled before it can be
501	 * accessed. It is therefore necessary to verify
502	 * this all the way up.
503	 */
504	parent = clk_hw_get_parent(hw);
505	if (!parent)
506		return 0;
507
508	if (!clk_hw_is_enabled(parent))
509		return 0;
510
511	return clk_gate_ops.is_enabled(hw);
512}
513
514static const struct clk_ops lpc18xx_gate_ops = {
515	.enable = lpc18xx_cgu_gate_enable,
516	.disable = lpc18xx_cgu_gate_disable,
517	.is_enabled = lpc18xx_cgu_gate_is_enabled,
518};
519
520static struct lpc18xx_cgu_pll_clk lpc18xx_cgu_src_clk_plls[] = {
521	LPC1XX_CGU_CLK_PLL(PLL0USB,	pll0_src_ids, pll0_ops),
522	LPC1XX_CGU_CLK_PLL(PLL0AUDIO,	pll0_src_ids, pll0_ops),
523	LPC1XX_CGU_CLK_PLL(PLL1,	pll1_src_ids, pll1_ops),
524};
525
526static void lpc18xx_fill_parent_names(const char **parent, u32 *id, int size)
527{
528	int i;
529
530	for (i = 0; i < size; i++)
531		parent[i] = clk_src_names[id[i]];
532}
533
534static struct clk *lpc18xx_cgu_register_div(struct lpc18xx_cgu_src_clk_div *clk,
535					    void __iomem *base, int n)
536{
537	void __iomem *reg = base + LPC18XX_CGU_IDIV_CTRL(n);
538	const char *name = clk_src_names[clk->clk_id];
539	const char *parents[CLK_SRC_MAX];
540
541	clk->div.reg = reg;
542	clk->mux.reg = reg;
543	clk->gate.reg = reg;
544
545	lpc18xx_fill_parent_names(parents, clk->mux.table, clk->n_parents);
546
547	return clk_register_composite(NULL, name, parents, clk->n_parents,
548				      &clk->mux.hw, &clk_mux_ops,
549				      &clk->div.hw, &clk_divider_ops,
550				      &clk->gate.hw, &lpc18xx_gate_ops, 0);
551}
552
553
554static struct clk *lpc18xx_register_base_clk(struct lpc18xx_cgu_base_clk *clk,
555					     void __iomem *reg_base, int n)
556{
557	void __iomem *reg = reg_base + LPC18XX_CGU_BASE_CLK(n);
558	const char *name = clk_base_names[clk->clk_id];
559	const char *parents[CLK_SRC_MAX];
560
561	if (clk->n_parents == 0)
562		return ERR_PTR(-ENOENT);
563
564	clk->mux.reg = reg;
565	clk->gate.reg = reg;
566
567	lpc18xx_fill_parent_names(parents, clk->mux.table, clk->n_parents);
568
569	/* SAFE_CLK can not be turned off */
570	if (n == BASE_SAFE_CLK)
571		return clk_register_composite(NULL, name, parents, clk->n_parents,
572					      &clk->mux.hw, &clk_mux_ops,
573					      NULL, NULL, NULL, NULL, 0);
574
575	return clk_register_composite(NULL, name, parents, clk->n_parents,
576				      &clk->mux.hw, &clk_mux_ops,
577				      NULL,  NULL,
578				      &clk->gate.hw, &lpc18xx_gate_ops, 0);
579}
580
581
582static struct clk *lpc18xx_cgu_register_pll(struct lpc18xx_cgu_pll_clk *clk,
583					    void __iomem *base)
584{
585	const char *name = clk_src_names[clk->clk_id];
586	const char *parents[CLK_SRC_MAX];
587
588	clk->pll.reg  = base;
589	clk->mux.reg  = base + clk->reg_offset + LPC18XX_CGU_PLL_CTRL_OFFSET;
590	clk->gate.reg = base + clk->reg_offset + LPC18XX_CGU_PLL_CTRL_OFFSET;
591
592	lpc18xx_fill_parent_names(parents, clk->mux.table, clk->n_parents);
593
594	return clk_register_composite(NULL, name, parents, clk->n_parents,
595				      &clk->mux.hw, &clk_mux_ops,
596				      &clk->pll.hw, clk->pll_ops,
597				      &clk->gate.hw, &lpc18xx_gate_ops, 0);
598}
599
600static void __init lpc18xx_cgu_register_source_clks(struct device_node *np,
601						    void __iomem *base)
602{
603	const char *parents[CLK_SRC_MAX];
604	struct clk *clk;
605	int i;
606
607	/* Register the internal 12 MHz RC oscillator (IRC) */
608	clk = clk_register_fixed_rate(NULL, clk_src_names[CLK_SRC_IRC],
609				      NULL, 0, 12000000);
610	if (IS_ERR(clk))
611		pr_warn("%s: failed to register irc clk\n", __func__);
612
613	/* Register crystal oscillator controlller */
614	parents[0] = of_clk_get_parent_name(np, 0);
615	clk = clk_register_gate(NULL, clk_src_names[CLK_SRC_OSC], parents[0],
616				0, base + LPC18XX_CGU_XTAL_OSC_CTRL,
617				0, CLK_GATE_SET_TO_DISABLE, NULL);
618	if (IS_ERR(clk))
619		pr_warn("%s: failed to register osc clk\n", __func__);
620
621	/* Register all PLLs */
622	for (i = 0; i < ARRAY_SIZE(lpc18xx_cgu_src_clk_plls); i++) {
623		clk = lpc18xx_cgu_register_pll(&lpc18xx_cgu_src_clk_plls[i],
624						   base);
625		if (IS_ERR(clk))
626			pr_warn("%s: failed to register pll (%d)\n", __func__, i);
627	}
628
629	/* Register all clock dividers A-E */
630	for (i = 0; i < ARRAY_SIZE(lpc18xx_cgu_src_clk_divs); i++) {
631		clk = lpc18xx_cgu_register_div(&lpc18xx_cgu_src_clk_divs[i],
632					       base, i);
633		if (IS_ERR(clk))
634			pr_warn("%s: failed to register div %d\n", __func__, i);
635	}
636}
637
638static struct clk *clk_base[BASE_CLK_MAX];
639static struct clk_onecell_data clk_base_data = {
640	.clks = clk_base,
641	.clk_num = BASE_CLK_MAX,
642};
643
644static void __init lpc18xx_cgu_register_base_clks(void __iomem *reg_base)
645{
646	int i;
647
648	for (i = BASE_SAFE_CLK; i < BASE_CLK_MAX; i++) {
649		clk_base[i] = lpc18xx_register_base_clk(&lpc18xx_cgu_base_clks[i],
650							reg_base, i);
651		if (IS_ERR(clk_base[i]) && PTR_ERR(clk_base[i]) != -ENOENT)
652			pr_warn("%s: register base clk %d failed\n", __func__, i);
653	}
654}
655
656static void __init lpc18xx_cgu_init(struct device_node *np)
657{
658	void __iomem *reg_base;
659
660	reg_base = of_iomap(np, 0);
661	if (!reg_base) {
662		pr_warn("%s: failed to map address range\n", __func__);
663		return;
664	}
665
666	lpc18xx_cgu_register_source_clks(np, reg_base);
667	lpc18xx_cgu_register_base_clks(reg_base);
668
669	of_clk_add_provider(np, of_clk_src_onecell_get, &clk_base_data);
670}
671CLK_OF_DECLARE(lpc18xx_cgu, "nxp,lpc1850-cgu", lpc18xx_cgu_init);