Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

pwm: Adapt sysfs API documentation to reality

Most low-level PWM drivers support duty_cycle == period, and so does the
sysfs API. Also polarity can be changed for enabled PWMs since commit
39100ceea79f ("pwm: Switch to the atomic API").

Reported-by: Jens Gehrlein <J.Gehrlein@eckelmann.de>
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230911154454.675057-1-u.kleine-koenig@pengutronix.de

authored by

Uwe Kleine-König and committed by
Jonathan Corbet
3240c375 02f99987

+3 -3
+3 -3
Documentation/driver-api/pwm.rst
··· 111 111 112 112 duty_cycle 113 113 The active time of the PWM signal (read/write). 114 - Value is in nanoseconds and must be less than the period. 114 + Value is in nanoseconds and must be less than or equal to the period. 115 115 116 116 polarity 117 117 Changes the polarity of the PWM signal (read/write). 118 118 Writes to this property only work if the PWM chip supports changing 119 - the polarity. The polarity can only be changed if the PWM is not 120 - enabled. Value is the string "normal" or "inversed". 119 + the polarity. 120 + Value is the string "normal" or "inversed". 121 121 122 122 enable 123 123 Enable/disable the PWM signal (read/write).