#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 50 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 27 of file usart-wrapper.cpp.

        : driver_ (driver), c_cb_func_ (c_cb_func)
    {
      trace::printf ("%s() %p\n", __func__, this);
    }

References os::trace::printf().

◆ 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 34 of file usart-wrapper.cpp.

    {
      trace::printf ("%s() %p\n", __func__, this);
 
      driver_ = nullptr;
    }

References driver_, and os::trace::printf().

Member Function Documentation

◆ clean()

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

noexceptinherited

Definition at line 55 of file serial.cpp.

    {
      status_.rx_break = false;
      status_.rx_busy = false;
      status_.rx_framing_error = false;
      status_.rx_overflow = false;
      status_.rx_parity_error = false;
      status_.tx_busy = false;
      status_.tx_underflow = false;
 
      modem_status_.cts = false;
      modem_status_.dsr = false;
      modem_status_.dcd = false;
      modem_status_.ri = false;
    }

Referenced by os::driver::Serial::Serial().

◆ configure()

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

inlinenoexceptinherited

Parameters

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

Returns: Common execution status and driver specific usart_execution_status

Definition at line 837 of file serial.h.

    {
      return do_configure (cfg, arg);
    }

References os::driver::Serial::do_configure().

◆ control()

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

inlinenoexceptinherited

Parameters

[in] ctrl Operation

Returns: Common execution status and driver specific usart_execution_status

Definition at line 843 of file serial.h.

    {
      return do_control (ctrl);
    }

References os::driver::Serial::do_control().

◆ control_modem_line()

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

inlinenoexceptinherited

Parameters

[in] ctrl Control.

Returns: Execution status.

Definition at line 855 of file serial.h.

    {
      return do_control_modem_line (ctrl);
    }

References os::driver::Serial::do_control_modem_line().

◆ do_configure()

return_t os::driver::usart_wrapper::do_configure	(	serial::config_t	ctrl,
		serial::config_arg_t	arg
	)

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->Control (cfg, arg);
    }

◆ do_control()

return_t os::driver::usart_wrapper::do_control ( serial::control_t ctrl )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      switch (ctrl)
        {
        case serial::Control::disable_tx:
        case serial::Control::disable_rx:
        case serial::Control::disable_break:
          return driver_->Control (
              ctrl
                  - (serial::Control::disable_tx - serial::Control::enable_tx),
              0);
        }
      return driver_->Control (ctrl, 1);
    }

References os::driver::serial::disable_break, os::driver::serial::disable_rx, os::driver::serial::disable_tx, and os::driver::serial::enable_tx.

◆ do_control_modem_line()

return_t os::driver::usart_wrapper::do_control_modem_line ( serial::Modem_control ctrl )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->SetModemControl (
          static_cast<ARM_USART_MODEM_CONTROL> (ctrl));
    }

◆ do_get_capabilities()

const serial::Capabilities & os::driver::usart_wrapper::do_get_capabilities ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_USART_CAPABILITIES*> (&capa_))
          = driver_->GetCapabilities ();
      return capa_;
    }

◆ do_get_modem_status()

serial::Modem_status & os::driver::usart_wrapper::do_get_modem_status ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_USART_MODEM_STATUS*> (&modem_status_))
          = driver_->GetModemStatus ();
      return modem_status_;
    }

◆ do_get_rx_count()

std::size_t os::driver::usart_wrapper::do_get_rx_count ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->GetRxCount ();
    }

◆ do_get_status()

serial::Status & os::driver::usart_wrapper::do_get_status ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_USART_STATUS*> (&status_))
          = driver_->GetStatus ();
      return status_;
    }

◆ do_get_tx_count()

std::size_t os::driver::usart_wrapper::do_get_tx_count ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->GetTxCount ();
    }

◆ do_get_version()

const Version & os::driver::usart_wrapper::do_get_version ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

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

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_DRIVER_VERSION*> (&version_))
          = driver_->GetVersion ();
      return version_;
    }

◆ do_power()

