From 6d00ae98ea93aaa0cf066addede417bcf222be69 Mon Sep 17 00:00:00 2001 From: Jordan Carlin Date: Thu, 17 Oct 2024 15:29:39 -0700 Subject: [PATCH] Update linux README formatting --- linux/README.MD | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/linux/README.MD b/linux/README.MD index ba7fb8dd4..7eb50dd9f 100644 --- a/linux/README.MD +++ b/linux/README.MD @@ -14,21 +14,27 @@ In order to generate the Linux and boot stage binaries compatible with Wally, Bu To set up a Buildroot directory, configuration files for Buildroot, Linux, and Busybox must be copied into the correct locations inside the main Buildroot directory. Buildroot and device tree binaries must be generated as well. This can all be done automatically using the Makefile inside Wally's Linux subdirectory (this one). To install a new buildroot directory, build the Buildroot binaries, generate the device tree binaries, generate test-vectors for simulation, and install the buildroot package needed to build the SD card driver for Linux, run: - $ make +```bash +$ make +``` This installs to the `$RISCV` directory. Buildroot itself is installed to `$RISCV/buildroot` and the test-vectors are installed to `$RISCV/linux-testvectors`. Optionally, you can override the `BUILDROOT` variable to install a different buildroot source directory. - $ make install BUILDROOT=path/to/buildroot +``` +$ make install BUILDROOT= +``` ## Generating Device Tree Binaries -The device tree files for the various FPGA's Wally supports, as well as QEMU's device tree for the virt machine, are located in the `./devicetree` subdirectory. These device tree files are necessary for the boot process. +The device tree files for the various FPGAs Wally supports, as well as QEMU's device tree for the virt machine, are located in the `./devicetree` subdirectory. These device tree files are necessary for the boot process. They are built automatically using the main `make` command. To build the device tree binaries (.dtb) from the device tree sources (.dts) separately, we can build all of them at once using: - $ make generate #optionally override BUILDROOT +```bash +$ make generate # optionally override BUILDROOT +``` The .dts files will end up in the `/output/images` folder of your chosen buildroot directory. @@ -38,23 +44,30 @@ By using the `riscv64-unknown-elf-objdump` utility, we can disassemble the binar The disassembled binaries are built automatically using the main `make` command. To create the disassembled binaries separately, run: - $ make disassemble #optionally override BUILDROOT +```bash +$ make disassemble # optionally override BUILDROOT +``` You'll find the resulting disassembled files in `/output/images/disassembly`. ## Generate Memory Files for Linux Boot -Running a linux boot simulation uses a preloaded bootrom and ram memory. We use QEMU to generate these preloaded memory files. The files are output to $RISCV/linux-testvectors. The memory files are generated automatically when using the main `make` command. Alternatively, they can be generated by running +Running a linux boot simulation uses a preloaded bootrom and ram memory. We use QEMU to generate these preloaded memory files. The files are output to `$RISCV/linux-testvectors`. The memory files are generated automatically when using the main `make` command. Alternatively, they can be generated by running - make dumptvs +```bash +$ make dumptvs +``` ## Creating a Bootable SD Card To flash a bootable sd card for Wally's bootloader, use the `flash-sd.sh` script located in `/linux/sdcard`. The script allows you to specify which buildroot directory you would like to use and to specify the device tree. By default it is set up for the default location of buildroot in `$RISCV` and uses the vcu108 device tree. To use the script with your own buildroot directory and device tree, type: - $ cd sdcard - $ ./flash-sd.sh -b -d +```bash +$ cd sdcard +$ ./flash-sd.sh -b -d +``` for example - - $ ./flash-sd.sh -b ~/repos/buildroot -d wally-vcu118.dtb /dev/sdb +```bash +$ ./flash-sd.sh -b ~/repos/buildroot -d wally-vcu118.dtb /dev/sdb +```