xref: /linux/drivers/pwm/pwm-brcmstb.c (revision ad30469a841b50dbb541df4d6971d891f703c297)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Broadcom BCM7038 PWM driver
4  * Author: Florian Fainelli
5  *
6  * Copyright (C) 2015 Broadcom Corporation
7  */
8 
9 #define pr_fmt(fmt)	KBUILD_MODNAME ": " fmt
10 
11 #include <linux/clk.h>
12 #include <linux/export.h>
13 #include <linux/init.h>
14 #include <linux/io.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/of.h>
18 #include <linux/platform_device.h>
19 #include <linux/pwm.h>
20 #include <linux/spinlock.h>
21 
22 #define PWM_CTRL		0x00
23 #define  CTRL_START		BIT(0)
24 #define  CTRL_OEB		BIT(1)
25 #define  CTRL_FORCE_HIGH	BIT(2)
26 #define  CTRL_OPENDRAIN		BIT(3)
27 #define  CTRL_CHAN_OFFS		4
28 
29 #define PWM_CTRL2		0x04
30 #define  CTRL2_OUT_SELECT	BIT(0)
31 
32 #define PWM_CH_SIZE		0x8
33 
34 #define PWM_CWORD_MSB(ch)	(0x08 + ((ch) * PWM_CH_SIZE))
35 #define PWM_CWORD_LSB(ch)	(0x0c + ((ch) * PWM_CH_SIZE))
36 
37 /* Number of bits for the CWORD value */
38 #define CWORD_BIT_SIZE		16
39 
40 /*
41  * Maximum control word value allowed when variable-frequency PWM is used as a
42  * clock for the constant-frequency PMW.
43  */
44 #define CONST_VAR_F_MAX		32768
45 #define CONST_VAR_F_MIN		1
46 
47 #define PWM_ON(ch)		(0x18 + ((ch) * PWM_CH_SIZE))
48 #define  PWM_ON_MIN		1
49 #define PWM_PERIOD(ch)		(0x1c + ((ch) * PWM_CH_SIZE))
50 #define  PWM_PERIOD_MIN		0
51 
52 #define PWM_ON_PERIOD_MAX	0xff
53 
54 struct brcmstb_pwm {
55 	void __iomem *base;
56 	struct clk *clk;
57 	struct pwm_chip chip;
58 };
59 
60 static inline u32 brcmstb_pwm_readl(struct brcmstb_pwm *p,
61 				    unsigned int offset)
62 {
63 	if (IS_ENABLED(CONFIG_MIPS) && IS_ENABLED(CONFIG_CPU_BIG_ENDIAN))
64 		return __raw_readl(p->base + offset);
65 	else
66 		return readl_relaxed(p->base + offset);
67 }
68 
69 static inline void brcmstb_pwm_writel(struct brcmstb_pwm *p, u32 value,
70 				      unsigned int offset)
71 {
72 	if (IS_ENABLED(CONFIG_MIPS) && IS_ENABLED(CONFIG_CPU_BIG_ENDIAN))
73 		__raw_writel(value, p->base + offset);
74 	else
75 		writel_relaxed(value, p->base + offset);
76 }
77 
78 static inline struct brcmstb_pwm *to_brcmstb_pwm(struct pwm_chip *chip)
79 {
80 	return container_of(chip, struct brcmstb_pwm, chip);
81 }
82 
83 /*
84  * Fv is derived from the variable frequency output. The variable frequency
85  * output is configured using this formula:
86  *
87  * W = cword, if cword < 2 ^ 15 else 16-bit 2's complement of cword
88  *
89  * Fv = W x 2 ^ -16 x 27Mhz (reference clock)
90  *
91  * The period is: (period + 1) / Fv and "on" time is on / (period + 1)
92  *
93  * The PWM core framework specifies that the "duty_ns" parameter is in fact the
94  * "on" time, so this translates directly into our HW programming here.
95  */
96 static int brcmstb_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
97 			      u64 duty_ns, u64 period_ns)
98 {
99 	struct brcmstb_pwm *p = to_brcmstb_pwm(chip);
100 	unsigned long pc, dc, cword = CONST_VAR_F_MAX;
101 	unsigned int channel = pwm->hwpwm;
102 	u32 value;
103 
104 	/*
105 	 * If asking for a duty_ns equal to period_ns, we need to substract
106 	 * the period value by 1 to make it shorter than the "on" time and
107 	 * produce a flat 100% duty cycle signal, and max out the "on" time
108 	 */
109 	if (duty_ns == period_ns) {
110 		dc = PWM_ON_PERIOD_MAX;
111 		pc = PWM_ON_PERIOD_MAX - 1;
112 		goto done;
113 	}
114 
115 	while (1) {
116 		u64 rate;
117 
118 		/*
119 		 * Calculate the base rate from base frequency and current
120 		 * cword
121 		 */
122 		rate = (u64)clk_get_rate(p->clk) * (u64)cword;
123 		rate >>= CWORD_BIT_SIZE;
124 
125 		pc = mul_u64_u64_div_u64(period_ns, rate, NSEC_PER_SEC);
126 		dc = mul_u64_u64_div_u64(duty_ns + 1, rate, NSEC_PER_SEC);
127 
128 		/*
129 		 * We can be called with separate duty and period updates,
130 		 * so do not reject dc == 0 right away
131 		 */
132 		if (pc == PWM_PERIOD_MIN || (dc < PWM_ON_MIN && duty_ns))
133 			return -EINVAL;
134 
135 		/* We converged on a calculation */
136 		if (pc <= PWM_ON_PERIOD_MAX && dc <= PWM_ON_PERIOD_MAX)
137 			break;
138 
139 		/*
140 		 * The cword needs to be a power of 2 for the variable
141 		 * frequency generator to output a 50% duty cycle variable
142 		 * frequency which is used as input clock to the fixed
143 		 * frequency generator.
144 		 */
145 		cword >>= 1;
146 
147 		/*
148 		 * Desired periods are too large, we do not have a divider
149 		 * for them
150 		 */
151 		if (cword < CONST_VAR_F_MIN)
152 			return -EINVAL;
153 	}
154 
155 done:
156 	/*
157 	 * Configure the defined "cword" value to have the variable frequency
158 	 * generator output a base frequency for the constant frequency
159 	 * generator to derive from.
160 	 */
161 	brcmstb_pwm_writel(p, cword >> 8, PWM_CWORD_MSB(channel));
162 	brcmstb_pwm_writel(p, cword & 0xff, PWM_CWORD_LSB(channel));
163 
164 	/* Select constant frequency signal output */
165 	value = brcmstb_pwm_readl(p, PWM_CTRL2);
166 	value |= CTRL2_OUT_SELECT << (channel * CTRL_CHAN_OFFS);
167 	brcmstb_pwm_writel(p, value, PWM_CTRL2);
168 
169 	/* Configure on and period value */
170 	brcmstb_pwm_writel(p, pc, PWM_PERIOD(channel));
171 	brcmstb_pwm_writel(p, dc, PWM_ON(channel));
172 
173 	return 0;
174 }
175 
176 static inline void brcmstb_pwm_enable_set(struct brcmstb_pwm *p,
177 					  unsigned int channel, bool enable)
178 {
179 	unsigned int shift = channel * CTRL_CHAN_OFFS;
180 	u32 value;
181 
182 	value = brcmstb_pwm_readl(p, PWM_CTRL);
183 
184 	if (enable) {
185 		value &= ~(CTRL_OEB << shift);
186 		value |= (CTRL_START | CTRL_OPENDRAIN) << shift;
187 	} else {
188 		value &= ~((CTRL_START | CTRL_OPENDRAIN) << shift);
189 		value |= CTRL_OEB << shift;
190 	}
191 
192 	brcmstb_pwm_writel(p, value, PWM_CTRL);
193 }
194 
195 static int brcmstb_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
196 			     const struct pwm_state *state)
197 {
198 	struct brcmstb_pwm *p = to_brcmstb_pwm(chip);
199 	int err;
200 
201 	if (state->polarity != PWM_POLARITY_NORMAL)
202 		return -EINVAL;
203 
204 	if (!state->enabled) {
205 		if (pwm->state.enabled)
206 			brcmstb_pwm_enable_set(p, pwm->hwpwm, false);
207 
208 		return 0;
209 	}
210 
211 	err = brcmstb_pwm_config(chip, pwm, state->duty_cycle, state->period);
212 	if (err)
213 		return err;
214 
215 	if (!pwm->state.enabled)
216 		brcmstb_pwm_enable_set(p, pwm->hwpwm, true);
217 
218 	return 0;
219 }
220 
221 static const struct pwm_ops brcmstb_pwm_ops = {
222 	.apply = brcmstb_pwm_apply,
223 };
224 
225 static const struct of_device_id brcmstb_pwm_of_match[] = {
226 	{ .compatible = "brcm,bcm7038-pwm", },
227 	{ /* sentinel */ }
228 };
229 MODULE_DEVICE_TABLE(of, brcmstb_pwm_of_match);
230 
231 static int brcmstb_pwm_probe(struct platform_device *pdev)
232 {
233 	struct brcmstb_pwm *p;
234 	int ret;
235 
236 	p = devm_kzalloc(&pdev->dev, sizeof(*p), GFP_KERNEL);
237 	if (!p)
238 		return -ENOMEM;
239 
240 	p->clk = devm_clk_get_enabled(&pdev->dev, NULL);
241 	if (IS_ERR(p->clk))
242 		return dev_err_probe(&pdev->dev, PTR_ERR(p->clk),
243 				     "failed to obtain clock\n");
244 
245 	platform_set_drvdata(pdev, p);
246 
247 	p->chip.dev = &pdev->dev;
248 	p->chip.ops = &brcmstb_pwm_ops;
249 	p->chip.npwm = 2;
250 
251 	p->base = devm_platform_ioremap_resource(pdev, 0);
252 	if (IS_ERR(p->base))
253 		return PTR_ERR(p->base);
254 
255 	ret = devm_pwmchip_add(&pdev->dev, &p->chip);
256 	if (ret)
257 		return dev_err_probe(&pdev->dev, ret, "failed to add PWM chip\n");
258 
259 	return 0;
260 }
261 
262 #ifdef CONFIG_PM_SLEEP
263 static int brcmstb_pwm_suspend(struct device *dev)
264 {
265 	struct brcmstb_pwm *p = dev_get_drvdata(dev);
266 
267 	clk_disable_unprepare(p->clk);
268 
269 	return 0;
270 }
271 
272 static int brcmstb_pwm_resume(struct device *dev)
273 {
274 	struct brcmstb_pwm *p = dev_get_drvdata(dev);
275 
276 	return clk_prepare_enable(p->clk);
277 }
278 #endif
279 
280 static SIMPLE_DEV_PM_OPS(brcmstb_pwm_pm_ops, brcmstb_pwm_suspend,
281 			 brcmstb_pwm_resume);
282 
283 static struct platform_driver brcmstb_pwm_driver = {
284 	.probe = brcmstb_pwm_probe,
285 	.driver = {
286 		.name = "pwm-brcmstb",
287 		.of_match_table = brcmstb_pwm_of_match,
288 		.pm = &brcmstb_pwm_pm_ops,
289 	},
290 };
291 module_platform_driver(brcmstb_pwm_driver);
292 
293 MODULE_AUTHOR("Florian Fainelli <f.fainelli@gmail.com>");
294 MODULE_DESCRIPTION("Broadcom STB PWM driver");
295 MODULE_ALIAS("platform:pwm-brcmstb");
296 MODULE_LICENSE("GPL");
297