ominitay / zigvale

A Zig implementation of the stivale2 boot protocol

Zigvale

Zigvale is a Zig implementation of the stivale2 boot protocol to be used both in kernels and bootloaders. The specification, along with C header files, may be found here.

Example

Visit zigvale-barebones for a bare-bones kernel demonstrating how to use Zigvale.

Add to your project

Zigvale is available on aquila, zpm, and astrolabe.

Gyro

gyro add ominitay/zigvale

Zigmod

Aquila

zigmod aq add 1/Ominitay/zigvale

ZPM

zigmod zpm add zigvale

ZKG

zkg add zigvale

Git

Submodule

git submodule add https://github.com/ominitay/zigvale zigvale

Clone

git clone https://github.com/ominitay/zigvale

Documentation

To generate documentation, run zig build docs

Zig's documentation generator is experimental and incomplete. When documentation generation has improved somewhat, I will host the documentation. In the meantime, you may both read the comments made manually, and read the documentation in the stivale repository.

zigvale's Issues

Spelling mistake

th4e should be the

zigvale/src/stivale2.zig

Line 306 in 779e0cf

/// This tag tells the kernel that th4e PMR flag in the header was recognised and that the kernel has been

Missing `Kernel base address structure tag`

This bootloader to kernel tag is missing: https://github.com/stivale/stivale/blob/master/STIVALE2.md#kernel-base-address-structure-tag

`Header.entry_point` incorrect default value

The default value of Header.entry_point should be null

zigvale/src/stivale2.zig

Line 44 in 1a112c1

entry_point: ?fn (*const Struct) callconv(.C) noreturn = 0,

./deps/zigvale/src/stivale2.zig:44:62: error: expected type 'fn(*const .zigvale.src.stivale2.Struct) callconv(.C) noreturn', found 'comptime_int'
    entry_point: ?fn (*const Struct) callconv(.C) noreturn = 0,
                                                             ^

Missing bits in Stivale2 header

the bits for fully virtual kernel mappings (3) and not failing to boot if low memory area could not be allocated (4, should always be set) don't exist in the Header struct

`u1` instead of `bool`

Is there any reason why you have prefered to use u1 instead of bool in packed structs?

Basic hello world example

I'm trying to make a basic kernel that just prints "Hello World" to the terminal, but nothing is printed to the screen. Is there anywhere I can find an example of the proper usage of this library?

Pointer Issues

Pointers are different lengths depending on whether memory addresses are 64 or 32-bits long. This will cause the library to fail on non-64 bit architectures, as the sizes of structs will change. To get around this, pointers should be stored as a u64, and then cast into the correct pointer type.