Commit 4f46cc1b authored by Kuldeep Singh's avatar Kuldeep Singh Committed by Rob Herring
Browse files

dt-bindings: dma: Convert Qualcomm BAM DMA binding to json format



Convert Qualcomm BAM DMA controller binding to DT schema format using
json schema.

Signed-off-by: default avatarKuldeep Singh <singh.kuldeep87k@gmail.com>
[robh: add back SoC mapping to compatible strings]
Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220417210436.6203-7-singh.kuldeep87k@gmail.com
parent c7c7ce58
Loading
Loading
Loading
Loading
+100 −0
Original line number Diff line number Diff line
# 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: Qualcomm Technologies Inc BAM DMA controller

maintainers:
  - Andy Gross <agross@kernel.org>
  - Bjorn Andersson <bjorn.andersson@linaro.org>

allOf:
  - $ref: "dma-controller.yaml#"

properties:
  compatible:
    enum:
        # APQ8064, IPQ8064 and MSM8960
      - qcom,bam-v1.3.0
        # MSM8974, APQ8074 and APQ8084
      - qcom,bam-v1.4.0
        # MSM8916
      - qcom,bam-v1.7.0

  clocks:
    maxItems: 1

  clock-names:
    items:
      - const: bam_clk

  "#dma-cells":
    const: 1

  interrupts:
    maxItems: 1

  iommus:
    minItems: 1
    maxItems: 4

  num-channels:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Indicates supported number of DMA channels in a remotely controlled bam.

  qcom,controlled-remotely:
    type: boolean
    description:
      Indicates that the bam is controlled by remote proccessor i.e. execution
      environment.

  qcom,ee:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 7
    description:
      Indicates the active Execution Environment identifier (0-7) used in the
      secure world.

  qcom,num-ees:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Indicates supported number of Execution Environments in a remotely
      controlled bam.

  qcom,powered-remotely:
    type: boolean
    description:
      Indicates that the bam is powered up by a remote processor but must be
      initialized by the local processor.

  reg:
    maxItems: 1

required:
  - compatible
  - "#dma-cells"
  - interrupts
  - qcom,ee
  - reg

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/clock/qcom,gcc-msm8974.h>

    dma-controller@f9944000 {
        compatible = "qcom,bam-v1.4.0";
        reg = <0xf9944000 0x15000>;
        interrupts = <GIC_SPI 94 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&gcc GCC_BLSP2_AHB_CLK>;
        clock-names = "bam_clk";
        #dma-cells = <1>;
        qcom,ee = <0>;
    };
...
+0 −52
Original line number Diff line number Diff line
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.
- qcom,powered-remotely : optional, indicates that the bam is powered up by
  a remote processor but must be initialized by the local processor.
- 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";
	};