nxp,edma

Vendor: NXP Semiconductors N.V.

Note

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

Description

These nodes are “dma” bus nodes.

NXP enhanced Direct Memory Access (eDMA) node

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

valid-channels

array

 
Use this property to specify which channel indexes are
to be considered valid. The difference between this
property and "dma-channels" is the fact that this
property allows you to have "gaps" between the channel
indexes. This is useful in cases where you know you're
not going to be using all of the possible channels, thus
leading to a more readable DTS. Of course, this property
and "dma-channels" are mutually exclusive, meaning you
can't specify both properties as this will lead to a
BUILD_ASSERT() failure.

hal-cfg-index

int

 
Use this property to specify which HAL configuration
should be used. In the case of some SoCs (e.g: i.MX93),
there can be multiple eDMA variants, each of them having
different configurations (e.g: i.MX93 eDMA3 has 31 channels,
i.MX93 eDMA4 has 64 channels and both of them have slightly
different register layouts). To overcome this issue, the HAL
exposes an array of configurations called "edma_hal_configs".
To perform various operations, the HAL uses an eDMA configuration
which will tell it what register layout the IP has, the number of
channels, various flags and offsets. As such, if there's multiple
configurations available, the user will have to specify which
configuration to use through this property. If missing, the
configuration found at index 0 will be used.

#dma-cells

int

 
Number of items to expect in a DMA specifier

This property is required.

Constant value: 2

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 “nxp,edma” compatible.

Name

Type

Details

reg

array

 
register space

This property is required.

See Important properties for more information.

status

string

 
indicates the operational status of a device

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

See Important properties for more information.

compatible

string-array

 
compatible strings

This property is required.

See Important properties for more information.

reg-names

string-array

 
name of each register space

interrupts

array

 
interrupts for device

See Important properties for more information.

interrupts-extended

compound

 
extended interrupt specifier for device

interrupt-names

string-array

 
name of each interrupt

interrupt-parent

phandle

 
phandle to interrupt controller node

label

string

 
Human readable string describing the device (used as device_get_binding() argument)

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

 
Clock gate information

clock-names

string-array

 
name of each clock

#address-cells

int

 
number of address cells in reg property

#size-cells

int

 
number of size cells in reg property

dmas

phandle-array

 
DMA channels specifiers

dma-names

string-array

 
Provided names of DMA channel specifiers

io-channels

phandle-array

 
IO channels specifiers

io-channel-names

string-array

 
Provided names of IO channel specifiers

mboxes

phandle-array

 
mailbox / IPM channels specifiers

mbox-names

string-array

 
Provided names of mailbox / IPM channel specifiers

power-domains

phandle-array

 
Power domain specifiers

power-domain-names

string-array

 
Provided names of power domain specifiers

#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.

Specifier cell names

  • dma cells: channel, mux