smiapp-pll.c 14.3 KB
Newer Older
1
/*
2
 * drivers/media/i2c/smiapp-pll.c
3 4 5 6
 *
 * Generic driver for SMIA/SMIA++ compliant camera modules
 *
 * Copyright (C) 2011--2012 Nokia Corporation
7
 * Contact: Sakari Ailus <sakari.ailus@iki.fi>
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
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#include <linux/gcd.h>
#include <linux/lcm.h>
#include <linux/module.h>

#include "smiapp-pll.h"

/* Return an even number or one. */
static inline uint32_t clk_div_even(uint32_t a)
{
	return max_t(uint32_t, 1, a & ~1);
}

/* Return an even number or one. */
static inline uint32_t clk_div_even_up(uint32_t a)
{
	if (a == 1)
		return 1;
	return (a + 1) & ~1;
}

static inline uint32_t is_one_or_even(uint32_t a)
{
	if (a == 1)
		return 1;
	if (a & 1)
		return 0;

	return 1;
}

static int bounds_check(struct device *dev, uint32_t val,
			uint32_t min, uint32_t max, char *str)
{
	if (val >= min && val <= max)
		return 0;

61
	dev_dbg(dev, "%s out of bounds: %d (%d--%d)\n", str, val, min, max);
62 63 64 65 66 67

	return -EINVAL;
}

static void print_pll(struct device *dev, struct smiapp_pll *pll)
{
68 69
	dev_dbg(dev, "pre_pll_clk_div\t%u\n",  pll->pre_pll_clk_div);
	dev_dbg(dev, "pll_multiplier \t%u\n",  pll->pll_multiplier);
70
	if (!(pll->flags & SMIAPP_PLL_FLAG_NO_OP_CLOCKS)) {
71 72
		dev_dbg(dev, "op_sys_clk_div \t%u\n", pll->op_sys_clk_div);
		dev_dbg(dev, "op_pix_clk_div \t%u\n", pll->op_pix_clk_div);
73
	}
74 75
	dev_dbg(dev, "vt_sys_clk_div \t%u\n",  pll->vt_sys_clk_div);
	dev_dbg(dev, "vt_pix_clk_div \t%u\n",  pll->vt_pix_clk_div);
76

77 78 79
	dev_dbg(dev, "ext_clk_freq_hz \t%u\n", pll->ext_clk_freq_hz);
	dev_dbg(dev, "pll_ip_clk_freq_hz \t%u\n", pll->pll_ip_clk_freq_hz);
	dev_dbg(dev, "pll_op_clk_freq_hz \t%u\n", pll->pll_op_clk_freq_hz);
80
	if (!(pll->flags & SMIAPP_PLL_FLAG_NO_OP_CLOCKS)) {
81
		dev_dbg(dev, "op_sys_clk_freq_hz \t%u\n",
82
			pll->op_sys_clk_freq_hz);
83
		dev_dbg(dev, "op_pix_clk_freq_hz \t%u\n",
84 85
			pll->op_pix_clk_freq_hz);
	}
86 87
	dev_dbg(dev, "vt_sys_clk_freq_hz \t%u\n", pll->vt_sys_clk_freq_hz);
	dev_dbg(dev, "vt_pix_clk_freq_hz \t%u\n", pll->vt_pix_clk_freq_hz);
88 89
}

90 91 92 93 94 95 96 97 98 99 100
/*
 * Heuristically guess the PLL tree for a given common multiplier and
 * divisor. Begin with the operational timing and continue to video
 * timing once operational timing has been verified.
 *
 * @mul is the PLL multiplier and @div is the common divisor
 * (pre_pll_clk_div and op_sys_clk_div combined). The final PLL
 * multiplier will be a multiple of @mul.
 *
 * @return Zero on success, error code on error.
 */
101
static int __smiapp_pll_calculate(struct device *dev,
102
				  const struct smiapp_pll_limits *limits,
103 104
				  struct smiapp_pll *pll, uint32_t mul,
				  uint32_t div, uint32_t lane_op_clock_ratio)
