diff mbox series

[RFC,2/6] dt-bindings: crypto: add binding for eip29t2 public key accelerator (PKA)

Message ID 856cbf3a002b5d400bbbdb7aa914ab5b8681a96e.1659985696.git.danielrparks@ti.com (mailing list archive)
State New, archived
Headers show
Series Add SA2UL Public Key Accelerator driver | expand

Commit Message

Daniel Parks Aug. 8, 2022, 7:12 p.m. UTC
The PKA is a mmio-only asymmetric crypto accelerator available on
certain K3 devices.

Signed-off-by: Daniel Parks <danielrparks@ti.com>
---
 .../inside-secure,safexcel-eip29t2.yaml       | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml

Comments

Krzysztof Kozlowski Aug. 9, 2022, 5:47 a.m. UTC | #1
On 08/08/2022 22:12, Daniel Parks wrote:
> The PKA is a mmio-only asymmetric crypto accelerator available on
> certain K3 devices.
> 
> Signed-off-by: Daniel Parks <danielrparks@ti.com>
> ---
>  .../inside-secure,safexcel-eip29t2.yaml       | 49 +++++++++++++++++++
>  1 file changed, 49 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml
> 
> diff --git a/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml b/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml
> new file mode 100644
> index 000000000000..b1e195a108cc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/inside-secure,safexcel-eip29t2.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: K3 SoC SA2UL PKA crypto module

If this is the child mentioned in patch #1, then this should be first
patch and your next one should reference it.

> +
> +maintainers:
> +  - Daniel Parks <danielrparks@ti.com>
> +
> +description: |
> +  Asymmetric crypto accelerator
> +
> +properties:
> +  compatible:
> +    const: inside-secure,safexcel-eip29t2
> +
> +  reg:
> +    items:
> +      - description: control registers
> +      - description: mapped memory
> +
> +  interrupts:
> +    items:
> +      - description: PKA interrupt

This could be "maxItems:1" because your description actually does not
bring anything new, but current choice is also OK.

Best regards,
Krzysztof
Rob Herring Aug. 9, 2022, 11:22 p.m. UTC | #2
On Mon, 08 Aug 2022 14:12:51 -0500, Daniel Parks wrote:
> The PKA is a mmio-only asymmetric crypto accelerator available on
> certain K3 devices.
> 
> Signed-off-by: Daniel Parks <danielrparks@ti.com>
> ---
>  .../inside-secure,safexcel-eip29t2.yaml       | 49 +++++++++++++++++++
>  1 file changed, 49 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.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/linux-dt-review/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.example.dtb: pka@40920000: reg: [[0, 1083310080], [0, 8192], [0, 1083326464], [0, 32768]] is too long
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

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.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml b/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml
new file mode 100644
index 000000000000..b1e195a108cc
--- /dev/null
+++ b/Documentation/devicetree/bindings/crypto/inside-secure,safexcel-eip29t2.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/crypto/inside-secure,safexcel-eip29t2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: K3 SoC SA2UL PKA crypto module
+
+maintainers:
+  - Daniel Parks <danielrparks@ti.com>
+
+description: |
+  Asymmetric crypto accelerator
+
+properties:
+  compatible:
+    const: inside-secure,safexcel-eip29t2
+
+  reg:
+    items:
+      - description: control registers
+      - description: mapped memory
+
+  interrupts:
+    items:
+      - description: PKA interrupt
+
+  clocks:
+    items:
+      - description: PKA in clock
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    pka: pka@40920000 {
+      compatible = "inside-secure,safexcel-eip29t2";
+      reg = <0x00 0x40920000 0x00 0x2000>,
+            <0x00 0x40924000 0x00 0x8000>;
+      interrupts = <GIC_SPI 167 IRQ_TYPE_LEVEL_HIGH>;
+      clocks = <&k3_clks 133 0>;
+    };