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,90 @@
+/*
+  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.
+
+ */
+
+#ifndef ARITHMETIC_WORDS_H
+#define ARITHMETIC_WORDS_H
+
+#include "vm.h"
+
+/* FORTH-79 Arithmetic Words:
+ * +         ( n1 n2 -- n3 )              Add n1 and n2
+ * -         ( n1 n2 -- n3 )              Subtract n2 from n1
+ * *         ( n1 n2 -- n3 )              Multiply n1 and n2
+ * /         ( n1 n2 -- n3 )              Divide n1 by n2
+ * MOD       ( n1 n2 -- n3 )              Remainder of n1/n2
+ * /MOD      ( n1 n2 -- n3 n4 )           n3=remainder, n4=quotient of n1/n2
+ * NEGATE    ( n1 -- n2 )                 Negate n1
+ * ABS       ( n1 -- n2 )                 Absolute value of n1
+ * MIN       ( n1 n2 -- n3 )              Minimum of n1 and n2
+ * MAX       ( n1 n2 -- n3 )              Maximum of n1 and n2
+ * 1+        ( n1 -- n2 )                 Add 1 to n1
+ * 1-        ( n1 -- n2 )                 Subtract 1 from n1
+ * 2*        ( n1 -- n2 )                 Multiply n1 by 2 (left shift)
+ * 2/        ( n1 -- n2 )                 Divide n1 by 2 (right shift)
+ * STAR-SLASH ( n1 n2 n3 -- n4 )          Multiply n1*n2, divide by n3
+ */
+
+/**
+ * @brief Registers all FORTH-79 arithmetic words with the virtual machine
+ *
+ * Registers the following words:
+ * - + (add)
+ * - - (subtract)
+ * - * (multiply)
+ * - / (divide)
+ * - MOD (modulo)
+ * - /MOD (divide with remainder)
+ * - NEGATE
+ * - ABS (absolute)
+ * - MIN
+ * - MAX
+ * - 1+ (increment)
+ * - 1- (decrement)
+ * - 2* (multiply by 2)
+ * - 2/ (divide by 2)
+ * - STAR-SLASH (multiply then divide)
+ *
+ * @param vm Pointer to the Forth virtual machine instance
+ */
+void register_arithmetic_words(VM * vm);
+
+#endif /* ARITHMETIC_WORDS_H */