Merge tag 'mips_4.16_2' of git://git.kernel.org/pub/scm/linux/kernel/git/jhogan/mips
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / dma / snps-dma.txt
1 * Synopsys Designware DMA Controller
2
3 Required properties:
4 - compatible: "snps,dma-spear1340"
5 - reg: Address range of the DMAC registers
6 - interrupt: Should contain the DMAC interrupt number
7 - dma-channels: Number of channels supported by hardware
8 - dma-requests: Number of DMA request lines supported, up to 16
9 - dma-masters: Number of AHB masters supported by the controller
10 - #dma-cells: must be <3>
11 - chan_allocation_order: order of allocation of channel, 0 (default): ascending,
12   1: descending
13 - chan_priority: priority of channels. 0 (default): increase from chan 0->n, 1:
14   increase from chan n->0
15 - block_size: Maximum block size supported by the controller
16 - data-width: Maximum data width supported by hardware per AHB master
17   (in bytes, power of 2)
18
19
20 Deprecated properties:
21 - data_width: Maximum data width supported by hardware per AHB master
22   (0 - 8bits, 1 - 16bits, ..., 5 - 256bits)
23
24
25 Optional properties:
26 - interrupt-parent: Should be the phandle for the interrupt controller
27   that services interrupts for this device
28 - is_private: The device channels should be marked as private and not for by the
29   general purpose DMA channel allocator. False if not passed.
30 - multi-block: Multi block transfers supported by hardware. Array property with
31   one cell per channel. 0: not supported, 1 (default): supported.
32
33 Example:
34
35         dmahost: dma@fc000000 {
36                 compatible = "snps,dma-spear1340";
37                 reg = <0xfc000000 0x1000>;
38                 interrupt-parent = <&vic1>;
39                 interrupts = <12>;
40
41                 dma-channels = <8>;
42                 dma-requests = <16>;
43                 dma-masters = <2>;
44                 #dma-cells = <3>;
45                 chan_allocation_order = <1>;
46                 chan_priority = <1>;
47                 block_size = <0xfff>;
48                 data-width = <8 8>;
49         };
50
51 DMA clients connected to the Designware DMA controller must use the format
52 described in the dma.txt file, using a four-cell specifier for each channel.
53 The four cells in order are:
54
55 1. A phandle pointing to the DMA controller
56 2. The DMA request line number
57 3. Memory master for transfers on allocated channel
58 4. Peripheral master for transfers on allocated channel
59
60 Example:
61         
62         serial@e0000000 {
63                 compatible = "arm,pl011", "arm,primecell";
64                 reg = <0xe0000000 0x1000>;
65                 interrupts = <0 35 0x4>;
66                 dmas = <&dmahost 12 0 1>,
67                         <&dmahost 13 1 0>;
68                 dma-names = "rx", "rx";
69         };