return_t os::driver::usart_wrapper::do_power ( Power state )

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

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

    {
      return_t status;
 
      if (state == Power::full)
        {
          status = driver_->Initialize (c_cb_func_);
          if (status != ARM_DRIVER_OK)
            {
              return status;
            }
        }
 
      status = driver_->PowerControl (static_cast<ARM_POWER_STATE> (state));
 
      if (state == Power::off)
        {
          driver_->Uninitialize ();
        }
 
      return status;
    }

References os::driver::full, and os::driver::off.

◆ do_receive()

return_t os::driver::usart_wrapper::do_receive	(	void *	data,
		std::size_t	num
	)

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->Receive (data, static_cast<uint32_t> (num));
    }

◆ do_send()

return_t os::driver::usart_wrapper::do_send	(	const void *	data,
		std::size_t	num
	)

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->Send (data, static_cast<uint32_t> (num));
    }

◆ do_transfer()

return_t os::driver::usart_wrapper::do_transfer	(	const void *	data_out,
		void *	data_in,
		std::size_t	num
	)

overrideprotectedvirtualnoexcept

Implements os::driver::Serial.

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

    {
      return driver_->Transfer (data_out, data_in,
                                static_cast<uint32_t> (num));
    }

◆ get_capabilities()

const serial::Capabilities & os::driver::Serial::get_capabilities ( void )

inlinenoexceptinherited

Returns: Capabilities.

Definition at line 819 of file serial.h.

    {
      return do_get_capabilities ();
    }

References os::driver::Serial::do_get_capabilities().

◆ get_modem_status()

serial::Modem_status & os::driver::Serial::get_modem_status ( void )

inlinenoexceptinherited

Returns: Modem status.

Definition at line 861 of file serial.h.

    {
      return do_get_modem_status ();
    }

References os::driver::Serial::do_get_modem_status().

◆ get_rx_count()

std::size_t os::driver::Serial::get_rx_count ( void )

inlinenoexceptinherited

Returns: number of bytes received

Definition at line 831 of file serial.h.

    {
      return do_get_rx_count ();
    }

References os::driver::Serial::do_get_rx_count().

◆ get_status()

serial::Status & os::driver::Serial::get_status ( void )

inlinenoexceptinherited

Returns: Serial status.

Definition at line 849 of file serial.h.

    {
      return do_get_status ();
    }

References os::driver::Serial::do_get_status().

◆ get_tx_count()

std::size_t os::driver::Serial::get_tx_count ( void )

inlinenoexceptinherited

Returns: number of bytes transmitted

Definition at line 825 of file serial.h.

    {
      return do_get_tx_count ();
    }

References os::driver::Serial::do_get_tx_count().

◆ get_version()

const Version & os::driver::Base::get_version ( void )

inlinenoexceptinherited

Returns: Version.

Definition at line 185 of file common.h.

    {
      return do_get_version ();
    }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

usart_wrapper & os::driver::usart_wrapper::operator= ( usart_wrapper && )

delete

◆ power()

return_t os::driver::Base::power ( Power state )

inlinenoexceptinherited

Parameters

[in] state Power state

Returns: Execution status

Definition at line 191 of file common.h.

    {
      return do_power (state);
    }

◆ receive()

return_t os::driver::Serial::receive	(	void *	data,
		std::size_t	num
	)

noexceptinherited

Parameters

[out]	data	Pointer to buffer for data to receive from USART receiver
[in]	num	Number of data items to receive

Returns: Execution status

Definition at line 93 of file serial.cpp.

    {
      assert (data != nullptr);
      if (num == 0)
        {
          return RETURN_OK;
        }
      return do_receive (data, num);
    }

References os::driver::RETURN_OK.

◆ register_callback()

void os::driver::Serial::register_callback	(	signal_event_t	cb_func,
		const void *	cb_object = `nullptr`
	)

noexceptinherited

Parameters

[in]	cb_func	Pointer to function.
[in]	cb_object	Pointer to object passed to function.

Returns: Nothing.

