mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-19 09:00:54 +00:00
light refactoring of kernel arguments structure
this is a fairly complicated bit of legacy code that we're trying to make slightly better/more readable. some docs are added, as well as getting rid of a bunch of "magic" constants, instead preferring to map things into structured data where possible. also fixed the location of the heap allocation relative to the boot flow. It's now in a spot where I think we can safely put dynamically allocated kernel arguments.
This commit is contained in:
parent
76e22e3d0a
commit
e1537328fa
4 changed files with 104 additions and 54 deletions
|
|
@ -8,11 +8,42 @@ macro_rules! make_type {
|
||||||
}};
|
}};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
/// This is a representation of tag data *on disk*. It can be located at any 4-byte
|
||||||
|
/// alignment within the argument list.
|
||||||
|
pub struct Tag {
|
||||||
|
/// Ascii-printable name, not null-terminated, in little endian format.
|
||||||
|
pub tag: u32,
|
||||||
|
|
||||||
|
/// CRC16 of the data section, using CCITT polynomial.
|
||||||
|
pub crc16: u16,
|
||||||
|
|
||||||
|
/// Size of the data section, in 4-byte words.
|
||||||
|
pub size: u16,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
pub struct XargArg {
|
||||||
|
tag: Tag,
|
||||||
|
/// Full length of the entire argument structure (not just this argument)
|
||||||
|
/// reported in units of u32.
|
||||||
|
arg_size_u32: u32,
|
||||||
|
version: u32,
|
||||||
|
ram_start: u32,
|
||||||
|
ram_size: u32,
|
||||||
|
ram_name: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// KernelArguments is a self-extracting structure which handles variable-length fields
|
||||||
|
/// that only needs a pointer to its start to derive the rest of its structure.
|
||||||
#[derive(Clone, Copy)]
|
#[derive(Clone, Copy)]
|
||||||
pub struct KernelArguments {
|
pub struct KernelArguments {
|
||||||
pub base: *const u32,
|
pub base: *const u32,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The arguments iterator is constructed by reading into kernel arguments structure, assuming
|
||||||
|
/// it is a well-formed structure where the first meta-tag is placed correctly, allowing the
|
||||||
|
/// extraction of a `size` field.
|
||||||
pub struct KernelArgumentsIterator {
|
pub struct KernelArgumentsIterator {
|
||||||
base: *const u32,
|
base: *const u32,
|
||||||
size: usize,
|
size: usize,
|
||||||
|
|
@ -27,11 +58,24 @@ impl KernelArguments {
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn size(self) -> usize {
|
pub fn size(self) -> usize {
|
||||||
let s = unsafe { self.base.add(2).read() * 4 };
|
// Add a rudimentary check to make sure that KernelArguments are pointed to the correct
|
||||||
s as usize
|
// structure, by checking for the right magic number in the first field.
|
||||||
|
let tag = unsafe { (self.base as *const Tag).as_ref().unwrap() };
|
||||||
|
if tag.tag != u32::from_le_bytes(*b"XArg") {
|
||||||
|
crate::println!("FATAL: Couldn't find XArg magic number on kernel tags.");
|
||||||
|
panic!(); // nothing we can do to repair this defect.
|
||||||
|
}
|
||||||
|
let xarg_tag = unsafe { (self.base as *const XargArg).as_ref().unwrap() };
|
||||||
|
xarg_tag.arg_size_u32 as usize * size_of::<u32>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// KernelArgument is a stack-allocated structure that describes a pointer to tagged data.
|
||||||
|
/// It effectively decompressed the tag name + size field and converts the embedded variable-length
|
||||||
|
/// data into a slice.
|
||||||
|
///
|
||||||
|
/// It is constructed by referring to the base of the tag structure, and then providing an
|
||||||
|
/// offset. The base + offset should point to the top of a Tag structure.
|
||||||
pub struct KernelArgument {
|
pub struct KernelArgument {
|
||||||
pub name: u32,
|
pub name: u32,
|
||||||
|
|
||||||
|
|
@ -44,10 +88,15 @@ pub struct KernelArgument {
|
||||||
|
|
||||||
impl KernelArgument {
|
impl KernelArgument {
|
||||||
pub fn new(base: *const u32, offset: u32) -> Self {
|
pub fn new(base: *const u32, offset: u32) -> Self {
|
||||||
let name = unsafe { base.add(offset as usize / 4).read() };
|
let tag = unsafe { (base.add(offset as usize / size_of::<u32>()) as *const Tag).as_ref().unwrap() };
|
||||||
let size = unsafe { (base.add(offset as usize / 4 + 1) as *const u16).add(1).read() } as u32;
|
let name = tag.tag;
|
||||||
let data = unsafe { core::slice::from_raw_parts(base.add(offset as usize / 4 + 2), size as usize) };
|
let size = tag.size as u32;
|
||||||
KernelArgument { name, size: size * 4, data }
|
// adding 1 to the tag yields the address immediately after the tag data.
|
||||||
|
let data =
|
||||||
|
unsafe { core::slice::from_raw_parts((tag as *const Tag).add(1) as *const u32, size as usize) };
|
||||||
|
// Return the stack-allocated KernelArgument, which embeds a reference to the now base/bounds
|
||||||
|
// protected data slice.
|
||||||
|
KernelArgument { name, size: size * size_of::<u32>() as u32, data }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -107,6 +107,13 @@ const SDBG: bool = false; // swap debug
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod test;
|
mod test;
|
||||||
|
|
||||||
|
#[global_allocator]
|
||||||
|
#[cfg(feature = "swap")]
|
||||||
|
static ALLOCATOR: linked_list_allocator::LockedHeap = linked_list_allocator::LockedHeap::empty();
|
||||||
|
// just a small heap, big enough for us to use alloc to simplify argument processing
|
||||||
|
#[cfg(feature = "swap")]
|
||||||
|
const HEAP_LEN: usize = 4096;
|
||||||
|
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub struct MemoryRegionExtra {
|
pub struct MemoryRegionExtra {
|
||||||
start: u32,
|
start: u32,
|
||||||
|
|
@ -160,29 +167,6 @@ pub unsafe extern "C" fn rust_entry(signed_buffer: *const usize, signature: u32)
|
||||||
loop {}
|
loop {}
|
||||||
};
|
};
|
||||||
|
|
||||||
#[cfg(feature = "bao1x")]
|
|
||||||
{
|
|
||||||
use bao1x_api::signatures::FunctionCode;
|
|
||||||
// validate using the bao1x signature scheme
|
|
||||||
match bao1x_hal::sigcheck::validate_image(
|
|
||||||
bao1x_api::KERNEL_START as *const u32,
|
|
||||||
bao1x_api::LOADER_START as *const u32,
|
|
||||||
bao1x_api::LOADER_REVOCATION_OFFSET,
|
|
||||||
&[
|
|
||||||
FunctionCode::Kernel as u32,
|
|
||||||
FunctionCode::UpdatedKernel as u32,
|
|
||||||
FunctionCode::Developer as u32,
|
|
||||||
],
|
|
||||||
false,
|
|
||||||
) {
|
|
||||||
Ok(k) => println!("Kernel signature check by key @ {} OK", k),
|
|
||||||
Err(e) => {
|
|
||||||
println!("Kernel failed signature check. Dying: {:?}", e);
|
|
||||||
bao1x_hal::sigcheck::die_no_std();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(all(feature = "vexii-test", not(feature = "verilator-only")))]
|
#[cfg(all(feature = "vexii-test", not(feature = "verilator-only")))]
|
||||||
{
|
{
|
||||||
// fake the prehash
|
// fake the prehash
|
||||||
|
|
@ -262,9 +246,6 @@ fn boot_sequence(args: KernelArguments, _signature: u32, fs_prehash: [u8; 64], _
|
||||||
// Store the initial boot config on the stack. We don't know
|
// Store the initial boot config on the stack. We don't know
|
||||||
// where in heap this memory will go.
|
// where in heap this memory will go.
|
||||||
#[allow(clippy::cast_ptr_alignment)] // This test only works on 32-bit systems
|
#[allow(clippy::cast_ptr_alignment)] // This test only works on 32-bit systems
|
||||||
#[cfg(feature = "platform-tests")]
|
|
||||||
platform::platform_tests();
|
|
||||||
|
|
||||||
let mut cfg = BootConfig { base_addr: args.base as *const usize, args, ..Default::default() };
|
let mut cfg = BootConfig { base_addr: args.base as *const usize, args, ..Default::default() };
|
||||||
#[cfg(feature = "swap")]
|
#[cfg(feature = "swap")]
|
||||||
println!("Size of BootConfig: {:x}", core::mem::size_of::<BootConfig>());
|
println!("Size of BootConfig: {:x}", core::mem::size_of::<BootConfig>());
|
||||||
|
|
@ -285,10 +266,34 @@ fn boot_sequence(args: KernelArguments, _signature: u32, fs_prehash: [u8; 64], _
|
||||||
println!("No suspend marker found, doing a cold boot!");
|
println!("No suspend marker found, doing a cold boot!");
|
||||||
#[cfg(feature = "simulation-only")]
|
#[cfg(feature = "simulation-only")]
|
||||||
println!("Configured for simulation. Skipping RAM clear!");
|
println!("Configured for simulation. Skipping RAM clear!");
|
||||||
#[cfg(not(any(feature = "bao1x")))]
|
|
||||||
// bao1x target clears RAM with assembly routine on boot
|
|
||||||
clear_ram(&mut cfg);
|
clear_ram(&mut cfg);
|
||||||
phase_1(&mut cfg);
|
phase_1(&mut cfg);
|
||||||
|
|
||||||
|
#[cfg(feature = "bao1x")]
|
||||||
|
{
|
||||||
|
// this is the soonest we can run the image validation because we need to
|
||||||
|
// have the heap setup first.
|
||||||
|
use bao1x_api::signatures::FunctionCode;
|
||||||
|
// validate using the bao1x signature scheme
|
||||||
|
match bao1x_hal::sigcheck::validate_image(
|
||||||
|
bao1x_api::KERNEL_START as *const u32,
|
||||||
|
bao1x_api::LOADER_START as *const u32,
|
||||||
|
bao1x_api::LOADER_REVOCATION_OFFSET,
|
||||||
|
&[
|
||||||
|
FunctionCode::Kernel as u32,
|
||||||
|
FunctionCode::UpdatedKernel as u32,
|
||||||
|
FunctionCode::Developer as u32,
|
||||||
|
],
|
||||||
|
false,
|
||||||
|
) {
|
||||||
|
Ok(k) => println!("*** Kernel signature check by key @ {} OK ***", k),
|
||||||
|
Err(e) => {
|
||||||
|
println!("Kernel failed signature check. Dying: {:?}", e);
|
||||||
|
bao1x_hal::sigcheck::die_no_std();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
phase_2(&mut cfg, &fs_prehash);
|
phase_2(&mut cfg, &fs_prehash);
|
||||||
#[cfg(any(feature = "debug-print", feature = "swap"))]
|
#[cfg(any(feature = "debug-print", feature = "swap"))]
|
||||||
if VDBG || SDBG {
|
if VDBG || SDBG {
|
||||||
|
|
@ -647,7 +652,7 @@ fn check_resume(cfg: &mut BootConfig) -> (bool, bool, u32) {
|
||||||
/// Clears all of RAM. This is a must for systems that have suspend-to-RAM for security.
|
/// Clears all of RAM. This is a must for systems that have suspend-to-RAM for security.
|
||||||
/// It is configured to be skipped in simulation only, to accelerate the simulation times
|
/// It is configured to be skipped in simulation only, to accelerate the simulation times
|
||||||
/// since we can initialize the RAM to zero in simulation.
|
/// since we can initialize the RAM to zero in simulation.
|
||||||
#[cfg(all(not(feature = "simulation-only"), not(feature = "bao1x")))]
|
#[cfg(all(not(feature = "simulation-only")))]
|
||||||
fn clear_ram(cfg: &mut BootConfig) {
|
fn clear_ram(cfg: &mut BootConfig) {
|
||||||
// clear RAM on a cold boot.
|
// clear RAM on a cold boot.
|
||||||
// RAM is persistent and battery-backed. This means secret material could potentially
|
// RAM is persistent and battery-backed. This means secret material could potentially
|
||||||
|
|
@ -655,7 +660,7 @@ fn clear_ram(cfg: &mut BootConfig) {
|
||||||
// to a cold boot, but it's probably worth it. Note that it doesn't happen on a suspend/resume.
|
// to a cold boot, but it's probably worth it. Note that it doesn't happen on a suspend/resume.
|
||||||
let ram: *mut u32 = cfg.sram_start as *mut u32;
|
let ram: *mut u32 = cfg.sram_start as *mut u32;
|
||||||
#[cfg(feature = "swap")]
|
#[cfg(feature = "swap")]
|
||||||
let clear_limit = ((2 * 4096 + core::mem::size_of::<BootConfig>()) + 4095) & !4095;
|
let clear_limit = GUARD_MEMORY_BYTES;
|
||||||
#[cfg(not(feature = "swap"))]
|
#[cfg(not(feature = "swap"))]
|
||||||
let clear_limit = ((4096 + core::mem::size_of::<BootConfig>()) + 4095) & !4095;
|
let clear_limit = ((4096 + core::mem::size_of::<BootConfig>()) + 4095) & !4095;
|
||||||
if VDBG {
|
if VDBG {
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,20 @@ pub fn phase_1(cfg: &mut BootConfig) {
|
||||||
cfg.init_size += GUARD_MEMORY_BYTES;
|
cfg.init_size += GUARD_MEMORY_BYTES;
|
||||||
println!("Loader runtime stack should not exceed: {:x}", cfg.get_top() as usize);
|
println!("Loader runtime stack should not exceed: {:x}", cfg.get_top() as usize);
|
||||||
|
|
||||||
|
// Initialize the allocator with heap memory range
|
||||||
|
#[cfg(any(feature = "bao1x", feature = "swap"))]
|
||||||
|
{
|
||||||
|
crate::println!(
|
||||||
|
"Setting up heap @ {:x}-{:x}",
|
||||||
|
cfg.get_top() as usize,
|
||||||
|
cfg.get_top() as usize + HEAP_LEN
|
||||||
|
);
|
||||||
|
cfg.init_size += HEAP_LEN;
|
||||||
|
unsafe {
|
||||||
|
ALLOCATOR.lock().init(cfg.get_top() as *mut u8, HEAP_LEN);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// The first region is defined as being "main RAM", which will be used
|
// The first region is defined as being "main RAM", which will be used
|
||||||
// to keep track of allocations.
|
// to keep track of allocations.
|
||||||
println!("Allocating regions");
|
println!("Allocating regions");
|
||||||
|
|
|
||||||
|
|
@ -5,9 +5,6 @@ use bao1x_hal::iox::Iox;
|
||||||
use bao1x_hal::udma;
|
use bao1x_hal::udma;
|
||||||
use utralib::generated::*;
|
use utralib::generated::*;
|
||||||
|
|
||||||
#[global_allocator]
|
|
||||||
static ALLOCATOR: linked_list_allocator::LockedHeap = linked_list_allocator::LockedHeap::empty();
|
|
||||||
|
|
||||||
// Notes about the reset vector location
|
// Notes about the reset vector location
|
||||||
// This can be set using fuses in the IFR (also called 'info') region
|
// This can be set using fuses in the IFR (also called 'info') region
|
||||||
// The offset is an 8-bit value, which is shifted into a final location
|
// The offset is an 8-bit value, which is shifted into a final location
|
||||||
|
|
@ -29,10 +26,6 @@ pub const FLASH_BASE: usize = utralib::generated::HW_RERAM_MEM;
|
||||||
// location of kernel, as offset from the base of RRAM.
|
// location of kernel, as offset from the base of RRAM.
|
||||||
pub const KERNEL_OFFSET: usize = bao1x_api::offsets::KERNEL_START - utralib::generated::HW_RERAM_MEM;
|
pub const KERNEL_OFFSET: usize = bao1x_api::offsets::KERNEL_START - utralib::generated::HW_RERAM_MEM;
|
||||||
|
|
||||||
const DATA_SIZE_BYTES: usize = 0x6000;
|
|
||||||
pub const HEAP_START: usize = RAM_BASE + DATA_SIZE_BYTES;
|
|
||||||
pub const HEAP_LEN: usize = 1024 * 256;
|
|
||||||
|
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
pub fn delay(quantum: usize) {
|
pub fn delay(quantum: usize) {
|
||||||
use utralib::{CSR, utra};
|
use utralib::{CSR, utra};
|
||||||
|
|
@ -138,23 +131,12 @@ pub fn early_init_hw() -> u32 {
|
||||||
glbl_csr.wo(utra::sce_glbsfr::SFR_FFEN, 0x30);
|
glbl_csr.wo(utra::sce_glbsfr::SFR_FFEN, 0x30);
|
||||||
glbl_csr.wo(utra::sce_glbsfr::SFR_FFCLR, 0xff05);
|
glbl_csr.wo(utra::sce_glbsfr::SFR_FFCLR, 0xff05);
|
||||||
|
|
||||||
setup_alloc();
|
|
||||||
|
|
||||||
// this should go to the serial console, because boot1 setup the console for us
|
// this should go to the serial console, because boot1 setup the console for us
|
||||||
crate::println!("\n\r~~ Xous Loader ~~\n\r");
|
crate::println!("\n\r~~ Xous Loader ~~\n\r");
|
||||||
|
|
||||||
perclk
|
perclk
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn setup_alloc() {
|
|
||||||
// Initialize the allocator with heap memory range
|
|
||||||
crate::println!("Setting up heap @ {:x}-{:x}", HEAP_START, HEAP_START + HEAP_LEN);
|
|
||||||
crate::println!("Stack @ {:x}-{:x}", HEAP_START + HEAP_LEN, RAM_BASE + RAM_SIZE);
|
|
||||||
unsafe {
|
|
||||||
ALLOCATOR.lock().init(HEAP_START as *mut u8, HEAP_LEN);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns the actual per_clk
|
// returns the actual per_clk
|
||||||
#[cfg(not(feature = "simulation-only"))]
|
#[cfg(not(feature = "simulation-only"))]
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue