mirror of https://github.com/saymrwulf/xous-core.git synced 2026-11-04 04:27:34 +00:00

History

bunnie dfd82c94b8 refactor write page syscall for explicitly managed writing this is a much simpler, race condition-free version of flash writing which has the penalty of requiring a copy of the page to be made by the caller before the write. However the copy is mostly already paid for because on the initial access to the page, we had to copy the flash into RAM.		2025-05-18 04:23:53 +08:00
..
bin
src	refactor write page syscall for explicitly managed writing	2025-05-18 04:23:53 +08:00
test	add a target for the kernel specifically on the boards	2025-05-06 19:09:37 +08:00
assemble.ps1
assemble.sh
build.rs
Cargo.toml	republish xous-rs to fix cargo test	2025-05-11 15:36:17 +08:00
link.x
README.md

README.md

Xous Kernel

This contains the core kernel for Xous. It requires a stage 1 loader in order to start up, as it assumes the system is already running in Supervisor mode.

Building

To build the kernel, you will need a riscv32 target for Rust. Possible targets include riscv32i-unknown-none-elf, riscv32imac-unknown-none-elf, or riscv32imac-unknown-xous-elf.

Decide what target you want. For simple, embedded systems this could be riscv32i-unknown-none-elf, and for more complex systems with compressed instructions you could use riscv32imac-unknown-none-elf.
Get Rust. Go to https://rustup.rs/ and follow its instructions.
Install the proper toolchain: rustup target add ${target_arch}
Build the kernel: cargo build --release --target ${target_arch}

Using

To use the kernel, you must package it up into an arguments binary with xous-tools.

Testing

TBD

Contribution Guidelines

Please see CONTRIBUTING for details on how to make a contribution.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide its terms.

License

This project is licensed under the Apache License 2.0 LICENSE. For accurate information, please check individual files.