Struct SerialPortComponent

pub struct SerialPortComponent { /* private fields */ }

Component interface used to instantiate a SerialPort

Implementations

impl SerialPortComponent

pub unsafe fn new(base: u16) -> Self

Constructs and returns a new instance of SerialPortComponent.

Safety

An 8250-compatible serial port must exist at the specified address. Otherwise we could end up spamming some unknown device with I/O operations.

The specified serial port must not be in use by any other instance of SerialPort or any other code.

Trait Implementations

impl Component for SerialPortComponent

type StaticInput = (&'static mut MaybeUninit<SerialPort<'static>>,)

An optional type to specify the chip or board specific static memory that a component needs to setup the output object(s). This is the memory that crate::static_buf!() would normally setup, but generic components cannot setup static buffers for types which are chip-dependent, so those buffers have to be passed in manually, and the Component::StaticInput type makes this possible.

type Output = &'static SerialPort<'static>

The type (e.g., capsule, peripheral) that this implementation of Component produces via Component::finalize(). This is typically a static reference (&'static).

fn finalize(self, s: Self::StaticInput) -> Self::Output

A factory method that returns an instance of the Output type of this Component implementation. This is used in the boot sequence to instantiate and initialize part of the Tock kernel. This factory method may only be called once per Component instance.