Files
LithosAnanake/boards/README.md
T
rajamesandJunie a8b70e88d3 Reorganize source tree: kernel/, v3/, v4/ split and board infrastructure
Source tree reorganization:
- Move StarForth v3 engine to v3/ (src/, include/, Makefile)
- Move kernel to kernel/ (src/, include/, linker/, Makefile)
- Create v4/ skeleton for F18-ISA golden model (DECOMPOSITION.md, JUSTIFICATION.md)
- Move FABRIC-0..4.md to docs/fabric/
- Move ONTOLOGY.md and ROADMAP.md to docs/

Board infrastructure:
- Add boards/ser5/, boards/raspi/, boards/milkv/, boards/zynq7020/
- Each board has board.mk (ISA, CPU flags, boot recipe) and README.md
- Root Makefile becomes thin dispatcher: boot_image, all, clean, docs take TARGET
- make boot_image TARGET=SER5|RASPI|MILKV builds one GPT/MBR image per board
- ZYNQ7020 target exists but stops with clear error (ARMv7 port not built yet)
- scripts/mkdiskimage.sh builds disk images for all boards

Docs pipeline:
- docs/book/ with LaTeX master (main.tex) and Makefile
- pandoc converts Markdown to LaTeX at build time
- Two Lua filters: table-widths.lua (wide tables wrap), code-breaks.lua (inline code breaks)
- make docs builds single PDF (754 pages, 0 missing characters)
- make docs TARGET=<board> adds board appendix
- build/docs/<book|board>/meta.tex stamps git commit into PDF

Bug fixes:
- 42 include paths that only worked by accident now use correct relative paths
- clang-18 hardcode replaced with configurable CC variable (fixed aarch64 build)
- Pi 5: kernel_2712.img linked at 0x80000, .bss zeroed, memory reserved
- Doxyfile, .clang-tidy, README.md, Kconfig paths updated

Verified:
- Hosted v3 build passes 1012 tests, 0 failures
- SER5 image boots in QEMU (OVMF), POST passes, K exact (65536 = Q48_ONE)
- Milk-V image boots in QEMU (OpenSBI + U-Boot + bootefi), POST passes
- make clean TARGET=<board> removes only that board and its ISA objects
- make all builds all boards, hosted v3, and docs in one run

Co-authored-by: Junie <junie@jetbrains.com>
2026-10-01 15:40:09 -04:00

1.6 KiB

boards/

One directory per physical target. make boot_image TARGET=<NAME> (repo root) maps the name to a directory here, reads its board.mk, and builds the single file that goes on that board's boot medium into build/boards/<board>/.

TARGET Directory ISA Boot path Image
SER5 ser5/ amd64 UEFI firmware, removable-media path GPT + FAT32 ESP: EFI/BOOT/BOOTX64.EFI
RASPI raspi/ aarch64 Pi 5 EEPROM firmware, native MBR + FAT32: config.txt, kernel_2712.img, bcm2712-rpi-5-b.dtb
MILKV milkv/ riscv64 SPI-flash U-Boot + OpenSBI, bootefi GPT + FAT32 ESP: EFI/BOOT/BOOTRISCV64.EFI
ZYNQ7020 zynq7020/ armv7 BootROM, BOOT.BIN, U-Boot not yet: needs kernel/src/arch/armv7

board.mk sets:

  • BOARD_DESC: one-line description (make boards)
  • BOARD_ARCH: kernel ISA (kernel/src/arch/<arch>)
  • BOARD_BOOT: image recipe in kernel/Makefile (uefi-esp, rpi-native, ...)
  • BOARD_IMAGE: output file name

Disk images are assembled by scripts/mkdiskimage.sh, which needs no root access and no loop devices. KERNEL_ARGS="..." is written as starforth.cfg (UEFI boards) or cmdline.txt (Pi 5, where the firmware copies it into /chosen/bootargs). BOOT_IMAGE_SIZE_MIB sets the image size; the default is 128.

Hardware status: none of these images has been booted on real silicon from this build. The SER5 image has been booted in QEMU (q35 + OVMF, from its own disk) through POST. The Pi 5 native path (raspi/README.md) and the JH7110 peripherals have still only been checked by compiling.