sourcebox / rtt-log-rs

Rust crate providing a log facade implementation for the Segger RTT protocol.

rtt-log

This Rust crate provides a log facade implementation for the Segger RTT protocol supported by the J-Link, ST-Link and other debug probes. It currently supports ARM Cortex-M and RISC-V targets via the rtt-target crate.

Usage

// Init the logger with maximum level (Trace).
rtt_log::init();

// Alternatively, init the logger with specific level.
rtt_log::init_with_level(log::LevelFilter::Debug);

// Log something.
log::debug!("Application started");

Note:

RTT uses a global symbol _SEGGER_RTT that can only appear once in a compiled binary. Therefore, if you want to use functions from rtt-target directly, import them from rtt-log instead of adding rtt-target as a separate dependency. Otherwise, a linker error about duplicate symbols will occur.

use rtt_log::rtt_target::rprintln;

rprintln!("Hello, world!");

Use a tool like probe-rs on the host to print the messages.

License

Published under the MIT license.

Author: Oliver Rockstedt [email protected]

rtt-log-rs's Issues

Use rtt_log with rtt_target

This linker error shows up when trying to use rtt_target with rtt_log. Is there a way to use regular rprintln with rtt-log?

  = note: rust-lld: error: duplicate symbol: _SEGGER_RTT
          >>> defined at eerie_embedded.7c2001f6d11f5a70-cgu.0
          >>>            /Users/gmmyung/Developer/eerie-embedded/target/thumbv7em-none-eabihf/release
/deps/eerie_embedded-b5a2d1bcc30af02c.eerie_embedded.7c2001f6d11f5a70-cgu.0.rcgu.o:(_SEGGER_RTT)
          >>> defined at rtt_log.c37f8a5fd759f351-cgu.0
          >>>            rtt_log-ade76af0363c4fae.rtt_log.c37f8a5fd759f351-cgu.0.rcgu.o:(.bss._SEGGER
_RTT+0x0) in archive /Users/gmmyung/Developer/eerie-embedded/target/thumbv7em-none-eabihf/release/dep
s/librtt_log-ade76af0363c4fae.rlib