Definition at line 74 of file serial.cpp.

    {
      cb_func_ = cb_func;
      cb_object_ = cb_object;
    }

◆ send()

return_t os::driver::Serial::send	(	const void *	data,
		std::size_t	num
	)

noexceptinherited

Parameters

[in]	data	Pointer to buffer with data to send to USART transmitter.
[in]	num	Number of data items to send.

Returns: Execution status

Definition at line 82 of file serial.cpp.

    {
      assert (data != nullptr);
      if (num == 0)
        {
          return RETURN_OK;
        }
      return do_send (data, num);
    }

References os::driver::RETURN_OK.

◆ signal_event()

void os::driver::Serial::signal_event ( event_t event )

inlinenoexceptinherited

Parameters

[in] event Event notification mask.

Returns: Nothing.

Definition at line 867 of file serial.h.

    {
      if (cb_func_ != nullptr)
        {
          // Forward event to registered callback.
          cb_func_ (cb_object_, event);
        }
    }

References os::driver::Serial::cb_func_, and os::driver::Serial::cb_object_.

◆ transfer()

return_t os::driver::Serial::transfer	(	const void *	data_out,
		void *	data_in,
		std::size_t	num
	)

noexceptinherited

Parameters

[in]	data_out	Pointer to buffer with data to send
[out]	data_in	Pointer to buffer for data to receive
[in]	num	Number of bytes to transfer

Returns: Execution status

Definition at line 104 of file serial.cpp.

    {
      assert (data_out != nullptr);
      assert (data_in != nullptr);
      if (num == 0)
        {
          return RETURN_OK;
        }
      return do_transfer (data_out, data_in, num);
    }

References os::driver::RETURN_OK.

Member Data Documentation

◆ c_cb_func_

ARM_USART_SignalEvent_t os::driver::usart_wrapper::c_cb_func_

private

Pointer to non-reentrant callback. Must be stored because Initialize() is now delayed just before PowerControl(FULL).

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

◆ capa_

serial::Capabilities os::driver::usart_wrapper::capa_

private

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

◆ cb_func_

signal_event_t os::driver::Serial::cb_func_

protectedinherited

Definition at line 729 of file serial.h.

Referenced by os::driver::Serial::Serial(), and os::driver::Serial::signal_event().

◆ cb_object_

const void* os::driver::Serial::cb_object_

protectedinherited

Definition at line 732 of file serial.h.

Referenced by os::driver::Serial::Serial(), and os::driver::Serial::signal_event().

◆ driver_

ARM_DRIVER_USART* os::driver::usart_wrapper::driver_

private

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

Referenced by ~usart_wrapper().

◆ modem_status_

serial::Modem_status os::driver::Serial::modem_status_

protectedinherited

Definition at line 735 of file serial.h.

◆ status_

serial::Status os::driver::Serial::status_

protectedinherited

Definition at line 734 of file serial.h.

◆ version_

Version os::driver::usart_wrapper::version_ { 0, 0 }

private

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

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ usart_wrapper() [1/3]

◆ usart_wrapper() [2/3]

◆ usart_wrapper() [3/3]

◆ ~usart_wrapper()

Member Function Documentation

◆ clean()

◆ configure()

◆ control()

◆ control_modem_line()

◆ do_configure()

◆ do_control()

◆ do_control_modem_line()

◆ do_get_capabilities()

◆ do_get_modem_status()

◆ do_get_rx_count()

◆ do_get_status()

◆ do_get_tx_count()

◆ do_get_version()

◆ do_power()

◆ do_receive()

◆ do_send()

◆ do_transfer()

◆ get_capabilities()

◆ get_modem_status()

◆ get_rx_count()

◆ get_status()

◆ get_tx_count()

◆ get_version()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ power()

◆ receive()

◆ register_callback()

◆ send()

◆ signal_event()

◆ transfer()

Member Data Documentation

◆ c_cb_func_

◆ capa_

◆ cb_func_

◆ cb_object_

◆ driver_

◆ modem_status_

◆ status_

◆ version_