pwm-rockchip.c 10.2 KB
Newer Older
1 2 3 4
/*
 * PWM driver for Rockchip SoCs
 *
 * Copyright (C) 2014 Beniamino Galvani <b.galvani@gmail.com>
5
 * Copyright (C) 2014 ROCKCHIP, Inc.
6 7 8 9 10 11 12 13 14 15
 *
 * 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.
 */

#include <linux/clk.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of.h>
16
#include <linux/of_device.h>
17 18 19 20 21 22 23
#include <linux/platform_device.h>
#include <linux/pwm.h>
#include <linux/time.h>

#define PWM_CTRL_TIMER_EN	(1 << 0)
#define PWM_CTRL_OUTPUT_EN	(1 << 3)

24 25 26
#define PWM_ENABLE		(1 << 0)
#define PWM_CONTINUOUS		(1 << 1)
#define PWM_DUTY_POSITIVE	(1 << 3)
27
#define PWM_DUTY_NEGATIVE	(0 << 3)
28
#define PWM_INACTIVE_NEGATIVE	(0 << 4)
29
#define PWM_INACTIVE_POSITIVE	(1 << 4)
30
#define PWM_POLARITY_MASK	(PWM_DUTY_POSITIVE | PWM_INACTIVE_POSITIVE)
31
#define PWM_OUTPUT_LEFT		(0 << 5)
David Wu's avatar
David Wu committed
32
#define PWM_LOCK_EN		(1 << 6)
33
#define PWM_LP_DISABLE		(0 << 8)
34 35 36 37

struct rockchip_pwm_chip {
	struct pwm_chip chip;
	struct clk *clk;
38
	struct clk *pclk;
39
	const struct rockchip_pwm_data *data;
40 41 42
	void __iomem *base;
};

43 44 45 46 47 48 49 50 51 52
struct rockchip_pwm_regs {
	unsigned long duty;
	unsigned long period;
	unsigned long cntr;
	unsigned long ctrl;
};

struct rockchip_pwm_data {
	struct rockchip_pwm_regs regs;
	unsigned int prescaler;
53
	bool supports_polarity;
David Wu's avatar
David Wu committed
54
	bool supports_lock;
55
	u32 enable_conf;
56 57
};

58 59 60 61 62
static inline struct rockchip_pwm_chip *to_rockchip_pwm_chip(struct pwm_chip *c)
{
	return container_of(c, struct rockchip_pwm_chip, chip);
}

63 64 65 66 67
static void rockchip_pwm_get_state(struct pwm_chip *chip,
				   struct pwm_device *pwm,
				   struct pwm_state *state)
{
	struct rockchip_pwm_chip *pc = to_rockchip_pwm_chip(chip);
68
	u32 enable_conf = pc->data->enable_conf;
69 70
	unsigned long clk_rate;
	u64 tmp;
71
	u32 val;
72 73
	int ret;

74
	ret = clk_enable(pc->pclk);
75 76 77 78 79 80 81 82 83 84 85
	if (ret)
		return;

	clk_rate = clk_get_rate(pc->clk);

	tmp = readl_relaxed(pc->base + pc->data->regs.period);
	tmp *= pc->data->prescaler * NSEC_PER_SEC;
	state->period = DIV_ROUND_CLOSEST_ULL(tmp, clk_rate);

	tmp = readl_relaxed(pc->base + pc->data->regs.duty);
	tmp *= pc->data->prescaler * NSEC_PER_SEC;
86
	state->duty_cycle =  DIV_ROUND_CLOSEST_ULL(tmp, clk_rate);
87

88 89 90 91 92 93 94 95 96 97 98 99
	val = readl_relaxed(pc->base + pc->data->regs.ctrl);
	if (pc->data->supports_polarity)
		state->enabled = ((val & enable_conf) != enable_conf) ?
				 false : true;
	else
		state->enabled = ((val & enable_conf) == enable_conf) ?
				 true : false;

	if (pc->data->supports_polarity) {
		if (!(val & PWM_DUTY_POSITIVE))
			state->polarity = PWM_POLARITY_INVERSED;
	}
100

101
	clk_disable(pc->pclk);
102 103
}

