Experimental kernel for embedded devices written in Rust
Rust Makefile Nix Tcl
Permalink
Failed to load latest commit information.
bscheduler
linkmem
nix/rust-nightly
smalloc
src
stm32f4
tests
.gitignore
.travis.yml
Cargo.toml
LICENSE
Makefile
README.md
build.rs
isr_vector.ld
openocd.cfg
openocd.tcl
peripherals.ld
shell.nix
stm32_flash.ld
thumbv7em-none-eabi

README.md

Build Status

bkernel is an experimental kernel for embedded devices written in Rust. I'm mostly trying out Rust now to see how it applies to kernel development.

Prerequisites

Note for Nix users

There is shell.nix for you. Just drop in with nix-shell and all dependencies are there (including nightly rust).

Note: it won't work for platforms other than x86-64_linux. You should change rust-nightly hash in shell.nix.

gcc-arm-none-eabi toolchain

You need an gcc-arm-none-eabi toolchain before you can build the kernel.

If you don't know where to get one, you can get it there:

  • Download one for your platform
  • Unpack
  • Add <path_to_toolchain>/bin to your $PATH variable

Rust version

This project needs lots of nightly features:

  • inline assembly
  • intrinsics
  • lang items

Nightly builds are not backward-compatible, so only the latest version is supported (it changes every 6 weeks). That's why you need a reasonably up-to-date nightly rust.

Rust sources

bkernel needs Rust sources to build libcore for the target. If you don't have one, don't worry: it will be automatically downloaded to rust directory.

If you have Rust git repo on you computer, you can point to it with:

export RUSTDIR=/path/to/rust

Note: building bkernel will checkout rust to a commit your rustc was compiled with.

Build instructions

Just invoke make.

Make targets

  • make build all binaries, documentation and run tests;
  • make build only build kernel;
  • make test run tests;
  • make doc build documentation;
  • make flash flash kernel;
  • make reset reset the device;
  • make device_test run device tests. $DEVICE can be set to point to the device tty (defaults to /dev/ttyUSB0).

Running

After booting the kernel you should see all LEDs are turned on and a terminal is running on PB6/PB7 pins.

The following commands are supported:

  • hi - says hello
  • +3/-3/+4/-4/+5/-5/+6/-6 - turn on/off LD3/4/5/6
  • panic - throw a panic
  • help - for more commands

Device tests

There are device tests that are executed with expect. It must be installed on your system.

You must flash the device before testing.

To run device tests, execute:

make device_test

or

make device_test DEVICE=/dev/ttyUSB0

Note: device path can be different on your platform.

Issues

If you have any issues or questions with the bkernel, just open an issue or mail me at rasen.dubi@gmail.com.

License

The bkernel source code is licensed by a modified GNU General Public License - the modification taking a form of an exception. The exception permits the source code of applications that use bkernel and are distributed as executables to remain closed source, thus permitting the use of bkernel in commercial applications without necessitating that the whole application be open sourced. The exception can only be used if you wish to combine bkernel with a proprietary product, and you comply with the terms stated in the exception itself.

The full text of the bkernel license is available here.