uart.h File Reference

SPP UART HAL API — dispatches through the registered HAL port. More...

#include "spp/core/types.h"
#include "spp/core/returnTypes.h"

Include dependency graph for uart.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
SPP_RetVal_t	SPP_HAL_UART_portInit (void)
	Initialise the UART port.
SPP_RetVal_t	SPP_HAL_UART_transmit (const void *p_data, spp_uint16_t len)
	Perform UART transaction.
SPP_RetVal_t	SPP_HAL_UART_read (void *p_data, spp_uint32_t len, spp_uint32_t *p_readBytes)
	Perform UART read.

Detailed Description

SPP UART HAL API — dispatches through the registered HAL port.

Definition in file uart.h.

Function Documentation

SPP_HAL_UART_portInit()

SPP_RetVal_t SPP_HAL_UART_portInit

(

void

)

Initialise the UART port.

Returns

K_SPP_OK on success.

Definition at line 22 of file uart.c.

References K_SPP_ERROR, K_SPP_ERROR_NULL_POINTER, K_SPP_OK, SPP_HAL_getPort(), SPP_HAL_UART_portInit(), SPP_HalPort_t::uart, and SPP_HALUart_t::uartPortInit.

Referenced by SPP_HAL_init(), and SPP_HAL_UART_portInit().

Here is the call graph for this function:

Here is the caller graph for this function:

SPP_HAL_UART_transmit()

SPP_RetVal_t SPP_HAL_UART_transmit	(	const void *	p_data,
		spp_uint16_t	len )

Perform UART transaction.

Returns

K_SPP_OK on success.

Definition at line 44 of file uart.c.

References K_SPP_CIPHER_FRAME_LEN, K_SPP_ERROR, K_SPP_ERROR_NULL_POINTER, K_SPP_OK, SPP_EXTERNAL_ENCRYPTION_CYPHER_encryptPacket(), SPP_HAL_getPort(), SPP_HAL_UART_transmit(), SPP_HalPort_t::uart, and SPP_HALUart_t::uartTransmit.

Referenced by SPP_HAL_UART_transmit(), and SPP_SERVICES_M10M_init().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Returns

K_SPP_OK on success.

Definition at line 76 of file uart.c.

References K_SPP_ERROR, K_SPP_ERROR_NULL_POINTER, SPP_HAL_getPort(), SPP_HAL_UART_read(), SPP_HalPort_t::uart, and SPP_HALUart_t::uartRead.

Referenced by SPP_HAL_UART_read(), and SPP_SERVICES_M10M_init().

Here is the call graph for this function:

Here is the caller graph for this function: