[PATCH] pwm: Adapt sysfs API documentation to reality

[PATCH] pwm: Adapt sysfs API documentation to reality

[Uwe Kleine-König]

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>
---
 Documentation/driver-api/pwm.rst | 6 +++---
 1 file 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).

base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d
-- 
2.40.1

Re: [PATCH] pwm: Adapt sysfs API documentation to reality

[Jonathan Corbet]

Uwe Kleine-König <u.kleine-koenig@pengutronix.de> writes:

> 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>
> ---
>  Documentation/driver-api/pwm.rst | 6 +++---
>  1 file 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".

I don't see this in linux-next yet, so I've gone ahead and applied it.

Thanks,

jon