Loading...
1/*
2 * drivers/pwm/pwm-tegra.c
3 *
4 * Tegra pulse-width-modulation controller driver
5 *
6 * Copyright (c) 2010, NVIDIA Corporation.
7 * Based on arch/arm/plat-mxc/pwm.c by Sascha Hauer <s.hauer@pengutronix.de>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 */
23
24#include <linux/clk.h>
25#include <linux/err.h>
26#include <linux/io.h>
27#include <linux/module.h>
28#include <linux/of.h>
29#include <linux/pwm.h>
30#include <linux/platform_device.h>
31#include <linux/slab.h>
32
33#define PWM_ENABLE (1 << 31)
34#define PWM_DUTY_WIDTH 8
35#define PWM_DUTY_SHIFT 16
36#define PWM_SCALE_WIDTH 13
37#define PWM_SCALE_SHIFT 0
38
39#define NUM_PWM 4
40
41struct tegra_pwm_chip {
42 struct pwm_chip chip;
43 struct device *dev;
44
45 struct clk *clk;
46
47 void __iomem *mmio_base;
48};
49
50static inline struct tegra_pwm_chip *to_tegra_pwm_chip(struct pwm_chip *chip)
51{
52 return container_of(chip, struct tegra_pwm_chip, chip);
53}
54
55static inline u32 pwm_readl(struct tegra_pwm_chip *chip, unsigned int num)
56{
57 return readl(chip->mmio_base + (num << 4));
58}
59
60static inline void pwm_writel(struct tegra_pwm_chip *chip, unsigned int num,
61 unsigned long val)
62{
63 writel(val, chip->mmio_base + (num << 4));
64}
65
66static int tegra_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
67 int duty_ns, int period_ns)
68{
69 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
70 unsigned long long c;
71 unsigned long rate, hz;
72 u32 val = 0;
73 int err;
74
75 /*
76 * Convert from duty_ns / period_ns to a fixed number of duty ticks
77 * per (1 << PWM_DUTY_WIDTH) cycles and make sure to round to the
78 * nearest integer during division.
79 */
80 c = duty_ns * ((1 << PWM_DUTY_WIDTH) - 1) + period_ns / 2;
81 do_div(c, period_ns);
82
83 val = (u32)c << PWM_DUTY_SHIFT;
84
85 /*
86 * Compute the prescaler value for which (1 << PWM_DUTY_WIDTH)
87 * cycles at the PWM clock rate will take period_ns nanoseconds.
88 */
89 rate = clk_get_rate(pc->clk) >> PWM_DUTY_WIDTH;
90 hz = NSEC_PER_SEC / period_ns;
91
92 rate = (rate + (hz / 2)) / hz;
93
94 /*
95 * Since the actual PWM divider is the register's frequency divider
96 * field minus 1, we need to decrement to get the correct value to
97 * write to the register.
98 */
99 if (rate > 0)
100 rate--;
101
102 /*
103 * Make sure that the rate will fit in the register's frequency
104 * divider field.
105 */
106 if (rate >> PWM_SCALE_WIDTH)
107 return -EINVAL;
108
109 val |= rate << PWM_SCALE_SHIFT;
110
111 /*
112 * If the PWM channel is disabled, make sure to turn on the clock
113 * before writing the register. Otherwise, keep it enabled.
114 */
115 if (!pwm_is_enabled(pwm)) {
116 err = clk_prepare_enable(pc->clk);
117 if (err < 0)
118 return err;
119 } else
120 val |= PWM_ENABLE;
121
122 pwm_writel(pc, pwm->hwpwm, val);
123
124 /*
125 * If the PWM is not enabled, turn the clock off again to save power.
126 */
127 if (!pwm_is_enabled(pwm))
128 clk_disable_unprepare(pc->clk);
129
130 return 0;
131}
132
133static int tegra_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
134{
135 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
136 int rc = 0;
137 u32 val;
138
139 rc = clk_prepare_enable(pc->clk);
140 if (rc < 0)
141 return rc;
142
143 val = pwm_readl(pc, pwm->hwpwm);
144 val |= PWM_ENABLE;
145 pwm_writel(pc, pwm->hwpwm, val);
146
147 return 0;
148}
149
150static void tegra_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
151{
152 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
153 u32 val;
154
155 val = pwm_readl(pc, pwm->hwpwm);
156 val &= ~PWM_ENABLE;
157 pwm_writel(pc, pwm->hwpwm, val);
158
159 clk_disable_unprepare(pc->clk);
160}
161
162static const struct pwm_ops tegra_pwm_ops = {
163 .config = tegra_pwm_config,
164 .enable = tegra_pwm_enable,
165 .disable = tegra_pwm_disable,
166 .owner = THIS_MODULE,
167};
168
169static int tegra_pwm_probe(struct platform_device *pdev)
170{
171 struct tegra_pwm_chip *pwm;
172 struct resource *r;
173 int ret;
174
175 pwm = devm_kzalloc(&pdev->dev, sizeof(*pwm), GFP_KERNEL);
176 if (!pwm)
177 return -ENOMEM;
178
179 pwm->dev = &pdev->dev;
180
181 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
182 pwm->mmio_base = devm_ioremap_resource(&pdev->dev, r);
183 if (IS_ERR(pwm->mmio_base))
184 return PTR_ERR(pwm->mmio_base);
185
186 platform_set_drvdata(pdev, pwm);
187
188 pwm->clk = devm_clk_get(&pdev->dev, NULL);
189 if (IS_ERR(pwm->clk))
190 return PTR_ERR(pwm->clk);
191
192 pwm->chip.dev = &pdev->dev;
193 pwm->chip.ops = &tegra_pwm_ops;
194 pwm->chip.base = -1;
195 pwm->chip.npwm = NUM_PWM;
196
197 ret = pwmchip_add(&pwm->chip);
198 if (ret < 0) {
199 dev_err(&pdev->dev, "pwmchip_add() failed: %d\n", ret);
200 return ret;
201 }
202
203 return 0;
204}
205
206static int tegra_pwm_remove(struct platform_device *pdev)
207{
208 struct tegra_pwm_chip *pc = platform_get_drvdata(pdev);
209 int i;
210
211 if (WARN_ON(!pc))
212 return -ENODEV;
213
214 for (i = 0; i < NUM_PWM; i++) {
215 struct pwm_device *pwm = &pc->chip.pwms[i];
216
217 if (!pwm_is_enabled(pwm))
218 if (clk_prepare_enable(pc->clk) < 0)
219 continue;
220
221 pwm_writel(pc, i, 0);
222
223 clk_disable_unprepare(pc->clk);
224 }
225
226 return pwmchip_remove(&pc->chip);
227}
228
229static const struct of_device_id tegra_pwm_of_match[] = {
230 { .compatible = "nvidia,tegra20-pwm" },
231 { .compatible = "nvidia,tegra30-pwm" },
232 { }
233};
234
235MODULE_DEVICE_TABLE(of, tegra_pwm_of_match);
236
237static struct platform_driver tegra_pwm_driver = {
238 .driver = {
239 .name = "tegra-pwm",
240 .of_match_table = tegra_pwm_of_match,
241 },
242 .probe = tegra_pwm_probe,
243 .remove = tegra_pwm_remove,
244};
245
246module_platform_driver(tegra_pwm_driver);
247
248MODULE_LICENSE("GPL");
249MODULE_AUTHOR("NVIDIA Corporation");
250MODULE_ALIAS("platform:tegra-pwm");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * drivers/pwm/pwm-tegra.c
4 *
5 * Tegra pulse-width-modulation controller driver
6 *
7 * Copyright (c) 2010-2020, NVIDIA Corporation.
8 * Based on arch/arm/plat-mxc/pwm.c by Sascha Hauer <s.hauer@pengutronix.de>
9 *
10 * Overview of Tegra Pulse Width Modulator Register:
11 * 1. 13-bit: Frequency division (SCALE)
12 * 2. 8-bit : Pulse division (DUTY)
13 * 3. 1-bit : Enable bit
14 *
15 * The PWM clock frequency is divided by 256 before subdividing it based
16 * on the programmable frequency division value to generate the required
17 * frequency for PWM output. The maximum output frequency that can be
18 * achieved is (max rate of source clock) / 256.
19 * e.g. if source clock rate is 408 MHz, maximum output frequency can be:
20 * 408 MHz/256 = 1.6 MHz.
21 * This 1.6 MHz frequency can further be divided using SCALE value in PWM.
22 *
23 * PWM pulse width: 8 bits are usable [23:16] for varying pulse width.
24 * To achieve 100% duty cycle, program Bit [24] of this register to
25 * 1’b1. In which case the other bits [23:16] are set to don't care.
26 *
27 * Limitations:
28 * - When PWM is disabled, the output is driven to inactive.
29 * - It does not allow the current PWM period to complete and
30 * stops abruptly.
31 *
32 * - If the register is reconfigured while PWM is running,
33 * it does not complete the currently running period.
34 *
35 * - If the user input duty is beyond acceptible limits,
36 * -EINVAL is returned.
37 */
38
39#include <linux/clk.h>
40#include <linux/err.h>
41#include <linux/io.h>
42#include <linux/module.h>
43#include <linux/of.h>
44#include <linux/pm_opp.h>
45#include <linux/pwm.h>
46#include <linux/platform_device.h>
47#include <linux/pinctrl/consumer.h>
48#include <linux/pm_runtime.h>
49#include <linux/slab.h>
50#include <linux/reset.h>
51
52#include <soc/tegra/common.h>
53
54#define PWM_ENABLE (1 << 31)
55#define PWM_DUTY_WIDTH 8
56#define PWM_DUTY_SHIFT 16
57#define PWM_SCALE_WIDTH 13
58#define PWM_SCALE_SHIFT 0
59
60struct tegra_pwm_soc {
61 unsigned int num_channels;
62
63 /* Maximum IP frequency for given SoCs */
64 unsigned long max_frequency;
65};
66
67struct tegra_pwm_chip {
68 struct pwm_chip chip;
69 struct device *dev;
70
71 struct clk *clk;
72 struct reset_control*rst;
73
74 unsigned long clk_rate;
75 unsigned long min_period_ns;
76
77 void __iomem *regs;
78
79 const struct tegra_pwm_soc *soc;
80};
81
82static inline struct tegra_pwm_chip *to_tegra_pwm_chip(struct pwm_chip *chip)
83{
84 return container_of(chip, struct tegra_pwm_chip, chip);
85}
86
87static inline u32 pwm_readl(struct tegra_pwm_chip *pc, unsigned int offset)
88{
89 return readl(pc->regs + (offset << 4));
90}
91
92static inline void pwm_writel(struct tegra_pwm_chip *pc, unsigned int offset, u32 value)
93{
94 writel(value, pc->regs + (offset << 4));
95}
96
97static int tegra_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
98 int duty_ns, int period_ns)
99{
100 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
101 unsigned long long c = duty_ns;
102 unsigned long rate, required_clk_rate;
103 u32 val = 0;
104 int err;
105
106 /*
107 * Convert from duty_ns / period_ns to a fixed number of duty ticks
108 * per (1 << PWM_DUTY_WIDTH) cycles and make sure to round to the
109 * nearest integer during division.
110 */
111 c *= (1 << PWM_DUTY_WIDTH);
112 c = DIV_ROUND_CLOSEST_ULL(c, period_ns);
113
114 val = (u32)c << PWM_DUTY_SHIFT;
115
116 /*
117 * min period = max clock limit >> PWM_DUTY_WIDTH
118 */
119 if (period_ns < pc->min_period_ns)
120 return -EINVAL;
121
122 /*
123 * Compute the prescaler value for which (1 << PWM_DUTY_WIDTH)
124 * cycles at the PWM clock rate will take period_ns nanoseconds.
125 *
126 * num_channels: If single instance of PWM controller has multiple
127 * channels (e.g. Tegra210 or older) then it is not possible to
128 * configure separate clock rates to each of the channels, in such
129 * case the value stored during probe will be referred.
130 *
131 * If every PWM controller instance has one channel respectively, i.e.
132 * nums_channels == 1 then only the clock rate can be modified
133 * dynamically (e.g. Tegra186 or Tegra194).
134 */
135 if (pc->soc->num_channels == 1) {
136 /*
137 * Rate is multiplied with 2^PWM_DUTY_WIDTH so that it matches
138 * with the maximum possible rate that the controller can
139 * provide. Any further lower value can be derived by setting
140 * PFM bits[0:12].
141 *
142 * required_clk_rate is a reference rate for source clock and
143 * it is derived based on user requested period. By setting the
144 * source clock rate as required_clk_rate, PWM controller will
145 * be able to configure the requested period.
146 */
147 required_clk_rate = DIV_ROUND_UP_ULL((u64)NSEC_PER_SEC << PWM_DUTY_WIDTH,
148 period_ns);
149
150 if (required_clk_rate > clk_round_rate(pc->clk, required_clk_rate))
151 /*
152 * required_clk_rate is a lower bound for the input
153 * rate; for lower rates there is no value for PWM_SCALE
154 * that yields a period less than or equal to the
155 * requested period. Hence, for lower rates, double the
156 * required_clk_rate to get a clock rate that can meet
157 * the requested period.
158 */
159 required_clk_rate *= 2;
160
161 err = dev_pm_opp_set_rate(pc->dev, required_clk_rate);
162 if (err < 0)
163 return -EINVAL;
164
165 /* Store the new rate for further references */
166 pc->clk_rate = clk_get_rate(pc->clk);
167 }
168
169 /* Consider precision in PWM_SCALE_WIDTH rate calculation */
170 rate = mul_u64_u64_div_u64(pc->clk_rate, period_ns,
171 (u64)NSEC_PER_SEC << PWM_DUTY_WIDTH);
172
173 /*
174 * Since the actual PWM divider is the register's frequency divider
175 * field plus 1, we need to decrement to get the correct value to
176 * write to the register.
177 */
178 if (rate > 0)
179 rate--;
180 else
181 return -EINVAL;
182
183 /*
184 * Make sure that the rate will fit in the register's frequency
185 * divider field.
186 */
187 if (rate >> PWM_SCALE_WIDTH)
188 return -EINVAL;
189
190 val |= rate << PWM_SCALE_SHIFT;
191
192 /*
193 * If the PWM channel is disabled, make sure to turn on the clock
194 * before writing the register. Otherwise, keep it enabled.
195 */
196 if (!pwm_is_enabled(pwm)) {
197 err = pm_runtime_resume_and_get(pc->dev);
198 if (err)
199 return err;
200 } else
201 val |= PWM_ENABLE;
202
203 pwm_writel(pc, pwm->hwpwm, val);
204
205 /*
206 * If the PWM is not enabled, turn the clock off again to save power.
207 */
208 if (!pwm_is_enabled(pwm))
209 pm_runtime_put(pc->dev);
210
211 return 0;
212}
213
214static int tegra_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
215{
216 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
217 int rc = 0;
218 u32 val;
219
220 rc = pm_runtime_resume_and_get(pc->dev);
221 if (rc)
222 return rc;
223
224 val = pwm_readl(pc, pwm->hwpwm);
225 val |= PWM_ENABLE;
226 pwm_writel(pc, pwm->hwpwm, val);
227
228 return 0;
229}
230
231static void tegra_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
232{
233 struct tegra_pwm_chip *pc = to_tegra_pwm_chip(chip);
234 u32 val;
235
236 val = pwm_readl(pc, pwm->hwpwm);
237 val &= ~PWM_ENABLE;
238 pwm_writel(pc, pwm->hwpwm, val);
239
240 pm_runtime_put_sync(pc->dev);
241}
242
243static int tegra_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
244 const struct pwm_state *state)
245{
246 int err;
247 bool enabled = pwm->state.enabled;
248
249 if (state->polarity != PWM_POLARITY_NORMAL)
250 return -EINVAL;
251
252 if (!state->enabled) {
253 if (enabled)
254 tegra_pwm_disable(chip, pwm);
255
256 return 0;
257 }
258
259 err = tegra_pwm_config(chip, pwm, state->duty_cycle, state->period);
260 if (err)
261 return err;
262
263 if (!enabled)
264 err = tegra_pwm_enable(chip, pwm);
265
266 return err;
267}
268
269static const struct pwm_ops tegra_pwm_ops = {
270 .apply = tegra_pwm_apply,
271};
272
273static int tegra_pwm_probe(struct platform_device *pdev)
274{
275 struct tegra_pwm_chip *pc;
276 int ret;
277
278 pc = devm_kzalloc(&pdev->dev, sizeof(*pc), GFP_KERNEL);
279 if (!pc)
280 return -ENOMEM;
281
282 pc->soc = of_device_get_match_data(&pdev->dev);
283 pc->dev = &pdev->dev;
284
285 pc->regs = devm_platform_ioremap_resource(pdev, 0);
286 if (IS_ERR(pc->regs))
287 return PTR_ERR(pc->regs);
288
289 platform_set_drvdata(pdev, pc);
290
291 pc->clk = devm_clk_get(&pdev->dev, NULL);
292 if (IS_ERR(pc->clk))
293 return PTR_ERR(pc->clk);
294
295 ret = devm_tegra_core_dev_init_opp_table_common(&pdev->dev);
296 if (ret)
297 return ret;
298
299 pm_runtime_enable(&pdev->dev);
300 ret = pm_runtime_resume_and_get(&pdev->dev);
301 if (ret)
302 return ret;
303
304 /* Set maximum frequency of the IP */
305 ret = dev_pm_opp_set_rate(pc->dev, pc->soc->max_frequency);
306 if (ret < 0) {
307 dev_err(&pdev->dev, "Failed to set max frequency: %d\n", ret);
308 goto put_pm;
309 }
310
311 /*
312 * The requested and configured frequency may differ due to
313 * clock register resolutions. Get the configured frequency
314 * so that PWM period can be calculated more accurately.
315 */
316 pc->clk_rate = clk_get_rate(pc->clk);
317
318 /* Set minimum limit of PWM period for the IP */
319 pc->min_period_ns =
320 (NSEC_PER_SEC / (pc->soc->max_frequency >> PWM_DUTY_WIDTH)) + 1;
321
322 pc->rst = devm_reset_control_get_exclusive(&pdev->dev, "pwm");
323 if (IS_ERR(pc->rst)) {
324 ret = PTR_ERR(pc->rst);
325 dev_err(&pdev->dev, "Reset control is not found: %d\n", ret);
326 goto put_pm;
327 }
328
329 reset_control_deassert(pc->rst);
330
331 pc->chip.dev = &pdev->dev;
332 pc->chip.ops = &tegra_pwm_ops;
333 pc->chip.npwm = pc->soc->num_channels;
334
335 ret = pwmchip_add(&pc->chip);
336 if (ret < 0) {
337 dev_err(&pdev->dev, "pwmchip_add() failed: %d\n", ret);
338 reset_control_assert(pc->rst);
339 goto put_pm;
340 }
341
342 pm_runtime_put(&pdev->dev);
343
344 return 0;
345put_pm:
346 pm_runtime_put_sync_suspend(&pdev->dev);
347 pm_runtime_force_suspend(&pdev->dev);
348 return ret;
349}
350
351static void tegra_pwm_remove(struct platform_device *pdev)
352{
353 struct tegra_pwm_chip *pc = platform_get_drvdata(pdev);
354
355 pwmchip_remove(&pc->chip);
356
357 reset_control_assert(pc->rst);
358
359 pm_runtime_force_suspend(&pdev->dev);
360}
361
362static int __maybe_unused tegra_pwm_runtime_suspend(struct device *dev)
363{
364 struct tegra_pwm_chip *pc = dev_get_drvdata(dev);
365 int err;
366
367 clk_disable_unprepare(pc->clk);
368
369 err = pinctrl_pm_select_sleep_state(dev);
370 if (err) {
371 clk_prepare_enable(pc->clk);
372 return err;
373 }
374
375 return 0;
376}
377
378static int __maybe_unused tegra_pwm_runtime_resume(struct device *dev)
379{
380 struct tegra_pwm_chip *pc = dev_get_drvdata(dev);
381 int err;
382
383 err = pinctrl_pm_select_default_state(dev);
384 if (err)
385 return err;
386
387 err = clk_prepare_enable(pc->clk);
388 if (err) {
389 pinctrl_pm_select_sleep_state(dev);
390 return err;
391 }
392
393 return 0;
394}
395
396static const struct tegra_pwm_soc tegra20_pwm_soc = {
397 .num_channels = 4,
398 .max_frequency = 48000000UL,
399};
400
401static const struct tegra_pwm_soc tegra186_pwm_soc = {
402 .num_channels = 1,
403 .max_frequency = 102000000UL,
404};
405
406static const struct tegra_pwm_soc tegra194_pwm_soc = {
407 .num_channels = 1,
408 .max_frequency = 408000000UL,
409};
410
411static const struct of_device_id tegra_pwm_of_match[] = {
412 { .compatible = "nvidia,tegra20-pwm", .data = &tegra20_pwm_soc },
413 { .compatible = "nvidia,tegra186-pwm", .data = &tegra186_pwm_soc },
414 { .compatible = "nvidia,tegra194-pwm", .data = &tegra194_pwm_soc },
415 { }
416};
417MODULE_DEVICE_TABLE(of, tegra_pwm_of_match);
418
419static const struct dev_pm_ops tegra_pwm_pm_ops = {
420 SET_RUNTIME_PM_OPS(tegra_pwm_runtime_suspend, tegra_pwm_runtime_resume,
421 NULL)
422 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
423 pm_runtime_force_resume)
424};
425
426static struct platform_driver tegra_pwm_driver = {
427 .driver = {
428 .name = "tegra-pwm",
429 .of_match_table = tegra_pwm_of_match,
430 .pm = &tegra_pwm_pm_ops,
431 },
432 .probe = tegra_pwm_probe,
433 .remove_new = tegra_pwm_remove,
434};
435
436module_platform_driver(tegra_pwm_driver);
437
438MODULE_LICENSE("GPL");
439MODULE_AUTHOR("Sandipan Patra <spatra@nvidia.com>");
440MODULE_DESCRIPTION("Tegra PWM controller driver");
441MODULE_ALIAS("platform:tegra-pwm");