README.md

X-HEEP DMA

The configurable X-HEEP DMA. For the full documentation, refer to X-HEEP's online documentation.

Quick Start

To genrate the DMA RTL files:

1. Render the Mako templates inside data/ with X-HEEP's mcu_gen.py or similar.
2. Make x-heep:ip:dma a dependency of your project, e.g.:

   filesets:
     rtl:
       depend:
       - x-heep:ip:dma
       ...

The configuration registers RTL and the corresponding C header and documentation are automatically generated inside the rtl, sw, and docs directories. If you need these files in different locations in your project, you can link -sr those directories there (see X-HEEP for a usage example). Alternatively, if your project does not rely on FuseSoC, you can use the included Makefile to generate the same files.

The X-HEEP DMA depends on pulp-platform.org::common_cells, so be sure that they are vendored in your project and FuseSoC detects the common_cells.core file.