Struct vexide_startup::ColdHeader

#[repr(C, packed(1))]
pub struct ColdHeader {
    pub magic: [u8; 4],
    pub program_type: u32,
    pub owner: u32,
    pub padding: [u32; 2],
    pub options: u32,
}

The cold header is a structure that is placed at the beginning of cold memory and tells VexOS details abuot the program.

Fields

magic: [u8; 4]

The magic number for the cold header. This should always be “XVX5”.

program_type: u32

The program type. PROS sets this to 0.

owner: u32

The owner of the program. PROS sets this to 2.

padding: [u32; 2]

Padding before the options.

options: u32

A bitfield of program options that change the behavior of some jumptable functions.

Implementations

impl ColdHeader

pub const fn new(program_type: u32, owner: u32, options: u32) -> Self

Creates a new cold header with the correct magic number and options.

Examples found in repository

examples/booting.rs (line 29)

static COLD_HEADER: vexide_startup::ColdHeader = vexide_startup::ColdHeader::new(2, 0, 0);