2022-11-23 07:11:47

by Billy Tsai

[permalink] [raw]
Subject: [v4 2/5] dt-bindings: pwm: Add bindings for aspeed pwm controller

Add the aspeed pwm device bindings which should be the child-node of
pwm-tach mfd.

Signed-off-by: Billy Tsai <[email protected]>
---
.../bindings/pwm/aspeed,ast2600-pwm.yaml | 54 +++++++++++++++++++
1 file changed, 54 insertions(+)
create mode 100644 Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml

diff --git a/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml b/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
new file mode 100644
index 000000000000..68a60fc73902
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
@@ -0,0 +1,54 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2021 Aspeed, Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/aspeed,ast2600-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Aspeed Ast2600 PWM controller
+
+maintainers:
+ - Billy Tsai <[email protected]>
+
+description: |
+ The Aspeed PWM controller supports up to 16 PWM outputs.
+ This module is part of the ast2600-pwm-tach multi-function device. For more
+ details see ../mfd/aspeed,ast2600-pwm-tach.yaml.
+
+allOf:
+ - $ref: pwm.yaml#
+
+properties:
+ compatible:
+ enum:
+ - aspeed,ast2600-pwm
+
+ "#pwm-cells":
+ const: 3
+patternProperties:
+ "^pwm@[a-z0-9]+$":
+ description: Set extend properties for each pwm channel.
+ type: object
+ properties:
+ reg:
+ description:
+ The pwm channel index.
+ maxItems: 1
+
+ aspeed,wdt-reload-enable:
+ type: boolean
+ description:
+ Enable the function of wdt reset reload duty point.
+
+ aspeed,wdt-reload-duty-point:
+ description:
+ Define the duty point after wdt reset, 0 = 100%
+ minimum: 0
+ maximum: 255
+ required:
+ - reg
+
+required:
+ - compatible
+
+additionalProperties: false
--
2.25.1


2022-11-23 09:50:42

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [v4 2/5] dt-bindings: pwm: Add bindings for aspeed pwm controller

On 23/11/2022 07:16, Billy Tsai wrote:
> Add the aspeed pwm device bindings which should be the child-node of
> pwm-tach mfd.

Subject: drop second, redundant "bindings".

>
> Signed-off-by: Billy Tsai <[email protected]>
> ---
> .../bindings/pwm/aspeed,ast2600-pwm.yaml | 54 +++++++++++++++++++
> 1 file changed, 54 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
>
> diff --git a/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml b/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
> new file mode 100644
> index 000000000000..68a60fc73902
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2021 Aspeed, Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/aspeed,ast2600-pwm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Aspeed Ast2600 PWM controller
> +
> +maintainers:
> + - Billy Tsai <[email protected]>
> +
> +description: |
> + The Aspeed PWM controller supports up to 16 PWM outputs.
> + This module is part of the ast2600-pwm-tach multi-function device. For more
> + details see ../mfd/aspeed,ast2600-pwm-tach.yaml.
> +
> +allOf:
> + - $ref: pwm.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - aspeed,ast2600-pwm
> +
> + "#pwm-cells":
> + const: 3

Blank line.

> +patternProperties:
> + "^pwm@[a-z0-9]+$":
> + description: Set extend properties for each pwm channel.

Description is not a correct sentence. Description explains the hardware
property you have here.

> + type: object
> + properties:
> + reg:
> + description:
> + The pwm channel index.
> + maxItems: 1
> +
> + aspeed,wdt-reload-enable:
> + type: boolean
> + description:
> + Enable the function of wdt reset reload duty point.
> +
> + aspeed,wdt-reload-duty-point:
> + description:
> + Define the duty point after wdt reset, 0 = 100%
> + minimum: 0
> + maximum: 255

Why maximum is 255? Why 0=100%? 0 should be equal to 0 and maximum to
some maximum value (e.g. 100%). If these are percents, use appropriate
units. If these are not - what are these? You need a $ref in such case.

> + required:
> + - reg
> +
> +required:
> + - compatible
> +
> +additionalProperties: false

Best regards,
Krzysztof

2022-11-23 15:12:08

by Rob Herring

[permalink] [raw]
Subject: Re: [v4 2/5] dt-bindings: pwm: Add bindings for aspeed pwm controller


On Wed, 23 Nov 2022 14:16:32 +0800, Billy Tsai wrote:
> Add the aspeed pwm device bindings which should be the child-node of
> pwm-tach mfd.
>
> Signed-off-by: Billy Tsai <[email protected]>
> ---
> .../bindings/pwm/aspeed,ast2600-pwm.yaml | 54 +++++++++++++++++++
> 1 file changed, 54 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml
>

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml: patternProperties:^pwm@[a-z0-9]+$:properties:aspeed,wdt-reload-duty-point: 'oneOf' conditional failed, one must be fixed:
'type' is a required property
hint: A vendor boolean property can use "type: boolean"
Additional properties are not allowed ('maximum', 'minimum' were unexpected)
hint: A vendor boolean property can use "type: boolean"
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml: patternProperties:^pwm@[a-z0-9]+$:properties:aspeed,wdt-reload-duty-point: 'oneOf' conditional failed, one must be fixed:
'enum' is a required property
'const' is a required property
hint: A vendor string property with exact values has an implicit type
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pwm/aspeed,ast2600-pwm.yaml: patternProperties:^pwm@[a-z0-9]+$:properties:aspeed,wdt-reload-duty-point: 'oneOf' conditional failed, one must be fixed:
'$ref' is a required property
'allOf' is a required property
hint: A vendor property needs a $ref to types.yaml
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
hint: Vendor specific properties must have a type and description unless they have a defined, common suffix.
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command.