#include <usart-wrapper.h>

Inheritance diagram for os::driver::usart_wrapper:

Public Member Functions
	usart_wrapper (ARM_DRIVER_USART *driver, ARM_USART_SignalEvent_t c_cb_func) noexcept

	usart_wrapper (const usart_wrapper &)=delete

	usart_wrapper (usart_wrapper &&)=delete

virtual	~usart_wrapper () noexcept override

void	clean (void) noexcept

return_t	configure (serial::config_t cfg, serial::config_arg_t arg) noexcept
	Configure the serial interface.

return_t	control (serial::control_t ctrl) noexcept
	Control the serial interface.

return_t	control_modem_line (serial::Modem_control ctrl) noexcept
	Configure serial modem lines.

const serial::Capabilities &	get_capabilities (void) noexcept
	Get driver capabilities.

serial::Modem_status &	get_modem_status (void) noexcept
	Get serial modem lines state.

std::size_t	get_rx_count (void) noexcept
	Get received bytes count.

serial::Status &	get_status (void) noexcept
	Get serial port status.

std::size_t	get_tx_count (void) noexcept
	Get transmitted bytes count.

const Version &	get_version (void) noexcept
	Get driver version.

usart_wrapper &	operator= (const usart_wrapper &)=delete

usart_wrapper &	operator= (usart_wrapper &&)=delete

return_t	power (Power state) noexcept
	Power up/down device.

return_t	receive (void *data, std::size_t num) noexcept
	Start the serial receiver.

void	register_callback (signal_event_t cb_func, const void *cb_object=nullptr) noexcept
	Register event callback.

return_t	send (const void *data, std::size_t num) noexcept
	Start the serial transmitter.

void	signal_event (event_t event) noexcept
	Signal serial events.

return_t	transfer (const void data_out, void data_in, std::size_t num) noexcept
	Start sending/receiving data to/from the serial transmitter/receiver.

Protected Member Functions
virtual return_t	do_configure (serial::config_t ctrl, serial::config_arg_t arg) noexcept override

virtual return_t	do_control (serial::control_t ctrl) noexcept override

virtual return_t	do_control_modem_line (serial::Modem_control ctrl) noexcept override

virtual const serial::Capabilities &	do_get_capabilities (void) noexcept override

virtual serial::Modem_status &	do_get_modem_status (void) noexcept override

virtual std::size_t	do_get_rx_count (void) noexcept override

virtual serial::Status &	do_get_status (void) noexcept override

virtual std::size_t	do_get_tx_count (void) noexcept override

virtual const Version &	do_get_version (void) noexcept override

virtual return_t	do_power (Power state) noexcept override

virtual return_t	do_receive (void *data, std::size_t num) noexcept override

virtual return_t	do_send (const void *data, std::size_t num) noexcept override

virtual return_t	do_transfer (const void data_out, void data_in, std::size_t num) noexcept override

Protected Attributes
signal_event_t	cb_func_
	Pointer to static function that implements the callback.

const void *	cb_object_
	Pointer to object instance associated with this driver.

serial::Modem_status	modem_status_

serial::Status	status_

Private Attributes
ARM_USART_SignalEvent_t	c_cb_func_

serial::Capabilities	capa_

ARM_DRIVER_USART *	driver_
	Pointer to CMSIS USART Keil driver.

Version	version_ { 0, 0 }

Detailed Description

Definition at line 52 of file usart-wrapper.h.

Constructor & Destructor Documentation

◆ usart_wrapper() [1/3]

os::driver::usart_wrapper::usart_wrapper	(	ARM_DRIVER_USART *	driver,
		ARM_USART_SignalEvent_t	c_cb_func
	)

noexcept

Definition at line 28 of file usart-wrapper.cpp.

◆ usart_wrapper() [2/3]

os::driver::usart_wrapper::usart_wrapper ( const usart_wrapper & )

delete

◆ usart_wrapper() [3/3]

os::driver::usart_wrapper::usart_wrapper ( usart_wrapper && )

delete

◆ ~usart_wrapper()

os::driver::usart_wrapper::~usart_wrapper ( )

overridevirtualnoexcept

Definition at line 36 of file usart-wrapper.cpp.

Member Function Documentation

◆ clean()

void os::driver::Serial::clean ( void )

noexceptinherited

Definition at line 56 of file serial.cpp.

◆ configure()

return_t os::driver::Serial::configure	(	serial::config_t	cfg,
		serial::config_arg_t	arg
	)

inlinenoexceptinherited

Configure the serial interface.

Parameters

[in]	cfg	Operation
[in]	arg	Argument of operation (optional)

Returns: Common execution status and driver specific usart_execution_status

Definition at line 825 of file serial.h.

◆ control()

return_t os::driver::Serial::control ( serial::control_t ctrl )

inlinenoexceptinherited

Control the serial interface.

Parameters

[in] ctrl Operation

Returns: Common execution status and driver specific usart_execution_status

Definition at line 831 of file serial.h.

◆ control_modem_line()

return_t os::driver::Serial::control_modem_line ( serial::Modem_control ctrl )

inlinenoexceptinherited

Configure serial modem lines.

Parameters

[in] ctrl Control.

Returns: Execution status.

Definition at line 843 of file serial.h.