xref: /openbmc/linux/Documentation/devicetree/bindings/dma/dma-common.yaml (revision b37e3534ac4275c1f0d0e08d1b6f672f6cc740c3)
1*b37e3534SMaxime Ripard# SPDX-License-Identifier: GPL-2.0
2*b37e3534SMaxime Ripard%YAML 1.2
3*b37e3534SMaxime Ripard---
4*b37e3534SMaxime Ripard$id: http://devicetree.org/schemas/dma/dma-common.yaml#
5*b37e3534SMaxime Ripard$schema: http://devicetree.org/meta-schemas/core.yaml#
6*b37e3534SMaxime Ripard
7*b37e3534SMaxime Ripardtitle: DMA Engine Generic Binding
8*b37e3534SMaxime Ripard
9*b37e3534SMaxime Ripardmaintainers:
10*b37e3534SMaxime Ripard  - Vinod Koul <vkoul@kernel.org>
11*b37e3534SMaxime Ripard
12*b37e3534SMaxime Riparddescription:
13*b37e3534SMaxime Ripard  Generic binding to provide a way for a driver using DMA Engine to
14*b37e3534SMaxime Ripard  retrieve the DMA request or channel information that goes from a
15*b37e3534SMaxime Ripard  hardware device to a DMA controller.
16*b37e3534SMaxime Ripard
17*b37e3534SMaxime Ripardselect: false
18*b37e3534SMaxime Ripard
19*b37e3534SMaxime Ripardproperties:
20*b37e3534SMaxime Ripard  "#dma-cells":
21*b37e3534SMaxime Ripard    minimum: 1
22*b37e3534SMaxime Ripard    # Should be enough
23*b37e3534SMaxime Ripard    maximum: 255
24*b37e3534SMaxime Ripard    description:
25*b37e3534SMaxime Ripard      Used to provide DMA controller specific information.
26*b37e3534SMaxime Ripard
27*b37e3534SMaxime Ripard  dma-channel-masks:
28*b37e3534SMaxime Ripard    $ref: /schemas/types.yaml#definitions/uint32
29*b37e3534SMaxime Ripard    description:
30*b37e3534SMaxime Ripard      Bitmask of available DMA channels in ascending order that are
31*b37e3534SMaxime Ripard      not reserved by firmware and are available to the
32*b37e3534SMaxime Ripard      kernel. i.e. first channel corresponds to LSB.
33*b37e3534SMaxime Ripard
34*b37e3534SMaxime Ripard  dma-channels:
35*b37e3534SMaxime Ripard    $ref: /schemas/types.yaml#definitions/uint32
36*b37e3534SMaxime Ripard    description:
37*b37e3534SMaxime Ripard      Number of DMA channels supported by the controller.
38*b37e3534SMaxime Ripard
39*b37e3534SMaxime Ripard  dma-requests:
40*b37e3534SMaxime Ripard    $ref: /schemas/types.yaml#definitions/uint32
41*b37e3534SMaxime Ripard    description:
42*b37e3534SMaxime Ripard      Number of DMA request signals supported by the controller.
43*b37e3534SMaxime Ripard
44*b37e3534SMaxime Ripardrequired:
45*b37e3534SMaxime Ripard  - "#dma-cells"
46