GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / dma / qcom_bam_dma.txt
1 QCOM BAM DMA controller
2
3 Required properties:
4 - compatible: must be one of the following:
5  * "qcom,bam-v1.4.0" for MSM8974, APQ8074 and APQ8084
6  * "qcom,bam-v1.3.0" for APQ8064, IPQ8064 and MSM8960
7  * "qcom,bam-v1.7.0" for MSM8916
8 - reg: Address range for DMA registers
9 - interrupts: Should contain the one interrupt shared by all channels
10 - #dma-cells: must be <1>, the cell in the dmas property of the client device
11   represents the channel number
12 - clocks: required clock
13 - clock-names: must contain "bam_clk" entry
14 - qcom,ee : indicates the active Execution Environment identifier (0-7) used in
15   the secure world.
16 - qcom,controlled-remotely : optional, indicates that the bam is controlled by
17   remote proccessor i.e. execution environment.
18 - num-channels : optional, indicates supported number of DMA channels in a
19   remotely controlled bam.
20 - qcom,num-ees : optional, indicates supported number of Execution Environments
21   in a remotely controlled bam.
22
23 Example:
24
25         uart-bam: dma@f9984000 = {
26                 compatible = "qcom,bam-v1.4.0";
27                 reg = <0xf9984000 0x15000>;
28                 interrupts = <0 94 0>;
29                 clocks = <&gcc GCC_BAM_DMA_AHB_CLK>;
30                 clock-names = "bam_clk";
31                 #dma-cells = <1>;
32                 qcom,ee = <0>;
33         };
34
35 DMA clients must use the format described in the dma.txt file, using a two cell
36 specifier for each channel.
37
38 Example:
39         serial@f991e000 {
40                 compatible = "qcom,msm-uart";
41                 reg = <0xf991e000 0x1000>
42                         <0xf9944000 0x19000>;
43                 interrupts = <0 108 0>;
44                 clocks = <&gcc GCC_BLSP1_UART2_APPS_CLK>,
45                         <&gcc GCC_BLSP1_AHB_CLK>;
46                 clock-names = "core", "iface";
47
48                 dmas = <&uart-bam 0>, <&uart-bam 1>;
49                 dma-names = "rx", "tx";
50         };