Re: [PATCH v5 07/22] dt-bindings: qcom-qce: Convert bindings to yaml

From: Bjorn Andersson
Date: Sat Nov 13 2021 - 14:41:14 EST


On Wed 10 Nov 04:59 CST 2021, Bhupesh Sharma wrote:

> Convert Qualcomm QCE crypto devicetree binding to YAML.
>
> Cc: Thara Gopinath <thara.gopinath@xxxxxxxxxx>
> Cc: Bjorn Andersson <bjorn.andersson@xxxxxxxxxx>
> Reviewed-by: Rob Herring <robh@xxxxxxxxxx>
> Signed-off-by: Bhupesh Sharma <bhupesh.sharma@xxxxxxxxxx>
> ---
> .../devicetree/bindings/crypto/qcom-qce.txt | 25 -------
> .../devicetree/bindings/crypto/qcom-qce.yaml | 67 +++++++++++++++++++
> 2 files changed, 67 insertions(+), 25 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/crypto/qcom-qce.txt
> create mode 100644 Documentation/devicetree/bindings/crypto/qcom-qce.yaml
>
> diff --git a/Documentation/devicetree/bindings/crypto/qcom-qce.txt b/Documentation/devicetree/bindings/crypto/qcom-qce.txt
> deleted file mode 100644
> index fdd53b184ba8..000000000000
> --- a/Documentation/devicetree/bindings/crypto/qcom-qce.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -Qualcomm crypto engine driver
> -
> -Required properties:
> -
> -- compatible : should be "qcom,crypto-v5.1"
> -- reg : specifies base physical address and size of the registers map
> -- clocks : phandle to clock-controller plus clock-specifier pair
> -- clock-names : "iface" clocks register interface
> - "bus" clocks data transfer interface
> - "core" clocks rest of the crypto block
> -- dmas : DMA specifiers for tx and rx dma channels. For more see
> - Documentation/devicetree/bindings/dma/dma.txt
> -- dma-names : DMA request names should be "rx" and "tx"
> -
> -Example:
> - crypto@fd45a000 {
> - compatible = "qcom,crypto-v5.1";
> - reg = <0xfd45a000 0x6000>;
> - clocks = <&gcc GCC_CE2_AHB_CLK>,
> - <&gcc GCC_CE2_AXI_CLK>,
> - <&gcc GCC_CE2_CLK>;
> - clock-names = "iface", "bus", "core";
> - dmas = <&cryptobam 2>, <&cryptobam 3>;
> - dma-names = "rx", "tx";
> - };
> diff --git a/Documentation/devicetree/bindings/crypto/qcom-qce.yaml b/Documentation/devicetree/bindings/crypto/qcom-qce.yaml
> new file mode 100644
> index 000000000000..3a839c159d92
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/qcom-qce.yaml
> @@ -0,0 +1,67 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/qcom-qce.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm crypto engine driver
> +
> +maintainers:
> + - Bhupesh Sharma <bhupesh.sharma@xxxxxxxxxx>
> +
> +description: |

Nit. The '|' retains the formatting of the description, there's no need
for that.

Reviewed-by: Bjorn Andersson <bjorn.andersson@xxxxxxxxxx>

Regards,
Bjorn

> + This document defines the binding for the QCE crypto
> + controller found on Qualcomm parts.
> +
> +properties:
> + compatible:
> + const: qcom,crypto-v5.1
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + items:
> + - description: iface clocks register interface.
> + - description: bus clocks data transfer interface.
> + - description: core clocks rest of the crypto block.
> +
> + clock-names:
> + items:
> + - const: iface
> + - const: bus
> + - const: core
> +
> + dmas:
> + items:
> + - description: DMA specifiers for rx dma channel.
> + - description: DMA specifiers for tx dma channel.
> +
> + dma-names:
> + items:
> + - const: rx
> + - const: tx
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - dmas
> + - dma-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/qcom,gcc-apq8084.h>
> + crypto-engine@fd45a000 {
> + compatible = "qcom,crypto-v5.1";
> + reg = <0xfd45a000 0x6000>;
> + clocks = <&gcc GCC_CE2_AHB_CLK>,
> + <&gcc GCC_CE2_AXI_CLK>,
> + <&gcc GCC_CE2_CLK>;
> + clock-names = "iface", "bus", "core";
> + dmas = <&cryptobam 2>, <&cryptobam 3>;
> + dma-names = "rx", "tx";
> + };
> --
> 2.31.1
>