treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / dma / jz4780-dma.txt
blob3459e77be294df8f15355e59869cf28132641d28
1 * Ingenic XBurst DMA Controller
3 Required properties:
5 - compatible: Should be one of:
6   * ingenic,jz4740-dma
7   * ingenic,jz4725b-dma
8   * ingenic,jz4770-dma
9   * ingenic,jz4780-dma
10   * ingenic,x1000-dma
11   * ingenic,x1830-dma
12 - reg: Should contain the DMA channel registers location and length, followed
13   by the DMA controller registers location and length.
14 - interrupts: Should contain the interrupt specifier of the DMA controller.
15 - clocks: Should contain a clock specifier for the JZ4780/X1000/X1830 PDMA
16   clock.
17 - #dma-cells: Must be <2>. Number of integer cells in the dmas property of
18   DMA clients (see below).
20 Optional properties:
22 - ingenic,reserved-channels: Bitmask of channels to reserve for devices that
23   need a specific channel. These channels will only be assigned when explicitly
24   requested by a client. The primary use for this is channels 0 and 1, which
25   can be configured to have special behaviour for NAND/BCH when using
26   programmable firmware.
28 Example:
30 dma: dma-controller@13420000 {
31         compatible = "ingenic,jz4780-dma";
32         reg = <0x13420000 0x400
33                0x13421000 0x40>;
35         interrupt-parent = <&intc>;
36         interrupts = <10>;
38         clocks = <&cgu JZ4780_CLK_PDMA>;
40         #dma-cells = <2>;
42         ingenic,reserved-channels = <0x3>;
45 DMA clients must use the format described in dma.txt, giving a phandle to the
46 DMA controller plus the following 2 integer cells:
48 1. Request type: The DMA request type for transfers to/from the device on
49    the allocated channel, as defined in the SoC documentation.
51 2. Channel: If set to 0xffffffff, any available channel will be allocated for
52    the client. Otherwise, the exact channel specified will be used. The channel
53    should be reserved on the DMA controller using the ingenic,reserved-channels
54    property.
56 Example:
58 uart0: serial@10030000 {
59         ...
60         dmas = <&dma 0x14 0xffffffff
61                 &dma 0x15 0xffffffff>;
62         dma-names = "tx", "rx";
63         ...