[PATCH v2] dt-bindings: pwm: renesas: tpu: fix "compatible" prop description

[PATCH v2] dt-bindings: pwm: renesas: tpu: fix "compatible" prop description

[Sergei Shtylyov]

The "compatible" property description contradicts even the example given:
it only says that there must be a single value while the example has the
fallback value too -- which makes much more sense. Moreover, the generic
property value is misdocumented as being R-Car (and RZ/G1) specific...

Fixes: 382457e562bb ("pwm: renesas-tpu: Add DT support")
Fixes: 3ba111a01822 ("dt-bindings: pwm: renesas-tpu: Document r8a774[35] support")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>

---
This patch is against Linus' repo -- the 'fixes' branch in Thierry Reding's
'linux-pwm.git' repo is very outdated...

Changes in version 2:
- fixed the wording of the fallback value description.

 Documentation/devicetree/bindings/pwm/renesas,tpu-pwm.txt |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Index: linux/Documentation/devicetree/bindings/pwm/renesas,tpu-pwm.txt
===================================================================
--- linux.orig/Documentation/devicetree/bindings/pwm/renesas,tpu-pwm.txt
+++ linux/Documentation/devicetree/bindings/pwm/renesas,tpu-pwm.txt
@@ -2,13 +2,14 @@
 
 Required Properties:
 
-  - compatible: should be one of the following.
+  - compatible: must contain one or more of the following:
     - "renesas,tpu-r8a73a4": for R8A73A4 (R-Mobile APE6) compatible PWM controller.
     - "renesas,tpu-r8a7740": for R8A7740 (R-Mobile A1) compatible PWM controller.
     - "renesas,tpu-r8a7743": for R8A7743 (RZ/G1M) compatible PWM controller.
     - "renesas,tpu-r8a7745": for R8A7745 (RZ/G1E) compatible PWM controller.
     - "renesas,tpu-r8a7790": for R8A7790 (R-Car H2) compatible PWM controller.
-    - "renesas,tpu": for generic R-Car and RZ/G1 TPU PWM controller.
+    - "renesas,tpu": for the generic TPU PWM controller; this is a fallback for
+		     the entries listed above.
 
   - reg: Base address and length of each memory resource used by the PWM
     controller hardware module.

Re: [PATCH v2] dt-bindings: pwm: renesas: tpu: fix "compatible" prop description

[Thierry Reding]

[-- Attachment #1: Type: text/plain, Size: 944 bytes --]

On Sat, Sep 22, 2018 at 10:43:24PM +0300, Sergei Shtylyov wrote:
> The "compatible" property description contradicts even the example given:
> it only says that there must be a single value while the example has the
> fallback value too -- which makes much more sense. Moreover, the generic
> property value is misdocumented as being R-Car (and RZ/G1) specific...
> 
> Fixes: 382457e562bb ("pwm: renesas-tpu: Add DT support")
> Fixes: 3ba111a01822 ("dt-bindings: pwm: renesas-tpu: Document r8a774[35] support")
> Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
> 
> ---
> This patch is against Linus' repo -- the 'fixes' branch in Thierry Reding's
> 'linux-pwm.git' repo is very outdated...

Yes, that's because it is only updated if there's actually anything that
needs to be fixed during a release cycle. Please use Linus' tree or,
better yet, linux-next as your baseline when sending patches.

Thierry

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v2] dt-bindings: pwm: renesas: tpu: fix "compatible" prop description

[Thierry Reding]

[-- Attachment #1: Type: text/plain, Size: 973 bytes --]

On Sat, Sep 22, 2018 at 10:43:24PM +0300, Sergei Shtylyov wrote:
> The "compatible" property description contradicts even the example given:
> it only says that there must be a single value while the example has the
> fallback value too -- which makes much more sense. Moreover, the generic
> property value is misdocumented as being R-Car (and RZ/G1) specific...
> 
> Fixes: 382457e562bb ("pwm: renesas-tpu: Add DT support")
> Fixes: 3ba111a01822 ("dt-bindings: pwm: renesas-tpu: Document r8a774[35] support")
> Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
> 
> ---
> This patch is against Linus' repo -- the 'fixes' branch in Thierry Reding's
> 'linux-pwm.git' repo is very outdated...
> 
> Changes in version 2:
> - fixed the wording of the fallback value description.
> 
>  Documentation/devicetree/bindings/pwm/renesas,tpu-pwm.txt |    5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

Applied, thanks.

Thierry

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]