Merge #135

135: cargo: Add support for building OpenTitan apps r=alistair23 a=alistair23

This fixes https://github.com/tock/libtock-rs/issues/134 and adds support for building OT apps,

Signed-off-by: Alistair Francis <alistair.francis@wdc.com>

Co-authored-by: Alistair Francis <alistair.francis@wdc.com>
tree: e239fbcf2991b51f0f46c1f85059f60f84ad1c53
  1. .cargo/
  2. .vscode/
  3. async-support/
  4. codegen/
  5. examples/
  6. src/
  7. .gitignore
  8. .travis.yml
  9. bors.toml
  10. build_examples.sh
  11. Cargo.toml
  12. CHANGELOG.md
  13. CONTRIBUTING.md
  14. hail_layout.ld
  15. layout.ld
  16. LICENSE-APACHE
  17. LICENSE-MIT
  18. nrf52840_layout.ld
  19. nrf52_layout.ld
  20. opentitan_layout.ld
  21. README.md
  22. riscv32_layout.ld
  23. run_all_checks.sh
  24. run_example.sh
  25. run_hardware_test.sh
  26. rust-toolchain
  27. rustfmt.toml
README.md

Build Status

libtock-rs

Rust userland library for Tock (WIP)

Tested with tock Release 1.4.1.

The library works in principle on most boards, but there is currently the showstopper bug #28 that prevents the generation of relocatable code. This means that all applications must be installed at the flash address they are compiled with, which usually means that they must be compiled especially for your board and that there can only be one application written in rust at a time and it must be installed as the first application on the board, unless you want to play games with linker scripts. There are some *_layout.ld files provided that allow to run the examples on common boards. Due to MPU region alignment issues they may not work for applications that use a lot of RAM, in that case you may have to change the SRAM start address to fit your application.

Getting Started

This project is nascent and still under heavy development, but first steps:

  1. Ensure you have rustup installed.

  2. Clone the repository.

    git clone https://github.com/tock/libtock-rs
    cd libtock-rs
    
  3. Install elf2tab.

    cargo install -f elf2tab --version 0.4.0
    
  4. Add dependencies for cross-compilation.

    rustup target add thumbv7em-none-eabi
    
  5. Use the run_example script to compile and run the example app you want to use:

    ./run_example.sh blink
    

    Due to bug #28 this will currently only work if you are using the nRF52-DK platform.

    If you have a nRF52840-DK you must change link-arg=-Tnrf52_layout.ld in .cargo/config to link-arg=-Tnrf52840_layout.ld

    If you have a hail board you can flash your device as follows:

    • set the environment variable hail to 1
    • change link-arg=-Tnrf52_layout.ld in .cargo/config to link-arg=-Thail_layout.ld
    • run run_example.sh as above.

    For other platforms, you may have to create your own memory layout definition.

Using libtock-rs

The easiest way to start using libtock-rs is adding an example to the examples folder. The boiler plate code you would write is

#![no_std]

use libtock::result::TockResult;

#[libtock::main]
async fn main() -> TockResult<()> {
  // Your code
}

If you want to use heap based allocation you will have to add

extern crate alloc;

to the preamble.

To run on the code on your board you can use

./run_example.sh <your app>

This script does the following steps for you:

  • cross-compile your program
  • create a TAB (tock application bundle)
  • if you have a nRF52-DK board connected: flash this TAB to your board (using tockloader)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

The contribution guidelines can be found here: contribution guidelines