#include <serial.h>
Inherits os::driver::Base.
Inherited by os::driver::usart_wrapper.
Definition at line 525 of file serial.h.
◆ Serial() [1/3]
os::driver::Serial::Serial |
( |
| ) |
|
|
noexcept |
◆ Serial() [2/3]
os::driver::Serial::Serial |
( |
const Serial & |
| ) |
|
|
delete |
◆ Serial() [3/3]
os::driver::Serial::Serial |
( |
Serial && |
| ) |
|
|
delete |
◆ ~Serial()
os::driver::Serial::~Serial |
( |
| ) |
|
|
virtualnoexcept |
◆ clean()
void os::driver::Serial::clean |
( |
void |
| ) |
|
|
noexcept |
◆ configure()
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 811 of file serial.h.
◆ control()
Control the serial interface.
- Parameters
-
- Returns
- Common execution status and driver specific usart_execution_status
Definition at line 817 of file serial.h.
◆ control_modem_line()
Configure serial modem lines.
- Parameters
-
- Returns
- Execution status.
Definition at line 829 of file serial.h.
◆ do_configure()
|
protectedpure virtualnoexcept |
◆ do_control()
|
protectedpure virtualnoexcept |
◆ do_control_modem_line()
|
protectedpure virtualnoexcept |
◆ do_get_capabilities()
|
protectedpure virtualnoexcept |
◆ do_get_modem_status()
|
protectedpure virtualnoexcept |
◆ do_get_rx_count()
virtual std::size_t os::driver::Serial::do_get_rx_count |
( |
void |
| ) |
|
|
protectedpure virtualnoexcept |
◆ do_get_status()
|
protectedpure virtualnoexcept |
◆ do_get_tx_count()
virtual std::size_t os::driver::Serial::do_get_tx_count |
( |
void |
| ) |
|
|
protectedpure virtualnoexcept |
◆ do_get_version()
virtual const Version& os::driver::Base::do_get_version |
( |
void |
| ) |
|
|
protectedpure virtualnoexceptinherited |
◆ do_power()
|
protectedpure virtualnoexceptinherited |
◆ do_receive()
virtual return_t os::driver::Serial::do_receive |
( |
void * |
data, |
|
|
std::size_t |
num |
|
) |
| |
|
protectedpure virtualnoexcept |
◆ do_send()
virtual return_t os::driver::Serial::do_send |
( |
const void * |
data, |
|
|
std::size_t |
num |
|
) |
| |
|
protectedpure virtualnoexcept |
◆ do_transfer()
virtual return_t os::driver::Serial::do_transfer |
( |
const void * |
data_out, |
|
|
void * |
data_in, |
|
|
std::size_t |
num |
|
) |
| |
|
protectedpure virtualnoexcept |
◆ get_capabilities()
Get driver capabilities.
- Returns
- Capabilities.
Definition at line 793 of file serial.h.
◆ get_modem_status()
Get serial modem lines state.
- Returns
- Modem status.
Definition at line 835 of file serial.h.
◆ get_rx_count()
std::size_t os::driver::Serial::get_rx_count |
( |
void |
| ) |
|
|
inlinenoexcept |
Get received bytes count.
- Returns
- number of bytes received
Definition at line 805 of file serial.h.
◆ get_status()
Get serial port status.
- Returns
- Serial status.
Definition at line 823 of file serial.h.
◆ get_tx_count()
std::size_t os::driver::Serial::get_tx_count |
( |
void |
| ) |
|
|
inlinenoexcept |
Get transmitted bytes count.
- Returns
- number of bytes transmitted
Definition at line 799 of file serial.h.
◆ get_version()
const Version & os::driver::Base::get_version |
( |
void |
| ) |
|
|
inlinenoexceptinherited |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ power()
Power up/down device.
- Parameters
-
- Returns
- Execution status
Definition at line 207 of file common.h.
◆ receive()
return_t os::driver::Serial::receive |
( |
void * |
data, |
|
|
std::size_t |
num |
|
) |
| |
|
noexcept |
Start the serial receiver.
- 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 102 of file serial.cpp.
◆ register_callback()
void os::driver::Serial::register_callback |
( |
signal_event_t |
cb_func, |
|
|
const void * |
cb_object = nullptr |
|
) |
| |
|
noexcept |
Register event callback.
- Parameters
-
[in] | cb_func | Pointer to function. |
[in] | cb_object | Pointer to object passed to function. |
- Returns
- Execution status
Definition at line 84 of file serial.cpp.
◆ send()
return_t os::driver::Serial::send |
( |
const void * |
data, |
|
|
std::size_t |
num |
|
) |
| |
|
noexcept |
Start the serial transmitter.
- 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 91 of file serial.cpp.
◆ signal_event()
void os::driver::Serial::signal_event |
( |
event_t |
event | ) |
|
|
inlinenoexcept |
Signal serial events.
- Parameters
-
[in] | event | Event notification mask. |
- Returns
- none
Definition at line 841 of file serial.h.
◆ transfer()
return_t os::driver::Serial::transfer |
( |
const void * |
data_out, |
|
|
void * |
data_in, |
|
|
std::size_t |
num |
|
) |
| |
|
noexcept |
Start sending/receiving data to/from the serial transmitter/receiver.
- 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 113 of file serial.cpp.
◆ cb_func_
Pointer to static function that implements the callback.
Definition at line 702 of file serial.h.
◆ cb_object_
const void* os::driver::Serial::cb_object_ |
|
protected |
Pointer to object instance associated with this driver.
Definition at line 705 of file serial.h.
◆ modem_status_
◆ status_
The documentation for this class was generated from the following files: