From 21de8e018be91a8c027386b12f115f49c25d364b Mon Sep 17 00:00:00 2001 From: Romain Dolbeau Date: Tue, 25 Apr 2023 07:45:06 +0200 Subject: [PATCH] ultra-basic readme --- nubus-to-ztex-gateware/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 nubus-to-ztex-gateware/README.md diff --git a/nubus-to-ztex-gateware/README.md b/nubus-to-ztex-gateware/README.md new file mode 100644 index 0000000..7602440 --- /dev/null +++ b/nubus-to-ztex-gateware/README.md @@ -0,0 +1,9 @@ +# Compiling + +Compiling the Declaration Rom (in DeclRom) requires the [Retro68](https://github.com/autc04/Retro68) toolchain. + +Compiling the acceleration code for the Framebuffer requires a RISC-V toolchain. + +Generating the bitstream requires Vivado, 2022 or newer should do. It also requires Litex, see for instance [Linux-on-Litex-VexRiscv](https://github.com/litex-hub/linux-on-litex-vexriscv). + +There's an interesting issue where you need the DeclRom to generate the bitstream (by defualt the Rom is emebedded in it), but you need CSR headers created during the generation of the bitstream to compile the Declaration Rom. A simple workaround is to create a Rom file with a kilobyte or two of fake data, generate the bitstream, then compile the declaration rom, then re-generate the bitsteam with the proper Rom.