diff --git a/nubus-to-ztex-gateware/README.md b/nubus-to-ztex-gateware/README.md index 7602440..fe7a2f7 100644 --- a/nubus-to-ztex-gateware/README.md +++ b/nubus-to-ztex-gateware/README.md @@ -1,9 +1,23 @@ # Compiling +## Rom + Compiling the Declaration Rom (in DeclRom) requires the [Retro68](https://github.com/autc04/Retro68) toolchain. +The beginning of the Makefile in DeclROM/ needs to be adapted to point to the toolchain. + +## Microcode for acceleration + Compiling the acceleration code for the Framebuffer requires a RISC-V toolchain. +The script blit_goblin_nubus.sh in VintageBusFPGA_Common/ needs to be adapted to point to the appropriate toolchain. + +## Bitstream + 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). +You will need LItex working, and an usable Vivado in yout $PATH. + +## Known issues + 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.