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
parent 3c709c115b
commit a8b70e88d3
630 changed files with 2646 additions and 2036 deletions
@@ -0,0 +1,9 @@
+# include/starkernel/hal/
+
+Top-level hardware-abstraction-layer interface for LithosAnanke.
+
+- `hal.h` — declares the HAL entry points implemented by
+  `src/starkernel/hal/{hal,console,memory,host_services,framebuffer,vt100}.c`:
+  console I/O, framebuffer/VT100 output, memory queries, and host-service
+  shims consumed by the rest of the kernel so architecture-specific
+  details stay out of `kernel_main.c`.
@@ -0,0 +1,80 @@
+/*
+  StarForth — Steady-State Virtual Machine Runtime
+
+  Copyright (c) 2023–2025 Robert A. James
+  All rights reserved.
+
+  This file is part of the StarForth project.
+
+  Licensed under the StarForth License, Version 1.0 (the "License");
+  you may not use this file except in compliance with the License.
+
+  You may obtain a copy of the License at:
+      https://github.com/star.4th@proton.me/StarForth/LICENSE.txt
+
+  This software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  express or implied, including but not limited to the warranties of
+  merchantability, fitness for a particular purpose, and noninfringement.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ StarForth — Steady-State Virtual Machine Runtime
+  Copyright (c) 2023–2025 Robert A. James
+  All rights reserved.
+
+  This file is part of the StarForth project.
+
+  Licensed under the StarForth License, Version 1.0 (the "License");
+  you may not use this file except in compliance with the License.
+
+  You may obtain a copy of the License at:
+       https://github.com/star.4th@proton.me/StarForth/LICENSE.txt
+
+  This software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  express or implied, including but not limited to the warranties of
+  merchantability, fitness for a particular purpose, and noninfringement.
+
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+ */
+
+/**
+ * Kernel HAL surface exposed to the StarForth VM integration layer.
+ *
+ * Hosted builds never include this header; kernel code funnels all VM-facing
+ * services through here so the VM core does not depend on kernel internals.
+ */
+
+#ifndef STARKERNEL_HAL_HAL_H
+#define STARKERNEL_HAL_HAL_H
+
+#ifdef __STARKERNEL__
+
+#include <stddef.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+struct VMHostServices;
+
+void                    sk_hal_init(void);
+void                   *sk_hal_alloc(size_t size, size_t align);
+void                    sk_hal_free(void *ptr);
+uint64_t                sk_hal_time_ns(void);
+uint64_t                sk_hal_heartbeat_ticks(void);
+size_t                  sk_hal_console_write(const char *buf, size_t len);
+int                     sk_hal_console_putc(int c);
+void                    sk_hal_panic(const char *message) __attribute__((noreturn));
+bool                    sk_hal_is_executable_ptr(const void *ptr);
+const struct VMHostServices *sk_hal_host_services(void);
+void                    sk_hal_whitelist_exec_region(uint64_t start, uint64_t end, const char *name);
+void                    sk_hal_freeze_exec_range(void);
+
+/* Section address getters - use inline asm to avoid GOT indirection issues with -fPIC */
+uint64_t                sk_hal_text_start(void);
+uint64_t                sk_hal_text_end(void);
+
+#endif /* __STARKERNEL__ */
+
+#endif /* STARKERNEL_HAL_HAL_H */