Subject: [PATCH v2 03/16] pwm: cros-ec: update documentation regarding pwm-cells

From: [email-masked] (Brian Norris)
Date: Fri, 12 Jan 2018 10:31:23 -0800

On Fri, Jan 12, 2018 at 04:22:50PM +0200, Claudiu Beznea wrote:
> pwm-cells should be at least 2 to provide channel number and period value.

Nacked-by: Brian Norris <[email-masked]>

We don't control the period from the kernel; only the duty cycle. (Now,
that's perhaps not a wise firmware interface, and we may fix that
someday, but you can't just declare a breaking change to a documented,
reviewed binding.)

> Cc: Brian Norris <[email-masked]>
> Signed-off-by: Claudiu Beznea <[email-masked]>
> ---
>  Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.txt b/Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.txt
> index 472bd46ab5a4..03347fd302b5 100644
> --- a/Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.txt
> +++ b/Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.txt
> @@ -8,7 +8,7 @@ Documentation/devicetree/bindings/mfd/cros-ec.txt).
>  
>  Required properties:
>  - compatible: Must contain "google,cros-ec-pwm"
> -- #pwm-cells: Should be 1. The cell specifies the PWM index.
> +- #pwm-cells: Should be 2. The cell specifies the PWM index.

Umm, "2 cells", but you use the singular "cell", and don't document what
the second one is? That's nonsense.

Brian

>  
>  Example:
>  	cros-ec at 0 {
> @@ -18,6 +18,6 @@ Example:
>  
>  		cros_ec_pwm: ec-pwm {
>  			compatible = "google,cros-ec-pwm";
> -			#pwm-cells = <1>;
> +			#pwm-cells = <2>;
>  		};
>  	};
> -- 
> 2.7.4
>