aboutsummaryrefslogtreecommitdiffstats
path: root/arch/arm/plat-spear/clock.c
blob: ee4f90e534d8b961e0fd7361b27894ba53e95b3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
/*
 * arch/arm/plat-spear/clock.c
 *
 * Clock framework for SPEAr platform
 *
 * Copyright (C) 2009 ST Microelectronics
 * Viresh Kumar<viresh.kumar@st.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2. This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#include <linux/bug.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <mach/misc_regs.h>
#include <plat/clock.h>

static DEFINE_SPINLOCK(clocks_lock);
static LIST_HEAD(root_clks);

static void propagate_rate(struct list_head *);

static int generic_clk_enable(struct clk *clk)
{
	unsigned int val;

	if (!clk->en_reg)
		return -EFAULT;

	val = readl(clk->en_reg);
	if (unlikely(clk->flags & RESET_TO_ENABLE))
		val &= ~(1 << clk->en_reg_bit);
	else
		val |= 1 << clk->en_reg_bit;

	writel(val, clk->en_reg);

	return 0;
}

static void generic_clk_disable(struct clk *clk)
{
	unsigned int val;

	if (!clk->en_reg)
		return;

	val = readl(clk->en_reg);
	if (unlikely(clk->flags & RESET_TO_ENABLE))
		val |= 1 << clk->en_reg_bit;
	else
		val &= ~(1 << clk->en_reg_bit);

	writel(val, clk->en_reg);
}

/* generic clk ops */
static struct clkops generic_clkops = {
	.enable = generic_clk_enable,
	.disable = generic_clk_disable,
};

/*
 * clk_enable - inform the system when the clock source should be running.
 * @clk: clock source
 *
 * If the clock can not be enabled/disabled, this should return success.
 *
 * Returns success (0) or negative errno.
 */
int clk_enable(struct clk *clk)
{
	unsigned long flags;
	int ret = 0;

	if (!clk || IS_ERR(clk))
		return -EFAULT;

	spin_lock_irqsave(&clocks_lock, flags);
	if (clk->usage_count == 0) {
		if (clk->ops && clk->ops->enable)
			ret = clk->ops->enable(clk);
	}
	clk->usage_count++;
	spin_unlock_irqrestore(&clocks_lock, flags);

	return ret;
}
EXPORT_SYMBOL(clk_enable);

/*
 * clk_disable - inform the system when the clock source is no longer required.
 * @clk: clock source
 *
 * Inform the system that a clock source is no longer required by
 * a driver and may be shut down.
 *
 * Implementation detail: if the clock source is shared between
 * multiple drivers, clk_enable() calls must be balanced by the
 * same number of clk_disable() calls for the clock source to be
 * disabled.
 */
void clk_disable(struct clk *clk)
{
	unsigned long flags;

	if (!clk || IS_ERR(clk))
		return;

	WARN_ON(clk->usage_count == 0);

	spin_lock_irqsave(&clocks_lock, flags);
	clk->usage_count--;
	if (clk->usage_count == 0) {
		if (clk->ops && clk->ops->disable)
			clk->ops->disable(clk);
	}
	spin_unlock_irqrestore(&clocks_lock, flags);
}
EXPORT_SYMBOL(clk_disable);

/**
 * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
 *		 This is only valid once the clock source has been enabled.
 * @clk: clock source
 */
unsigned long clk_get_rate(struct clk *clk)
{
	unsigned long flags, rate;

	spin_lock_irqsave(&clocks_lock, flags);
	rate = clk->rate;
	spin_unlock_irqrestore(&clocks_lock, flags);

	return rate;
}
EXPORT_SYMBOL(clk_get_rate);

/**
 * clk_set_parent - set the parent clock source for this clock
 * @clk: clock source
 * @parent: parent clock source
 *
 * Returns success (0) or negative errno.
 */
int clk_set_parent(struct clk *clk, struct clk *parent)
{
	int i, found = 0, val = 0;
	unsigned long flags;

	if (!clk || IS_ERR(clk) || !parent || IS_ERR(parent))
		return -EFAULT;
	if (clk->usage_count)
		return -EBUSY;
	if (!clk->pclk_sel)
		return -EPERM;
	if (clk->pclk == parent)
		return 0;

	for (i = 0; i < clk->pclk_sel->pclk_count; i++) {
		if (clk->pclk_sel->pclk_info[i].pclk == parent) {
			found = 1;
			break;
		}
	}

	if (!found)
		return -EINVAL;

	spin_lock_irqsave(&clocks_lock, flags);
	/* reflect parent change in hardware */
	val = readl(clk->pclk_sel->pclk_sel_reg);
	val &= ~(clk->pclk_sel->pclk_sel_mask << clk->pclk_sel_shift);
	val |= clk->pclk_sel->pclk_info[i].pclk_mask << clk->pclk_sel_shift;
	writel(val, clk->pclk_sel->pclk_sel_reg);
	spin_unlock_irqrestore(&clocks_lock, flags);

	/* reflect parent change in software */
	clk->recalc(clk);
	propagate_rate(&clk->children);
	return 0;
}
EXPORT_SYMBOL(clk_set_parent);

/* registers clock in platform clock framework */
void clk_register(struct clk_lookup *cl)
{
	struct clk *clk = cl->clk;
	unsigned long flags;

	if (!clk || IS_ERR(clk))
		return;

	spin_lock_irqsave(&clocks_lock, flags);

	INIT_LIST_HEAD(&clk->children);
	if (clk->flags & ALWAYS_ENABLED)
		clk->ops = NULL;
	else if (!clk->ops)
		clk->ops = &generic_clkops;

	/* root clock don't have any parents */
	if (!clk->pclk && !clk->pclk_sel) {
		list_add(&clk->sibling, &root_clks);
		/* add clocks with only one parent to parent's children list */
	} else if (clk->pclk && !clk->pclk_sel) {
		list_add(&clk->sibling, &clk->pclk->children);
	} else {
		/* add clocks with > 1 parent to 1st parent's children list */
		list_add(&clk->sibling,
			 &clk->pclk_sel->pclk_info[0].pclk->children);
	}
	spin_unlock_irqrestore(&clocks_lock, flags);

	/* add clock to arm clockdev framework */
	clkdev_add(cl);
}

/**
 * propagate_rate - recalculate and propagate all clocks in list head
 *
 * Recalculates all root clocks in list head, which if the clock's .recalc is
 * set correctly, should also propagate their rates.
 */
static void propagate_rate(struct list_head *lhead)
{
	struct clk *clkp, *_temp;

	list_for_each_entry_safe(clkp, _temp, lhead, sibling) {
		if (clkp->recalc)
			clkp->recalc(clkp);
		propagate_rate(&clkp->children);
	}
}

/* returns current programmed clocks clock info structure */
static struct pclk_info *pclk_info_get(struct clk *clk)
{
	unsigned int mask, i;
	unsigned long flags;
	struct pclk_info *info = NULL;

	spin_lock_irqsave(&clocks_lock, flags);
	mask = (readl(clk->pclk_sel->pclk_sel_reg) >> clk->pclk_sel_shift)
			& clk->pclk_sel->pclk_sel_mask;

	for (i = 0; i < clk->pclk_sel->pclk_count; i++) {
		if (clk->pclk_sel->pclk_info[i].pclk_mask == mask)
			info = &clk->pclk_sel->pclk_info[i];
	}
	spin_unlock_irqrestore(&clocks_lock, flags);

	return info;
}

/*
 * Set pclk as cclk's parent and add clock sibling node to current parents
 * children list
 */
