Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2014 Free Electrons
4 * Copyright (C) 2014 Atmel
5 *
6 * Author: Boris BREZILLON <boris.brezillon@free-electrons.com>
7 */
8
9#include <linux/clk.h>
10#include <linux/delay.h>
11#include <linux/mfd/atmel-hlcdc.h>
12#include <linux/module.h>
13#include <linux/platform_device.h>
14#include <linux/pwm.h>
15#include <linux/regmap.h>
16
17#define ATMEL_HLCDC_PWMCVAL_MASK GENMASK(15, 8)
18#define ATMEL_HLCDC_PWMCVAL(x) (((x) << 8) & ATMEL_HLCDC_PWMCVAL_MASK)
19#define ATMEL_HLCDC_PWMPOL BIT(4)
20#define ATMEL_HLCDC_PWMPS_MASK GENMASK(2, 0)
21#define ATMEL_HLCDC_PWMPS_MAX 0x6
22#define ATMEL_HLCDC_PWMPS(x) ((x) & ATMEL_HLCDC_PWMPS_MASK)
23
24struct atmel_hlcdc_pwm_errata {
25 bool slow_clk_erratum;
26 bool div1_clk_erratum;
27};
28
29struct atmel_hlcdc_pwm {
30 struct pwm_chip chip;
31 struct atmel_hlcdc *hlcdc;
32 struct clk *cur_clk;
33 const struct atmel_hlcdc_pwm_errata *errata;
34};
35
36static inline struct atmel_hlcdc_pwm *to_atmel_hlcdc_pwm(struct pwm_chip *chip)
37{
38 return container_of(chip, struct atmel_hlcdc_pwm, chip);
39}
40
41static int atmel_hlcdc_pwm_apply(struct pwm_chip *c, struct pwm_device *pwm,
42 const struct pwm_state *state)
43{
44 struct atmel_hlcdc_pwm *chip = to_atmel_hlcdc_pwm(c);
45 struct atmel_hlcdc *hlcdc = chip->hlcdc;
46 unsigned int status;
47 int ret;
48
49 if (state->enabled) {
50 struct clk *new_clk = hlcdc->slow_clk;
51 u64 pwmcval = state->duty_cycle * 256;
52 unsigned long clk_freq;
53 u64 clk_period_ns;
54 u32 pwmcfg;
55 int pres;
56
57 if (!chip->errata || !chip->errata->slow_clk_erratum) {
58 clk_freq = clk_get_rate(new_clk);
59 if (!clk_freq)
60 return -EINVAL;
61
62 clk_period_ns = (u64)NSEC_PER_SEC * 256;
63 do_div(clk_period_ns, clk_freq);
64 }
65
66 /* Errata: cannot use slow clk on some IP revisions */
67 if ((chip->errata && chip->errata->slow_clk_erratum) ||
68 clk_period_ns > state->period) {
69 new_clk = hlcdc->sys_clk;
70 clk_freq = clk_get_rate(new_clk);
71 if (!clk_freq)
72 return -EINVAL;
73
74 clk_period_ns = (u64)NSEC_PER_SEC * 256;
75 do_div(clk_period_ns, clk_freq);
76 }
77
78 for (pres = 0; pres <= ATMEL_HLCDC_PWMPS_MAX; pres++) {
79 /* Errata: cannot divide by 1 on some IP revisions */
80 if (!pres && chip->errata &&
81 chip->errata->div1_clk_erratum)
82 continue;
83
84 if ((clk_period_ns << pres) >= state->period)
85 break;
86 }
87
88 if (pres > ATMEL_HLCDC_PWMPS_MAX)
89 return -EINVAL;
90
91 pwmcfg = ATMEL_HLCDC_PWMPS(pres);
92
93 if (new_clk != chip->cur_clk) {
94 u32 gencfg = 0;
95 int ret;
96
97 ret = clk_prepare_enable(new_clk);
98 if (ret)
99 return ret;
100
101 clk_disable_unprepare(chip->cur_clk);
102 chip->cur_clk = new_clk;
103
104 if (new_clk == hlcdc->sys_clk)
105 gencfg = ATMEL_HLCDC_CLKPWMSEL;
106
107 ret = regmap_update_bits(hlcdc->regmap,
108 ATMEL_HLCDC_CFG(0),
109 ATMEL_HLCDC_CLKPWMSEL,
110 gencfg);
111 if (ret)
112 return ret;
113 }
114
115 do_div(pwmcval, state->period);
116
117 /*
118 * The PWM duty cycle is configurable from 0/256 to 255/256 of
119 * the period cycle. Hence we can't set a duty cycle occupying
120 * the whole period cycle if we're asked to.
121 * Set it to 255 if pwmcval is greater than 256.
122 */
123 if (pwmcval > 255)
124 pwmcval = 255;
125
126 pwmcfg |= ATMEL_HLCDC_PWMCVAL(pwmcval);
127
128 if (state->polarity == PWM_POLARITY_NORMAL)
129 pwmcfg |= ATMEL_HLCDC_PWMPOL;
130
131 ret = regmap_update_bits(hlcdc->regmap, ATMEL_HLCDC_CFG(6),
132 ATMEL_HLCDC_PWMCVAL_MASK |
133 ATMEL_HLCDC_PWMPS_MASK |
134 ATMEL_HLCDC_PWMPOL,
135 pwmcfg);
136 if (ret)
137 return ret;
138
139 ret = regmap_write(hlcdc->regmap, ATMEL_HLCDC_EN,
140 ATMEL_HLCDC_PWM);
141 if (ret)
142 return ret;
143
144 ret = regmap_read_poll_timeout(hlcdc->regmap, ATMEL_HLCDC_SR,
145 status,
146 status & ATMEL_HLCDC_PWM,
147 10, 0);
148 if (ret)
149 return ret;
150 } else {
151 ret = regmap_write(hlcdc->regmap, ATMEL_HLCDC_DIS,
152 ATMEL_HLCDC_PWM);
153 if (ret)
154 return ret;
155
156 ret = regmap_read_poll_timeout(hlcdc->regmap, ATMEL_HLCDC_SR,
157 status,
158 !(status & ATMEL_HLCDC_PWM),
159 10, 0);
160 if (ret)
161 return ret;
162
163 clk_disable_unprepare(chip->cur_clk);
164 chip->cur_clk = NULL;
165 }
166
167 return 0;
168}
169
170static const struct pwm_ops atmel_hlcdc_pwm_ops = {
171 .apply = atmel_hlcdc_pwm_apply,
172 .owner = THIS_MODULE,
173};
174
175static const struct atmel_hlcdc_pwm_errata atmel_hlcdc_pwm_at91sam9x5_errata = {
176 .slow_clk_erratum = true,
177};
178
179static const struct atmel_hlcdc_pwm_errata atmel_hlcdc_pwm_sama5d3_errata = {
180 .div1_clk_erratum = true,
181};
182
183#ifdef CONFIG_PM_SLEEP
184static int atmel_hlcdc_pwm_suspend(struct device *dev)
185{
186 struct atmel_hlcdc_pwm *chip = dev_get_drvdata(dev);
187
188 /* Keep the periph clock enabled if the PWM is still running. */
189 if (pwm_is_enabled(&chip->chip.pwms[0]))
190 clk_disable_unprepare(chip->hlcdc->periph_clk);
191
192 return 0;
193}
194
195static int atmel_hlcdc_pwm_resume(struct device *dev)
196{
197 struct atmel_hlcdc_pwm *chip = dev_get_drvdata(dev);
198 struct pwm_state state;
199 int ret;
200
201 pwm_get_state(&chip->chip.pwms[0], &state);
202
203 /* Re-enable the periph clock it was stopped during suspend. */
204 if (!state.enabled) {
205 ret = clk_prepare_enable(chip->hlcdc->periph_clk);
206 if (ret)
207 return ret;
208 }
209
210 return atmel_hlcdc_pwm_apply(&chip->chip, &chip->chip.pwms[0], &state);
211}
212#endif
213
214static SIMPLE_DEV_PM_OPS(atmel_hlcdc_pwm_pm_ops,
215 atmel_hlcdc_pwm_suspend, atmel_hlcdc_pwm_resume);
216
217static const struct of_device_id atmel_hlcdc_dt_ids[] = {
218 {
219 .compatible = "atmel,at91sam9n12-hlcdc",
220 /* 9n12 has same errata as 9x5 HLCDC PWM */
221 .data = &atmel_hlcdc_pwm_at91sam9x5_errata,
222 },
223 {
224 .compatible = "atmel,at91sam9x5-hlcdc",
225 .data = &atmel_hlcdc_pwm_at91sam9x5_errata,
226 },
227 {
228 .compatible = "atmel,sama5d2-hlcdc",
229 },
230 {
231 .compatible = "atmel,sama5d3-hlcdc",
232 .data = &atmel_hlcdc_pwm_sama5d3_errata,
233 },
234 {
235 .compatible = "atmel,sama5d4-hlcdc",
236 .data = &atmel_hlcdc_pwm_sama5d3_errata,
237 },
238 { .compatible = "microchip,sam9x60-hlcdc", },
239 { /* sentinel */ },
240};
241MODULE_DEVICE_TABLE(of, atmel_hlcdc_dt_ids);
242
243static int atmel_hlcdc_pwm_probe(struct platform_device *pdev)
244{
245 const struct of_device_id *match;
246 struct device *dev = &pdev->dev;
247 struct atmel_hlcdc_pwm *chip;
248 struct atmel_hlcdc *hlcdc;
249 int ret;
250
251 hlcdc = dev_get_drvdata(dev->parent);
252
253 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
254 if (!chip)
255 return -ENOMEM;
256
257 ret = clk_prepare_enable(hlcdc->periph_clk);
258 if (ret)
259 return ret;
260
261 match = of_match_node(atmel_hlcdc_dt_ids, dev->parent->of_node);
262 if (match)
263 chip->errata = match->data;
264
265 chip->hlcdc = hlcdc;
266 chip->chip.ops = &atmel_hlcdc_pwm_ops;
267 chip->chip.dev = dev;
268 chip->chip.base = -1;
269 chip->chip.npwm = 1;
270 chip->chip.of_xlate = of_pwm_xlate_with_flags;
271 chip->chip.of_pwm_n_cells = 3;
272
273 ret = pwmchip_add_with_polarity(&chip->chip, PWM_POLARITY_INVERSED);
274 if (ret) {
275 clk_disable_unprepare(hlcdc->periph_clk);
276 return ret;
277 }
278
279 platform_set_drvdata(pdev, chip);
280
281 return 0;
282}
283
284static int atmel_hlcdc_pwm_remove(struct platform_device *pdev)
285{
286 struct atmel_hlcdc_pwm *chip = platform_get_drvdata(pdev);
287 int ret;
288
289 ret = pwmchip_remove(&chip->chip);
290 if (ret)
291 return ret;
292
293 clk_disable_unprepare(chip->hlcdc->periph_clk);
294
295 return 0;
296}
297
298static const struct of_device_id atmel_hlcdc_pwm_dt_ids[] = {
299 { .compatible = "atmel,hlcdc-pwm" },
300 { /* sentinel */ },
301};
302
303static struct platform_driver atmel_hlcdc_pwm_driver = {
304 .driver = {
305 .name = "atmel-hlcdc-pwm",
306 .of_match_table = atmel_hlcdc_pwm_dt_ids,
307 .pm = &atmel_hlcdc_pwm_pm_ops,
308 },
309 .probe = atmel_hlcdc_pwm_probe,
310 .remove = atmel_hlcdc_pwm_remove,
311};
312module_platform_driver(atmel_hlcdc_pwm_driver);
313
314MODULE_ALIAS("platform:atmel-hlcdc-pwm");
315MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
316MODULE_DESCRIPTION("Atmel HLCDC PWM driver");
317MODULE_LICENSE("GPL v2");
1/*
2 * Copyright (C) 2014 Free Electrons
3 * Copyright (C) 2014 Atmel
4 *
5 * Author: Boris BREZILLON <boris.brezillon@free-electrons.com>
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published by
9 * the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * more details.
15 *
16 * You should have received a copy of the GNU General Public License along with
17 * this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <linux/clk.h>
21#include <linux/delay.h>
22#include <linux/mfd/atmel-hlcdc.h>
23#include <linux/module.h>
24#include <linux/platform_device.h>
25#include <linux/pwm.h>
26#include <linux/regmap.h>
27
28#define ATMEL_HLCDC_PWMCVAL_MASK GENMASK(15, 8)
29#define ATMEL_HLCDC_PWMCVAL(x) (((x) << 8) & ATMEL_HLCDC_PWMCVAL_MASK)
30#define ATMEL_HLCDC_PWMPOL BIT(4)
31#define ATMEL_HLCDC_PWMPS_MASK GENMASK(2, 0)
32#define ATMEL_HLCDC_PWMPS_MAX 0x6
33#define ATMEL_HLCDC_PWMPS(x) ((x) & ATMEL_HLCDC_PWMPS_MASK)
34
35struct atmel_hlcdc_pwm_errata {
36 bool slow_clk_erratum;
37 bool div1_clk_erratum;
38};
39
40struct atmel_hlcdc_pwm {
41 struct pwm_chip chip;
42 struct atmel_hlcdc *hlcdc;
43 struct clk *cur_clk;
44 const struct atmel_hlcdc_pwm_errata *errata;
45};
46
47static inline struct atmel_hlcdc_pwm *to_atmel_hlcdc_pwm(struct pwm_chip *chip)
48{
49 return container_of(chip, struct atmel_hlcdc_pwm, chip);
50}
51
52static int atmel_hlcdc_pwm_apply(struct pwm_chip *c, struct pwm_device *pwm,
53 struct pwm_state *state)
54{
55 struct atmel_hlcdc_pwm *chip = to_atmel_hlcdc_pwm(c);
56 struct atmel_hlcdc *hlcdc = chip->hlcdc;
57 unsigned int status;
58 int ret;
59
60 if (state->enabled) {
61 struct clk *new_clk = hlcdc->slow_clk;
62 u64 pwmcval = state->duty_cycle * 256;
63 unsigned long clk_freq;
64 u64 clk_period_ns;
65 u32 pwmcfg;
66 int pres;
67
68 if (!chip->errata || !chip->errata->slow_clk_erratum) {
69 clk_freq = clk_get_rate(new_clk);
70 if (!clk_freq)
71 return -EINVAL;
72
73 clk_period_ns = (u64)NSEC_PER_SEC * 256;
74 do_div(clk_period_ns, clk_freq);
75 }
76
77 /* Errata: cannot use slow clk on some IP revisions */
78 if ((chip->errata && chip->errata->slow_clk_erratum) ||
79 clk_period_ns > state->period) {
80 new_clk = hlcdc->sys_clk;
81 clk_freq = clk_get_rate(new_clk);
82 if (!clk_freq)
83 return -EINVAL;
84
85 clk_period_ns = (u64)NSEC_PER_SEC * 256;
86 do_div(clk_period_ns, clk_freq);
87 }
88
89 for (pres = 0; pres <= ATMEL_HLCDC_PWMPS_MAX; pres++) {
90 /* Errata: cannot divide by 1 on some IP revisions */
91 if (!pres && chip->errata &&
92 chip->errata->div1_clk_erratum)
93 continue;
94
95 if ((clk_period_ns << pres) >= state->period)
96 break;
97 }
98
99 if (pres > ATMEL_HLCDC_PWMPS_MAX)
100 return -EINVAL;
101
102 pwmcfg = ATMEL_HLCDC_PWMPS(pres);
103
104 if (new_clk != chip->cur_clk) {
105 u32 gencfg = 0;
106 int ret;
107
108 ret = clk_prepare_enable(new_clk);
109 if (ret)
110 return ret;
111
112 clk_disable_unprepare(chip->cur_clk);
113 chip->cur_clk = new_clk;
114
115 if (new_clk == hlcdc->sys_clk)
116 gencfg = ATMEL_HLCDC_CLKPWMSEL;
117
118 ret = regmap_update_bits(hlcdc->regmap,
119 ATMEL_HLCDC_CFG(0),
120 ATMEL_HLCDC_CLKPWMSEL,
121 gencfg);
122 if (ret)
123 return ret;
124 }
125
126 do_div(pwmcval, state->period);
127
128 /*
129 * The PWM duty cycle is configurable from 0/256 to 255/256 of
130 * the period cycle. Hence we can't set a duty cycle occupying
131 * the whole period cycle if we're asked to.
132 * Set it to 255 if pwmcval is greater than 256.
133 */
134 if (pwmcval > 255)
135 pwmcval = 255;
136
137 pwmcfg |= ATMEL_HLCDC_PWMCVAL(pwmcval);
138
139 if (state->polarity == PWM_POLARITY_NORMAL)
140 pwmcfg |= ATMEL_HLCDC_PWMPOL;
141
142 ret = regmap_update_bits(hlcdc->regmap, ATMEL_HLCDC_CFG(6),
143 ATMEL_HLCDC_PWMCVAL_MASK |
144 ATMEL_HLCDC_PWMPS_MASK |
145 ATMEL_HLCDC_PWMPOL,
146 pwmcfg);
147 if (ret)
148 return ret;
149
150 ret = regmap_write(hlcdc->regmap, ATMEL_HLCDC_EN,
151 ATMEL_HLCDC_PWM);
152 if (ret)
153 return ret;
154
155 ret = regmap_read_poll_timeout(hlcdc->regmap, ATMEL_HLCDC_SR,
156 status,
157 status & ATMEL_HLCDC_PWM,
158 10, 0);
159 if (ret)
160 return ret;
161 } else {
162 ret = regmap_write(hlcdc->regmap, ATMEL_HLCDC_DIS,
163 ATMEL_HLCDC_PWM);
164 if (ret)
165 return ret;
166
167 ret = regmap_read_poll_timeout(hlcdc->regmap, ATMEL_HLCDC_SR,
168 status,
169 !(status & ATMEL_HLCDC_PWM),
170 10, 0);
171 if (ret)
172 return ret;
173
174 clk_disable_unprepare(chip->cur_clk);
175 chip->cur_clk = NULL;
176 }
177
178 return 0;
179}
180
181static const struct pwm_ops atmel_hlcdc_pwm_ops = {
182 .apply = atmel_hlcdc_pwm_apply,
183 .owner = THIS_MODULE,
184};
185
186static const struct atmel_hlcdc_pwm_errata atmel_hlcdc_pwm_at91sam9x5_errata = {
187 .slow_clk_erratum = true,
188};
189
190static const struct atmel_hlcdc_pwm_errata atmel_hlcdc_pwm_sama5d3_errata = {
191 .div1_clk_erratum = true,
192};
193
194#ifdef CONFIG_PM_SLEEP
195static int atmel_hlcdc_pwm_suspend(struct device *dev)
196{
197 struct atmel_hlcdc_pwm *chip = dev_get_drvdata(dev);
198
199 /* Keep the periph clock enabled if the PWM is still running. */
200 if (pwm_is_enabled(&chip->chip.pwms[0]))
201 clk_disable_unprepare(chip->hlcdc->periph_clk);
202
203 return 0;
204}
205
206static int atmel_hlcdc_pwm_resume(struct device *dev)
207{
208 struct atmel_hlcdc_pwm *chip = dev_get_drvdata(dev);
209 struct pwm_state state;
210 int ret;
211
212 pwm_get_state(&chip->chip.pwms[0], &state);
213
214 /* Re-enable the periph clock it was stopped during suspend. */
215 if (!state.enabled) {
216 ret = clk_prepare_enable(chip->hlcdc->periph_clk);
217 if (ret)
218 return ret;
219 }
220
221 return atmel_hlcdc_pwm_apply(&chip->chip, &chip->chip.pwms[0], &state);
222}
223#endif
224
225static SIMPLE_DEV_PM_OPS(atmel_hlcdc_pwm_pm_ops,
226 atmel_hlcdc_pwm_suspend, atmel_hlcdc_pwm_resume);
227
228static const struct of_device_id atmel_hlcdc_dt_ids[] = {
229 {
230 .compatible = "atmel,at91sam9n12-hlcdc",
231 /* 9n12 has same errata as 9x5 HLCDC PWM */
232 .data = &atmel_hlcdc_pwm_at91sam9x5_errata,
233 },
234 {
235 .compatible = "atmel,at91sam9x5-hlcdc",
236 .data = &atmel_hlcdc_pwm_at91sam9x5_errata,
237 },
238 {
239 .compatible = "atmel,sama5d2-hlcdc",
240 },
241 {
242 .compatible = "atmel,sama5d3-hlcdc",
243 .data = &atmel_hlcdc_pwm_sama5d3_errata,
244 },
245 {
246 .compatible = "atmel,sama5d4-hlcdc",
247 .data = &atmel_hlcdc_pwm_sama5d3_errata,
248 },
249 { /* sentinel */ },
250};
251MODULE_DEVICE_TABLE(of, atmel_hlcdc_dt_ids);
252
253static int atmel_hlcdc_pwm_probe(struct platform_device *pdev)
254{
255 const struct of_device_id *match;
256 struct device *dev = &pdev->dev;
257 struct atmel_hlcdc_pwm *chip;
258 struct atmel_hlcdc *hlcdc;
259 int ret;
260
261 hlcdc = dev_get_drvdata(dev->parent);
262
263 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
264 if (!chip)
265 return -ENOMEM;
266
267 ret = clk_prepare_enable(hlcdc->periph_clk);
268 if (ret)
269 return ret;
270
271 match = of_match_node(atmel_hlcdc_dt_ids, dev->parent->of_node);
272 if (match)
273 chip->errata = match->data;
274
275 chip->hlcdc = hlcdc;
276 chip->chip.ops = &atmel_hlcdc_pwm_ops;
277 chip->chip.dev = dev;
278 chip->chip.base = -1;
279 chip->chip.npwm = 1;
280 chip->chip.of_xlate = of_pwm_xlate_with_flags;
281 chip->chip.of_pwm_n_cells = 3;
282
283 ret = pwmchip_add_with_polarity(&chip->chip, PWM_POLARITY_INVERSED);
284 if (ret) {
285 clk_disable_unprepare(hlcdc->periph_clk);
286 return ret;
287 }
288
289 platform_set_drvdata(pdev, chip);
290
291 return 0;
292}
293
294static int atmel_hlcdc_pwm_remove(struct platform_device *pdev)
295{
296 struct atmel_hlcdc_pwm *chip = platform_get_drvdata(pdev);
297 int ret;
298
299 ret = pwmchip_remove(&chip->chip);
300 if (ret)
301 return ret;
302
303 clk_disable_unprepare(chip->hlcdc->periph_clk);
304
305 return 0;
306}
307
308static const struct of_device_id atmel_hlcdc_pwm_dt_ids[] = {
309 { .compatible = "atmel,hlcdc-pwm" },
310 { /* sentinel */ },
311};
312
313static struct platform_driver atmel_hlcdc_pwm_driver = {
314 .driver = {
315 .name = "atmel-hlcdc-pwm",
316 .of_match_table = atmel_hlcdc_pwm_dt_ids,
317 .pm = &atmel_hlcdc_pwm_pm_ops,
318 },
319 .probe = atmel_hlcdc_pwm_probe,
320 .remove = atmel_hlcdc_pwm_remove,
321};
322module_platform_driver(atmel_hlcdc_pwm_driver);
323
324MODULE_ALIAS("platform:atmel-hlcdc-pwm");
325MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
326MODULE_DESCRIPTION("Atmel HLCDC PWM driver");
327MODULE_LICENSE("GPL v2");