[PATCH RFC 1/3] dt-bindings: crypto: Add binding for TI DTHE V2 driver

T Pratham posted 3 patches 10 months, 1 week ago
There is a newer version of this series
[PATCH RFC 1/3] dt-bindings: crypto: Add binding for TI DTHE V2 driver
Posted by T Pratham 10 months, 1 week ago
Add new DT binding for Texas Instruments DTHE V2 crypto driver.

DTHE V2 is introduced as a part of TI AM62L SoC and can currently be
only found in it.

Signed-off-by: T Pratham <t-pratham@ti.com>
---
PS: Please note that the dmas option in dt-bindings is subject to change in
future as dma driver is not finalized yet. Any updated changes will be
sent in the next version of the patch.

 .../devicetree/bindings/crypto/ti,dthev2.yaml      | 50 ++++++++++++++++++++++
 MAINTAINERS                                        |  6 +++
 2 files changed, 56 insertions(+)

diff --git a/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml b/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..9c871fe191ae0a3341d047d4565ec1e1bf1f21ef
--- /dev/null
+++ b/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml
@@ -0,0 +1,50 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/crypto/ti,dthev2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: K3 SoC DTHE V2 crypto module
+
+maintainers:
+  - T Pratham <t-pratham@ti.com>
+
+properties:
+  compatible:
+    enum:
+      - ti,dthe-v2
+
+  reg:
+    maxItems: 1
+
+  dmas:
+    items:
+      - description: 'AES Engine RX DMA Channel'
+      - description: 'AES Engine TX DMA Channel'
+      - description: 'SHA Engine TX DMA Channel'
+
+  dma-names:
+    items:
+      - const: rx
+      - const: tx1
+      - const: tx2
+
+
+required:
+  - compatible
+  - reg
+  - dmas
+  - dma-names
+
+additionalProperties: false
+
+examples:
+  - |
+
+    crypto: crypto@40800000 {
+		compatible = "ti,dthe-v2";
+		reg = <0x00 0x40800000 0x00 0x10000>;
+
+		dmas = <&main_bcdma 0 0xc701 0>, <&main_bcdma 0 0x4700 0>, <&main_bcdma 0 0xc700 0>;
+		dma-names = "tx", "rx", "tx2";
+	};
diff --git a/MAINTAINERS b/MAINTAINERS
index 0d65aa9093f63ed8f09bee3d6f31fe6d8e0d16b6..e3a32533cf3922d799439b14453248d23350bb18 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -23433,6 +23433,12 @@ S:	Odd Fixes
 F:	drivers/clk/ti/
 F:	include/linux/clk/ti.h
 
+TI DATA TRANSFORM AND HASHING ENGINE (DTHE) V2 CRYPTO ACCELERATOR DRIVER
+M:	T Pratham <t-pratham@ti.com>
+L:	linux-crypto@vger.kernel.org
+S:	Supported
+F:	Documentation/devicetree/bindings/crypto/ti,dthe-v2.yaml
+
 TI DAVINCI MACHINE SUPPORT
 M:	Bartosz Golaszewski <brgl@bgdev.pl>
 L:	linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)

-- 
2.34.1
Re: [PATCH RFC 1/3] dt-bindings: crypto: Add binding for TI DTHE V2 driver
Posted by Krzysztof Kozlowski 10 months, 1 week ago
On Thu, Feb 06, 2025 at 02:44:30PM +0530, T Pratham wrote:
> Add new DT binding for Texas Instruments DTHE V2 crypto driver.

This was never tested so only limited review.

Subject and commit msg: Bindings are for hardware, not driver. Rephrase
to accurately describe the hardware.


