Commit e463b05d authored by Uwe Kleine-König's avatar Uwe Kleine-König Committed by Uwe Kleine-König
Browse files

pwm: Better document return value of pwm_round_waveform_might_sleep() 



Better explain how pwm_round_waveform_might_sleep() (and so the
respective lowlevel driver callback) is supposed to round and the
meaning of the return value.

Signed-off-by: default avatarUwe Kleine-König <u.kleine-koenig@baylibre.com>
Link: https://lore.kernel.org/r/db84abf1e82e4498fc0e7c318d2673771d0039fe.1744120697.git.ukleinek@kernel.org


[ukleinek: Fix a rst formatting issue reported by Stephen Rothwell]
Signed-off-by: default avatarUwe Kleine-König <ukleinek@kernel.org>
parent bd897149

drivers/pwm/core.c

+6 −2
Original line number Diff line number Diff line
@@ -229,8 +229,12 @@ static int __pwm_write_waveform(struct pwm_chip *chip, struct pwm_device *pwm, c 
 * these two calls and the waveform determined by

 * pwm_round_waveform_might_sleep() cannot be implemented any more.

 *

 * Returns 0 on success, 1 if there is no valid hardware configuration matching

 * the input waveform under the PWM rounding rules or a negative errno.

 * Usually all values passed in @wf are rounded down to the nearest possible

 * value (in the order period_length_ns, duty_length_ns and then

 * duty_offset_ns). Only if this isn't possible, a value might grow.

 *

 * Returns 0 on success, 1 if at least one value had to be rounded up or a

 * negative errno.

 */

int pwm_round_waveform_might_sleep(struct pwm_device *pwm, struct pwm_waveform *wf)

{