summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>2023-09-11 17:44:54 +0200
committerThierry Reding <thierry.reding@gmail.com>2023-10-13 10:07:18 +0200
commit8151b37b418310c83f133a9ea8ec2a654fb30d20 (patch)
tree12a6c28ffa05a666cf0bf23f92ff48d031e77c23 /Documentation
parentpwm: dwc: add PWM bit unset in get_state call (diff)
downloadlinux-8151b37b418310c83f133a9ea8ec2a654fb30d20.tar.xz
linux-8151b37b418310c83f133a9ea8ec2a654fb30d20.zip
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> Link: https://lore.kernel.org/r/20230911154454.675057-1-u.kleine-koenig@pengutronix.de Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/driver-api/pwm.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/driver-api/pwm.rst b/Documentation/driver-api/pwm.rst
index 3fdc95f7a1d1..bb264490a87a 100644
--- a/Documentation/driver-api/pwm.rst
+++ b/Documentation/driver-api/pwm.rst
@@ -111,13 +111,13 @@ channel that was exported. The following properties will then be available:
duty_cycle
The active time of the PWM signal (read/write).
- Value is in nanoseconds and must be less than the period.
+ Value is in nanoseconds and must be less than or equal to the period.
polarity
Changes the polarity of the PWM signal (read/write).
Writes to this property only work if the PWM chip supports changing
- the polarity. The polarity can only be changed if the PWM is not
- enabled. Value is the string "normal" or "inversed".
+ the polarity.
+ Value is the string "normal" or "inversed".
enable
Enable/disable the PWM signal (read/write).