xref: /src/sys/contrib/device-tree/Bindings/dma/renesas,nbpfaxi.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1081ea6e2SWarner Losh* Renesas "Type-AXI" NBPFAXI* DMA controllers
2081ea6e2SWarner Losh
3081ea6e2SWarner Losh* DMA controller
4081ea6e2SWarner Losh
5081ea6e2SWarner LoshRequired properties
6081ea6e2SWarner Losh
7081ea6e2SWarner Losh- compatible:	must be one of
8081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac1b4"
9081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac1b8"
10081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac1b16"
11081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac4b4"
12081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac4b8"
13081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac4b16"
14081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac8b4"
15081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac8b8"
16081ea6e2SWarner Losh		"renesas,nbpfaxi64dmac8b16"
17081ea6e2SWarner Losh- #dma-cells:	must be 2: the first integer is a terminal number, to which this
18081ea6e2SWarner Losh		slave is connected, the second one is flags. Flags is a bitmask
19081ea6e2SWarner Losh		with the following bits defined:
20081ea6e2SWarner Losh
21081ea6e2SWarner Losh#define NBPF_SLAVE_RQ_HIGH	1
22081ea6e2SWarner Losh#define NBPF_SLAVE_RQ_LOW	2
23081ea6e2SWarner Losh#define NBPF_SLAVE_RQ_LEVEL	4
24081ea6e2SWarner Losh
25081ea6e2SWarner LoshOptional properties:
26ff018dbfSEmmanuel Vadot- max-burst-mem-read:	limit burst size for memory reads
27ff018dbfSEmmanuel Vadot  (DMA_MEM_TO_MEM/DMA_MEM_TO_DEV) to this value, specified in bytes, rather
28ff018dbfSEmmanuel Vadot  than using the maximum burst size allowed by the hardware's buffer size.
29ff018dbfSEmmanuel Vadot- max-burst-mem-write:	limit burst size for memory writes
30ff018dbfSEmmanuel Vadot  (DMA_DEV_TO_MEM/DMA_MEM_TO_MEM) to this value, specified in bytes, rather
31ff018dbfSEmmanuel Vadot  than using the maximum burst size allowed by the hardware's buffer size.
32ff018dbfSEmmanuel Vadot  If both max-burst-mem-read and max-burst-mem-write are set, DMA_MEM_TO_MEM
33ff018dbfSEmmanuel Vadot  will use the lower value.
34081ea6e2SWarner Losh
35081ea6e2SWarner LoshYou can use dma-channels and dma-requests as described in dma.txt, although they
36081ea6e2SWarner Loshwon't be used, this information is derived from the compatibility string.
37081ea6e2SWarner Losh
38081ea6e2SWarner LoshExample:
39081ea6e2SWarner Losh
40081ea6e2SWarner Losh	dma: dma-controller@48000000 {
41081ea6e2SWarner Losh		compatible = "renesas,nbpfaxi64dmac8b4";
42081ea6e2SWarner Losh		reg = <0x48000000 0x400>;
43081ea6e2SWarner Losh		interrupts = <0 12 0x4
44081ea6e2SWarner Losh			      0 13 0x4
45081ea6e2SWarner Losh			      0 14 0x4
46081ea6e2SWarner Losh			      0 15 0x4
47081ea6e2SWarner Losh			      0 16 0x4
48081ea6e2SWarner Losh			      0 17 0x4
49081ea6e2SWarner Losh			      0 18 0x4
50081ea6e2SWarner Losh			      0 19 0x4>;
51081ea6e2SWarner Losh		#dma-cells = <2>;
52081ea6e2SWarner Losh		dma-channels = <8>;
53081ea6e2SWarner Losh		dma-requests = <8>;
54081ea6e2SWarner Losh	};
55081ea6e2SWarner Losh
56081ea6e2SWarner Losh* DMA client
57081ea6e2SWarner Losh
58081ea6e2SWarner LoshRequired properties:
59081ea6e2SWarner Losh
60081ea6e2SWarner Loshdmas and dma-names are required, as described in dma.txt.
61081ea6e2SWarner Losh
62081ea6e2SWarner LoshExample:
63081ea6e2SWarner Losh
64081ea6e2SWarner Losh#include <dt-bindings/dma/nbpfaxi.h>
65081ea6e2SWarner Losh
66081ea6e2SWarner Losh...
67081ea6e2SWarner Losh		dmas = <&dma 0 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)
68081ea6e2SWarner Losh			&dma 1 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)>;
69081ea6e2SWarner Losh		dma-names = "rx", "tx";
70