Robert Allan JamesandClaude Sonnet 5
b031b802e3
FABRIC.md -> FABRIC-0.md FABRIC-2.md -> FABRIC-1.md FABRIC-3.md -> FABRIC-2.md (the current/living document) FABRIC-4.md unchanged (new #3 to follow separately) Every cross-reference repo-wide updated to match, including doc-comment citations inside kernel source (.c/.h) files -- done via an ordered placeholder substitution (FABRIC-3.md->placeholder2, FABRIC-2.md-> placeholder1, FABRIC.md->placeholder0, then placeholders resolved to final names) in a single pass per file to avoid double-shifting already-renamed references. One line in capsules/font.4th grew past the 64-char block-format limit as a side effect of the longer filename; shortened it and reverified with mkcapsule --lint (34/34 pass) before rebuilding. Verified 3-arch boot to ok> (amd64/aarch64/riscv64, each in the foreground) after the fix; logs and DoE CSVs from this session's verification runs included per this repo's own audit-artifact convention. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019YcT3H2PQeyujrzjqS3Var
127 lines
4.7 KiB
C
127 lines
4.7 KiB
C
/*
|
||
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 */
|