xous-core/kernel
Jean-Pierre De Jesus DIAZ b334e5bc31
kernel: Split debug shell and uart driver.
I've added a `platform` module to store all platform specific code, (not
architecture specific) as some platforms will require custom drivers, e.g.
for debug output and for the random number generation code.  The platform
code is in charge of mapping any peripherals needed to work, also to
initialize any other parts of the kernel that require drivers, for example
the debug shell.

Signed-off-by: Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
2022-11-02 14:30:31 +01:00
..
.vscode vscode: specify platform for vscode support 2021-08-06 17:51:47 +08:00
bin kernel: compatibility with riscv32imac-unknown-xous-elf 2021-08-18 18:14:24 +08:00
src kernel: Split debug shell and uart driver. 2022-11-02 14:30:31 +01:00
assemble.ps1 kernel: compatibility with riscv32imac-unknown-xous-elf 2021-08-18 18:14:24 +08:00
assemble.sh Switch to using env to find the path to bash. 2022-03-28 16:43:47 -06:00
build.rs xous: Use CARGO_CFG_TARGET_OS in build scripts. 2022-10-12 19:03:46 +02:00
Cargo.toml fix dangling kernel dep 2022-10-25 23:08:50 +08:00
link.x kernel: compatibility with riscv32imac-unknown-xous-elf 2021-08-18 18:14:24 +08:00
README.md adding license info to README 2021-01-25 14:57:39 +01:00

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.

  1. 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.
  2. Get Rust. Go to https://rustup.rs/ and follow its instructions.
  3. Install the proper toolchain: rustup target add ${target_arch}
  4. 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

Contributor Covenant

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

Copyright © 2020

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