Merge tag 'dmaengine-5.13-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/vkoul...
[platform/kernel/linux-rpi.git] / Documentation / devicetree / bindings / dma / qcom,gpi.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/dma/qcom,gpi.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Qualcomm Technologies Inc GPI DMA controller
8
9 maintainers:
10   - Vinod Koul <vkoul@kernel.org>
11
12 description: |
13   QCOM GPI DMA controller provides DMA capabilities for
14   peripheral buses such as I2C, UART, and SPI.
15
16 allOf:
17   - $ref: "dma-controller.yaml#"
18
19 properties:
20   compatible:
21     enum:
22       - qcom,sdm845-gpi-dma
23       - qcom,sm8150-gpi-dma
24
25   reg:
26     maxItems: 1
27
28   interrupts:
29     description:
30       Interrupt lines for each GPI instance
31     maxItems: 13
32
33   "#dma-cells":
34     const: 3
35     description: >
36       DMA clients must use the format described in dma.txt, giving a phandle
37       to the DMA controller plus the following 3 integer cells:
38       - channel: if set to 0xffffffff, any available channel will be allocated
39         for the client. Otherwise, the exact channel specified will be used.
40       - seid: serial id of the client as defined in the SoC documentation.
41       - client: type of the client as defined in dt-bindings/dma/qcom-gpi.h
42
43   iommus:
44     maxItems: 1
45
46   dma-channels:
47     maximum: 31
48
49   dma-channel-mask:
50     maxItems: 1
51
52 required:
53   - compatible
54   - reg
55   - interrupts
56   - "#dma-cells"
57   - iommus
58   - dma-channels
59   - dma-channel-mask
60
61 additionalProperties: false
62
63 examples:
64   - |
65     #include <dt-bindings/interrupt-controller/arm-gic.h>
66     #include <dt-bindings/dma/qcom-gpi.h>
67     gpi_dma0: dma-controller@800000 {
68         compatible = "qcom,sdm845-gpi-dma";
69         #dma-cells = <3>;
70         reg = <0x00800000 0x60000>;
71         iommus = <&apps_smmu 0x0016 0x0>;
72         dma-channels = <13>;
73         dma-channel-mask = <0xfa>;
74         interrupts = <GIC_SPI 244 IRQ_TYPE_LEVEL_HIGH>,
75                      <GIC_SPI 245 IRQ_TYPE_LEVEL_HIGH>,
76                      <GIC_SPI 246 IRQ_TYPE_LEVEL_HIGH>,
77                      <GIC_SPI 247 IRQ_TYPE_LEVEL_HIGH>,
78                      <GIC_SPI 248 IRQ_TYPE_LEVEL_HIGH>,
79                      <GIC_SPI 249 IRQ_TYPE_LEVEL_HIGH>,
80                      <GIC_SPI 250 IRQ_TYPE_LEVEL_HIGH>,
81                      <GIC_SPI 251 IRQ_TYPE_LEVEL_HIGH>,
82                      <GIC_SPI 252 IRQ_TYPE_LEVEL_HIGH>,
83                      <GIC_SPI 253 IRQ_TYPE_LEVEL_HIGH>,
84                      <GIC_SPI 254 IRQ_TYPE_LEVEL_HIGH>,
85                      <GIC_SPI 255 IRQ_TYPE_LEVEL_HIGH>,
86                      <GIC_SPI 256 IRQ_TYPE_LEVEL_HIGH>;
87     };
88
89 ...