SPP_HALUart_t Struct Reference

UART port struct that contains all the pointers to the UART functions. More...

#include <hal.h>

Data Fields
SPP_RetVal_t(*)	uartPortInit (void)
	Initialise the UART port.
SPP_RetVal_t(*)	uartTransmit (const void *p_data, spp_uint32_t len)
	Perform an UART transaction.
SPP_RetVal_t(*)	uartRead (void *p_data, spp_uint32_t len, spp_uint32_t *p_readBytes)
	Reads data from the ESP32 UART.

Detailed Description

UART port struct that contains all the pointers to the UART functions.

Definition at line 85 of file hal.h.

Field Documentation

uartPortInit

SPP_RetVal_t(*) SPP_HALUart_t::uartPortInit(void)

Initialise the UART port.

Parameters

[in]

p_cfg

Pointer to UART init configuration.

Returns

K_SPP_OK on success.

Definition at line 94 of file hal.h.

Referenced by SPP_HAL_UART_portInit().

uartTransmit

SPP_RetVal_t(*) SPP_HALUart_t::uartTransmit(const void *p_data, spp_uint32_t len)

Perform an UART transaction.

Parameters

[in,out]	p_handle	SPI device handle.
[in,out]	p_data	TX data in, RX data out.
[in]	length	Number of bytes in the transaction.

Returns

K_SPP_OK on success, K_SPP_ERROR_ON_SPI_TRANSACTION on failure.

Definition at line 105 of file hal.h.

Referenced by SPP_HAL_UART_transmit().

uartRead

SPP_RetVal_t(*) SPP_HALUart_t::uartRead(void *p_data, spp_uint32_t len, spp_uint32_t *p_readBytes)

Reads data from the ESP32 UART.

Parameters

[out]	p_data	Pointer to the buffer where received data will be stored.
[in]	len	Number of bytes to read.
[out]	p_readBytes	Pointer to the variable where the number of bytes read will be stored.

Definition at line 115 of file hal.h.

Referenced by SPP_HAL_UART_read().

---

The documentation for this struct was generated from the following file:

• solaris-v2/spp/hal/hal.h