Module kernel::debug[][src]

Support for in-kernel debugging.

For printing, this module uses an internal buffer to write the strings into. If you are writing and the buffer fills up, you can make the size of output_buffer larger.

Before debug interfaces can be used, the board file must assign them hardware:

kernel::debug::assign_gpios(
    Some(&sam4l::gpio::PA[13]),
    Some(&sam4l::gpio::PA[15]),
    None,
);

components::debug_writer::DebugWriterComponent::new(uart_mux).finalize(());

The debug queue is optional, if not set in the board it is just ignored. You can add one in the board file as follows:

let buf = static_init!([u8; 1024], [0; 1024]);
components::debug_queue::DebugQueueComponent::new(buf).finalize(());

Example

debug!("Yes the code gets here with value {}", i);
debug_verbose!("got here"); // Includes message count, file, and line.

debug_gpio!(0, toggle); // Toggles the first debug GPIO.

debug_enqueue!("foo"); // Adds some message to the debug queue.
debug_flush_queue!(); // Flushes the queue, writing "foo".
debug_enqueue!("bar");
panic!("42"); // Flushes the queue, writing "bar" in the debug queue section
              // of the panic diagnostic.
Yes the code gets here with value 42
TOCK_DEBUG(0): /tock/capsules/src/sensys.rs:24: got here

Structs

DebugQueue
DebugQueueWrapper

Wrapper type that we need a mutable reference to for the core::fmt::Write interface.

DebugWriter

Main type that we need an immutable reference to so we can share it with the UART provider and this debug module.

DebugWriterWrapper

Wrapper type that we need a mutable reference to for the core::fmt::Write interface.

Statics

DEBUG_GPIOS

Traits

Debug
IoWrite

This trait is similar to std::io::Write in that it takes bytes instead of a string (contrary to core::fmt::Write), but io::Write isn’t available in no_std (due to std::io::Error not being available).

Functions

assign_gpios
begin_debug_fmt
begin_debug_verbose_fmt
debug_enqueue_fmt
debug_flush_queue_
flush
panic

Tock default panic routine.

panic_banner

Lightweight prints about the current panic and kernel version.

panic_begin

Generic panic entry.

panic_blink_forever

Blinks a recognizable pattern forever.

panic_cpu_state

Print current machine (CPU) state.

panic_print

Tock panic routine, without the infinite LED-blinking loop.

panic_process_info

More detailed prints about all processes.

set_debug_queue

Function used by board main.rs to set a reference to the debug queue.

set_debug_writer_wrapper

Function used by board main.rs to set a reference to the writer.