Solaris Software
Loading...
Searching...
No Matches
uart.h
Go to the documentation of this file.
1/**
2 * @file uart.h
3 * @brief SPP UART HAL API — dispatches through the registered HAL port.
4 */
5
6#include "spp/core/types.h"
7#include "spp/core/returnTypes.h"
8
9/* ----------------------------------------------------------------
10 * Public API
11 * ---------------------------------------------------------------- */
12
13/**
14 * @brief Initialise the UART port.
15 *
16 * @return K_SPP_OK on success.
17 */
18SPP_RetVal_t SPP_HAL_UART_portInit(void);
19
20
21/**
22 * @brief Perform UART transaction.
23 *
24 * @return K_SPP_OK on success.
25 */
26SPP_RetVal_t SPP_HAL_UART_transmit(const void *p_data, spp_uint16_t len);
27
28/**
29 * @brief Perform UART read.
30 *
31 * @return K_SPP_OK on success.
32 */
33SPP_RetVal_t SPP_HAL_UART_read(void *p_data, spp_uint32_t len, spp_uint32_t *p_readBytes);
returnTypes.h
Standard return-value type used across all SPP modules.
SPP_RetVal_t
SPP_RetVal_t
Unified return type for all SPP API functions.
Definition returnTypes.h:24
types.h
Portable integer types and SPI/storage configuration types for SPP.
spp_uint16_t
uint16_t spp_uint16_t
Definition types.h:29
spp_uint32_t
uint32_t spp_uint32_t
Definition types.h:31
SPP_HAL_UART_transmit
SPP_RetVal_t SPP_HAL_UART_transmit(const void *p_data, spp_uint16_t len)
Perform UART transaction.
Definition uart.c:44
SPP_HAL_UART_read
SPP_RetVal_t SPP_HAL_UART_read(void *p_data, spp_uint32_t len, spp_uint32_t *p_readBytes)
Perform UART read.
Definition uart.c:76
SPP_HAL_UART_portInit
SPP_RetVal_t SPP_HAL_UART_portInit(void)
Initialise the UART port.
Definition uart.c:22