5 #include <linux/mutex.h>
14 * enum pwm_polarity - polarity of a PWM signal
15 * @PWM_POLARITY_NORMAL: a high signal for the duration of the duty-
16 * cycle, followed by a low signal for the remainder of the pulse
18 * @PWM_POLARITY_INVERSED: a low signal for the duration of the duty-
19 * cycle, followed by a high signal for the remainder of the pulse
24 PWM_POLARITY_INVERSED
,
28 * struct pwm_args - board-dependent PWM arguments
29 * @period: reference period
30 * @polarity: reference polarity
32 * This structure describes board-dependent arguments attached to a PWM
33 * device. These arguments are usually retrieved from the PWM lookup table or
36 * Do not confuse this with the PWM state: PWM arguments represent the initial
37 * configuration that users want to use on this PWM device rather than the
38 * current PWM hardware state.
42 enum pwm_polarity polarity
;
46 PWMF_REQUESTED
= 1 << 0,
47 PWMF_EXPORTED
= 1 << 1,
51 * struct pwm_state - state of a PWM channel
52 * @period: PWM period (in nanoseconds)
53 * @duty_cycle: PWM duty cycle (in nanoseconds)
54 * @polarity: PWM polarity
55 * @enabled: PWM enabled status
59 unsigned int duty_cycle
;
60 enum pwm_polarity polarity
;
65 * struct pwm_device - PWM channel object
66 * @label: name of the PWM device
67 * @flags: flags associated with the PWM device
68 * @hwpwm: per-chip relative index of the PWM device
69 * @pwm: global index of the PWM device
70 * @chip: PWM chip providing this PWM device
71 * @chip_data: chip-private data associated with the PWM device
72 * @args: PWM arguments
73 * @state: curent PWM channel state
80 struct pwm_chip
*chip
;
84 struct pwm_state state
;
88 * pwm_get_state() - retrieve the current PWM state
90 * @state: state to fill with the current PWM state
92 static inline void pwm_get_state(const struct pwm_device
*pwm
,
93 struct pwm_state
*state
)
98 static inline bool pwm_is_enabled(const struct pwm_device
*pwm
)
100 struct pwm_state state
;
102 pwm_get_state(pwm
, &state
);
104 return state
.enabled
;
107 static inline void pwm_set_period(struct pwm_device
*pwm
, unsigned int period
)
110 pwm
->state
.period
= period
;
113 static inline unsigned int pwm_get_period(const struct pwm_device
*pwm
)
115 struct pwm_state state
;
117 pwm_get_state(pwm
, &state
);
122 static inline void pwm_set_duty_cycle(struct pwm_device
*pwm
, unsigned int duty
)
125 pwm
->state
.duty_cycle
= duty
;
128 static inline unsigned int pwm_get_duty_cycle(const struct pwm_device
*pwm
)
130 struct pwm_state state
;
132 pwm_get_state(pwm
, &state
);
134 return state
.duty_cycle
;
137 static inline enum pwm_polarity
pwm_get_polarity(const struct pwm_device
*pwm
)
139 struct pwm_state state
;
141 pwm_get_state(pwm
, &state
);
143 return state
.polarity
;
146 static inline void pwm_get_args(const struct pwm_device
*pwm
,
147 struct pwm_args
*args
)
153 * pwm_init_state() - prepare a new state to be applied with pwm_apply_state()
155 * @state: state to fill with the prepared PWM state
157 * This functions prepares a state that can later be tweaked and applied
158 * to the PWM device with pwm_apply_state(). This is a convenient function
159 * that first retrieves the current PWM state and the replaces the period
160 * and polarity fields with the reference values defined in pwm->args.
161 * Once the function returns, you can adjust the ->enabled and ->duty_cycle
162 * fields according to your needs before calling pwm_apply_state().
164 * ->duty_cycle is initially set to zero to avoid cases where the current
165 * ->duty_cycle value exceed the pwm_args->period one, which would trigger
166 * an error if the user calls pwm_apply_state() without adjusting ->duty_cycle
169 static inline void pwm_init_state(const struct pwm_device
*pwm
,
170 struct pwm_state
*state
)
172 struct pwm_args args
;
174 /* First get the current state. */
175 pwm_get_state(pwm
, state
);
177 /* Then fill it with the reference config */
178 pwm_get_args(pwm
, &args
);
180 state
->period
= args
.period
;
181 state
->polarity
= args
.polarity
;
182 state
->duty_cycle
= 0;
186 * pwm_get_relative_duty_cycle() - Get a relative duty cycle value
187 * @state: PWM state to extract the duty cycle from
188 * @scale: target scale of the relative duty cycle
190 * This functions converts the absolute duty cycle stored in @state (expressed
191 * in nanosecond) into a value relative to the period.
193 * For example if you want to get the duty_cycle expressed in percent, call:
195 * pwm_get_state(pwm, &state);
196 * duty = pwm_get_relative_duty_cycle(&state, 100);
198 static inline unsigned int
199 pwm_get_relative_duty_cycle(const struct pwm_state
*state
, unsigned int scale
)
204 return DIV_ROUND_CLOSEST_ULL((u64
)state
->duty_cycle
* scale
,
209 * pwm_set_relative_duty_cycle() - Set a relative duty cycle value
210 * @state: PWM state to fill
211 * @duty_cycle: relative duty cycle value
212 * @scale: scale in which @duty_cycle is expressed
214 * This functions converts a relative into an absolute duty cycle (expressed
215 * in nanoseconds), and puts the result in state->duty_cycle.
217 * For example if you want to configure a 50% duty cycle, call:
219 * pwm_init_state(pwm, &state);
220 * pwm_set_relative_duty_cycle(&state, 50, 100);
221 * pwm_apply_state(pwm, &state);
223 * This functions returns -EINVAL if @duty_cycle and/or @scale are
224 * inconsistent (@scale == 0 or @duty_cycle > @scale).
227 pwm_set_relative_duty_cycle(struct pwm_state
*state
, unsigned int duty_cycle
,
230 if (!scale
|| duty_cycle
> scale
)
233 state
->duty_cycle
= DIV_ROUND_CLOSEST_ULL((u64
)duty_cycle
*
241 * struct pwm_ops - PWM controller operations
242 * @request: optional hook for requesting a PWM
243 * @free: optional hook for freeing a PWM
244 * @config: configure duty cycles and period length for this PWM
245 * @set_polarity: configure the polarity of this PWM
246 * @capture: capture and report PWM signal
247 * @enable: enable PWM output toggling
248 * @disable: disable PWM output toggling
249 * @apply: atomically apply a new PWM config. The state argument
250 * should be adjusted with the real hardware config (if the
251 * approximate the period or duty_cycle value, state should
253 * @get_state: get the current PWM state. This function is only
254 * called once per PWM device when the PWM chip is
256 * @dbg_show: optional routine to show contents in debugfs
257 * @owner: helps prevent removal of modules exporting active PWMs
260 int (*request
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
);
261 void (*free
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
);
262 int (*config
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
263 int duty_ns
, int period_ns
);
264 int (*set_polarity
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
265 enum pwm_polarity polarity
);
266 int (*capture
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
267 struct pwm_capture
*result
, unsigned long timeout
);
268 int (*enable
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
);
269 void (*disable
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
);
270 int (*apply
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
271 struct pwm_state
*state
);
272 void (*get_state
)(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
273 struct pwm_state
*state
);
274 #ifdef CONFIG_DEBUG_FS
275 void (*dbg_show
)(struct pwm_chip
*chip
, struct seq_file
*s
);
277 struct module
*owner
;
281 * struct pwm_chip - abstract a PWM controller
282 * @dev: device providing the PWMs
283 * @list: list node for internal use
284 * @ops: callbacks for this PWM controller
285 * @base: number of first PWM controlled by this chip
286 * @npwm: number of PWMs controlled by this chip
287 * @pwms: array of PWM devices allocated by the framework
288 * @of_xlate: request a PWM device given a device tree PWM specifier
289 * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier
293 struct list_head list
;
294 const struct pwm_ops
*ops
;
298 struct pwm_device
*pwms
;
300 struct pwm_device
* (*of_xlate
)(struct pwm_chip
*pc
,
301 const struct of_phandle_args
*args
);
302 unsigned int of_pwm_n_cells
;
306 * struct pwm_capture - PWM capture data
307 * @period: period of the PWM signal (in nanoseconds)
308 * @duty_cycle: duty cycle of the PWM signal (in nanoseconds)
312 unsigned int duty_cycle
;
315 #if IS_ENABLED(CONFIG_PWM)
317 struct pwm_device
*pwm_request(int pwm_id
, const char *label
);
318 void pwm_free(struct pwm_device
*pwm
);
319 int pwm_apply_state(struct pwm_device
*pwm
, struct pwm_state
*state
);
320 int pwm_adjust_config(struct pwm_device
*pwm
);
323 * pwm_config() - change a PWM device configuration
325 * @duty_ns: "on" time (in nanoseconds)
326 * @period_ns: duration (in nanoseconds) of one cycle
328 * Returns: 0 on success or a negative error code on failure.
330 static inline int pwm_config(struct pwm_device
*pwm
, int duty_ns
,
333 struct pwm_state state
;
338 if (duty_ns
< 0 || period_ns
< 0)
341 pwm_get_state(pwm
, &state
);
342 if (state
.duty_cycle
== duty_ns
&& state
.period
== period_ns
)
345 state
.duty_cycle
= duty_ns
;
346 state
.period
= period_ns
;
347 return pwm_apply_state(pwm
, &state
);
351 * pwm_set_polarity() - configure the polarity of a PWM signal
353 * @polarity: new polarity of the PWM signal
355 * Note that the polarity cannot be configured while the PWM device is
358 * Returns: 0 on success or a negative error code on failure.
360 static inline int pwm_set_polarity(struct pwm_device
*pwm
,
361 enum pwm_polarity polarity
)
363 struct pwm_state state
;
368 pwm_get_state(pwm
, &state
);
369 if (state
.polarity
== polarity
)
373 * Changing the polarity of a running PWM without adjusting the
374 * dutycycle/period value is a bit risky (can introduce glitches).
375 * Return -EBUSY in this case.
376 * Note that this is allowed when using pwm_apply_state() because
377 * the user specifies all the parameters.
382 state
.polarity
= polarity
;
383 return pwm_apply_state(pwm
, &state
);
387 * pwm_enable() - start a PWM output toggling
390 * Returns: 0 on success or a negative error code on failure.
392 static inline int pwm_enable(struct pwm_device
*pwm
)
394 struct pwm_state state
;
399 pwm_get_state(pwm
, &state
);
403 state
.enabled
= true;
404 return pwm_apply_state(pwm
, &state
);
408 * pwm_disable() - stop a PWM output toggling
411 static inline void pwm_disable(struct pwm_device
*pwm
)
413 struct pwm_state state
;
418 pwm_get_state(pwm
, &state
);
422 state
.enabled
= false;
423 pwm_apply_state(pwm
, &state
);
426 /* PWM provider APIs */
427 int pwm_capture(struct pwm_device
*pwm
, struct pwm_capture
*result
,
428 unsigned long timeout
);
429 int pwm_set_chip_data(struct pwm_device
*pwm
, void *data
);
430 void *pwm_get_chip_data(struct pwm_device
*pwm
);
432 int pwmchip_add_with_polarity(struct pwm_chip
*chip
,
433 enum pwm_polarity polarity
);
434 int pwmchip_add(struct pwm_chip
*chip
);
435 int pwmchip_remove(struct pwm_chip
*chip
);
436 struct pwm_device
*pwm_request_from_chip(struct pwm_chip
*chip
,
440 struct pwm_device
*of_pwm_xlate_with_flags(struct pwm_chip
*pc
,
441 const struct of_phandle_args
*args
);
443 struct pwm_device
*pwm_get(struct device
*dev
, const char *con_id
);
444 struct pwm_device
*of_pwm_get(struct device_node
*np
, const char *con_id
);
445 void pwm_put(struct pwm_device
*pwm
);
447 struct pwm_device
*devm_pwm_get(struct device
*dev
, const char *con_id
);
448 struct pwm_device
*devm_of_pwm_get(struct device
*dev
, struct device_node
*np
,
450 void devm_pwm_put(struct device
*dev
, struct pwm_device
*pwm
);
452 static inline struct pwm_device
*pwm_request(int pwm_id
, const char *label
)
454 return ERR_PTR(-ENODEV
);
457 static inline void pwm_free(struct pwm_device
*pwm
)
461 static inline int pwm_apply_state(struct pwm_device
*pwm
,
462 const struct pwm_state
*state
)
467 static inline int pwm_adjust_config(struct pwm_device
*pwm
)
472 static inline int pwm_config(struct pwm_device
*pwm
, int duty_ns
,
478 static inline int pwm_capture(struct pwm_device
*pwm
,
479 struct pwm_capture
*result
,
480 unsigned long timeout
)
485 static inline int pwm_set_polarity(struct pwm_device
*pwm
,
486 enum pwm_polarity polarity
)
491 static inline int pwm_enable(struct pwm_device
*pwm
)
496 static inline void pwm_disable(struct pwm_device
*pwm
)
500 static inline int pwm_set_chip_data(struct pwm_device
*pwm
, void *data
)
505 static inline void *pwm_get_chip_data(struct pwm_device
*pwm
)
510 static inline int pwmchip_add(struct pwm_chip
*chip
)
515 static inline int pwmchip_add_inversed(struct pwm_chip
*chip
)
520 static inline int pwmchip_remove(struct pwm_chip
*chip
)
525 static inline struct pwm_device
*pwm_request_from_chip(struct pwm_chip
*chip
,
529 return ERR_PTR(-ENODEV
);
532 static inline struct pwm_device
*pwm_get(struct device
*dev
,
533 const char *consumer
)
535 return ERR_PTR(-ENODEV
);
538 static inline struct pwm_device
*of_pwm_get(struct device_node
*np
,
541 return ERR_PTR(-ENODEV
);
544 static inline void pwm_put(struct pwm_device
*pwm
)
548 static inline struct pwm_device
*devm_pwm_get(struct device
*dev
,
549 const char *consumer
)
551 return ERR_PTR(-ENODEV
);
554 static inline struct pwm_device
*devm_of_pwm_get(struct device
*dev
,
555 struct device_node
*np
,
558 return ERR_PTR(-ENODEV
);
561 static inline void devm_pwm_put(struct device
*dev
, struct pwm_device
*pwm
)
566 static inline void pwm_apply_args(struct pwm_device
*pwm
)
568 struct pwm_state state
= { };
571 * PWM users calling pwm_apply_args() expect to have a fresh config
572 * where the polarity and period are set according to pwm_args info.
573 * The problem is, polarity can only be changed when the PWM is
576 * PWM drivers supporting hardware readout may declare the PWM device
577 * as enabled, and prevent polarity setting, which changes from the
578 * existing behavior, where all PWM devices are declared as disabled
579 * at startup (even if they are actually enabled), thus authorizing
582 * To fulfill this requirement, we apply a new state which disables
583 * the PWM device and set the reference period and polarity config.
585 * Note that PWM users requiring a smooth handover between the
586 * bootloader and the kernel (like critical regulators controlled by
587 * PWM devices) will have to switch to the atomic API and avoid calling
591 state
.enabled
= false;
592 state
.polarity
= pwm
->args
.polarity
;
593 state
.period
= pwm
->args
.period
;
595 pwm_apply_state(pwm
, &state
);
599 struct list_head list
;
600 const char *provider
;
605 enum pwm_polarity polarity
;
606 const char *module
; /* optional, may be NULL */
609 #define PWM_LOOKUP_WITH_MODULE(_provider, _index, _dev_id, _con_id, \
610 _period, _polarity, _module) \
612 .provider = _provider, \
617 .polarity = _polarity, \
621 #define PWM_LOOKUP(_provider, _index, _dev_id, _con_id, _period, _polarity) \
622 PWM_LOOKUP_WITH_MODULE(_provider, _index, _dev_id, _con_id, _period, \
625 #if IS_ENABLED(CONFIG_PWM)
626 void pwm_add_table(struct pwm_lookup
*table
, size_t num
);
627 void pwm_remove_table(struct pwm_lookup
*table
, size_t num
);
629 static inline void pwm_add_table(struct pwm_lookup
*table
, size_t num
)
633 static inline void pwm_remove_table(struct pwm_lookup
*table
, size_t num
)
638 #ifdef CONFIG_PWM_SYSFS
639 void pwmchip_sysfs_export(struct pwm_chip
*chip
);
640 void pwmchip_sysfs_unexport(struct pwm_chip
*chip
);
641 void pwmchip_sysfs_unexport_children(struct pwm_chip
*chip
);
643 static inline void pwmchip_sysfs_export(struct pwm_chip
*chip
)
647 static inline void pwmchip_sysfs_unexport(struct pwm_chip
*chip
)
651 static inline void pwmchip_sysfs_unexport_children(struct pwm_chip
*chip
)
654 #endif /* CONFIG_PWM_SYSFS */
656 #endif /* __LINUX_PWM_H */