105 106 107 108
{
	uint32_t sys_div;
	uint32_t best_pix_div = INT_MAX >> 1;
	uint32_t vt_op_binning_div;
109 110 111 112 113 114
	/*
	 * Higher multipliers (and divisors) are often required than
	 * necessitated by the external clock and the output clocks.
	 * There are limits for all values in the clock tree. These
	 * are the minimum and maximum multiplier for mul.
	 */
115 116 117 118 119 120 121 122 123 124 125
	uint32_t more_mul_min, more_mul_max;
	uint32_t more_mul_factor;
	uint32_t min_vt_div, max_vt_div, vt_div;
	uint32_t min_sys_div, max_sys_div;
	unsigned int i;
	int rval;

	/*
	 * Get pre_pll_clk_div so that our pll_op_clk_freq_hz won't be
	 * too high.
	 */
126
	dev_dbg(dev, "pre_pll_clk_div %u\n", pll->pre_pll_clk_div);
127 128 129

	/* Don't go above max pll multiplier. */
	more_mul_max = limits->max_pll_multiplier / mul;
130
	dev_dbg(dev, "more_mul_max: max_pll_multiplier check: %u\n",
131 132 133
		more_mul_max);
	/* Don't go above max pll op frequency. */
	more_mul_max =
134
		min_t(uint32_t,
135 136 137
		      more_mul_max,
		      limits->max_pll_op_freq_hz
		      / (pll->ext_clk_freq_hz / pll->pre_pll_clk_div * mul));
138
	dev_dbg(dev, "more_mul_max: max_pll_op_freq_hz check: %u\n",
139 140 141
		more_mul_max);
	/* Don't go above the division capability of op sys clock divider. */
	more_mul_max = min(more_mul_max,
142
			   limits->op.max_sys_clk_div * pll->pre_pll_clk_div
143
			   / div);
144
	dev_dbg(dev, "more_mul_max: max_op_sys_clk_div check: %u\n",
145 146 147 148
		more_mul_max);
	/* Ensure we won't go above min_pll_multiplier. */
	more_mul_max = min(more_mul_max,
			   DIV_ROUND_UP(limits->max_pll_multiplier, mul));
149
	dev_dbg(dev, "more_mul_max: min_pll_multiplier check: %u\n",
150 151 152 153 154 155
		more_mul_max);

	/* Ensure we won't go below min_pll_op_freq_hz. */
	more_mul_min = DIV_ROUND_UP(limits->min_pll_op_freq_hz,
				    pll->ext_clk_freq_hz / pll->pre_pll_clk_div
				    * mul);
156
	dev_dbg(dev, "more_mul_min: min_pll_op_freq_hz check: %u\n",
157 158 159 160
		more_mul_min);
	/* Ensure we won't go below min_pll_multiplier. */
	more_mul_min = max(more_mul_min,
			   DIV_ROUND_UP(limits->min_pll_multiplier, mul));
161
	dev_dbg(dev, "more_mul_min: min_pll_multiplier check: %u\n",
162 163 164
		more_mul_min);

	if (more_mul_min > more_mul_max) {
165 166
		dev_dbg(dev,
			"unable to compute more_mul_min and more_mul_max\n");
167 168 169 170
		return -EINVAL;
	}

	more_mul_factor = lcm(div, pll->pre_pll_clk_div) / div;
171
	dev_dbg(dev, "more_mul_factor: %u\n", more_mul_factor);
172
	more_mul_factor = lcm(more_mul_factor, limits->op.min_sys_clk_div);
173
	dev_dbg(dev, "more_mul_factor: min_op_sys_clk_div: %u\n",
174 175 176 177 178
		more_mul_factor);
	i = roundup(more_mul_min, more_mul_factor);
	if (!is_one_or_even(i))
		i <<= 1;

179
	dev_dbg(dev, "final more_mul: %u\n", i);
180
	if (i > more_mul_max) {
181
		dev_dbg(dev, "final more_mul is bad, max %u\n", more_mul_max);
182 183 184 185 186
		return -EINVAL;
	}

	pll->pll_multiplier = mul * i;
	pll->op_sys_clk_div = div * i / pll->pre_pll_clk_div;
187
	dev_dbg(dev, "op_sys_clk_div: %u\n", pll->op_sys_clk_div);
188 189 190 191 192 193 194 195 196 197 198 199

	pll->pll_ip_clk_freq_hz = pll->ext_clk_freq_hz
		/ pll->pre_pll_clk_div;

	pll->pll_op_clk_freq_hz = pll->pll_ip_clk_freq_hz
		* pll->pll_multiplier;

	/* Derive pll_op_clk_freq_hz. */
	pll->op_sys_clk_freq_hz =
		pll->pll_op_clk_freq_hz / pll->op_sys_clk_div;

	pll->op_pix_clk_div = pll->bits_per_pixel;
200
	dev_dbg(dev, "op_pix_clk_div: %u\n", pll->op_pix_clk_div);
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

	pll->op_pix_clk_freq_hz =
		pll->op_sys_clk_freq_hz / pll->op_pix_clk_div;

	/*
	 * Some sensors perform analogue binning and some do this
	 * digitally. The ones doing this digitally can be roughly be
	 * found out using this formula. The ones doing this digitally
	 * should run at higher clock rate, so smaller divisor is used
	 * on video timing side.
	 */
	if (limits->min_line_length_pck_bin > limits->min_line_length_pck
	    / pll->binning_horizontal)
		vt_op_binning_div = pll->binning_horizontal;
	else
		vt_op_binning_div = 1;
217
	dev_dbg(dev, "vt_op_binning_div: %u\n", vt_op_binning_div);
218 219 220 221 222 223 224 225 226 227 228 229

	/*
	 * Profile 2 supports vt_pix_clk_div E [4, 10]
	 *
	 * Horizontal binning can be used as a base for difference in
	 * divisors. One must make sure that horizontal blanking is
	 * enough to accommodate the CSI-2 sync codes.
	 *
	 * Take scaling factor into account as well.
	 *
	 * Find absolute limits for the factor of vt divider.
	 */
230
	dev_dbg(dev, "scale_m: %u\n", pll->scale_m);
231 232 233 234 235 236
	min_vt_div = DIV_ROUND_UP(pll->op_pix_clk_div * pll->op_sys_clk_div
				  * pll->scale_n,
				  lane_op_clock_ratio * vt_op_binning_div
				  * pll->scale_m);

	/* Find smallest and biggest allowed vt divisor. */
237
	dev_dbg(dev, "min_vt_div: %u\n", min_vt_div);
238 239
	min_vt_div = max(min_vt_div,
			 DIV_ROUND_UP(pll->pll_op_clk_freq_hz,
240
				      limits->vt.max_pix_clk_freq_hz));
241
	dev_dbg(dev, "min_vt_div: max_vt_pix_clk_freq_hz: %u\n",
242 243
		min_vt_div);
	min_vt_div = max_t(uint32_t, min_vt_div,
244 245
			   limits->vt.min_pix_clk_div
			   * limits->vt.min_sys_clk_div);
246
	dev_dbg(dev, "min_vt_div: min_vt_clk_div: %u\n", min_vt_div);
247

248
	max_vt_div = limits->vt.max_sys_clk_div * limits->vt.max_pix_clk_div;
249
	dev_dbg(dev, "max_vt_div: %u\n", max_vt_div);
250 251
	max_vt_div = min(max_vt_div,
			 DIV_ROUND_UP(pll->pll_op_clk_freq_hz,
252
				      limits->vt.min_pix_clk_freq_hz));
253
	dev_dbg(dev, "max_vt_div: min_vt_pix_clk_freq_hz: %u\n",
254 255 256 257 258 259
		max_vt_div);

	/*
	 * Find limitsits for sys_clk_div. Not all values are possible
	 * with all values of pix_clk_div.
	 */
260
	min_sys_div = limits->vt.min_sys_clk_div;
261
	dev_dbg(dev, "min_sys_div: %u\n", min_sys_div);
262 263
	min_sys_div = max(min_sys_div,
			  DIV_ROUND_UP(min_vt_div,
264
				       limits->vt.max_pix_clk_div));
265
	dev_dbg(dev, "min_sys_div: max_vt_pix_clk_div: %u\n", min_sys_div);
266 267
	min_sys_div = max(min_sys_div,
			  pll->pll_op_clk_freq_hz
268
			  / limits->vt.max_sys_clk_freq_hz);
269
	dev_dbg(dev, "min_sys_div: max_pll_op_clk_freq_hz: %u\n", min_sys_div);
270
	min_sys_div = clk_div_even_up(min_sys_div);
271
	dev_dbg(dev, "min_sys_div: one or even: %u\n", min_sys_div);
272

273
	max_sys_div = limits->vt.max_sys_clk_div;
274
	dev_dbg(dev, "max_sys_div: %u\n", max_sys_div);
275 276
	max_sys_div = min(max_sys_div,
			  DIV_ROUND_UP(max_vt_div,
277
				       limits->vt.min_pix_clk_div));
278
	dev_dbg(dev, "max_sys_div: min_vt_pix_clk_div: %u\n", max_sys_div);
279 280
	max_sys_div = min(max_sys_div,
			  DIV_ROUND_UP(pll->pll_op_clk_freq_hz,
281
				       limits->vt.min_pix_clk_freq_hz));
282
	dev_dbg(dev, "max_sys_div: min_vt_pix_clk_freq_hz: %u\n", max_sys_div);
283 284 285 286 287 288 289 290 291 292 293

	/*
	 * Find pix_div such that a legal pix_div * sys_div results
	 * into a value which is not smaller than div, the desired
	 * divisor.
	 */
	for (vt_div = min_vt_div; vt_div <= max_vt_div;
	     vt_div += 2 - (vt_div & 1)) {
		for (sys_div = min_sys_div;
		     sys_div <= max_sys_div;
		     sys_div += 2 - (sys_div & 1)) {
294
			uint16_t pix_div = DIV_ROUND_UP(vt_div, sys_div);
295

296 297
			if (pix_div < limits->vt.min_pix_clk_div
			    || pix_div > limits->vt.max_pix_clk_div) {
298
				dev_dbg(dev,
299
					"pix_div %u too small or too big (%u--%u)\n",
300
					pix_div,
301 302
					limits->vt.min_pix_clk_div,
					limits->vt.max_pix_clk_div);
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
				continue;
			}

			/* Check if this one is better. */
			if (pix_div * sys_div
			    <= roundup(min_vt_div, best_pix_div))
				best_pix_div = pix_div;
		}
		if (best_pix_div < INT_MAX >> 1)
			break;
	}

	pll->vt_sys_clk_div = DIV_ROUND_UP(min_vt_div, best_pix_div);
	pll->vt_pix_clk_div = best_pix_div;

	pll->vt_sys_clk_freq_hz =
		pll->pll_op_clk_freq_hz / pll->vt_sys_clk_div;
	pll->vt_pix_clk_freq_hz =
		pll->vt_sys_clk_freq_hz / pll->vt_pix_clk_div;

	pll->pixel_rate_csi =
		pll->op_pix_clk_freq_hz * lane_op_clock_ratio;

326 327 328 329
	rval = bounds_check(dev, pll->pll_ip_clk_freq_hz,
			    limits->min_pll_ip_freq_hz,
			    limits->max_pll_ip_freq_hz,
			    "pll_ip_clk_freq_hz");
330 331 332 333 334 335 336 337 338 339 340 341 342
	if (!rval)
		rval = bounds_check(
			dev, pll->pll_multiplier,
			limits->min_pll_multiplier, limits->max_pll_multiplier,
			"pll_multiplier");
	if (!rval)
		rval = bounds_check(
			dev, pll->pll_op_clk_freq_hz,
			limits->min_pll_op_freq_hz, limits->max_pll_op_freq_hz,
			"pll_op_clk_freq_hz");
	if (!rval)
		rval = bounds_check(
			dev, pll->op_sys_clk_div,
343
			limits->op.min_sys_clk_div, limits->op.max_sys_clk_div,
344 345 346 347
			"op_sys_clk_div");
	if (!rval)
		rval = bounds_check(
			dev, pll->op_pix_clk_div,
348
			limits->op.min_pix_clk_div, limits->op.max_pix_clk_div,
349 350 351 352
			"op_pix_clk_div");
	if (!rval)
		rval = bounds_check(
			dev, pll->op_sys_clk_freq_hz,
353 354
			limits->op.min_sys_clk_freq_hz,
			limits->op.max_sys_clk_freq_hz,
355 356 357 358
			"op_sys_clk_freq_hz");
	if (!rval)
		rval = bounds_check(
			dev, pll->op_pix_clk_freq_hz,
359 360
			limits->op.min_pix_clk_freq_hz,
			limits->op.max_pix_clk_freq_hz,
361 362 363 364
			"op_pix_clk_freq_hz");
	if (!rval)
		rval = bounds_check(
			dev, pll->vt_sys_clk_freq_hz,
365 366
			limits->vt.min_sys_clk_freq_hz,
			limits->vt.max_sys_clk_freq_hz,
367 368 369 370
			"vt_sys_clk_freq_hz");
	if (!rval)
		rval = bounds_check(
			dev, pll->vt_pix_clk_freq_hz,
371 372
			limits->vt.min_pix_clk_freq_hz,
			limits->vt.max_pix_clk_freq_hz,
373 374 375 376
			"vt_pix_clk_freq_hz");

	return rval;
}
377

378 379
int smiapp_pll_calculate(struct device *dev,
			 const struct smiapp_pll_limits *limits,
380 381
			 struct smiapp_pll *pll)
{
382 383
	uint16_t min_pre_pll_clk_div;
	uint16_t max_pre_pll_clk_div;
384 385 386 387 388 389
	uint32_t lane_op_clock_ratio;
	uint32_t mul, div;
	unsigned int i;
	int rval = -EINVAL;

	if (pll->flags & SMIAPP_PLL_FLAG_OP_PIX_CLOCK_PER_LANE)
390
		lane_op_clock_ratio = pll->csi2.lanes;
391 392
	else
		lane_op_clock_ratio = 1;
393
	dev_dbg(dev, "lane_op_clock_ratio: %u\n", lane_op_clock_ratio);
394

395
	dev_dbg(dev, "binning: %ux%u\n", pll->binning_horizontal,
396 397
		pll->binning_vertical);

398 399 400 401 402 403 404 405 406 407 408 409 410 411
	switch (pll->bus_type) {
	case SMIAPP_PLL_BUS_TYPE_CSI2:
		/* CSI transfers 2 bits per clock per lane; thus times 2 */
		pll->pll_op_clk_freq_hz = pll->link_freq * 2
			* (pll->csi2.lanes / lane_op_clock_ratio);
		break;
	case SMIAPP_PLL_BUS_TYPE_PARALLEL:
		pll->pll_op_clk_freq_hz = pll->link_freq * pll->bits_per_pixel
			/ DIV_ROUND_UP(pll->bits_per_pixel,
				       pll->parallel.bus_width);
		break;
	default:
		return -EINVAL;
	}
412 413

