DMA: Freescale: revise device tree binding document
[linux-drm-fsl-dcu.git] / Documentation / devicetree / bindings / powerpc / fsl / dma.txt
1 * Freescale DMA Controllers
2
3 ** Freescale Elo DMA Controller
4    This is a little-endian 4-channel DMA controller, used in Freescale mpc83xx
5    series chips such as mpc8315, mpc8349, mpc8379 etc.
6
7 Required properties:
8
9 - compatible        : must include "fsl,elo-dma"
10 - reg               : DMA General Status Register, i.e. DGSR which contains
11                       status for all the 4 DMA channels
12 - ranges            : describes the mapping between the address space of the
13                       DMA channels and the address space of the DMA controller
14 - cell-index        : controller index.  0 for controller @ 0x8100
15 - interrupts        : interrupt specifier for DMA IRQ
16 - interrupt-parent  : optional, if needed for interrupt mapping
17
18 - DMA channel nodes:
19         - compatible        : must include "fsl,elo-dma-channel"
20                               However, see note below.
21         - reg               : DMA channel specific registers
22         - cell-index        : DMA channel index starts at 0.
23
24 Optional properties:
25         - interrupts        : interrupt specifier for DMA channel IRQ
26                               (on 83xx this is expected to be identical to
27                               the interrupts property of the parent node)
28         - interrupt-parent  : optional, if needed for interrupt mapping
29
30 Example:
31         dma@82a8 {
32                 #address-cells = <1>;
33                 #size-cells = <1>;
34                 compatible = "fsl,mpc8349-dma", "fsl,elo-dma";
35                 reg = <0x82a8 4>;
36                 ranges = <0 0x8100 0x1a4>;
37                 interrupt-parent = <&ipic>;
38                 interrupts = <71 8>;
39                 cell-index = <0>;
40                 dma-channel@0 {
41                         compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
42                         cell-index = <0>;
43                         reg = <0 0x80>;
44                         interrupt-parent = <&ipic>;
45                         interrupts = <71 8>;
46                 };
47                 dma-channel@80 {
48                         compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
49                         cell-index = <1>;
50                         reg = <0x80 0x80>;
51                         interrupt-parent = <&ipic>;
52                         interrupts = <71 8>;
53                 };
54                 dma-channel@100 {
55                         compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
56                         cell-index = <2>;
57                         reg = <0x100 0x80>;
58                         interrupt-parent = <&ipic>;
59                         interrupts = <71 8>;
60                 };
61                 dma-channel@180 {
62                         compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
63                         cell-index = <3>;
64                         reg = <0x180 0x80>;
65                         interrupt-parent = <&ipic>;
66                         interrupts = <71 8>;
67                 };
68         };
69
70 ** Freescale EloPlus DMA Controller
71    This is a 4-channel DMA controller with extended addresses and chaining,
72    mainly used in Freescale mpc85xx/86xx, Pxxx and BSC series chips, such as
73    mpc8540, mpc8641 p4080, bsc9131 etc.
74
75 Required properties:
76
77 - compatible        : must include "fsl,eloplus-dma"
78 - reg               : DMA General Status Register, i.e. DGSR which contains
79                       status for all the 4 DMA channels
80 - cell-index        : controller index.  0 for controller @ 0x21000,
81                                          1 for controller @ 0xc000
82 - ranges            : describes the mapping between the address space of the
83                       DMA channels and the address space of the DMA controller
84
85 - DMA channel nodes:
86         - compatible        : must include "fsl,eloplus-dma-channel"
87                               However, see note below.
88         - cell-index        : DMA channel index starts at 0.
89         - reg               : DMA channel specific registers
90         - interrupts        : interrupt specifier for DMA channel IRQ
91         - interrupt-parent  : optional, if needed for interrupt mapping
92
93 Example:
94         dma@21300 {
95                 #address-cells = <1>;
96                 #size-cells = <1>;
97                 compatible = "fsl,mpc8540-dma", "fsl,eloplus-dma";
98                 reg = <0x21300 4>;
99                 ranges = <0 0x21100 0x200>;
100                 cell-index = <0>;
101                 dma-channel@0 {
102                         compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
103                         reg = <0 0x80>;
104                         cell-index = <0>;
105                         interrupt-parent = <&mpic>;
106                         interrupts = <20 2>;
107                 };
108                 dma-channel@80 {
109                         compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
110                         reg = <0x80 0x80>;
111                         cell-index = <1>;
112                         interrupt-parent = <&mpic>;
113                         interrupts = <21 2>;
114                 };
115                 dma-channel@100 {
116                         compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
117                         reg = <0x100 0x80>;
118                         cell-index = <2>;
119                         interrupt-parent = <&mpic>;
120                         interrupts = <22 2>;
121                 };
122                 dma-channel@180 {
123                         compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
124                         reg = <0x180 0x80>;
125                         cell-index = <3>;
126                         interrupt-parent = <&mpic>;
127                         interrupts = <23 2>;
128                 };
129         };
130
131 Note on DMA channel compatible properties: The compatible property must say
132 "fsl,elo-dma-channel" or "fsl,eloplus-dma-channel" to be used by the Elo DMA
133 driver (fsldma).  Any DMA channel used by fsldma cannot be used by another
134 DMA driver, such as the SSI sound drivers for the MPC8610.  Therefore, any DMA
135 channel that should be used for another driver should not use
136 "fsl,elo-dma-channel" or "fsl,eloplus-dma-channel".  For the SSI drivers, for
137 example, the compatible property should be "fsl,ssi-dma-channel".  See ssi.txt
138 for more information.