104
static void rockchip_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
105
			       struct pwm_state *state)
106 107 108 109
{
	struct rockchip_pwm_chip *pc = to_rockchip_pwm_chip(chip);
	unsigned long period, duty;
	u64 clk_rate, div;
110
	u32 ctrl;
111 112 113 114 115 116 117 118

	clk_rate = clk_get_rate(pc->clk);

	/*
	 * Since period and duty cycle registers have a width of 32
	 * bits, every possible input period can be obtained using the
	 * default prescaler value for all practical clock rate values.
	 */
119
	div = clk_rate * state->period;
120 121
	period = DIV_ROUND_CLOSEST_ULL(div,
				       pc->data->prescaler * NSEC_PER_SEC);
122

123
	div = clk_rate * state->duty_cycle;
124
	duty = DIV_ROUND_CLOSEST_ULL(div, pc->data->prescaler * NSEC_PER_SEC);
125

David Wu's avatar
David Wu committed
126 127 128 129 130 131 132 133 134 135
	/*
	 * Lock the period and duty of previous configuration, then
	 * change the duty and period, that would not be effective.
	 */
	ctrl = readl_relaxed(pc->base + pc->data->regs.ctrl);
	if (pc->data->supports_lock) {
		ctrl |= PWM_LOCK_EN;
		writel_relaxed(ctrl, pc->base + pc->data->regs.ctrl);
	}

136 137
	writel(period, pc->base + pc->data->regs.period);
	writel(duty, pc->base + pc->data->regs.duty);
138 139 140 141 142 143 144 145

	if (pc->data->supports_polarity) {
		ctrl &= ~PWM_POLARITY_MASK;
		if (state->polarity == PWM_POLARITY_INVERSED)
			ctrl |= PWM_DUTY_NEGATIVE | PWM_INACTIVE_POSITIVE;
		else
			ctrl |= PWM_DUTY_POSITIVE | PWM_INACTIVE_NEGATIVE;
	}
David Wu's avatar
David Wu committed
146 147 148 149 150 151 152 153 154

	/*
	 * Unlock and set polarity at the same time,
	 * the configuration of duty, period and polarity
	 * would be effective together at next period.
	 */
	if (pc->data->supports_lock)
		ctrl &= ~PWM_LOCK_EN;

155
	writel(ctrl, pc->base + pc->data->regs.ctrl);
156 157
}

158
static int rockchip_pwm_enable(struct pwm_chip *chip,
159
			       struct pwm_device *pwm,
160
			       bool enable)
161 162
{
	struct rockchip_pwm_chip *pc = to_rockchip_pwm_chip(chip);
163
	u32 enable_conf = pc->data->enable_conf;
164
	int ret;
165
	u32 val;
166 167 168 169 170 171 172

	if (enable) {
		ret = clk_enable(pc->clk);
		if (ret)
			return ret;
	}

173 174 175 176 177 178 179 180
	val = readl_relaxed(pc->base + pc->data->regs.ctrl);

	if (enable)
		val |= enable_conf;
	else
		val &= ~enable_conf;

	writel_relaxed(val, pc->base + pc->data->regs.ctrl);
181 182 183 184 185 186 187

	if (!enable)
		clk_disable(pc->clk);

	return 0;
}

188 189
static int rockchip_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
			      struct pwm_state *state)
190
{
191
	struct rockchip_pwm_chip *pc = to_rockchip_pwm_chip(chip);
192 193
	struct pwm_state curstate;
	bool enabled;
194
	int ret = 0;
195

196 197 198 199
	ret = clk_enable(pc->pclk);
	if (ret)
		return ret;

200 201 202
	pwm_get_state(pwm, &curstate);
	enabled = curstate.enabled;

David Wu's avatar
David Wu committed
203 204
	if (state->polarity != curstate.polarity && enabled &&
	    !pc->data->supports_lock) {
205
		ret = rockchip_pwm_enable(chip, pwm, false);
206
		if (ret)
207
			goto out;
208 209
		enabled = false;
	}
210

211
	rockchip_pwm_config(chip, pwm, state);
212 213
	if (state->enabled != enabled) {
		ret = rockchip_pwm_enable(chip, pwm, state->enabled);
214
		if (ret)
215
			goto out;
216
	}
217

218 219 220 221 222
	/*
	 * Update the state with the real hardware, which can differ a bit
	 * because of period/duty_cycle approximation.
	 */
	rockchip_pwm_get_state(chip, pwm, state);
223

224
out:
225
	clk_disable(pc->pclk);
226 227

	return ret;
228 229
}

