[4/9] dt-bindings: crypto: add fsl-sec4-snvs DT schema
Commit Message
From: Peng Fan <peng.fan@nxp.com>
Convert fsl-sec4.txt SNVS RTC and PowerKey to DT schema
Signed-off-by: Peng Fan <peng.fan@nxp.com>
---
.../bindings/crypto/fsl-sec4-snvs.yaml | 153 ++++++++++++++++++
1 file changed, 153 insertions(+)
create mode 100644 Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
Comments
On Wed, 01 Mar 2023 09:56:57 +0800, Peng Fan (OSS) wrote:
> From: Peng Fan <peng.fan@nxp.com>
>
> Convert fsl-sec4.txt SNVS RTC and PowerKey to DT schema
>
> Signed-off-by: Peng Fan <peng.fan@nxp.com>
> ---
> .../bindings/crypto/fsl-sec4-snvs.yaml | 153 ++++++++++++++++++
> 1 file changed, 153 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.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/nvmem/snvs-lpgpr.example.dtb: snvs@20cc000: compatible: 'oneOf' conditional failed, one must be fixed:
['fsl,sec-v4.0-mon', 'syscon', 'simple-mfd'] is too long
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/nvmem/snvs-lpgpr.example.dtb: snvs@20cc000: Unevaluated properties are not allowed ('compatible', 'snvs-lpgpr' were unexpected)
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230301015702.3388458-5-peng.fan@oss.nxp.com
The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.
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 yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
On 01/03/2023 02:56, Peng Fan (OSS) wrote:
> From: Peng Fan <peng.fan@nxp.com>
>
> Convert fsl-sec4.txt SNVS RTC and PowerKey to DT schema
This is a mess. Subject says add, commit msg says convert and body does
what?
>
> Signed-off-by: Peng Fan <peng.fan@nxp.com>
> ---
> .../bindings/crypto/fsl-sec4-snvs.yaml | 153 ++++++++++++++++++
> 1 file changed, 153 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
>
> diff --git a/Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml b/Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
> new file mode 100644
> index 000000000000..633e70f9b303
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/fsl-sec4-snvs.yaml
Filename matching compatibles.
> @@ -0,0 +1,153 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/fsl-sec4-snvs.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP SEC4 SNVS Binding
Drop Binding.
> +
> +description:
> + CONTENTS
> + -Secure Non-Volatile Storage (SNVS) Node
> + -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
OK, this is some copy-paste from some poor other code. Please fix all
your bindings like I mentioned in previous emails.
> +
> + Node defines address range and the associated interrupt for the SNVS
> + function. This function monitors security state information & reports
> + security violations. This also included rtc, system power off and ON/OFF
> + key.
> +
> + For more information on SEC4, ref fsl-sec4-crypto.yaml
> +
> +maintainers:
> + - Peng Fan <peng.fan@nxp.com>
> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - const: fsl,sec-v4.0-mon
> + - const: syscon
> +
> + reg:
> + maxItems: 1
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 1
> +
> + ranges:
> + description:
> + A standard property. Specifies the physical address range of the SNVS
So the rest are non-standard properties?
> + register space. A triplet that includes the child address, parent
> + address, & length.
> +
> + interrupts:
> + description:
> + Specifies the interrupts generated by this device. The value of the
> + interrupts property consists of one interrupt specifier. The format
> + of the specifier is defined by the binding document describing the
> + node's interrupt parent.
Please point me to any useful information in this description. Anything
useful. All interrupts are generated from the devices, aren't they?
> + minItems: 1
> + maxItems: 2
No, you need to describe the items instead.
> +
(...)
> + sec_mon: sec_mon@314000 {
Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
No underscores in node names.
> + compatible = "fsl,sec-v4.0-mon", "syscon";
> + reg = <0x314000 0x1000>;
> +
> + snvs-rtc-lp {
Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
> + compatible = "fsl,sec-v4.0-mon-rtc-lp";
> + regmap = <&sec_mon>;
> + offset = <0x34>;
> + interrupts = <GIC_SPI 19 IRQ_TYPE_LEVEL_HIGH>,
> + <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> + clocks = <&clks IMX7D_SNVS_CLK>;
> + clock-names = "snvs-rtc";
> + };
> +
> + snvs-powerkey {
Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
Best regards,
Krzysztof
new file mode 100644
@@ -0,0 +1,153 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/crypto/fsl-sec4-snvs.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP SEC4 SNVS Binding
+
+description:
+ CONTENTS
+ -Secure Non-Volatile Storage (SNVS) Node
+ -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
+
+ Node defines address range and the associated interrupt for the SNVS
+ function. This function monitors security state information & reports
+ security violations. This also included rtc, system power off and ON/OFF
+ key.
+
+ For more information on SEC4, ref fsl-sec4-crypto.yaml
+
+maintainers:
+ - Peng Fan <peng.fan@nxp.com>
+
+properties:
+ compatible:
+ oneOf:
+ - items:
+ - const: fsl,sec-v4.0-mon
+ - const: syscon
+
+ reg:
+ maxItems: 1
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 1
+
+ ranges:
+ description:
+ A standard property. Specifies the physical address range of the SNVS
+ register space. A triplet that includes the child address, parent
+ address, & length.
+
+ interrupts:
+ description:
+ Specifies the interrupts generated by this device. The value of the
+ interrupts property consists of one interrupt specifier. The format
+ of the specifier is defined by the binding document describing the
+ node's interrupt parent.
+ minItems: 1
+ maxItems: 2
+
+ snvs-rtc-lp:
+ type: object
+ description:
+ Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node. A SNVS
+ child node that defines SNVS LP RTC.
+
+ properties:
+ compatible:
+ enum:
+ - fsl,sec-v4.0-mon-rtc-lp
+
+ interrupts:
+ minItems: 1
+ maxItems: 2
+
+ regmap:
+ description: This is phandle to the register map node.
+ $ref: /schemas/types.yaml#/definitions/phandle
+
+ offset:
+ description: LP register offset. default it is 0x34.
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ clocks:
+ maxItems: 1
+
+ clock-names:
+ items:
+ - const: snvs-rtc
+
+ required:
+ - compatible
+ - interrupts
+ - regmap
+
+ snvs-powerkey:
+ type: object
+ description:
+ The snvs-pwrkey is designed to enable POWER key function which
+ controlled by SNVS ONOFF, the driver can report the status of POWER
+ key and wakeup system if pressed after system suspend.
+
+ properties:
+ compatible:
+ enum:
+ - fsl,sec-v4.0-pwrkey
+
+ interrupts:
+ description: The SNVS ON/OFF interrupt number to the CPU(s).
+ maxItems: 1
+
+ linux,keycode:
+ description: Keycode to emit, KEY_POWER by default.
+ $ref: /schemas/types.yaml#/definitions/int32
+
+ regmap:
+ description: This is phandle to the register map node.
+ $ref: /schemas/types.yaml#/definitions/phandle
+
+ wakeup-source:
+ description: Button can wake-up the system.
+ type: boolean
+
+ required:
+ - compatible
+ - interrupts
+
+required:
+ - compatible
+ - reg
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/clock/imx7d-clock.h>
+ sec_mon: sec_mon@314000 {
+ compatible = "fsl,sec-v4.0-mon", "syscon";
+ reg = <0x314000 0x1000>;
+
+ snvs-rtc-lp {
+ compatible = "fsl,sec-v4.0-mon-rtc-lp";
+ regmap = <&sec_mon>;
+ offset = <0x34>;
+ interrupts = <GIC_SPI 19 IRQ_TYPE_LEVEL_HIGH>,
+ <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
+ clocks = <&clks IMX7D_SNVS_CLK>;
+ clock-names = "snvs-rtc";
+ };
+
+ snvs-powerkey {
+ compatible = "fsl,sec-v4.0-pwrkey";
+ regmap = <&sec_mon>;
+ interrupts = <GIC_SPI 4 IRQ_TYPE_LEVEL_HIGH>;
+ linux,keycode = <116>; /* KEY_POWER */
+ wakeup-source;
+ };
+ };