.. _components-dma:

Dma
===

The Dma component handles the configuration and control of the Direct Memory Access (DMA). It is
used to transfer data from the hardware design to the memory.

Additional information
----------------------

The Dma component works only with the Dma implementation of AMD/Xilinx [#axi_dma_ip_core]_.

When creating a Dma object the corresponding DMA is configured using a
:ref:`memory map<components-memorycontrol-memorymap>` to access the DMA registers and a
:ref:`descriptor control<components-dma-descriptorcontrol>` to access the descriptor control
registers. A :ref:`Uio device <components-memorycontrol-uio>` is used to wait for Dma interrupts. On
each interrupt it is checked if the interrupt was caused by the measurement stop. If this happened
the DMA waits for the last transfer to finish and then the DMA is stopped.

Classes
-------

.. contents::
   :local:
   :class: this-will-duplicate-information-and-it-is-still-useful-here


DMA Class
~~~~~~~~~

.. doxygenclass:: nexmess::components::dma::Dma
   :members:
   :protected-members:
   :private-members:

.. _components-dma-descriptorcontrol:

DescriptorControl Class
~~~~~~~~~~~~~~~~~~~~~~~

.. doxygenclass:: nexmess::components::dma::DescriptorControl
   :members:
   :protected-members:
   :private-members:


Bibliography
------------

.. [#axi_dma_ip_core] `AXI DMA IP Core <https://docs.xilinx.com/r/en-US/pg021_axi_dma>`_