linux-arm-msm.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Vladimir Zapolskiy <vladimir.zapolskiy@linaro.org>
To: Bhupesh Sharma <bhupesh.sharma@linaro.org>,
	linux-arm-msm@vger.kernel.org, linux-crypto@vger.kernel.org
Cc: bhupesh.linux@gmail.com, linux-kernel@vger.kernel.org,
	devicetree@vger.kernel.org, robh+dt@kernel.org,
	agross@kernel.org, herbert@gondor.apana.org.au,
	davem@davemloft.net, Thara Gopinath <thara.gopinath@linaro.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>
Subject: Re: [PATCH v4 04/20] dt-bindings: qcom-bam: Convert binding to YAML
Date: Wed, 13 Oct 2021 15:56:52 +0300	[thread overview]
Message-ID: <b41ba845-5f28-8405-0cd0-2342e4b6b372@linaro.org> (raw)
In-Reply-To: <20211013105541.68045-5-bhupesh.sharma@linaro.org>

Hi Bhupesh,

On 10/13/21 1:55 PM, Bhupesh Sharma wrote:
> Convert Qualcomm BAM DMA devicetree binding to YAML.
> 
> Cc: Thara Gopinath <thara.gopinath@linaro.org>
> Cc: Bjorn Andersson <bjorn.andersson@linaro.org>
> Cc: Rob Herring <robh+dt@kernel.org>
> Signed-off-by: Bhupesh Sharma <bhupesh.sharma@linaro.org>
> ---
>   .../devicetree/bindings/dma/qcom_bam_dma.txt  | 50 -----------
>   .../devicetree/bindings/dma/qcom_bam_dma.yaml | 89 +++++++++++++++++++
>   2 files changed, 89 insertions(+), 50 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/dma/qcom_bam_dma.txt
>   create mode 100644 Documentation/devicetree/bindings/dma/qcom_bam_dma.yaml
> 
> diff --git a/Documentation/devicetree/bindings/dma/qcom_bam_dma.txt b/Documentation/devicetree/bindings/dma/qcom_bam_dma.txt
> deleted file mode 100644
> index cf5b9e44432c..000000000000
> --- a/Documentation/devicetree/bindings/dma/qcom_bam_dma.txt
> +++ /dev/null
> @@ -1,50 +0,0 @@
> -QCOM BAM DMA controller
> -
> -Required properties:
> -- compatible: must be one of the following:
> - * "qcom,bam-v1.4.0" for MSM8974, APQ8074 and APQ8084
> - * "qcom,bam-v1.3.0" for APQ8064, IPQ8064 and MSM8960
> - * "qcom,bam-v1.7.0" for MSM8916
> -- reg: Address range for DMA registers
> -- interrupts: Should contain the one interrupt shared by all channels
> -- #dma-cells: must be <1>, the cell in the dmas property of the client device
> -  represents the channel number
> -- clocks: required clock
> -- clock-names: must contain "bam_clk" entry
> -- qcom,ee : indicates the active Execution Environment identifier (0-7) used in
> -  the secure world.
> -- qcom,controlled-remotely : optional, indicates that the bam is controlled by
> -  remote proccessor i.e. execution environment.
> -- num-channels : optional, indicates supported number of DMA channels in a
> -  remotely controlled bam.
> -- qcom,num-ees : optional, indicates supported number of Execution Environments
> -  in a remotely controlled bam.
> -
> -Example:
> -
> -	uart-bam: dma@f9984000 = {
> -		compatible = "qcom,bam-v1.4.0";
> -		reg = <0xf9984000 0x15000>;
> -		interrupts = <0 94 0>;
> -		clocks = <&gcc GCC_BAM_DMA_AHB_CLK>;
> -		clock-names = "bam_clk";
> -		#dma-cells = <1>;
> -		qcom,ee = <0>;
> -	};
> -
> -DMA clients must use the format described in the dma.txt file, using a two cell
> -specifier for each channel.
> -
> -Example:
> -	serial@f991e000 {
> -		compatible = "qcom,msm-uart";
> -		reg = <0xf991e000 0x1000>
> -			<0xf9944000 0x19000>;
> -		interrupts = <0 108 0>;
> -		clocks = <&gcc GCC_BLSP1_UART2_APPS_CLK>,
> -			<&gcc GCC_BLSP1_AHB_CLK>;
> -		clock-names = "core", "iface";
> -
> -		dmas = <&uart-bam 0>, <&uart-bam 1>;
> -		dma-names = "rx", "tx";
> -	};
> diff --git a/Documentation/devicetree/bindings/dma/qcom_bam_dma.yaml b/Documentation/devicetree/bindings/dma/qcom_bam_dma.yaml
> new file mode 100644
> index 000000000000..32b47e3b7769
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/qcom_bam_dma.yaml
> @@ -0,0 +1,89 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/qcom_bam_dma.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: QCOM BAM DMA controller binding
> +
> +maintainers:
> +  - Bhupesh Sharma <bhupesh.sharma@linaro.org>
> +
> +description: |
> +  This document defines the binding for the BAM DMA controller
> +  found on Qualcomm parts.
> +
> +allOf:
> +  - $ref: "dma-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    enum:
> +      - qcom,bam-v1.4.0 # for MSM8974, APQ8074 and APQ8084
> +      - qcom,bam-v1.3.0 # for APQ8064, IPQ8064 and MSM8960
> +      - qcom,bam-v1.7.0 # for MSM8916

would it be better to sort the list above by IP version?

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: bam_clk
> +
> +  interrupts:
> +    minItems: 1
> +    maxItems: 31
> +
> +  num-channels:
> +    maximum: 31
> +    description: |
> +      Indicates supported number of DMA channels in a remotely controlled bam.

A comment about YAML specifics, I'm not sure, if it makes sense to set a control
to enable literal style of the given multiline description, since it is a one-liner.

My main observation though is that all actually multi-line descriptions in the
schema are different and of the folded style ("pipe" symbol is not set).

Probably it's good enough just to remove the "pipe" above.

> +
> +  "#dma-cells":
> +    const: 1
> +    description: The single cell represents the channel index.
> +
> +  qcom,ee:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      Indicates the active Execution Environment identifier (0-7)
> +      used in the secure world.

Would it make sense to add here

   minimum: 0
   maximum: 7

?

> +
> +  qcom,controlled-remotely:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description:
> +      Indicates that the bam is controlled by remote proccessor i.e.
> +      execution environment.
> +
> +  qcom,num-ees:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 0
> +    maximum: 31
> +    default: 2
> +    description:
> +      Indicates supported number of Execution Environments in a
> +      remotely controlled bam.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - "#dma-cells"
> +  - qcom,ee
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/qcom,gcc-msm8974.h>
> +    dma-controller@f9984000 {
> +        compatible = "qcom,bam-v1.4.0";
> +        reg = <0xf9984000 0x15000>;
> +        interrupts = <0 94 0>;
> +        clocks = <&gcc GCC_BAM_DMA_AHB_CLK>;
> +        clock-names = "bam_clk";
> +        #dma-cells = <1>;
> +        qcom,ee = <0>;
> +    };
> 

--
Best wishes,
Vladimir

  reply	other threads:[~2021-10-13 12:57 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-13 10:55 [PATCH v4 00/20] Enable Qualcomm Crypto Engine on sm8250 Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 01/20] arm64/dts: qcom: Fix 'dma' & 'qcom,controlled-remotely' nodes in dts Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 02/20] arm64/dts: qcom: ipq6018: Remove unused 'qcom,config-pipe-trust-reg' property Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 03/20] arm64/dts: qcom: ipq6018: Remove unused 'iface_clk' property from dma-controller node Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 04/20] dt-bindings: qcom-bam: Convert binding to YAML Bhupesh Sharma
