]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
dt-bindings: pwm: describe the cells in #pwm-cells in pwm.yaml
authorConor Dooley <conor.dooley@microchip.com>
Fri, 17 May 2024 17:38:46 +0000 (18:38 +0100)
committerUwe Kleine-König <ukleinek@kernel.org>
Fri, 5 Jul 2024 21:26:43 +0000 (23:26 +0200)
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>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Link: https://lore.kernel.org/r/20240517-patient-stingily-30611f73e792@spud
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Documentation/devicetree/bindings/pwm/pwm.yaml

index abd9fa873354e2d7b3768279b08037482a3eaae3..f2206ec3c7c4c15a44300df48f6c6a9166a2b550 100644 (file)
@@ -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"