static void change_parent(struct clk *cclk, struct clk *pclk)
{
	unsigned long flags;

	spin_lock_irqsave(&clocks_lock, flags);
	list_del(&cclk->sibling);
	list_add(&cclk->sibling, &pclk->children);

	cclk->pclk = pclk;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/*
 * calculates current programmed rate of pll1
 *
 * In normal mode
 * rate = (2 * M[15:8] * Fin)/(N * 2^P)
 *
 * In Dithered mode
 * rate = (2 * M[15:0] * Fin)/(256 * N * 2^P)
 */
void pll1_clk_recalc(struct clk *clk)
{
	struct pll_clk_config *config = clk->private_data;
	unsigned int num = 2, den = 0, val, mode = 0;
	unsigned long flags;

	spin_lock_irqsave(&clocks_lock, flags);
	mode = (readl(config->mode_reg) >> PLL_MODE_SHIFT) &
		PLL_MODE_MASK;

	val = readl(config->cfg_reg);
	/* calculate denominator */
	den = (val >> PLL_DIV_P_SHIFT) & PLL_DIV_P_MASK;
	den = 1 << den;
	den *= (val >> PLL_DIV_N_SHIFT) & PLL_DIV_N_MASK;

	/* calculate numerator & denominator */
	if (!mode) {
		/* Normal mode */
		num *= (val >> PLL_NORM_FDBK_M_SHIFT) & PLL_NORM_FDBK_M_MASK;
	} else {
		/* Dithered mode */
		num *= (val >> PLL_DITH_FDBK_M_SHIFT) & PLL_DITH_FDBK_M_MASK;
		den *= 256;
	}

	clk->rate = (((clk->pclk->rate/10000) * num) / den) * 10000;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/* calculates current programmed rate of ahb or apb bus */
void bus_clk_recalc(struct clk *clk)
{
	struct bus_clk_config *config = clk->private_data;
	unsigned int div;
	unsigned long flags;

	spin_lock_irqsave(&clocks_lock, flags);
	div = ((readl(config->reg) >> config->shift) & config->mask) + 1;
	clk->rate = (unsigned long)clk->pclk->rate / div;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/*
 * calculates current programmed rate of auxiliary synthesizers
 * used by: UART, FIRDA
 *
 * Fout from synthesizer can be given from two equations:
 * Fout1 = (Fin * X/Y)/2
 * Fout2 = Fin * X/Y
 *
 * Selection of eqn 1 or 2 is programmed in register
 */
void aux_clk_recalc(struct clk *clk)
{
	struct aux_clk_config *config = clk->private_data;
	struct pclk_info *pclk_info = NULL;
	unsigned int num = 1, den = 1, val, eqn;
	unsigned long flags;

	/* get current programmed parent */
	pclk_info = pclk_info_get(clk);
	if (!pclk_info) {
		spin_lock_irqsave(&clocks_lock, flags);
		clk->pclk = NULL;
		clk->rate = 0;
		spin_unlock_irqrestore(&clocks_lock, flags);
		return;
	}

	change_parent(clk, pclk_info->pclk);

	spin_lock_irqsave(&clocks_lock, flags);
	if (pclk_info->scalable) {
		val = readl(config->synth_reg);

		eqn = (val >> AUX_EQ_SEL_SHIFT) & AUX_EQ_SEL_MASK;
		if (eqn == AUX_EQ1_SEL)
			den *= 2;

		/* calculate numerator */
		num = (val >> AUX_XSCALE_SHIFT) & AUX_XSCALE_MASK;

		/* calculate denominator */
		den *= (val >> AUX_YSCALE_SHIFT) & AUX_YSCALE_MASK;
		val = (((clk->pclk->rate/10000) * num) / den) * 10000;
	} else
		val = clk->pclk->rate;

	clk->rate = val;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/*
 * calculates current programmed rate of gpt synthesizers
 * Fout from synthesizer can be given from below equations:
 * Fout= Fin/((2 ^ (N+1)) * (M+1))
 */
void gpt_clk_recalc(struct clk *clk)
{
	struct aux_clk_config *config = clk->private_data;
	struct pclk_info *pclk_info = NULL;
	unsigned int div = 1, val;
	unsigned long flags;

	pclk_info = pclk_info_get(clk);
	if (!pclk_info) {
		spin_lock_irqsave(&clocks_lock, flags);
		clk->pclk = NULL;
		clk->rate = 0;
		spin_unlock_irqrestore(&clocks_lock, flags);
		return;
	}

	change_parent(clk, pclk_info->pclk);

	spin_lock_irqsave(&clocks_lock, flags);
	if (pclk_info->scalable) {
		val = readl(config->synth_reg);
		div += (val >> GPT_MSCALE_SHIFT) & GPT_MSCALE_MASK;
		div *= 1 << (((val >> GPT_NSCALE_SHIFT) & GPT_NSCALE_MASK) + 1);
	}

	clk->rate = (unsigned long)clk->pclk->rate / div;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/*
 * Used for clocks that always have same value as the parent clock divided by a
 * fixed divisor
 */
void follow_parent(struct clk *clk)
{
	unsigned long flags;

	spin_lock_irqsave(&clocks_lock, flags);
	clk->rate = clk->pclk->rate;
	spin_unlock_irqrestore(&clocks_lock, flags);
}

/**
 * recalc_root_clocks - recalculate and propagate all root clocks
 *
 * Recalculates all root clocks (clocks with no parent), which if the
 * clock's .recalc is set correctly, should also propagate their rates.
 */
void recalc_root_clocks(void)
{
	propagate_rate(&root_clks);
}