1 // SPDX-License-Identifier: GPL-2.0+
3 * Azoteq IQS620A PWM Generator
5 * Copyright (C) 2019 Jeff LaBundy <jeff@labundy.com>
8 * - The period is fixed to 1 ms and is generated continuously despite changes
9 * to the duty cycle or enable/disable state.
10 * - Changes to the duty cycle or enable/disable state take effect immediately
11 * and may result in a glitch during the period in which the change is made.
12 * - The device cannot generate a 0% duty cycle. For duty cycles below 1 / 256
13 * ms, the output is disabled and relies upon an external pull-down resistor
14 * to hold the GPIO3/LTX pin low.
17 #include <linux/device.h>
18 #include <linux/kernel.h>
19 #include <linux/mfd/iqs62x.h>
20 #include <linux/module.h>
21 #include <linux/mutex.h>
22 #include <linux/notifier.h>
23 #include <linux/platform_device.h>
24 #include <linux/pwm.h>
25 #include <linux/regmap.h>
26 #include <linux/slab.h>
28 #define IQS620_PWR_SETTINGS 0xd2
29 #define IQS620_PWR_SETTINGS_PWM_OUT BIT(7)
31 #define IQS620_PWM_DUTY_CYCLE 0xd8
33 #define IQS620_PWM_PERIOD_NS 1000000
35 struct iqs620_pwm_private
{
36 struct iqs62x_core
*iqs62x
;
38 struct notifier_block notifier
;
44 static int iqs620_pwm_apply(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
45 const struct pwm_state
*state
)
47 struct iqs620_pwm_private
*iqs620_pwm
;
48 struct iqs62x_core
*iqs62x
;
52 if (state
->polarity
!= PWM_POLARITY_NORMAL
)
55 if (state
->period
< IQS620_PWM_PERIOD_NS
)
58 iqs620_pwm
= container_of(chip
, struct iqs620_pwm_private
, chip
);
59 iqs62x
= iqs620_pwm
->iqs62x
;
62 * The duty cycle generated by the device is calculated as follows:
64 * duty_cycle = (IQS620_PWM_DUTY_CYCLE + 1) / 256 * 1 ms
66 * ...where IQS620_PWM_DUTY_CYCLE is a register value between 0 and 255
67 * (inclusive). Therefore the lowest duty cycle the device can generate
68 * while the output is enabled is 1 / 256 ms.
70 * For lower duty cycles (e.g. 0), the PWM output is simply disabled to
71 * allow an external pull-down resistor to hold the GPIO3/LTX pin low.
73 duty_scale
= div_u64(state
->duty_cycle
* 256, IQS620_PWM_PERIOD_NS
);
75 mutex_lock(&iqs620_pwm
->lock
);
77 if (!state
->enabled
|| !duty_scale
) {
78 ret
= regmap_update_bits(iqs62x
->regmap
, IQS620_PWR_SETTINGS
,
79 IQS620_PWR_SETTINGS_PWM_OUT
, 0);
85 u8 duty_val
= min_t(u64
, duty_scale
- 1, 0xff);
87 ret
= regmap_write(iqs62x
->regmap
, IQS620_PWM_DUTY_CYCLE
,
92 iqs620_pwm
->duty_val
= duty_val
;
95 if (state
->enabled
&& duty_scale
) {
96 ret
= regmap_update_bits(iqs62x
->regmap
, IQS620_PWR_SETTINGS
,
97 IQS620_PWR_SETTINGS_PWM_OUT
, 0xff);
102 iqs620_pwm
->out_en
= state
->enabled
;
105 mutex_unlock(&iqs620_pwm
->lock
);
110 static void iqs620_pwm_get_state(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
111 struct pwm_state
*state
)
113 struct iqs620_pwm_private
*iqs620_pwm
;
115 iqs620_pwm
= container_of(chip
, struct iqs620_pwm_private
, chip
);
117 mutex_lock(&iqs620_pwm
->lock
);
120 * Since the device cannot generate a 0% duty cycle, requests to do so
121 * cause subsequent calls to iqs620_pwm_get_state to report the output
122 * as disabled with duty cycle equal to that which was in use prior to
123 * the request. This is not ideal, but is the best compromise based on
124 * the capabilities of the device.
126 state
->enabled
= iqs620_pwm
->out_en
;
127 state
->duty_cycle
= DIV_ROUND_UP((iqs620_pwm
->duty_val
+ 1) *
128 IQS620_PWM_PERIOD_NS
, 256);
130 mutex_unlock(&iqs620_pwm
->lock
);
132 state
->period
= IQS620_PWM_PERIOD_NS
;
135 static int iqs620_pwm_notifier(struct notifier_block
*notifier
,
136 unsigned long event_flags
, void *context
)
138 struct iqs620_pwm_private
*iqs620_pwm
;
139 struct iqs62x_core
*iqs62x
;
142 if (!(event_flags
& BIT(IQS62X_EVENT_SYS_RESET
)))
145 iqs620_pwm
= container_of(notifier
, struct iqs620_pwm_private
,
147 iqs62x
= iqs620_pwm
->iqs62x
;
149 mutex_lock(&iqs620_pwm
->lock
);
152 * The parent MFD driver already prints an error message in the event
153 * of a device reset, so nothing else is printed here unless there is
154 * an additional failure.
156 ret
= regmap_write(iqs62x
->regmap
, IQS620_PWM_DUTY_CYCLE
,
157 iqs620_pwm
->duty_val
);
161 ret
= regmap_update_bits(iqs62x
->regmap
, IQS620_PWR_SETTINGS
,
162 IQS620_PWR_SETTINGS_PWM_OUT
,
163 iqs620_pwm
->out_en
? 0xff : 0);
166 mutex_unlock(&iqs620_pwm
->lock
);
169 dev_err(iqs620_pwm
->chip
.dev
,
170 "Failed to re-initialize device: %d\n", ret
);
177 static const struct pwm_ops iqs620_pwm_ops
= {
178 .apply
= iqs620_pwm_apply
,
179 .get_state
= iqs620_pwm_get_state
,
180 .owner
= THIS_MODULE
,
183 static void iqs620_pwm_notifier_unregister(void *context
)
185 struct iqs620_pwm_private
*iqs620_pwm
= context
;
188 ret
= blocking_notifier_chain_unregister(&iqs620_pwm
->iqs62x
->nh
,
189 &iqs620_pwm
->notifier
);
191 dev_err(iqs620_pwm
->chip
.dev
,
192 "Failed to unregister notifier: %d\n", ret
);
195 static int iqs620_pwm_probe(struct platform_device
*pdev
)
197 struct iqs62x_core
*iqs62x
= dev_get_drvdata(pdev
->dev
.parent
);
198 struct iqs620_pwm_private
*iqs620_pwm
;
202 iqs620_pwm
= devm_kzalloc(&pdev
->dev
, sizeof(*iqs620_pwm
), GFP_KERNEL
);
206 platform_set_drvdata(pdev
, iqs620_pwm
);
207 iqs620_pwm
->iqs62x
= iqs62x
;
209 ret
= regmap_read(iqs62x
->regmap
, IQS620_PWR_SETTINGS
, &val
);
212 iqs620_pwm
->out_en
= val
& IQS620_PWR_SETTINGS_PWM_OUT
;
214 ret
= regmap_read(iqs62x
->regmap
, IQS620_PWM_DUTY_CYCLE
, &val
);
217 iqs620_pwm
->duty_val
= val
;
219 iqs620_pwm
->chip
.dev
= &pdev
->dev
;
220 iqs620_pwm
->chip
.ops
= &iqs620_pwm_ops
;
221 iqs620_pwm
->chip
.base
= -1;
222 iqs620_pwm
->chip
.npwm
= 1;
224 mutex_init(&iqs620_pwm
->lock
);
226 iqs620_pwm
->notifier
.notifier_call
= iqs620_pwm_notifier
;
227 ret
= blocking_notifier_chain_register(&iqs620_pwm
->iqs62x
->nh
,
228 &iqs620_pwm
->notifier
);
230 dev_err(&pdev
->dev
, "Failed to register notifier: %d\n", ret
);
234 ret
= devm_add_action_or_reset(&pdev
->dev
,
235 iqs620_pwm_notifier_unregister
,
240 ret
= pwmchip_add(&iqs620_pwm
->chip
);
242 dev_err(&pdev
->dev
, "Failed to add device: %d\n", ret
);
247 static int iqs620_pwm_remove(struct platform_device
*pdev
)
249 struct iqs620_pwm_private
*iqs620_pwm
= platform_get_drvdata(pdev
);
252 ret
= pwmchip_remove(&iqs620_pwm
->chip
);
254 dev_err(&pdev
->dev
, "Failed to remove device: %d\n", ret
);
259 static struct platform_driver iqs620_pwm_platform_driver
= {
261 .name
= "iqs620a-pwm",
263 .probe
= iqs620_pwm_probe
,
264 .remove
= iqs620_pwm_remove
,
266 module_platform_driver(iqs620_pwm_platform_driver
);
268 MODULE_AUTHOR("Jeff LaBundy <jeff@labundy.com>");
269 MODULE_DESCRIPTION("Azoteq IQS620A PWM Generator");
270 MODULE_LICENSE("GPL");
271 MODULE_ALIAS("platform:iqs620a-pwm");