gd32f1x0-hal

HAL for the GD32F1x0 family of microcontrollers

Quick start guide

Embedded Rust development requires a bit more setup than ordinary development.

You will also need a debug probe, for example an ST-Link V3 mini for programming and debugging. (There are many different STLink probes out there, all of them should work fine with the instructions given here, other JTAG or SWD debug probes will work as well but will need different software or configuration).

Installing software

To program your microcontroller, you need to install:

• openocd or stlink
• gdb-multiarch (on some platforms you may need to use gdb-arm-none-eabi instead, make sure to update .cargo/config to reflect this change)

Finally, you need to install arm target support for the Rust compiler. To do so, run

rustup target install thumbv7m-none-eabi

Setting up your project

Create a new Rust project as you usually do with cargo init. The hello world of embedded development is usually to blink an LED and code to do so is available in examples/blinky.rs. Copy that file to the main.rs of your project.

You also need to add some dependencies to your Cargo.toml:

[dependencies]
embedded-hal = "1.0.0"
nb = "1.1.0"
cortex-m = { version = "0.7.7", features = ["critical-section-single-core"] }
cortex-m-rt = "0.7.3"
# Panic behaviour, see https://crates.io/keywords/panic-impl for alternatives
panic-halt = "0.2.0"
gd32f1x0-hal = { version = "0.10.1", features = ["rt", "gd32f130x8"] }

If you build your project now, you should get a single error: error: language item required, but not found: eh_personality. This unhelpful error message is fixed by compiling for the right target.

We also need to tell Rust how to link our executable, and how to lay out the result in memory. To accomplish all this, copy .cargo/config and memory.x from the gd32f1x0-hal repo to your project.

cargo build

If everything went well, your project should have built without errors.

Programming the microcontroller

It is now time to actually run the code on the hardware. To do so plug your debug probe into your board and start openocd using

openocd -f interface/stlink-v3.cfg -f target/stm32f1x.cfg

If you are not using an stlink V3, change the interface accordingly. For more information, see the embeddonomicon.

If all went well, it should detect your microcontroller and say Info : stm32f1x.cpu: hardware has 6 breakpoints, 4 watchpoints. Keep it running in the background.

We will use gdb for uploading the compiled binary to the microcontroller and for debugging. Cargo will automatically start gdb thanks to the .cargo/config you added earlier. gdb also needs to be told to connect to openocd which is done by copying .gdbinit to the root of your project.

You may also need to tell gdb that it is safe to load .gdbinit from the working directory.

• Linux

  echo "set auto-load safe-path $(pwd)" >> ~/.gdbinit
  

• Windows

  echo set auto-load safe-path %CD% >> %USERPROFILE%\.gdbinit
  

If everything was successful, cargo should compile your project, start GDB, load your program and give you a prompt. If you type continue in the GDB prompt, your program should start and an LED attached to PC13 should start blinking.

Going further

From here on, you can start adding more code to your project to make it do something more interesting. For crate documentation, see docs.rs/gd32f1x0-hal. There are also a lot more examples available. If something is unclear in the docs or examples, please, open an issue and we will try to improve it.

Selecting a microcontroller

This crate supports multiple microcontrollers in the GD32F1x0 family. Which specific microcontroller you want to build for has to be specified with a feature, for example gd32f130x8.

If no microcontroller is specified, the crate will not compile.

Supported Microcontrollers

• gd32f130x4 (e.g. GD32F130F4, GD32F130G4, ...)
• gd32f130x6 (e.g. GD32F130F6, GD32F130G6, ...)
• gd32f130x8 (e.g. GD32F130F8, GD32F130G8, ...)
• gd32f150x4 (e.g. GD32F150G4, GD32F150K4, ...)
• gd32f150x6 (e.g. GD32F150G6, GD32F150K6, ...)
• gd32f150x8 (e.g. GD32F150G8, GD32F150K8, ...)
• gd32f170x4 (e.g. GD32F170T4, GD32F170C4, ...)
• gd32f170x6 (e.g. GD32F170T6, GD32F170C6, ...)
• gd32f170x8 (e.g. GD32F170T8, GD32F170C8, ...)
• gd32f190x4 (e.g. GD32F190T4, GD32F190C4, ...)
• gd32f190x6 (e.g. GD32F190T6, GD32F190C6, ...)
• gd32f190x8 (e.g. GD32F190T8, GD32F190C8, ...)

Trying out the examples

You may need to give cargo permission to call gdb from the working directory.

• Linux

  echo "set auto-load safe-path $(pwd)" >> ~/.gdbinit
  

• Windows

  echo set auto-load safe-path %CD% >> %USERPROFILE%\.gdbinit
  

Compile, load, and launch the hardware debugger.

$ rustup target add thumbv7m-none-eabi

# on another terminal
$ openocd -f interface/$INTERFACE.cfg -f target/stm32f1x.cfg

# flash and debug the "Hello, world" example. Change gd32f130x8 to match your hardware
$ cargo run --features gd32f130x8 --example hello

$INTERFACE should be set based on your debugging hardware. If you are using an stlink V2, use stlink-v2.cfg. For more information, see the embeddonomicon.

Using as a Dependency

When using this crate as a dependency in your project, the microcontroller can be specified as part of the Cargo.toml definition.

gd32f1x0-hal = { version = "0.10.1", features = ["gd32f130x8", "rt"] }

Documentation

The documentation can be found at docs.rs.

Disclaimer

This is not an officially supported Google product.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.

See the contributing guide for more details.