DocID026046 Rev 1

17/24

AN4457

Software description

23

2.4.3

UART main functions

This section provides a set of functions ensuring UART transmission/reception emulation.

Callback functions are also available. They allow the user to implement his own code in the

user file.

Table 3. Callback functions

Table 2. Transmission/reception functions

Function

Parameters

Description

HAL_UART_Emul_Transmit_DMA

(UART_Emul_HandleTypeDef *huart, uint8_t *pData,

uint16_t Size)

huart: UART Emulator handle

pData: Pointer to data buffer

Size: Amount of data to be sent

Sends data

HAL_StatusTypeDef HAL_UART_Emul_Receive_DMA

(UART_Emul_HandleTypeDef *huart, uint8_t *pData,

uint16_t Size)

huart: UART Emulator handle

pData: Pointer to data buffer

Size: Amount of data to be received

Receives data

Function

Parameters

Description

__weak void HAL_UART_Emul_TxCpltCallback

(UART_Emul_HandleTypeDef *huart)

huart: UART Emulator handle

This function is called at the end

of transmit process.

__weak void HAL_UART_Emul_RxCpltCallback

(UART_Emul_HandleTypeDef *huart)

huart: UART Emulator handle

This function is called at the end

of receive process.

__weak void HAL_UART_Emul_ErrorCallback

(UART_Emul_HandleTypeDef *huart)

huart: UART Emulator handle

This function is called when a

communication error is detected.