Module debug

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(components::debug_writer_component_static!());

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:

components::debug_queue::DebugQueueComponent::new()
    .finalize(components::debug_queue_component_static!());

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
  Queue to hold debug strings.
• DebugQueueWrapper
  Wrapper type that we need a mutable reference to for the core::fmt::Write interface.
• DebugWriter
  Main type that we share 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
  Object to hold the assigned debugging GPIOs.

Traits

• IoWrite
  Implementation of std::io::Write for no_std.

Functions

• assign_gpios^⚠
  Map up to three GPIO pins to use for debugging.
• debug_available_len
  Return how many bytes are remaining in the internal debug buffer.
• debug_enqueue_fmt
  Add a format string to the debug queue.
• debug_flush_queue_
  Flush the debug queue by writing to the underlying writer implementation.
• debug_print
  Write a debug message without a trailing newline.
• debug_println
  Write a debug message with a trailing newline.
• debug_slice
  Write a ReadableProcessSlice to the debug output.
• debug_verbose_print
  Write a debug message with file and line information without a trailing newline.
• debug_verbose_println
  Write a debug message with file and line information with a trailing newline.
• flush^⚠
  Flush any stored messages to the output writer.
• 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.