Convert the Arm TrustZone CryptoCell cryptographic engine Device Tree
binding documentation to json-schema.
Document missing properties.
Update the example to match reality.
Signed-off-by: Geert Uytterhoeven <[email protected]>
---
v2:
- Use "SPDX-License-Identifier: GPL-2.0", as requested by Gilad.
---
.../bindings/crypto/arm,cryptocell.yaml | 53 +++++++++++++++++++
.../bindings/crypto/arm-cryptocell.txt | 25 ---------
2 files changed, 53 insertions(+), 25 deletions(-)
create mode 100644 Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
delete mode 100644 Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
diff --git a/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
new file mode 100644
index 0000000000000000..b8331863ee754988
--- /dev/null
+++ b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/crypto/arm,cryptocell.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Arm TrustZone CryptoCell cryptographic engine
+
+maintainers:
+ - Gilad Ben-Yossef <[email protected]>
+
+properties:
+ compatible:
+ enum:
+ - arm,cryptocell-713-ree
+ - arm,cryptocell-703-ree
+ - arm,cryptocell-712-ree
+ - arm,cryptocell-710-ree
+ - arm,cryptocell-630p-ree
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+ power-domains:
+ maxItems: 1
+
+ resets:
+ maxItems: 1
+
+ dma-coherent: true
+
+required:
+ - compatible
+ - reg
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+ arm_cc712: crypto@80000000 {
+ compatible = "arm,cryptocell-712-ree";
+ reg = <0x80000000 0x10000>;
+ interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>;
+ };
diff --git a/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt b/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
deleted file mode 100644
index 6130e6eb4af89135..0000000000000000
--- a/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-Arm TrustZone CryptoCell cryptographic engine
-
-Required properties:
-- compatible: Should be one of -
- "arm,cryptocell-713-ree"
- "arm,cryptocell-703-ree"
- "arm,cryptocell-712-ree"
- "arm,cryptocell-710-ree"
- "arm,cryptocell-630p-ree"
-- reg: Base physical address of the engine and length of memory mapped region.
-- interrupts: Interrupt number for the device.
-
-Optional properties:
-- clocks: Reference to the crypto engine clock.
-- dma-coherent: Present if dma operations are coherent.
-
-Examples:
-
- arm_cc712: crypto@80000000 {
- compatible = "arm,cryptocell-712-ree";
- interrupt-parent = <&intc>;
- interrupts = < 0 30 4 >;
- reg = < 0x80000000 0x10000 >;
-
- };
--
2.25.1
On Wed, Jun 16, 2021 at 12:29 PM Geert Uytterhoeven
<[email protected]> wrote:
>
> Convert the Arm TrustZone CryptoCell cryptographic engine Device Tree
> binding documentation to json-schema.
>
> Document missing properties.
> Update the example to match reality.
>
> Signed-off-by: Geert Uytterhoeven <[email protected]>
> ---
> v2:
> - Use "SPDX-License-Identifier: GPL-2.0", as requested by Gilad.
Acked-by: Gilad Ben Yossef <[email protected]>
> ---
> .../bindings/crypto/arm,cryptocell.yaml | 53 +++++++++++++++++++
> .../bindings/crypto/arm-cryptocell.txt | 25 ---------
> 2 files changed, 53 insertions(+), 25 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
> delete mode 100644 Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
>
> diff --git a/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
> new file mode 100644
> index 0000000000000000..b8331863ee754988
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
> @@ -0,0 +1,53 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/arm,cryptocell.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Arm TrustZone CryptoCell cryptographic engine
> +
> +maintainers:
> + - Gilad Ben-Yossef <[email protected]>
> +
> +properties:
> + compatible:
> + enum:
> + - arm,cryptocell-713-ree
> + - arm,cryptocell-703-ree
> + - arm,cryptocell-712-ree
> + - arm,cryptocell-710-ree
> + - arm,cryptocell-630p-ree
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> + power-domains:
> + maxItems: 1
> +
> + resets:
> + maxItems: 1
> +
> + dma-coherent: true
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> + arm_cc712: crypto@80000000 {
> + compatible = "arm,cryptocell-712-ree";
> + reg = <0x80000000 0x10000>;
> + interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>;
> + };
> diff --git a/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt b/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
> deleted file mode 100644
> index 6130e6eb4af89135..0000000000000000
> --- a/Documentation/devicetree/bindings/crypto/arm-cryptocell.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -Arm TrustZone CryptoCell cryptographic engine
> -
> -Required properties:
> -- compatible: Should be one of -
> - "arm,cryptocell-713-ree"
> - "arm,cryptocell-703-ree"
> - "arm,cryptocell-712-ree"
> - "arm,cryptocell-710-ree"
> - "arm,cryptocell-630p-ree"
> -- reg: Base physical address of the engine and length of memory mapped region.
> -- interrupts: Interrupt number for the device.
> -
> -Optional properties:
> -- clocks: Reference to the crypto engine clock.
> -- dma-coherent: Present if dma operations are coherent.
> -
> -Examples:
> -
> - arm_cc712: crypto@80000000 {
> - compatible = "arm,cryptocell-712-ree";
> - interrupt-parent = <&intc>;
> - interrupts = < 0 30 4 >;
> - reg = < 0x80000000 0x10000 >;
> -
> - };
> --
> 2.25.1
>
--
Gilad Ben-Yossef
Chief Coffee Drinker
values of β will give rise to dom!