xlnx,axi-dma-1.00.a

Vendor: Xilinx

Note

An implementation of a driver matching this compatible is available in drivers/dma/dma_xilinx_axi_dma.c.

Description

These nodes are “dma” bus nodes.

Xilinx AXI DMA LogiCORE IP controller with compatibility string
generated for use of the DMA outside of the AXI Ethernet subsystem.

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

clock-frequency

int

xlnx,addrwidth

int

 
DMA address width (64 or 32 bit)

This property is required.

Legal values: 32, 64

axistream-connected

phandle

 
Handle to connected node, e.g., AXI Ethernet controller.
The axistream-connected and axistream-control-connected properties can easily cause circular
dependencies, if they are provided at the second device as well.
In this case, the python device tree script fails to assign ordinals, causing build failure.
I suggest you do not provide them at the DMA.

axistream-control-connected

phandle

 
Handle to connected control node, e.g., AXI Ethernet controller

xlnx,include-dre

boolean

 
Data realignment engine activated. This enables unaligned DMA transfers.

xlnx,num-queues

int

 
Number of queues per channel.

#dma-cells

int

 
Number of items to expect in a DMA specifier

This property is required.

dma-channel-mask

int

 
Bitmask of available DMA channels in ascending order that are
not reserved by firmware and are available to the
kernel. i.e. first channel corresponds to LSB.

dma-channels

int

 
Number of DMA channels supported by the controller

dma-requests

int

 
Number of DMA request signals supported by the controller.

dma-buf-addr-alignment

int

 
Memory address alignment requirement for DMA buffers used by the controller.

dma-buf-size-alignment

int

 
Memory size alignment requirement for DMA buffers used by the controller.

dma-copy-alignment

int

 
Minimal chunk of data possible to be copied by the controller.

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

Base properties

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “xlnx,axi-dma-1.00.a” compatible.

Name

Type

Details

reg

array

 
DMA Control registers

This property is required.

See Important properties for more information.

interrupts

array

 
TX IRQ number followed by RX IRQ number

This property is required.

See Important properties for more information.

interrupt-parent

phandle

 
Interrupt controller that the DMA is connected to

clocks

phandle-array

 
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:

  https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml

status

string

 
Indicates the operational status of the hardware or other
resource that the node represents. In particular:

  - "okay" means the resource is operational and, for example,
    can be used by device drivers
  - "disabled" means the resource is not operational and the system
    should treat it as if it is not present

For details, see "2.3.4 status" in Devicetree Specification v0.4.

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

 
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.

The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.

The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.

For details, see "2.3.1 compatible" in Devicetree Specification v0.4.

This property is required.

See Important properties for more information.

reg-names

string-array

 
Optional names given to each register block in the "reg" property.
For example:

  / {
       soc {
           #address-cells = <1>;
           #size-cells = <1>;

           uart@1000 {
               reg = <0x1000 0x2000>, <0x3000 0x4000>;
               reg-names = "foo", "bar";
           };
       };
  };

The uart@1000 node has two register blocks:

  - one with base address 0x1000, size 0x2000, and name "foo"
  - another with base address 0x3000, size 0x4000, and name "bar"

interrupts-extended

compound

 
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.

For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.

interrupt-names

string-array

 
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.

For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.

label

string

 
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.

For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.

See Important properties for more information.

clock-names

string-array

 
Optional names given to each clock provider in the "clocks" property.

#address-cells

int

 
This property encodes the number of <u32> cells used by address fields
in "reg" properties in this node's children.

For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.

#size-cells

int

 
This property encodes the number of <u32> cells used by size fields in
"reg" properties in this node's children.

For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.

dmas

phandle-array

 
DMA channel specifiers relevant to the device.

dma-names

string-array

 
Optional names given to the DMA channel specifiers in the "dmas" property.

io-channels

phandle-array

 
IO channel specifiers relevant to the device.

io-channel-names

string-array

 
Optional names given to the IO channel specifiers in the "io-channels" property.

mboxes

phandle-array

 
Mailbox / IPM channel specifiers relevant to the device.

mbox-names

string-array

 
Optional names given to the mbox specifiers in the "mboxes" property.

power-domains

phandle-array

 
Power domain specifiers relevant to the device.

power-domain-names

string-array

 
Optional names given to the power domain specifiers in the "power-domains" property.

#power-domain-cells

int

 
Number of cells in power-domains property

zephyr,deferred-init

boolean

 
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

wakeup-source

boolean

 
Property to identify that a device can be used as wake up source.

When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.

Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.

zephyr,pm-device-runtime-auto

boolean

 
Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

 
List of power states that will disable this device power.