mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-15 08:30:02 +00:00
Add an aligned bio_code macro
This macro introduces page-level padding around the BIO code regions, so that the rust assembler/linker computes relative offsets correctly. This is necessary for code that is autogenerated from C that uses `statics` It's not recommended to be used *everywhere* because even tiny BIO snippets of a few bytes would be blow up to 4k each.
This commit is contained in:
parent
a97675592c
commit
29437c1ae8
1 changed files with 49 additions and 4 deletions
|
|
@ -32,8 +32,7 @@ pub trait BioApi<'a> {
|
|||
fn init_core(
|
||||
&mut self,
|
||||
core: BioCore,
|
||||
code: &[u8],
|
||||
offset: usize,
|
||||
code: (&[u8], Option<u32>),
|
||||
config: CoreConfig,
|
||||
) -> Result<Option<u32>, BioError>;
|
||||
|
||||
|
|
@ -116,15 +115,18 @@ pub trait BioApi<'a> {
|
|||
/// The macro is unable to derive names of functions or identifiers for labels
|
||||
/// due to the partially hygienic macro rules of Rust, so you have to come
|
||||
/// up with a list of unique names by yourself.
|
||||
///
|
||||
/// The macro has a convenience routine that returns a tuple of `(&[u8], None)`. The
|
||||
/// pad word specifier for this macro is always `None`.
|
||||
macro_rules! bio_code {
|
||||
($fn_name:ident, $name_start:ident, $name_end:ident, $($item:expr),*) => {
|
||||
pub fn $fn_name() -> &'static [u8] {
|
||||
pub fn $fn_name() -> (&'static [u8], Option<u32>) {
|
||||
extern "C" {
|
||||
static $name_start: *const u8;
|
||||
static $name_end: *const u8;
|
||||
}
|
||||
// skip the first 4 bytes, as they contain the loading offset
|
||||
unsafe { core::slice::from_raw_parts($name_start.add(4), ($name_end as usize) - ($name_start as usize) - 4)}
|
||||
(unsafe { core::slice::from_raw_parts($name_start.add(4), ($name_end as usize) - ($name_start as usize) - 4)}, None)
|
||||
}
|
||||
|
||||
core::arch::global_asm!(
|
||||
|
|
@ -142,6 +144,47 @@ macro_rules! bio_code {
|
|||
};
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
/// Same as `bio_code` except this forces the block to be aligned to 4096 byte boundaries.
|
||||
/// The main utility of this is that labels for loads/stores are correct (modulo the 4-byte header,
|
||||
/// which is fixed by replacing it with a NOP).
|
||||
///
|
||||
/// Code that only contains relative jumps should *not* use this because it ends up wasting 4096 bytes
|
||||
/// in the executable, which really adds up if you have a whole bunch of small 64-byte-ish BIO snippets
|
||||
/// in a library and you're throwing away 4000 bytes of padding per routine.
|
||||
///
|
||||
/// In particular: this macro was designed to accommodate specifically C-compiled code that uses `static`
|
||||
/// variables to reference tables compiled into the code, which invokes absolute addressing.
|
||||
///
|
||||
/// The macro has a convenience routine that returns a tuple of `(&[u8], Some(0x33))`. The
|
||||
/// pad word specifier is a NOP, that is used to replace the identifier that place-holds the offset
|
||||
/// of the code in the ROM image, such that the copied code to BIO RAM has the same page-level offset.
|
||||
macro_rules! bio_code_aligned {
|
||||
($fn_name:ident, $name_start:ident, $name_end:ident, $($item:expr),*) => {
|
||||
pub fn $fn_name() -> (&'static [u8], Option<u32>) {
|
||||
extern "C" {
|
||||
static $name_start: *const u8;
|
||||
static $name_end: *const u8;
|
||||
}
|
||||
// skip the first 4 bytes, as they contain the loading offset
|
||||
(unsafe { core::slice::from_raw_parts($name_start.add(4), ($name_end as usize) - ($name_start as usize) - 4)}, Some(0x33))
|
||||
}
|
||||
|
||||
core::arch::global_asm!(
|
||||
".option arch, +m",
|
||||
".align 12",
|
||||
concat!(".globl ", stringify!($name_start)),
|
||||
concat!(stringify!($name_start), ":"),
|
||||
".word .",
|
||||
$($item),*
|
||||
, ".align 4",
|
||||
concat!(".globl ", stringify!($name_end)),
|
||||
concat!(stringify!($name_end), ":"),
|
||||
".word .",
|
||||
);
|
||||
};
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, num_derive::FromPrimitive, num_derive::ToPrimitive)]
|
||||
pub enum BioOp {
|
||||
InitCore,
|
||||
|
|
@ -179,9 +222,11 @@ pub enum BioOp {
|
|||
pub struct CoreInitRkyv {
|
||||
pub core: BioCore,
|
||||
pub offset: usize,
|
||||
pub pad_word: Option<u32>,
|
||||
pub actual_freq: Option<u32>,
|
||||
pub config: CoreConfig,
|
||||
pub code: [u8; 4096],
|
||||
pub code_len: usize,
|
||||
pub result: BioError,
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue