rajamesandJunie
a8b70e88d3
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>
82 lines
2.9 KiB
C
82 lines
2.9 KiB
C
/*
|
||
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.
|
||
|
||
*/
|
||
|
||
/**
|
||
* i8042.h - PS/2 keyboard controller interface (amd64 only)
|
||
*
|
||
* Item 4.3.5 (FABRIC-0.md §27.5). Interrupt-driven only — no polling of the
|
||
* status port (0x64) anywhere in this path. Groundwork only: this captures
|
||
* and prints raw scancodes. Scancode-to-keycode translation and a consumer
|
||
* API belong to the REPL keyboard-input work noted in FABRIC-0.md, not here.
|
||
*/
|
||
|
||
#ifndef STARKERNEL_I8042_H
|
||
#define STARKERNEL_I8042_H
|
||
|
||
#include <stdint.h>
|
||
|
||
/* IDT vector the I/O APIC delivers legacy IRQ1 to. */
|
||
#define I8042_KEYBOARD_VECTOR 0x21
|
||
|
||
/**
|
||
* Enable IRQ1 delivery in the i8042 controller's command byte. Assumes the
|
||
* controller was already brought up by firmware (OVMF) — does not run the
|
||
* 0xAA self-test or the full two-port init sequence, since that is more
|
||
* than this item's scope requires.
|
||
*/
|
||
void i8042_init(void);
|
||
|
||
/**
|
||
* Drain any byte sitting in the output buffer right before unmasking IRQ1.
|
||
* Edge-triggered lines only assert on a rising edge; if OBF is already set
|
||
* (from real wall-clock time elapsing between i8042_init() and unmask
|
||
* while OBF was already high), there is no edge left to fire on, ever.
|
||
*/
|
||
void i8042_drain_stale(void);
|
||
|
||
/* Count of real keyboard IRQs serviced since boot (diagnostic). */
|
||
extern volatile uint32_t g_i8042_isr_count;
|
||
|
||
/**
|
||
* Called from the keyboard IRQ dispatch path (interrupts.c) on every
|
||
* I8042_KEYBOARD_VECTOR interrupt. Trivial by design: reads the scancode
|
||
* from port 0x60 (must always be read, or the controller never clears
|
||
* OBF and stops delivering further interrupts) and pushes it onto a small
|
||
* ring buffer. No printing, no translation, no other work — that all
|
||
* happens outside interrupt context via i8042_pop_scancode(). Does not
|
||
* issue apic_eoi() — the caller does.
|
||
*/
|
||
void i8042_handle_irq(void);
|
||
|
||
/**
|
||
* Pop one raw scancode off the ring buffer, from non-interrupt context.
|
||
* Single producer (the ISR), single reader (this function) — same shape
|
||
* already established safe on one hart elsewhere in this tree (§21.1).
|
||
*
|
||
* @param out Written with the popped scancode on success.
|
||
* @return 1 if a scancode was popped, 0 if the buffer was empty.
|
||
*/
|
||
int i8042_pop_scancode(uint8_t *out);
|
||
|
||
#endif /* STARKERNEL_I8042_H */
|