GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / dma / qcom,bam-dma.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/dma/qcom,bam-dma.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Qualcomm Technologies Inc BAM DMA controller
8
9 maintainers:
10   - Andy Gross <agross@kernel.org>
11   - Bjorn Andersson <andersson@kernel.org>
12
13 allOf:
14   - $ref: "dma-controller.yaml#"
15
16 properties:
17   compatible:
18     enum:
19         # APQ8064, IPQ8064 and MSM8960
20       - qcom,bam-v1.3.0
21         # MSM8974, APQ8074 and APQ8084
22       - qcom,bam-v1.4.0
23         # MSM8916 and SDM845
24       - qcom,bam-v1.7.0
25
26   clocks:
27     maxItems: 1
28
29   clock-names:
30     items:
31       - const: bam_clk
32
33   "#dma-cells":
34     const: 1
35
36   interrupts:
37     maxItems: 1
38
39   iommus:
40     minItems: 1
41     maxItems: 4
42
43   num-channels:
44     $ref: /schemas/types.yaml#/definitions/uint32
45     description:
46       Indicates supported number of DMA channels in a remotely controlled bam.
47
48   qcom,controlled-remotely:
49     type: boolean
50     description:
51       Indicates that the bam is controlled by remote proccessor i.e. execution
52       environment.
53
54   qcom,ee:
55     $ref: /schemas/types.yaml#/definitions/uint32
56     minimum: 0
57     maximum: 7
58     description:
59       Indicates the active Execution Environment identifier (0-7) used in the
60       secure world.
61
62   qcom,num-ees:
63     $ref: /schemas/types.yaml#/definitions/uint32
64     description:
65       Indicates supported number of Execution Environments in a remotely
66       controlled bam.
67
68   qcom,powered-remotely:
69     type: boolean
70     description:
71       Indicates that the bam is powered up by a remote processor but must be
72       initialized by the local processor.
73
74   reg:
75     maxItems: 1
76
77 required:
78   - compatible
79   - "#dma-cells"
80   - interrupts
81   - qcom,ee
82   - reg
83
84 additionalProperties: false
85
86 examples:
87   - |
88     #include <dt-bindings/interrupt-controller/arm-gic.h>
89     #include <dt-bindings/clock/qcom,gcc-msm8974.h>
90
91     dma-controller@f9944000 {
92         compatible = "qcom,bam-v1.4.0";
93         reg = <0xf9944000 0x19000>;
94         interrupts = <GIC_SPI 239 IRQ_TYPE_LEVEL_HIGH>;
95         clocks = <&gcc GCC_BLSP2_AHB_CLK>;
96         clock-names = "bam_clk";
97         #dma-cells = <1>;
98         qcom,ee = <0>;
99     };
100 ...