230
static const struct pwm_ops rockchip_pwm_ops = {
231
	.get_state = rockchip_pwm_get_state,
232
	.apply = rockchip_pwm_apply,
233 234 235
	.owner = THIS_MODULE,
};

236 237 238 239 240 241 242 243
static const struct rockchip_pwm_data pwm_data_v1 = {
	.regs = {
		.duty = 0x04,
		.period = 0x08,
		.cntr = 0x00,
		.ctrl = 0x0c,
	},
	.prescaler = 2,
244
	.supports_polarity = false,
David Wu's avatar
David Wu committed
245
	.supports_lock = false,
246
	.enable_conf = PWM_CTRL_OUTPUT_EN | PWM_CTRL_TIMER_EN,
247 248 249 250 251 252 253 254 255 256
};

static const struct rockchip_pwm_data pwm_data_v2 = {
	.regs = {
		.duty = 0x08,
		.period = 0x04,
		.cntr = 0x00,
		.ctrl = 0x0c,
	},
	.prescaler = 1,
257
	.supports_polarity = true,
David Wu's avatar
David Wu committed
258
	.supports_lock = false,
259 260
	.enable_conf = PWM_OUTPUT_LEFT | PWM_LP_DISABLE | PWM_ENABLE |
		       PWM_CONTINUOUS,
261 262 263 264 265 266 267 268 269 270
};

static const struct rockchip_pwm_data pwm_data_vop = {
	.regs = {
		.duty = 0x08,
		.period = 0x04,
		.cntr = 0x0c,
		.ctrl = 0x00,
	},
	.prescaler = 1,
271
	.supports_polarity = true,
David Wu's avatar
David Wu committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
	.supports_lock = false,
	.enable_conf = PWM_OUTPUT_LEFT | PWM_LP_DISABLE | PWM_ENABLE |
		       PWM_CONTINUOUS,
};

static const struct rockchip_pwm_data pwm_data_v3 = {
	.regs = {
		.duty = 0x08,
		.period = 0x04,
		.cntr = 0x00,
		.ctrl = 0x0c,
	},
	.prescaler = 1,
	.supports_polarity = true,
	.supports_lock = true,
287 288
	.enable_conf = PWM_OUTPUT_LEFT | PWM_LP_DISABLE | PWM_ENABLE |
		       PWM_CONTINUOUS,
289 290 291 292 293 294
};

