PIC UART port interface

PIC UART port interface. More...

Data Structures
struct	_ewf_interface_microchip_pic_uart
	the PIC UART interface implementation data structure type More...

Macros
#define	EWF_INTERFACE_MICROCHIP_PIC_UART_CONFIG_RESPONSE_QUEUE_SIZE   (8)
#define	EWF_INTERFACE_MICROCHIP_PIC_UART_CONFIG_URC_QUEUE_SIZE   (8)
#define	EWF_INTERFACE_MICROCHIP_PIC_UART_INITIALIZE_HEADER(interface_ptr)
#define	EWF_INTERFACE_MICROCHIP_PIC_UART_STATIC_DECLARE(interface_ptr, interface_name_symb)
	Declare a PIC UART interface. More...

Typedefs
typedef struct _ewf_interface_microchip_pic_uart	ewf_interface_microchip_pic_uart
	the PIC UART interface implementation data structure type

Functions
ewf_result	ewf_interface_microchip_pic_uart_hardware_start (ewf_interface *interface_ptr)
	Start the PIC UART hardware interface.
ewf_result	ewf_interface_microchip_pic_uart_hardware_stop (ewf_interface *interface_ptr)
	Stop the PIC UART hardware interface.
ewf_result	ewf_interface_microchip_pic_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_microchip_pic_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.

Variables
uint8_t	_ewf_interface_microchip_pic_uart::rx_buffer [sizeof(uint8_t)]

Detailed Description

PIC UART port interface.

Macro Definition Documentation

EWF_INTERFACE_MICROCHIP_PIC_UART_STATIC_DECLARE

#define EWF_INTERFACE_MICROCHIP_PIC_UART_STATIC_DECLARE	(		interface_ptr,
			interface_name_symb
	)

Value:

do {                                                                                                                                                                \
static ewf_interface_microchip_pic_uart ewf_interface_microchip_pic_uart__implementation__##interface_name_symb = {0};                                              \
static ewf_interface ewf_interface_microchip_pic_uart__interface__##interface_name_symb = {0};                                                                      \
EWF_PLATFORM_QUEUE_STATIC_DECLARE(                                                                                                                                  \
    ewf_interface_microchip_pic_uart__interface__##interface_name_symb.response_queue_ptr,                                                                          \
    ewf_interface_microchip_pic_uart__response_queue__##interface_name_symb,                                                                                        \
    ewf_interface_message,                                                                                                                                          \
    EWF_INTERFACE_MICROCHIP_PIC_UART_CONFIG_RESPONSE_QUEUE_SIZE);                                                                                                   \
EWF_PLATFORM_QUEUE_STATIC_DECLARE(                                                                                                                                  \
    ewf_interface_microchip_pic_uart__interface__##interface_name_symb.urc_queue_ptr,                                                                               \
    ewf_interface_microchip_pic_uart__urc_queue__##interface_name_symb,                                                                                             \
    ewf_interface_message,                                                                                                                                          \
    EWF_INTERFACE_MICROCHIP_PIC_UART_CONFIG_URC_QUEUE_SIZE);                                                                                                        \
ewf_interface_microchip_pic_uart__interface__##interface_name_symb.hardware_start = ewf_interface_microchip_pic_uart_hardware_start;                                \
ewf_interface_microchip_pic_uart__interface__##interface_name_symb.hardware_stop = ewf_interface_microchip_pic_uart_hardware_stop;                                  \
ewf_interface_microchip_pic_uart__interface__##interface_name_symb.hardware_send = ewf_interface_microchip_pic_uart_hardware_send;                                  \
ewf_interface_microchip_pic_uart__interface__##interface_name_symb.hardware_receive = ewf_interface_microchip_pic_uart_hardware_receive;                            \
ewf_interface_microchip_pic_uart__interface__##interface_name_symb.implementation_ptr = &(ewf_interface_microchip_pic_uart__implementation__##interface_name_symb); \
interface_ptr = &(ewf_interface_microchip_pic_uart__interface__##interface_name_symb);                                                                              \
EWF_INTERFACE_MICROCHIP_PIC_UART_INITIALIZE_HEADER(interface_ptr);                                                                                                  \
} while(0)

Declare a PIC UART interface.

Parameters

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