	/* Figure out limits for pre-pll divider based on extclk */
414
	dev_dbg(dev, "min / max pre_pll_clk_div: %u / %u\n",
415
		limits->min_pre_pll_clk_div, limits->max_pre_pll_clk_div);
416
	max_pre_pll_clk_div =
417 418 419
		min_t(uint16_t, limits->max_pre_pll_clk_div,
		      clk_div_even(pll->ext_clk_freq_hz /
				   limits->min_pll_ip_freq_hz));
420
	min_pre_pll_clk_div =
421 422 423 424
		max_t(uint16_t, limits->min_pre_pll_clk_div,
		      clk_div_even_up(
			      DIV_ROUND_UP(pll->ext_clk_freq_hz,
					   limits->max_pll_ip_freq_hz)));
425
	dev_dbg(dev, "pre-pll check: min / max pre_pll_clk_div: %u / %u\n",
426
		min_pre_pll_clk_div, max_pre_pll_clk_div);
427 428 429 430

	i = gcd(pll->pll_op_clk_freq_hz, pll->ext_clk_freq_hz);
	mul = div_u64(pll->pll_op_clk_freq_hz, i);
	div = pll->ext_clk_freq_hz / i;
431
	dev_dbg(dev, "mul %u / div %u\n", mul, div);
432

433 434
	min_pre_pll_clk_div =
		max_t(uint16_t, min_pre_pll_clk_div,
435 436 437
		      clk_div_even_up(
			      DIV_ROUND_UP(mul * pll->ext_clk_freq_hz,
					   limits->max_pll_op_freq_hz)));
438
	dev_dbg(dev, "pll_op check: min / max pre_pll_clk_div: %u / %u\n",
439
		min_pre_pll_clk_div, max_pre_pll_clk_div);
440

441 442
	for (pll->pre_pll_clk_div = min_pre_pll_clk_div;
	     pll->pre_pll_clk_div <= max_pre_pll_clk_div;
443 444 445 446 447 448 449 450 451 452 453 454 455
	     pll->pre_pll_clk_div += 2 - (pll->pre_pll_clk_div & 1)) {
		rval = __smiapp_pll_calculate(dev, limits, pll, mul, div,
					      lane_op_clock_ratio);
		if (rval)
			continue;

		print_pll(dev, pll);
		return 0;
	}

	dev_info(dev, "unable to compute pre_pll divisor\n");
	return rval;
}
456 457
EXPORT_SYMBOL_GPL(smiapp_pll_calculate);

458
MODULE_AUTHOR("Sakari Ailus <sakari.ailus@iki.fi>");
459 460
MODULE_DESCRIPTION("Generic SMIA/SMIA++ PLL calculator");
MODULE_LICENSE("GPL");