192 lines
6.5 KiB
C
192 lines
6.5 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.
|
||
|
||
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.
|
||
|
||
*/
|
||
|
||
/**
|
||
* console.h - Serial console + framebuffer VT100 interface for StarKernel
|
||
*
|
||
* Output policy:
|
||
* - Serial UART is always active (initialized by console_init).
|
||
* - When console_fb_init() has been called and the framebuffer is ready,
|
||
* every character is also rendered through the VT100 terminal on screen.
|
||
* - Both outputs are always live simultaneously; serial cannot be disabled.
|
||
*/
|
||
|
||
#ifndef STARKERNEL_CONSOLE_H
|
||
#define STARKERNEL_CONSOLE_H
|
||
|
||
#include <stdint.h>
|
||
#include <stddef.h>
|
||
#include "uefi.h"
|
||
|
||
/**
|
||
* Initialize serial console (UART).
|
||
* Must be called once during early kernel boot.
|
||
*/
|
||
void console_init(void);
|
||
|
||
/**
|
||
* Initialize the framebuffer VT100 terminal.
|
||
* Call after UEFI boot services have been exited and the GOP framebuffer
|
||
* address is known (from BootInfo). Safe to call with info==NULL (no-op).
|
||
* fmt: FB_PIXEL_BGRX32 is correct for most QEMU / real hardware GOP.
|
||
*/
|
||
#include "framebuffer.h"
|
||
void console_fb_init(const FramebufferInfo *info, FbPixelFormat fmt);
|
||
|
||
/**
|
||
* FABRIC.md item 4.4j: switch the framebuffer console's glyph backend from
|
||
* font_8x16.c to TTF-TEXT's rasterizer. Thin wrapper over
|
||
* vt100_enable_ttf() -- see that function's doc comment for the full
|
||
* contract (lazy font load, cell-geometry/cols/rows recompute, screen
|
||
* clear, one-shot). No-op if the framebuffer console was never
|
||
* initialized (console_fb_init() not called, or it no-op'd on a NULL
|
||
* framebuffer).
|
||
*/
|
||
void console_fb_enable_ttf(void);
|
||
|
||
/**
|
||
* FABRIC.md item 4.4q: thin wrappers over vt100_scroll_back()/
|
||
* vt100_scroll_fwd() -- see those functions' doc comments for the full
|
||
* contract. No-op if the framebuffer console was never initialized.
|
||
*/
|
||
void console_fb_scroll_back(uint32_t n);
|
||
void console_fb_scroll_fwd(uint32_t n);
|
||
|
||
/**
|
||
* FABRIC.md item 4.4y-revised: thin wrapper over vt100_toggle_graphics()
|
||
* -- see that function's doc comment for the full contract (the
|
||
* Alt+TAB graphics/text state machine). No-op if the framebuffer console
|
||
* was never initialized.
|
||
*/
|
||
void console_fb_toggle_graphics(void);
|
||
|
||
/**
|
||
* Thin wrapper over vt100_draw_cursor() -- see that function's doc
|
||
* comment for the full contract (a static block cursor at the terminal's
|
||
* current position). No-op if the framebuffer console was never
|
||
* initialized.
|
||
*/
|
||
void console_fb_draw_cursor(void);
|
||
|
||
/**
|
||
* Thin wrapper over vt100_erase_cursor(). No-op if the framebuffer
|
||
* console was never initialized.
|
||
*/
|
||
void console_fb_erase_cursor(void);
|
||
|
||
/**
|
||
* Write a single character to serial console
|
||
*/
|
||
void console_putc(char c);
|
||
|
||
/**
|
||
* Write a null-terminated string to serial console
|
||
*/
|
||
void console_puts(const char *s);
|
||
|
||
/**
|
||
* Write a string with newline to serial console
|
||
*/
|
||
void console_println(const char *s);
|
||
|
||
/**
|
||
* console_ensure_line_start - Make sure the next console_putc() starts at
|
||
* the beginning of a fresh output line, emitting a newline if output is
|
||
* currently mid-line (e.g. dangling behind a re-anchored prompt).
|
||
* No-op if already at line start. Mirrors console_putc()'s dual
|
||
* serial+framebuffer behavior (a bare '\n' reaches both).
|
||
*/
|
||
void console_ensure_line_start(void);
|
||
|
||
/**
|
||
* console_tx_count - Monotonic count of console_putc() calls delivered to
|
||
* either output (serial and/or framebuffer). In use by the REPL to detect
|
||
* that an idle bottom half (heartbeat, USB attach/detach) wrote to the
|
||
* console while the top-level prompt was showing, so it can re-anchor the
|
||
* prompt afterward. Never decreases.
|
||
*/
|
||
uint64_t console_tx_count(void);
|
||
|
||
/**
|
||
* Read a single character from serial console (non-blocking)
|
||
* Returns -1 if no character available
|
||
*/
|
||
int console_getc(void);
|
||
|
||
/**
|
||
* Check if character is available for reading
|
||
*/
|
||
int console_poll(void);
|
||
|
||
/**
|
||
* Set the active VM name shown as [Name] prefix on each output line.
|
||
* Pass NULL to suppress the prefix (kernel-only output before any VM).
|
||
* Copies into internal storage (FABRIC-3.md Phase F, 2026-08-28) -- the
|
||
* caller's own pointer does not need to remain valid afterward.
|
||
*/
|
||
void console_set_vm_name(const char *name);
|
||
const char *console_get_vm_name(void);
|
||
|
||
/**
|
||
* console_save_vm_name - Copy the current active-VM name into the
|
||
* caller's own buffer, for a later console_set_vm_name() restore.
|
||
*
|
||
* console_get_vm_name() alone is NOT safe for save-then-restore: it
|
||
* returns a pointer into the single internal buffer console_set_vm_name()
|
||
* copies into, so an intervening console_set_vm_name() call (the normal
|
||
* "switch, do work, switch back" pattern every BIRTH/VM-EXEC/CONNECT-*
|
||
* call site uses) overwrites the very bytes the saved pointer points at
|
||
* before the restore ever runs -- found live 2026-08-28, the restore
|
||
* silently no-ops. Copies at most cap-1 bytes plus a NUL terminator;
|
||
* writes "" if there was no active name (NULL) to save.
|
||
*
|
||
* @param out Caller-owned buffer.
|
||
* @param cap Its size in bytes.
|
||
*/
|
||
void console_save_vm_name(char *out, size_t cap);
|
||
|
||
/* Last FORTH word name set by the dispatcher before entry->func(vm).
|
||
* Printed by the #GP fault handler to identify the faulting word. */
|
||
extern volatile const char *g_sk_fault_word;
|
||
|
||
#endif /* STARKERNEL_CONSOLE_H */
|