docs: fill out compat, lvglh, and toolchain documentation
continuous-integration/drone/push Build is failing
continuous-integration/drone/push Build is failing
Replace placeholder content in doc/compat/, doc/lvglh/, and doc/toolchain/ with comprehensive documentation derived from the source files. - compat: document Wasuro WASM VM compatibility shims - lvglh: document LVGL v9.2.2 configuration, fonts, and patches - toolchain: document all 13 build pipeline scripts
This commit is contained in:
t3hn3rd committed
1 parent
d059ff1ffb
commit
466173613f
19 files changed
+888
-32
No files matched your search
+53
-1
@@ -1 +1,53 @@
|
||||
# Placeholder
|
||||
# hack_14.c
|
||||
|
||||
LVGL bitmap font source for the Hack Regular typeface at 14 px.
|
||||
|
||||
## Overview
|
||||
|
||||
This file contains a pre-rendered bitmap font generated from the Hack Regular TrueType font (`Hack-Regular.ttf`) for use with LVGL. It provides a complete monospaced programmer font covering the full Basic Multilingual Plane (Unicode range 0x0000--0xFFFF). The font is intended for use in terminal emulators, code editors, or any UI element within Asuro that benefits from a fixed-width typeface.
|
||||
|
||||
The file was generated by the LVGL font converter tool and is approximately 12,900 lines (~548 KB) of static bitmap and glyph descriptor data.
|
||||
|
||||
## Configuration Options / Defines
|
||||
|
||||
### HACK_14
|
||||
Value: `1` (default). Acts as a compile-time guard. Set to `0` to exclude this font from the build entirely.
|
||||
|
||||
## Font Properties
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Font family | Hack Regular |
|
||||
| Size | 14 px |
|
||||
| Bits per pixel | 4 (16-level anti-aliasing) |
|
||||
| Compression | None (`--no-compress`) |
|
||||
| Stride alignment | 1 byte |
|
||||
| Data alignment | 1 byte |
|
||||
| Line height | 19 px |
|
||||
| Baseline | 5 px from bottom |
|
||||
| Underline position | -2 |
|
||||
| Underline thickness | 1 |
|
||||
| Unicode range | 0x0000--0xFFFF |
|
||||
| Subpixel rendering | None |
|
||||
|
||||
## Public Symbol
|
||||
|
||||
```c
|
||||
const lv_font_t hack_14;
|
||||
```
|
||||
|
||||
This is the font descriptor exposed for use in LVGL widget styles. Reference it as `&hack_14` when assigning fonts to labels, text areas, or other text-bearing widgets.
|
||||
|
||||
## Generation Command
|
||||
|
||||
```
|
||||
--bpp 4 --size 14 --no-compress --stride 1 --align 1 \
|
||||
--font Hack-Regular.ttf --range 0-65535 --format lvgl -o hack_14.c
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- This is a machine-generated file. Do not edit by hand; regenerate using the LVGL font converter if changes are needed.
|
||||
- The full 0--65535 Unicode range makes this a large file. If binary size is a concern, the range could be narrowed to only the code points actually used.
|
||||
- The font includes version-conditional compilation guards for compatibility across LVGL 6.x through 9.x, though Asuro targets LVGL 9.2.2.
|
||||
- The `LV_ATTRIBUTE_LARGE_CONST` annotation on the glyph bitmap array allows the linker to place it in an appropriate read-only section.
|
||||
+133
-1
@@ -1 +1,133 @@
|
||||
# Placeholder
|
||||
# lv_conf.h
|
||||
|
||||
LVGL v9.2.2 configuration header tailored for the Asuro bare-metal kernel environment.
|
||||
|
||||
## Overview
|
||||
|
||||
This file configures the LVGL graphics library for use inside the Asuro kernel, where no standard C library, operating system, or GPU hardware is available. It selects a 32-bit XRGB8888 color depth to match the VESA framebuffer, routes all stdlib functionality through LVGL's built-in implementations, enables only the software renderer, and disables every hardware backend, filesystem driver, and image decoder. The result is a minimal but functional GUI stack that runs entirely in kernel space.
|
||||
|
||||
## Configuration Options / Defines
|
||||
|
||||
### Color Settings
|
||||
|
||||
#### LV_COLOR_DEPTH
|
||||
Value: `32`. Matches the VESA XRGB8888 framebuffer used by Asuro.
|
||||
|
||||
### Standard Library Wrappers
|
||||
|
||||
#### LV_USE_STDLIB_MALLOC / LV_USE_STDLIB_STRING / LV_USE_STDLIB_SPRINTF
|
||||
Value: `LV_STDLIB_BUILTIN`. All three are set to use LVGL's own built-in implementations since no libc is available in the bare-metal environment.
|
||||
|
||||
### Memory Pool
|
||||
|
||||
#### LV_MEM_SIZE
|
||||
Value: `256 * 1024U` (256 KB). Size of LVGL's internal memory pool for widget allocations and draw buffers.
|
||||
|
||||
#### LV_MEM_POOL_EXPAND_SIZE
|
||||
Value: `0`. Pool expansion is disabled; the 256 KB allocation is fixed.
|
||||
|
||||
#### LV_MEM_ADR
|
||||
Value: `0`. LVGL allocates the pool itself rather than using a fixed address.
|
||||
|
||||
### HAL Settings
|
||||
|
||||
#### LV_DEF_REFR_PERIOD
|
||||
Value: `33` (milliseconds). Targets approximately 30 frames per second.
|
||||
|
||||
#### LV_DPI_DEF
|
||||
Value: `96`. Standard screen DPI assumption.
|
||||
|
||||
### Operating System
|
||||
|
||||
#### LV_USE_OS
|
||||
Value: `LV_OS_NONE`. No OS abstraction layer; LVGL runs in a bare-metal cooperative model.
|
||||
|
||||
### Rendering Configuration
|
||||
|
||||
#### LV_USE_DRAW_SW
|
||||
Value: `1`. The software renderer is the sole rendering backend.
|
||||
|
||||
Only the color formats actually used are enabled within the software renderer:
|
||||
|
||||
| Define | Value | Description |
|
||||
|--------|-------|-------------|
|
||||
| `LV_DRAW_SW_SUPPORT_XRGB8888` | 1 | Primary framebuffer format |
|
||||
| `LV_DRAW_SW_SUPPORT_ARGB8888` | 1 | Alpha-blended surfaces |
|
||||
| `LV_DRAW_SW_SUPPORT_RGB888` | 1 | 24-bit fallback |
|
||||
| `LV_DRAW_SW_SUPPORT_RGB565` | 0 | Disabled |
|
||||
| All other formats | 0 | Disabled |
|
||||
|
||||
#### LV_DRAW_SW_COMPLEX
|
||||
Value: `1`. Enables complex draw operations (shadows, rounded corners). Shadow cache is disabled (`LV_DRAW_SW_SHADOW_CACHE_SIZE = 0`); circle cache is set to 4 entries.
|
||||
|
||||
#### LV_DRAW_LAYER_SIMPLE_BUF_SIZE
|
||||
Value: `24 * 1024` (24 KB). Buffer for simple layer rendering.
|
||||
|
||||
#### GPU Backends
|
||||
All GPU-accelerated backends are disabled: VGLite, PXP, Dave2D, SDL, VG-Lite.
|
||||
|
||||
### Logging
|
||||
|
||||
#### LV_USE_LOG
|
||||
Value: `1`. Logging is enabled at `LV_LOG_LEVEL_WARN`. Printf-based logging, timestamps, and file/line info are all disabled to reduce overhead. All trace categories (memory, timer, indev, display refresh, events, object creation, layout, animation, cache) are disabled.
|
||||
|
||||
### Assertions
|
||||
|
||||
#### LV_USE_ASSERT_NULL / LV_USE_ASSERT_MALLOC
|
||||
Value: `1`. Null-pointer and malloc-failure assertions are active.
|
||||
|
||||
#### LV_ASSERT_HANDLER
|
||||
Value: `{}` (no-op). The assert handler intentionally does nothing to avoid hanging the kernel on a failed assertion.
|
||||
|
||||
### Fonts
|
||||
|
||||
#### LV_FONT_MONTSERRAT_14
|
||||
Value: `1`. The only built-in Montserrat size enabled.
|
||||
|
||||
#### LV_FONT_DEFAULT
|
||||
Value: `&lv_font_montserrat_14`. All other Montserrat sizes (8--48), compressed variants, and alternative font families (DejaVu, SimSun, UNSCII) are disabled.
|
||||
|
||||
### Text Settings
|
||||
|
||||
#### LV_TXT_ENC
|
||||
Value: `LV_TXT_ENC_UTF8`. UTF-8 text encoding. BiDi and Arabic/Persian character support are disabled.
|
||||
|
||||
### Widgets
|
||||
|
||||
Enabled widgets: AnimImg, Arc, Bar, Button, ButtonMatrix, Checkbox, Dropdown, Image, Keyboard, Label, Line, List, MsgBox, Roller, Slider, Spinner, Switch, TextArea, Table, TabView, Win.
|
||||
|
||||
Disabled widgets: Calendar, Canvas, Chart, ImageButton, LED, Lottie, Menu, Scale, Span, SpinBox, TileView.
|
||||
|
||||
### Themes
|
||||
|
||||
#### LV_USE_THEME_DEFAULT
|
||||
Value: `1`. Dark mode enabled (`LV_THEME_DEFAULT_DARK = 1`) with 80 ms transition time.
|
||||
|
||||
#### LV_USE_THEME_SIMPLE
|
||||
Value: `1`.
|
||||
|
||||
#### LV_USE_THEME_MONO
|
||||
Value: `0`.
|
||||
|
||||
### Layouts
|
||||
|
||||
Both Flex and Grid layout engines are enabled.
|
||||
|
||||
### Third-Party Libraries
|
||||
|
||||
All filesystem drivers are disabled (stdio, POSIX, Win32, FatFS, MemFS, LittleFS). All image decoders are disabled (PNG, BMP, JPEG, GIF, RLE). FreeType, TinyTTF, Rlottie, vector graphics, LZ4, and FFmpeg are all disabled.
|
||||
|
||||
### Device Drivers
|
||||
|
||||
All platform-specific device drivers are disabled (SDL, X11, Wayland, Linux FBDEV, Linux DRM, NuttX, various SPI display controllers, Windows, OpenGLES, QNX). Display and input are handled by Asuro's own HAL layer.
|
||||
|
||||
### Examples and Demos
|
||||
|
||||
All built-in examples and demo applications are disabled.
|
||||
|
||||
## Notes
|
||||
|
||||
- The configuration is designed for minimal footprint. Features are enabled only when required by the Asuro desktop shell.
|
||||
- Since no libc is linked, all string, memory, and formatting operations fall through to LVGL's internal implementations.
|
||||
- The assert handler is a deliberate no-op to prevent the kernel from halting on non-critical UI assertion failures.
|
||||
- The 256 KB memory pool is fixed and cannot expand at runtime. UI complexity must stay within this budget.
|
||||
@@ -1 +1,55 @@
|
||||
# Placeholder
|
||||
# lv_font_fa_solid_16.c
|
||||
|
||||
LVGL bitmap font source for Font Awesome 7 Free Solid at 16 px.
|
||||
|
||||
## Overview
|
||||
|
||||
This file contains a pre-rendered bitmap font generated from the Font Awesome 7 Free Solid TrueType font (`Font Awesome 7 Free-Solid-900.ttf`) for use with LVGL. It provides a library of solid-style vector icons rendered as bitmaps, suitable for toolbar buttons, status indicators, navigation elements, and general iconography in the Asuro GUI.
|
||||
|
||||
The file was generated by the LVGL font converter tool and is approximately 35,800 lines (~1.6 MB) of static bitmap and glyph descriptor data.
|
||||
|
||||
## Configuration Options / Defines
|
||||
|
||||
### LV_FONT_FA_SOLID_16
|
||||
Value: `1` (default). Acts as a compile-time guard. Set to `0` to exclude this font from the build entirely.
|
||||
|
||||
## Font Properties
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Font family | Font Awesome 7 Free Solid 900 |
|
||||
| Size | 16 px |
|
||||
| Bits per pixel | 4 (16-level anti-aliasing) |
|
||||
| Compression | None (`--no-compress`) |
|
||||
| Stride alignment | 1 byte |
|
||||
| Data alignment | 1 byte |
|
||||
| Line height | 20 px |
|
||||
| Baseline | 4 px from bottom |
|
||||
| Underline position | 0 |
|
||||
| Underline thickness | 0 |
|
||||
| Unicode range | 0x0000--0xFFFF |
|
||||
| Subpixel rendering | None |
|
||||
|
||||
## Public Symbol
|
||||
|
||||
```c
|
||||
const lv_font_t lv_font_fa_solid_16;
|
||||
```
|
||||
|
||||
This is the font descriptor exposed for use in LVGL widget styles. Reference it as `&lv_font_fa_solid_16` when assigning icon fonts to labels or buttons. Font Awesome icons are addressed by their Unicode code points (e.g., `LV_SYMBOL_*` constants or raw `\uXXXX` escape sequences).
|
||||
|
||||
## Generation Command
|
||||
|
||||
```
|
||||
--bpp 4 --size 16 --no-compress --stride 1 --align 1 \
|
||||
--font "Font Awesome 7 Free-Solid-900.ttf" --range 0-65535 --format lvgl \
|
||||
-o lv_font_fa_solid_16.c
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- This is a machine-generated file. Do not edit by hand; regenerate using the LVGL font converter if changes are needed.
|
||||
- The full 0--65535 Unicode range includes all Font Awesome solid icons. Since most code points in this range are blank (Font Awesome only defines glyphs for its icon set), the actual rendered glyph count is much smaller than the range suggests, but the descriptor tables still consume significant space.
|
||||
- The file is the largest in the `lvglh/` directory at approximately 1.6 MB. If binary size becomes a constraint, the Unicode range should be narrowed to only the icon code points actually used by the Asuro shell.
|
||||
- The font includes version-conditional compilation guards for compatibility across LVGL 6.x through 9.x, though Asuro targets LVGL 9.2.2.
|
||||
- The `LV_ATTRIBUTE_LARGE_CONST` annotation on the glyph bitmap array allows the linker to place it in an appropriate read-only section.
|
||||
Reference in new issue
Block a user