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>
This commit is contained in:
rajames
@@ -0,0 +1,126 @@
|
||||
/*
|
||||
StarForth — Steady-State Virtual Machine Runtime
|
||||
|
||||
Copyright (c) 2023–2025 Robert A. James
|
||||
All rights reserved.
|
||||
|
||||
Licensed under the StarForth License, Version 1.0.
|
||||
*/
|
||||
|
||||
/**
|
||||
* framebuffer.h — UEFI GOP framebuffer driver interface
|
||||
*
|
||||
* Pixel format: BGRX32 (PixelBlueGreenRedReserved8BitPerColor),
|
||||
* the dominant format for QEMU virt GOP. RGBX32 is also supported.
|
||||
*
|
||||
* Color values throughout this API are packed as 0x00RRGGBB.
|
||||
*/
|
||||
|
||||
#ifndef STARKERNEL_FRAMEBUFFER_H
|
||||
#define STARKERNEL_FRAMEBUFFER_H
|
||||
|
||||
#include <stdint.h>
|
||||
#include "uefi.h"
|
||||
|
||||
/* Pixel format of the GOP framebuffer */
|
||||
typedef enum {
|
||||
FB_PIXEL_BGRX32 = 0, /* PixelBlueGreenRedReserved8BitPerColor (default) */
|
||||
FB_PIXEL_RGBX32 = 1, /* PixelRedGreenBlueReserved8BitPerColor */
|
||||
} FbPixelFormat;
|
||||
|
||||
/* Pack / unpack 24-bit 0x00RRGGBB color */
|
||||
#define FB_RGB(r, g, b) \
|
||||
(((uint32_t)(r) << 16) | ((uint32_t)(g) << 8) | (uint32_t)(b))
|
||||
#define FB_R(c) (((uint32_t)(c) >> 16) & 0xFFu)
|
||||
#define FB_G(c) (((uint32_t)(c) >> 8) & 0xFFu)
|
||||
#define FB_B(c) ( (uint32_t)(c) & 0xFFu)
|
||||
|
||||
/* Standard ANSI 16-color palette (indices 0–15) */
|
||||
extern const uint32_t FB_ANSI_PALETTE[16] __attribute__((visibility("hidden")));
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Lifecycle
|
||||
* --------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Initialize the framebuffer from UEFI bootloader GOP data.
|
||||
* Must be called before any other fb_* function.
|
||||
* fmt: pixel layout reported by GOP (default FB_PIXEL_BGRX32).
|
||||
*/
|
||||
void fb_init(const FramebufferInfo *info, FbPixelFormat fmt);
|
||||
|
||||
/** Returns 1 if the framebuffer has been successfully initialized. */
|
||||
int fb_is_available(void);
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Geometry queries
|
||||
* --------------------------------------------------------------------- */
|
||||
uint32_t fb_width(void);
|
||||
uint32_t fb_height(void);
|
||||
|
||||
/** Effective character cell width/height in pixels (8/16 × scale factor). */
|
||||
uint32_t fb_cell_w(void);
|
||||
uint32_t fb_cell_h(void);
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Pixel-level primitives
|
||||
* --------------------------------------------------------------------- */
|
||||
|
||||
/** Write a single pixel. Out-of-bounds writes are silently ignored. */
|
||||
void fb_put_pixel(uint32_t x, uint32_t y, uint32_t rgb);
|
||||
|
||||
/** Fill a rectangle with a solid color. */
|
||||
void fb_fill_rect(uint32_t x, uint32_t y, uint32_t w, uint32_t h,
|
||||
uint32_t rgb);
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Glyph rendering (8 × 16 font cells)
|
||||
* --------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Draw one 8×16 character glyph at pixel position (px, py).
|
||||
* fg / bg are packed 0x00RRGGBB colors.
|
||||
*/
|
||||
void fb_draw_glyph(uint32_t px, uint32_t py, uint8_t ch,
|
||||
uint32_t fg, uint32_t bg);
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Boot diagnostic
|
||||
* --------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* One-time boot diagnostic (FABRIC-0.md item 4.3.1): fills each raster corner
|
||||
* with a distinct solid color so a screendump reveals orientation. Not part
|
||||
* of the Console drawing fabric -- diagnostic-only.
|
||||
*/
|
||||
void fb_draw_orientation_test(void);
|
||||
|
||||
/* -----------------------------------------------------------------------
|
||||
* Scrolling
|
||||
* --------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Scroll the whole framebuffer up by `pixel_rows` pixel rows. The vacated
|
||||
* rows at the bottom are filled with bg. Takes an explicit pixel-row count
|
||||
* (not a hardcoded 8x16-cell assumption) so callers with a non-8x16 cell
|
||||
* height (e.g. TTF mode, 24px) pass their own cell height directly --
|
||||
* same convention fb_scroll_rect() below already uses, for the same reason
|
||||
* (a caller-computed char_rows * fixed-16px assumption drifts out of sync
|
||||
* with the text model's own row height in TTF mode, and that drift
|
||||
* compounds with every scroll).
|
||||
*/
|
||||
void fb_scroll_rows(uint32_t pixel_rows, uint32_t bg);
|
||||
|
||||
/**
|
||||
* Scroll a sub-rectangle of the framebuffer up by `pixel_rows` pixel rows
|
||||
* (FABRIC-0.md item 4.4t: box-confined REPL scrolling). Unlike fb_scroll_rows()
|
||||
* (whole-framebuffer), this is bounded to
|
||||
* [x, x+w) x [y, y+h). Both take an explicit pixel-row count so callers with
|
||||
* a non-8x16 cell height (e.g. TTF mode) pass their own cell height directly.
|
||||
* Pixels outside the rect are untouched. The vacated rows at the bottom of
|
||||
* the rect are filled with bg.
|
||||
*/
|
||||
void fb_scroll_rect(uint32_t x, uint32_t y, uint32_t w, uint32_t h,
|
||||
uint32_t pixel_rows, uint32_t bg);
|
||||
|
||||
#endif /* STARKERNEL_FRAMEBUFFER_H */
|
||||
Reference in New Issue
Block a user