Input: add document for rockchip keys
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / dma / arm-pl330.txt
1 * ARM PrimeCell PL330 DMA Controller
2
3 The ARM PrimeCell PL330 DMA controller can move blocks of memory contents
4 between memory and peripherals or memory to memory.
5
6 Required properties:
7   - compatible: should include both "arm,pl330" and "arm,primecell".
8   - reg: physical base address of the controller and length of memory mapped
9     region.
10   - interrupts: interrupt number to the cpu.
11
12 Optional properties:
13   - dma-coherent      : Present if dma operations are coherent
14   - #dma-cells: must be <1>. used to represent the number of integer
15     cells in the dmas property of client device.
16   - dma-channels: contains the total number of DMA channels supported by the DMAC
17   - dma-requests: contains the total number of DMA requests supported by the DMAC
18   - arm,pl330-broken-no-flushp: quirk for avoiding to execute DMAFLUSHP
19   - peripherals-req-type-burst: set peripheral dma request type as burst mode
20
21 Example:
22
23         pdma0: pdma@12680000 {
24                 compatible = "arm,pl330", "arm,primecell";
25                 reg = <0x12680000 0x1000>;
26                 interrupts = <99>;
27                 #dma-cells = <1>;
28                 #dma-channels = <8>;
29                 #dma-requests = <32>;
30         };
31
32 Client drivers (device nodes requiring dma transfers from dev-to-mem or
33 mem-to-dev) should specify the DMA channel numbers and dma channel names
34 as shown below.
35
36   [property name]  = <[phandle of the dma controller] [dma request id]>;
37   [property name]  = <[dma channel name]>
38
39       where 'dma request id' is the dma request number which is connected
40       to the client controller. The 'property name' 'dmas' and 'dma-names'
41       as required by the generic dma device tree binding helpers. The dma
42       names correspond 1:1 with the dma request ids in the dmas property.
43
44   Example:  dmas = <&pdma0 12
45                     &pdma1 11>;
46             dma-names = "tx", "rx";