Struct kernel::serial_trace::SerialTraceSettings

#[non_exhaustive]
pub struct SerialTraceSettings {
    pub enabled: bool,
    pub port: u16,
    pub sendbuf_capacity: usize,
    pub tracebuf_capacity: usize,
    pub initial_level: LevelFilter,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Should the serial trace be enabled?

port: u16

SerialMux port for sermux tracing.

sendbuf_capacity: usize

Capacity for the serial port’s send buffer.

tracebuf_capacity: usize

Capacity for the trace ring buffer.

Note that two buffers of this size will be allocated. One buffer is used for the normal trace ring buffer, and another is used for the interrupt service routine trace ring buffer.

initial_level: LevelFilter

Initial level filter used if the debug host does not select a max level.

Implementations

impl SerialTraceSettings

pub const DEFAULT_PORT: u16 = 3u16

pub const DEFAULT_SENDBUF_CAPACITY: usize = 1_024usize

pub const DEFAULT_TRACEBUF_CAPACITY: usize = 4_096usize

pub const DEFAULT_INITIAL_LEVEL: LevelFilter = LevelFilter::INFO

const fn default_port() -> u16

const fn default_sendbuf_capacity() -> usize

const fn default_tracebuf_capacity() -> usize

const fn default_initial_level() -> LevelFilter

pub const fn new() -> Self

pub fn with_port(self, port: impl Into<u16>) -> Self

Sets the serial_mux port on which the binary tracing service is served.

By default, this is Self::DEFAULT_PORT (the value of serial_mux::WellKnown::BinaryTracing).

pub fn with_initial_level(self, level: impl Into<LevelFilter>) -> Self

Sets the initial LevelFilter used when no trace client is connected or when the trace client does not select a level.

By default, this set to Self::DEFAULT_INITIAL_LEVEL (LevelFilter::OFF).

pub const fn with_sendbuf_capacity(self, capacity: usize) -> Self

Sets the maximum capacity of the serial port send buffer (the buffer used for communication between the trace service task and the serial mux server).

By default, this set to Self::DEFAULT_SENDBUF_CAPACITY (1 KB).

pub const fn with_tracebuf_capacity(self, capacity: usize) -> Self

Sets the maximum capacity of the trace ring buffer (the buffer into which new traces are serialized before being sent to the worker task).

Note that two buffers of this size will be allocated. One buffer is used for traces emitted by non-interrupt kernel code, and the other is used for traces emitted inside of interrupt service routines (ISRs).

By default, this set to Self::DEFAULT_TRACEBUF_CAPACITY (64 KB).

Trait Implementations

impl Clone for SerialTraceSettings

fn clone(&self) -> SerialTraceSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SerialTraceSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SerialTraceSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SerialTraceSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SerialTraceSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.