Embedded Wireless Framework
Modules | Data Structures | Macros | Typedefs | Functions
RX UART interface

RX UART interface. More...

Modules

 RA UART configuration
 

Data Structures

struct  _ewf_interface_rx_uart
 The RX UART interface implementation data structure type. More...
 

Macros

#define EWF_INTERFACE_RX_UART_INITIALIZE_HEADER(interface_ptr)
 
#define EWF_INTERFACE_RX_UART_STATIC_DECLARE(interface_ptr, interface_name_symb)
 Declare a RX UART HOST interface. More...
 

Typedefs

typedef struct _ewf_interface_rx_uart ewf_interface_rx_uart
 The RX UART interface implementation data structure type. More...
 

Functions

ewf_result ewf_interface_rx_uart_hardware_start (ewf_interface *interface_ptr)
 Start the RX UART hardware interface.
 
ewf_result ewf_interface_rx_uart_hardware_stop (ewf_interface *interface_ptr)
 Stop the RX UART hardware interface.
 
ewf_result ewf_interface_rx_uart_hardware_send (ewf_interface *interface_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)
 Send a buffer using the RX UART hardware interface.
 
ewf_result ewf_interface_rx_uart_hardware_receive (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t *buffer_length_ptr, bool wait)
 Receive a buffer using the RX UART hardware interface.
 

Detailed Description

RX UART interface.

Macro Definition Documentation

◆ EWF_INTERFACE_RX_UART_STATIC_DECLARE

#define EWF_INTERFACE_RX_UART_STATIC_DECLARE (   interface_ptr,
  interface_name_symb 
)
Value:
do { \
static ewf_interface_rx_uart ewf_interface_rx_uart__implementation__##interface_name_symb = {0}; \
static ewf_interface ewf_interface_rx_uart__interface__##interface_name_symb = {0}; \
EWF_PLATFORM_QUEUE_STATIC_DECLARE( \
ewf_interface_rx_uart__interface__##interface_name_symb.response_queue_ptr, \
ewf_interface_rx_uart__response_queue__##interface_name_symb, \
EWF_INTERFACE_RX_UART_CONFIG_RESPONSE_QUEUE_SIZE); \
EWF_PLATFORM_QUEUE_STATIC_DECLARE( \
ewf_interface_rx_uart__interface__##interface_name_symb.urc_queue_ptr, \
ewf_interface_rx_uart__urc_queue__##interface_name_symb, \
EWF_INTERFACE_RX_UART_CONFIG_URC_QUEUE_SIZE); \
ewf_interface_rx_uart__interface__##interface_name_symb.hardware_start = ewf_interface_rx_uart_hardware_start; \
ewf_interface_rx_uart__interface__##interface_name_symb.hardware_stop = ewf_interface_rx_uart_hardware_stop; \
ewf_interface_rx_uart__interface__##interface_name_symb.hardware_send = ewf_interface_rx_uart_hardware_send; \
ewf_interface_rx_uart__interface__##interface_name_symb.hardware_receive = ewf_interface_rx_uart_hardware_receive; \
ewf_interface_rx_uart__interface__##interface_name_symb.implementation_ptr = &(ewf_interface_rx_uart__implementation__##interface_name_symb); \
interface_ptr = &(ewf_interface_rx_uart__interface__##interface_name_symb); \
EWF_INTERFACE_RX_UART_INITIALIZE_HEADER(interface_ptr); \
} while(0)
ewf_result ewf_interface_rx_uart_hardware_receive(ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t *buffer_length_ptr, bool wait)
Receive a buffer using the RX UART hardware interface.
Definition: ewf_interface_rx_uart.c:169
ewf_result ewf_interface_rx_uart_hardware_stop(ewf_interface *interface_ptr)
Stop the RX UART hardware interface.
Definition: ewf_interface_rx_uart.c:114
ewf_result ewf_interface_rx_uart_hardware_send(ewf_interface *interface_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)
Send a buffer using the RX UART hardware interface.
Definition: ewf_interface_rx_uart.c:129
ewf_result ewf_interface_rx_uart_hardware_start(ewf_interface *interface_ptr)
Start the RX UART hardware interface.
Definition: ewf_interface_rx_uart.c:56
The RX UART interface implementation data structure type.
Definition: ewf_interface_rx_uart.h:52
The interface structure definition.
Definition: ewf_interface.h:66
The interface message structure definition.
Definition: ewf_message.h:27

Declare a RX UART HOST interface.

Parameters
[in,out]interface_ptra pointer to an interface that will be initialized to point to the one statically declared by the macro
[in]interface_name_symba unique symbol name that will be used as a name suffix for the statically declared data

Typedef Documentation

◆ ewf_interface_rx_uart

The RX UART interface implementation data structure type.

*** group_interface_rx_uart_config