Rust support for the VA416xx family of MCUs
Go to file
Robin Müller 5b23024108
All checks were successful
Rust/va416xx-rs/pipeline/head This commit looks good
Merge pull request 'add additional memory section' (#10) from add-sram1-mem-section into main
Reviewed-on: #10
2024-06-25 19:44:52 +02:00
.cargo smaller fixes for config files 2024-06-12 11:51:22 +02:00
.github/workflows update CI as well 2024-06-25 16:12:09 +02:00
automation update CI as well 2024-06-25 16:12:09 +02:00
examples/simple timer, PWM and I2C module 2024-06-25 09:57:37 +02:00
jlink update JLink files 2024-06-22 18:37:51 +02:00
scripts update VA416xx flash script file 2024-06-12 13:54:00 +02:00
va416xx updates for documentation 2024-06-25 16:10:17 +02:00
va416xx-hal Add CI badge 2024-06-25 16:34:53 +02:00
vorago-peb1 updates for documentation 2024-06-25 16:10:17 +02:00
vscode timer, PWM and I2C module 2024-06-25 09:57:37 +02:00
.gitignore init commit 2024-06-12 11:48:13 +02:00
.gitmodules init commit 2024-06-12 11:48:13 +02:00
Cargo.toml smaller workspace file tweaks 2024-06-20 20:04:05 +02:00
jlink-gdb.sh init commit 2024-06-12 11:48:13 +02:00
LICENSE-APACHE init commit 2024-06-12 11:48:13 +02:00
memory.x add additional memory section 2024-06-25 17:53:53 +02:00
NOTICE init commit 2024-06-12 11:48:13 +02:00
README.md Add CI badge 2024-06-25 16:34:53 +02:00

build

Vorago VA416xx Rust Support

This crate collection provided support to write Rust applications for the VA416XX family of devices.

List of crates

This workspace contains the following crates:

  • The va416xx PAC crate containing basic low-level register definition
  • The va416xx-hal HAL crate containing higher-level abstractions on top of the PAC register crate.
  • The vorago-peb1 BSP crate containing support for the PEB1 development board.

It also contains the following helper crates:

  • The examples crates contains various example applications for the HAL and the PAC.

Using the .cargo/config.toml file

Use the following command to have a starting config.toml file

cp .cargo/def-config.toml .cargo/config.toml

You then can adapt the config.toml to your needs. For example, you can configure runners to conveniently flash with cargo run.

Using the sample VS Code files

Use the following command to have a starting configuration for VS Code:

cp -rT vscode .vscode

You can then adapt the files in .vscode to your needs.

Flashing, running and debugging the software

You can use CLI or VS Code for flashing, running and debugging. In any case, take care of installing the pre-requisites first.

Pre-Requisites

  1. SEGGER J-Link tools installed
  2. gdb-multiarch or similar cross-architecture debugger installed. All commands here assume gdb-multiarch.

Using CLI

You can build the blinky example application with the following command

cargo build --example blinky

Start the GDB server first. The server needs to be started with a certain configuration and with a JLink script to disable ROM protection. For example, on Debian based system the following command can be used to do this (this command is also run when running the jlink-gdb.sh script)

JLinkGDBServer -select USB -device Cortex-M4 -endian little -if SWD -speed 2000 \
  -LocalhostOnly -vd -jlinkscriptfile ./jlink/JLinkSettings.JLinkScript

After this, you can flash and debug the application with the following command

gdb-mutliarch -q -x jlink/jlink.gdb target/thumbv7em-none-eabihf/debug/examples/blinky

Please note that you can automate all steps except starting the GDB server by using a cargo runner configuration, for example with the following lines in your .cargo/config.toml file:

[target.'cfg(all(target_arch = "arm", target_os = "none"))']
runner = "gdb-multiarch -q -x jlink/jlink.gdb"

After that, you can simply use cargo run --example blinky to flash the blinky example.

Using VS Code

Assuming a working debug connection to your VA108xx board, you can debug using VS Code with the Cortex-Debug plugin.

Some sample configuration files for VS code were provided and can be used by running cp -rT vscode .vscode like specified above. After that, you can use Run and Debug to automatically rebuild and flash your application.

If you would like to use a custom GDB application, you can specify the gdb binary in the following configuration variables in your settings.json:

  • "cortex-debug.gdbPath"
  • "cortex-debug.gdbPath.linux"
  • "cortex-debug.gdbPath.windows"
  • "cortex-debug.gdbPath.osx"

The provided VS Code configurations also provide an integrated RTT logger, which you can access via the terminal at RTT Ch:0 console.