Documenting the DMA

Now that you have developed your own DMA, write a piece or set of documentation to describe your design and its features.

Consider for example:

• What are the interfaces? What features of the standard are supported?
• What is the register/memory mapping? How can your design be programmed?
• What are the functional limitations and corner cases in your design?
• E.g., how latency-tolerant is your design?
• Does your design have parameters?
• What are they?
• What are their legal bounds?
• How do they affect the size and complexity of an instance?
• Does your design have external dependencies? What? Which versions?

Tips for writing documentation:

• Draw a block diagram, for example with Draw.io.
• Learn how to use Markdown if you have not done so already.

Some examples of nice documentation:

• PULP AXI
• PULP RedMulE
• Ibex Reference Guide

Instructions

Create a directory ./doc/ in the repository root. This directory must contain at least a README.md file as the entry point to your documentation. Add other documentation sources in this path and link to them appropriately from your README.md.

Returning

Tag your submission with ex2.N.

Ensure you have your Git repository up to date and insert your clone url here.

---

Enter your Git repository address for grading

Did you remember git add - git commit - git push?