pwm: Adapt sysfs API documentation to reality
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Mon, 11 Sep 2023 15:44:54 +0000 (17:44 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 10 Oct 2023 19:35:54 +0000 (13:35 -0600)
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
Documentation/driver-api/pwm.rst

index 3fdc95f7a1d1591bc76bbddecca084f7f504f65e..bb264490a87a16a981095ac4b88de93662bcf134 100644 (file)
@@ -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).