dt-bindings: crypto: ccree: Convert to json-schema

Commit Message

Geert Uytterhoeven June 11, 2021, 12:20 p.m. UTC

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 <[e-mail]>
---
 .../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

Comments

Gilad Ben-Yossef June 14, 2021, 8:12 a.m. UTC | #1

Hi Geert,

Thank you for taking the initiative to do this.

On Fri, Jun 11, 2021 at 3:20 PM Geert Uytterhoeven
<[e-mail]> 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 <[e-mail]>
> ---
>  .../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..9c97874a6dbd1db9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
> @@ -0,0 +1,53 @@

I am fine with the change as a whole except this line:

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

Please keep it as as the rest of the ccree driver:
# SPDX-License-Identifier: GPL-2.0

This is not because I care about the difference so much but because
otherwise I need to authorize the change with my employer legal
department.

Thanks,
Gilad

Rob Herring June 24, 2021, 9:13 p.m. UTC | #2

On Fri, 11 Jun 2021 14:20:17 +0200, Geert Uytterhoeven 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 <[e-mail]>
> ---
>  .../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
> 

I'm applying this version which is dual licensed as that is the 
preference of my employeer, Arm, who is the copyright holder here. I'll 
sort this out internally with Gilad.

Besides, for the bulk of the new file Geert is the copyright holder.

Rob

Gilad Ben-Yossef June 25, 2021, 9:05 a.m. UTC | #3

Hi,

On Fri, Jun 25, 2021 at 12:13 AM Rob Herring <[e-mail]> wrote:
>
> On Fri, 11 Jun 2021 14:20:17 +0200, Geert Uytterhoeven 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 <[e-mail]>
> > ---
> >  .../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
> >
>
> I'm applying this version which is dual licensed as that is the
> preference of my employeer, Arm, who is the copyright holder here. I'll
> sort this out internally with Gilad.

If it's fine with you, Rob, it's fine with me.

I'll sort out the procedure internally. Sorry for the previous noise.

For what it's worth:

Acked-by: Gilad Ben-Yossef <[e-mail]>

Gilad

Patch

diff --git a/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
new file mode 100644
index 0000000000000000..9c97874a6dbd1db9
--- /dev/null
+++ b/Documentation/devicetree/bindings/crypto/arm,cryptocell.yaml
@@ -0,0 +1,53 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%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 <[e-mail]>
+
+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 >;
-
-       };