dt-bindings: pwm: describe the cells in #pwm-cells in pwm.yaml

[PATCH v1] dt-bindings: pwm: describe the cells in #pwm-cells in pwm.yaml

Posted by Conor Dooley 1 year, 9 months ago

From: Conor Dooley <conor.dooley@microchip.com>

When commit 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings
to json-schema") converted the pwm provider section of the text binding
to dt-schema it also updated all references to pwm.txt in pwm provider
bindings to pwm.yaml.

Most pwm provider bindings had a reference to pwm.txt as it contains a
description of what the cells in #pwm-cells are, albeit in the consumer
section of the document. Only information in the provider section of the
document was moved to the yaml binding, and it contains no information
about the cell format, making all references to it for the cell format
unhelpful.

Fixes: 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings to json-schema")
Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
---

I yoinked the wording from pwm.txt. Having "Typically" feels a bit
clumsy, but a given provider is free to override that order AFAIU.

CC: Chris Packham <Chris.Packham@alliedtelesis.co.nz>
CC: Guenter Roeck <linux@roeck-us.net>
CC: Uwe Kleine-König <ukleinek@kernel.org>
CC: Rob Herring <robh@kernel.org>
CC: Krzysztof Kozlowski <krzk+dt@kernel.org>
CC: Conor Dooley <conor+dt@kernel.org>
CC: linux-pwm@vger.kernel.org
CC: devicetree@vger.kernel.org
CC: linux-kernel@vger.kernel.org
---
 Documentation/devicetree/bindings/pwm/pwm.yaml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/pwm/pwm.yaml b/Documentation/devicetree/bindings/pwm/pwm.yaml
index abd9fa873354..f2206ec3c7c4 100644
--- a/Documentation/devicetree/bindings/pwm/pwm.yaml
+++ b/Documentation/devicetree/bindings/pwm/pwm.yaml
@@ -16,8 +16,10 @@ properties:
     pattern: "^pwm(@.*|-([0-9]|[1-9][0-9]+))?$"
 
   "#pwm-cells":
-    description:
-      Number of cells in a PWM specifier.
+    description: |
+      Number of cells in a PWM specifier. Typically the cells represent, in
+      order: the chip-relative PWM number, the PWM period in nanoseconds and
+      optionally a number of flags (defined in <dt-bindings/pwm/pwm.h>).
 
 required:
   - "#pwm-cells"
-- 
2.43.0

Re: [PATCH v1] dt-bindings: pwm: describe the cells in #pwm-cells in pwm.yaml

Posted by Rob Herring (Arm) 1 year, 8 months ago

On Fri, 17 May 2024 18:38:46 +0100, Conor Dooley wrote:
> From: Conor Dooley <conor.dooley@microchip.com>
> 
> When commit 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings
> to json-schema") converted the pwm provider section of the text binding
> to dt-schema it also updated all references to pwm.txt in pwm provider
> bindings to pwm.yaml.
> 
> Most pwm provider bindings had a reference to pwm.txt as it contains a
> description of what the cells in #pwm-cells are, albeit in the consumer
> section of the document. Only information in the provider section of the
> document was moved to the yaml binding, and it contains no information
> about the cell format, making all references to it for the cell format
> unhelpful.
> 
> Fixes: 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings to json-schema")
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> ---
> 
> I yoinked the wording from pwm.txt. Having "Typically" feels a bit
> clumsy, but a given provider is free to override that order AFAIU.
> 
> CC: Chris Packham <Chris.Packham@alliedtelesis.co.nz>
> CC: Guenter Roeck <linux@roeck-us.net>
> CC: Uwe Kleine-König <ukleinek@kernel.org>
> CC: Rob Herring <robh@kernel.org>
> CC: Krzysztof Kozlowski <krzk+dt@kernel.org>
> CC: Conor Dooley <conor+dt@kernel.org>
> CC: linux-pwm@vger.kernel.org
> CC: devicetree@vger.kernel.org
> CC: linux-kernel@vger.kernel.org
> ---
>  Documentation/devicetree/bindings/pwm/pwm.yaml | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>

Re: [PATCH v1] dt-bindings: pwm: describe the cells in #pwm-cells in pwm.yaml

Posted by Uwe Kleine-König 1 year, 9 months ago

On Fri, May 17, 2024 at 06:38:46PM +0100, Conor Dooley wrote:
> From: Conor Dooley <conor.dooley@microchip.com>
> 
> When commit 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings
> to json-schema") converted the pwm provider section of the text binding
> to dt-schema it also updated all references to pwm.txt in pwm provider
> bindings to pwm.yaml.
> 
> Most pwm provider bindings had a reference to pwm.txt as it contains a
> description of what the cells in #pwm-cells are, albeit in the consumer
> section of the document. Only information in the provider section of the
> document was moved to the yaml binding, and it contains no information
> about the cell format, making all references to it for the cell format
> unhelpful.
> 
> Fixes: 89650a1e3b6f ("dt-bindings: pwm: Convert PWM bindings to json-schema")
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> ---
> 
> I yoinked the wording from pwm.txt. Having "Typically" feels a bit
> clumsy, but a given provider is free to override that order AFAIU.

All drivers that have 3 cells use that order, some drivers use less and
skip different values.

The patch looks fine, thanks. Will apply it after the merge window.

Thanks
Uwe

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |