Documentation/devicetree/bindings/dma/xilinx/xlnx,axi-dma.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/dma/xilinx/xlnx,axi-dma.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/dma/xilinx/xlnx,axi-dma.yaml
Extension
.yaml
Size
8325 bytes
Lines
300
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/dma/xilinx/xlnx,axi-dma.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Xilinx AXI VDMA, DMA, CDMA and MCDMA IP

maintainers:
  - Radhey Shyam Pandey <radhey.shyam.pandey@amd.com>
  - Abin Joseph <abin.joseph@amd.com>

description: >
  Xilinx AXI VDMA engine, it does transfers between memory and video devices.
  It can be configured to have one channel or two channels. If configured
  as two channels, one is to transmit to the video device and another is
  to receive from the video device.

  Xilinx AXI DMA engine, it does transfers between memory and AXI4 stream
  target devices. It can be configured to have one channel or two channels.
  If configured as two channels, one is to transmit to the device and another
  is to receive from the device.

  Xilinx AXI CDMA engine, it does transfers between memory-mapped source
  address and a memory-mapped destination address.

  Xilinx AXI MCDMA engine, it does transfer between memory and AXI4 stream
  target devices. It can be configured to have up to 16 independent transmit
  and receive channels.

properties:
  compatible:
    enum:
      - xlnx,axi-cdma-1.00.a
      - xlnx,axi-dma-1.00.a
      - xlnx,axi-mcdma-1.00.a
      - xlnx,axi-vdma-1.00.a

  reg:
    maxItems: 1

  "#dma-cells":
    const: 1

  "#address-cells":
    const: 1

  "#size-cells":
    const: 1

  interrupts:
    items:
      - description: Interrupt for single channel (MM2S or S2MM)
      - description: Interrupt for dual channel configuration
    minItems: 1
    description:
      Interrupt lines for the DMA controller. Only used when
      xlnx,axistream-connected is present (DMA connected to AXI Stream
      IP). When child dma-channel nodes are present, interrupts are
      specified in the child nodes instead.

  clocks:
    minItems: 1
    maxItems: 5

  clock-names:
    minItems: 1
    maxItems: 5

  dma-ranges: true

Annotation

Implementation Notes