> 
> DTHE V2 is introduced as a part of TI AM62L SoC and can currently be
> only found in it.
> 
> Signed-off-by: T Pratham <t-pratham@ti.com>
> ---
> PS: Please note that the dmas option in dt-bindings is subject to change in
> future as dma driver is not finalized yet. Any updated changes will be
> sent in the next version of the patch.
> 
>  .../devicetree/bindings/crypto/ti,dthev2.yaml      | 50 ++++++++++++++++++++++
>  MAINTAINERS                                        |  6 +++
>  2 files changed, 56 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml b/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..9c871fe191ae0a3341d047d4565ec1e1bf1f21ef
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml

Filename matching compatible.

> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/ti,dthev2.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: K3 SoC DTHE V2 crypto module
> +
> +maintainers:
> +  - T Pratham <t-pratham@ti.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ti,dthe-v2

NAK, SoC-based compatible instead.


> +
> +  reg:
> +    maxItems: 1
> +
> +  dmas:
> +    items:
> +      - description: 'AES Engine RX DMA Channel'
> +      - description: 'AES Engine TX DMA Channel'
> +      - description: 'SHA Engine TX DMA Channel'
> +
> +  dma-names:
> +    items:
> +      - const: rx
> +      - const: tx1
> +      - const: tx2
> +
> +

Drop stray blank line

> +required:
> +  - compatible
> +  - reg
> +  - dmas
> +  - dma-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +

Drop stray blank line

> +    crypto: crypto@40800000 {

Drop label

> +		compatible = "ti,dthe-v2";
> +		reg = <0x00 0x40800000 0x00 0x10000>;
> +
> +		dmas = <&main_bcdma 0 0xc701 0>, <&main_bcdma 0 0x4700 0>, <&main_bcdma 0 0xc700 0>;

Wrap according to coding style.

Best regards,
Krzysztof
Re: [PATCH RFC 1/3] dt-bindings: crypto: Add binding for TI DTHE V2 driver
Posted by Rob Herring (Arm) 10 months, 1 week ago
On Thu, 06 Feb 2025 14:44:30 +0530, T Pratham wrote:
> Add new DT binding for Texas Instruments DTHE V2 crypto driver.
> 
> DTHE V2 is introduced as a part of TI AM62L SoC and can currently be
> only found in it.
> 
> Signed-off-by: T Pratham <t-pratham@ti.com>
> ---
> PS: Please note that the dmas option in dt-bindings is subject to change in
> future as dma driver is not finalized yet. Any updated changes will be
> sent in the next version of the patch.
> 
>  .../devicetree/bindings/crypto/ti,dthev2.yaml      | 50 ++++++++++++++++++++++
>  MAINTAINERS                                        |  6 +++
>  2 files changed, 56 insertions(+)
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:
./Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:22:22: [error] string value is redundantly quoted with any quotes (quoted-strings)
./Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:23:22: [error] string value is redundantly quoted with any quotes (quoted-strings)
./Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:24:22: [error] string value is redundantly quoted with any quotes (quoted-strings)
./Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:45:1: [error] syntax error: found character '\t' that cannot start any token (syntax)

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/crypto/ti,dthev2.yaml: ignoring, error parsing file
./Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:45:1: found character '\t' that cannot start any token
make[2]: *** Deleting file 'Documentation/devicetree/bindings/crypto/ti,dthev2.example.dts'
Documentation/devicetree/bindings/crypto/ti,dthev2.yaml:45:1: found character '\t' that cannot start any token
make[2]: *** [Documentation/devicetree/bindings/Makefile:26: Documentation/devicetree/bindings/crypto/ti,dthev2.example.dts] Error 1
make[2]: *** Waiting for unfinished jobs....
make[1]: *** [/builds/robherring/dt-review-ci/linux/Makefile:1511: dt_binding_check] Error 2
make: *** [Makefile:251: __sub-make] Error 2

doc reference errors (make refcheckdocs):
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/crypto/ti,dthe-v2.yaml
MAINTAINERS: Documentation/devicetree/bindings/crypto/ti,dthe-v2.yaml

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250206-dthe-v2-aes-v1-1-1e86cf683928@ti.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.