static const struct of_device_id rockchip_pwm_dt_ids[] = {
	{ .compatible = "rockchip,rk2928-pwm", .data = &pwm_data_v1},
	{ .compatible = "rockchip,rk3288-pwm", .data = &pwm_data_v2},
	{ .compatible = "rockchip,vop-pwm", .data = &pwm_data_vop},
David Wu's avatar
David Wu committed
295
	{ .compatible = "rockchip,rk3328-pwm", .data = &pwm_data_v3},
296 297 298 299
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(of, rockchip_pwm_dt_ids);

300 301
static int rockchip_pwm_probe(struct platform_device *pdev)
{
302
	const struct of_device_id *id;
303 304
	struct rockchip_pwm_chip *pc;
	struct resource *r;
305
	int ret, count;
306

307 308 309 310
	id = of_match_device(rockchip_pwm_dt_ids, &pdev->dev);
	if (!id)
		return -EINVAL;

311 312 313 314 315 316 317 318 319
	pc = devm_kzalloc(&pdev->dev, sizeof(*pc), GFP_KERNEL);
	if (!pc)
		return -ENOMEM;

	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	pc->base = devm_ioremap_resource(&pdev->dev, r);
	if (IS_ERR(pc->base))
		return PTR_ERR(pc->base);

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
	pc->clk = devm_clk_get(&pdev->dev, "pwm");
	if (IS_ERR(pc->clk)) {
		pc->clk = devm_clk_get(&pdev->dev, NULL);
		if (IS_ERR(pc->clk)) {
			ret = PTR_ERR(pc->clk);
			if (ret != -EPROBE_DEFER)
				dev_err(&pdev->dev, "Can't get bus clk: %d\n",
					ret);
			return ret;
		}
	}

	count = of_count_phandle_with_args(pdev->dev.of_node,
					   "clocks", "#clock-cells");
	if (count == 2)
		pc->pclk = devm_clk_get(&pdev->dev, "pclk");
	else
		pc->pclk = pc->clk;

	if (IS_ERR(pc->pclk)) {
		ret = PTR_ERR(pc->pclk);
		if (ret != -EPROBE_DEFER)
			dev_err(&pdev->dev, "Can't get APB clk: %d\n", ret);
		return ret;
	}
345

346
	ret = clk_prepare_enable(pc->clk);
347 348
	if (ret) {
		dev_err(&pdev->dev, "Can't prepare enable bus clk: %d\n", ret);
349
		return ret;
350 351 352 353 354 355 356
	}

	ret = clk_prepare(pc->pclk);
	if (ret) {
		dev_err(&pdev->dev, "Can't prepare APB clk: %d\n", ret);
		goto err_clk;
	}
357 358 359

	platform_set_drvdata(pdev, pc);

360
	pc->data = id->data;
361
	pc->chip.dev = &pdev->dev;
362
	pc->chip.ops = &rockchip_pwm_ops;
363 364 365
	pc->chip.base = -1;
	pc->chip.npwm = 1;

366
	if (pc->data->supports_polarity) {
367 368 369 370
		pc->chip.of_xlate = of_pwm_xlate_with_flags;
		pc->chip.of_pwm_n_cells = 3;
	}

371 372 373 374
	ret = pwmchip_add(&pc->chip);
	if (ret < 0) {
		clk_unprepare(pc->clk);
		dev_err(&pdev->dev, "pwmchip_add() failed: %d\n", ret);
375
		goto err_pclk;
376 377
	}

378 379 380 381
	/* Keep the PWM clk enabled if the PWM appears to be up and running. */
	if (!pwm_is_enabled(pc->chip.pwms))
		clk_disable(pc->clk);

382 383 384 385 386 387 388
	return 0;

err_pclk:
	clk_unprepare(pc->pclk);
err_clk:
	clk_disable_unprepare(pc->clk);

389 390 391 392 393 394 395
	return ret;
}

static int rockchip_pwm_remove(struct platform_device *pdev)
{
	struct rockchip_pwm_chip *pc = platform_get_drvdata(pdev);

396 397 398 399 400 401 402 403 404 405 406 407 408 409
	/*
	 * Disable the PWM clk before unpreparing it if the PWM device is still
	 * running. This should only happen when the last PWM user left it
	 * enabled, or when nobody requested a PWM that was previously enabled
	 * by the bootloader.
	 *
	 * FIXME: Maybe the core should disable all PWM devices in
	 * pwmchip_remove(). In this case we'd only have to call
	 * clk_unprepare() after pwmchip_remove().
	 *
	 */
	if (pwm_is_enabled(pc->chip.pwms))
		clk_disable(pc->clk);

410
	clk_unprepare(pc->pclk);
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
	clk_unprepare(pc->clk);

	return pwmchip_remove(&pc->chip);
}

static struct platform_driver rockchip_pwm_driver = {
	.driver = {
		.name = "rockchip-pwm",
		.of_match_table = rockchip_pwm_dt_ids,
	},
	.probe = rockchip_pwm_probe,
	.remove = rockchip_pwm_remove,
};
module_platform_driver(rockchip_pwm_driver);

MODULE_AUTHOR("Beniamino Galvani <b.galvani@gmail.com>");
MODULE_DESCRIPTION("Rockchip SoC PWM driver");
MODULE_LICENSE("GPL v2");