How rakeshmonkee/dma works
Project Type and Purpose
• This is primarily an educational “guide” repository for DMA firmware creation, flashing, and troubleshooting, augmented by a small set of helper scripts (Vivado customization, COE conversion).
• It’s not a classic full-stack web app or microservice suite but a “pipeline plus documentation” project that walks a user through firmware generation, bitstream conversion, device flashing, speed testing, and troubleshooting.
File-Structure Analysis
• Top-level directories each correspond to a stage or topic in the guide:
• “Vivado Customisations” – Python and TCL scripts to auto-generate FPGA/Vivado projects
• “.tlscan to .coe” – Python script to convert scan data into COE memory‐init files
• “Anti-Cheese FW Creation” & “VGK FW Creation” – user exercises for crafting two styles of DMA firmware
• “How to Flash” – archived tools (CH341PAR, OpenOCD builds, etc.) and instructions for flashing the firmware onto devices
• “Speed Test” – sample test harness and data for validating DMA throughput
• “DMA FAQ” & “DMA Troubleshooting” – static Markdown FAQs and common‐issue walk-throughs
• Configuration files and scripts are clearly separated from static docs and archives.
Key Components
a. Input & Preparation
• Hardware design files or exported scan data (e.g. from real device)
• Vivado scripts (.py, .tcl) in “Vivado Customisations”
b. Bitstream & Memory Init Generation
• Vivado runs → generates .bit or .elf → outputs raw memory data
• .tlscan to .coe script converts scan dumps into .coe format
c. Firmware Creation
• Two parallel flows: “Anti-Cheese FW Creation” and “VGK FW Creation”
• Each produces a custom DMA firmware image (hex, bin)
d. Flashing Tools & Processes
• CH341PAR, GhostDMA‐OpenOCD, MVPDMA, flash_screamer archives
• User runs host‐PC tools to write firmware image to hardware over USB/JTAG
e. Verification & Troubleshooting
• Speed Test harness measures throughput
• DMA FAQ & Troubleshooting docs guide the user through issues
Relationships & Data Flow
• Sequential pipeline:
1. Hardware Scan →
2. Vivado Project →
3. Bitstream/Mem-Init →
4. Firmware Creation →
5. Flashing →
6. Speed Test →
7. Troubleshooting
• Branch for two firmware types (Anti-Cheese vs VGK) after Mem-Init
Architectural Patterns & Design Principles
• Clear separation of concerns:
• “Generation” (Vivado + COE)
• “Firmware logic” (two custom flows)
• “Deployment” (flashing tools)
• “Validation & Support” (tests + docs)
• Modularity: each top-level folder is a self-contained guide or script set
• Reusability: .tlscan→.coe and Vivado scripts can be reused across firmware flows
Technologies & Frameworks to Highlight
• Python scripts for automation (“Vivado.py”, “generate-project.py”, “telescan_to_coe.py”)
• Tcl scripting for Vivado .tcl automation
• FPGA/Vivado toolchain producing .bit/.coe
• Host-side flashing utilities (CH341 drivers, OpenOCD variants, GhostDMA)
• Markdown docs as the primary user interface