2021-10-13 12:56   ` Vladimir Zapolskiy [this message]
2021-10-13 17:13     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 05/20] dt-bindings: qcom-bam: Add 'interconnects' & 'interconnect-names' to optional properties Bhupesh Sharma
2021-10-13 13:03   ` Vladimir Zapolskiy
2021-10-13 17:14     ` Bhupesh Sharma
2021-10-13 18:39   ` Rob Herring
2021-10-14  7:03     ` Bhupesh Sharma
2021-10-24 13:55       ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 06/20] dt-bindings: qcom-bam: Add 'iommus' " Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 07/20] dt-bindings: qcom-qce: Convert bindings to yaml Bhupesh Sharma
2021-10-13 13:05   ` Vladimir Zapolskiy
2021-10-13 17:15     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 08/20] dt-bindings: qcom-qce: Add 'interconnects' and move 'clocks' to optional properties Bhupesh Sharma
2021-10-26 19:40   ` Rob Herring
2021-10-13 10:55 ` [PATCH v4 09/20] dt-bindings: qcom-qce: Add 'iommus' " Bhupesh Sharma
2021-10-26 19:40   ` Rob Herring
2021-10-13 10:55 ` [PATCH v4 10/20] arm64/dts: qcom: sdm845: Use RPMH_CE_CLK macro directly Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 11/20] dt-bindings: crypto : Add new compatible strings for qcom-qce Bhupesh Sharma
2021-10-18 18:26   ` Rob Herring
2021-10-13 10:55 ` [PATCH v4 12/20] arm64/dts: qcom: Use new compatibles for crypto nodes Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 13/20] dma: qcom: bam_dma: Add support to initialize interconnect path Bhupesh Sharma
2021-10-13 19:15   ` Vladimir Zapolskiy
2021-10-24 13:53     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 14/20] crypto: qce: core: " Bhupesh Sharma
2021-10-13 19:19   ` Vladimir Zapolskiy
2021-10-24 13:53     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 15/20] crypto: qce: Add new compatibles for qce crypto driver Bhupesh Sharma
2021-10-13 19:22   ` Vladimir Zapolskiy
2021-10-20 14:07   ` Thara Gopinath
2021-10-24 13:52     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 16/20] crypto: qce: core: Make clocks optional Bhupesh Sharma
2021-10-13 19:23   ` Vladimir Zapolskiy
2021-10-24 13:34     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 17/20] crypto: qce: Print a failure msg in case probe() fails Bhupesh Sharma
2021-10-13 19:26   ` Vladimir Zapolskiy
2021-10-24 13:33     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 18/20] crypto: qce: Defer probing if BAM dma channel is not yet initialized Bhupesh Sharma
2021-10-13 20:49   ` Vladimir Zapolskiy
2021-10-14  7:40     ` Bhupesh Sharma
2021-10-14  8:42       ` Vladimir Zapolskiy
2021-10-20 14:10   ` Thara Gopinath
2021-10-24 14:05     ` Bhupesh Sharma
2021-10-13 10:55 ` [PATCH v4 19/20] crypto: qce: Add 'sm8250-qce' compatible string check Bhupesh Sharma
2021-10-20 14:11   ` Thara Gopinath
2021-10-13 10:55 ` [PATCH v4 20/20] arm64/dts: qcom: sm8250: Add dt entries to support crypto engine Bhupesh Sharma
2021-10-20 14:03 ` [PATCH v4 00/20] Enable Qualcomm Crypto Engine on sm8250 Thara Gopinath
2021-10-24 13:58   ` Bhupesh Sharma

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b41ba845-5f28-8405-0cd0-2342e4b6b372@linaro.org \
    --to=vladimir.zapolskiy@linaro.org \
    --cc=agross@kernel.org \
    --cc=bhupesh.linux@gmail.com \
    --cc=bhupesh.sharma@linaro.org \
    --cc=bjorn.andersson@linaro.org \
    --cc=davem@davemloft.net \
    --cc=devicetree@vger.kernel.org \
    --cc=herbert@gondor.apana.org.au \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    --cc=thara.gopinath@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).