lib-console

lib-console provides shared framebuffer console primitives used by bootloader, kernel, and userspace console services.

EriX is a clean-room, capability-based microkernel operating system written entirely in Rust.

Technical requirements are tracked in the EriX requirements, conventions, and project documentation.

See:

• docs for design documents, specifications, and development plans.
• Related architecture repositories for kernel, services, libraries, drivers, and integration tooling.

Purpose of This Repository

This repository implements the EriX console library. Its purpose in EriX is to provide reusable console primitives and contracts to EriX components.

Functionally, it exposes the console APIs, validation tests, and documentation used by dependent repositories. The repository keeps the implementation, interface contracts, tests, and documentation for that behavior in one reviewable ownership boundary.

The maintained responsibilities are:

• expose the lib-console crate API for console behavior used by dependent components
• accept only canonical GRUB PF2 framing, ordinary/contextual glyph index keys, and file-relative glyph offsets
• provide an owned validated PF2 index that callers parse once and lend to short-lived renderers without rescanning or copying its lookup table
• preserve inherited scanout pixels until the visible page fills, then scroll the visible text rows upward by one cell row and clear only the newly exposed final row
• encode each rectangle's pixel value once and fill checked contiguous row slices, avoiding per-pixel geometry and format revalidation
• keep data formats, constants, and validation helpers documented and tested
• provide an opt-in, fragmented ordinary-terminal CSI decoder with bounded relative movement, current-row erasure, and a reversible steady text caret; existing literal-text rendering stays unchanged for logs and trusted chrome
• preserve clean-room, no-external-crate implementation boundaries
• coordinate deliberate pre-alpha API and format changes with downstream repositories

Clean-Room Policy

EriX follows a strict clean-room philosophy:

• No external source code may be copied.
• No external Rust crates are allowed.
• No code generation tools that embed third-party code.
• All code must be authored within the project.

Violations will result in rejection of the contribution.

License

All EriX repositories are licensed under the ISC License.

Development Model

EriX development is modular, deterministic, reproducible, authority-explicit, security-first, and self-hosting oriented.

This repository follows the project roadmap and the validation rules documented in its own roadmap.

Build and test

cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test

Governance Principles

lib-console governance is scoped to reusable console contracts shared by dependent repositories.

The scoped governance rules are:

• It must expose narrow, documented APIs rather than component-specific policy.
• It keeps wire formats, constants, parsers, and validation helpers deterministic and testable.
• It preserves clean-room implementation boundaries and does not introduce external crate dependencies.
• Breaking API or format changes require coordinated updates in every dependent repository.

Library Boundaries

• lib-console carries no runtime authority by itself; authority is held by callers that use the library.
• The crate must not hide ambient I/O, allocation policy, or service discovery behind helper APIs.

Contact

Development occurs in EriX organization and discussions happen in issues and design documents.

No decisions are considered valid without documented rationale.

Maintainers can be reached via email: admin@erikinkinen.fi.