Struct capsules_core::process_console::ProcessConsole

pub struct ProcessConsole<'a, const COMMAND_HISTORY_LEN: usize, A: Alarm<'a>, C: ProcessManagementCapability> { /* private fields */ }

Implementations

impl<'a, const COMMAND_HISTORY_LEN: usize, A: Alarm<'a>, C: ProcessManagementCapability> ProcessConsole<'a, COMMAND_HISTORY_LEN, A, C>

pub fn new( uart: &'a dyn UartData<'a>, alarm: &'a A, process_printer: &'a dyn ProcessPrinter, tx_buffer: &'static mut [u8], rx_buffer: &'static mut [u8], queue_buffer: &'static mut [u8], cmd_buffer: &'static mut [u8], cmd_history_buffer: &'static mut [Command; COMMAND_HISTORY_LEN], kernel: &'static Kernel, kernel_addresses: KernelAddresses, reset_function: Option<fn() -> !>, capability: C ) -> ProcessConsole<'a, COMMAND_HISTORY_LEN, A, C>

pub fn start(&self) -> Result<(), ErrorCode>

Start the process console listening for user commands.

pub fn start_hibernated(&self) -> Result<(), ErrorCode>

Start the process console listening but in a hibernated state.

The process console will not respond to commands, but can be activated with the console-start command.

pub fn display_welcome(&self)

Print base information about the kernel version installed and the help message.

Trait Implementations

impl<'a, const COMMAND_HISTORY_LEN: usize, A: Alarm<'a>, C: ProcessManagementCapability> AlarmClient for ProcessConsole<'a, COMMAND_HISTORY_LEN, A, C>

fn alarm(&self)

Callback indicating the alarm time has been reached. The alarm MUST be disabled when this is called. If a new alarm is needed, the client can call Alarm::set_alarm.

impl<'a, const COMMAND_HISTORY_LEN: usize, A: Alarm<'a>, C: ProcessManagementCapability> ReceiveClient for ProcessConsole<'a, COMMAND_HISTORY_LEN, A, C>

fn received_buffer( &self, read_buf: &'static mut [u8], rx_len: usize, _rcode: Result<(), ErrorCode>, error: Error )

A call to Receive::receive_buffer completed. The Result<(), ErrorCode> indicates whether the buffer was successfully received. A call to receive_word or receive_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

fn received_word(&self, _word: u32, _rval: Result<(), ErrorCode>, _error: Error)

A call to Receive::receive_word completed. The Result<(), ErrorCode> indicates whether the word was successfully received. A call to receive_word or receive_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

impl<'a, const COMMAND_HISTORY_LEN: usize, A: Alarm<'a>, C: ProcessManagementCapability> TransmitClient for ProcessConsole<'a, COMMAND_HISTORY_LEN, A, C>

fn transmitted_buffer( &self, buffer: &'static mut [u8], _tx_len: usize, _rcode: Result<(), ErrorCode> )

A call to Transmit::transmit_buffer completed. The Result<(), ErrorCode> indicates whether the buffer was successfully transmitted. A call to transmit_word or transmit_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.

fn transmitted_word(&self, _rval: Result<(), ErrorCode>)

A call to Transmit::transmit_word completed. The Result<(), ErrorCode> indicates whether the word was successfully transmitted. A call to transmit_word or transmit_buffer made within this callback SHOULD NOT return BUSY: when this callback is made the UART should be ready to receive another call.