IO operation functions

Functions
HAL_StatusTypeDef	HAL_UART_Transmit (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Send an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_UART_Receive (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_UART_Transmit_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Send an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_UART_Receive_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Receive an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_UART_Transmit_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Send an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_UART_Receive_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Receive an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_UART_DmaTransmit (UART_HandleTypeDef *huart, uint8_t *buf, uint32_t size, int direction)
	Start UART DMA transfer. More...
HAL_StatusTypeDef	HAL_UART_DMAPause (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_DMAResume (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_DMAStop (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_Abort (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_AbortTransmit (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_AbortReceive (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_Abort_IT (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_AbortTransmit_IT (UART_HandleTypeDef *huart)
HAL_StatusTypeDef	HAL_UART_AbortReceive_IT (UART_HandleTypeDef *huart)
void	HAL_UART_IRQHandler (UART_HandleTypeDef *huart)
	Handle UART interrupt request. More...
void	HAL_UART_TxHalfCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_TxCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_RxHalfCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_RxCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_ErrorCallback (UART_HandleTypeDef *huart)
void	HAL_UART_AbortCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_AbortTransmitCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_AbortReceiveCpltCallback (UART_HandleTypeDef *huart)
void	HAL_UART_WakeupCallback (UART_HandleTypeDef *huart)

Detailed Description

Function Documentation

HAL_UART_DmaTransmit()

HAL_StatusTypeDef HAL_UART_DmaTransmit	(	UART_HandleTypeDef *	huart,
		uint8_t *	buf,
		uint32_t	size,
		int	direction
	)

Start UART DMA transfer.

Parameters

huart	UART handle.
buf	Buffer to receive/send from/to UART.
size	Size of buf.
direction	DMA_PERIPH_TO_MEMORY for uart rX, DMA_MEMORY_TO_PERIPH for uart tx.

Return values

HAL

status

HAL_UART_IRQHandler()

void HAL_UART_IRQHandler

(

UART_HandleTypeDef *

huart

)

Handle UART interrupt request.

Parameters

huart

UART handle.

Return values

None

HAL_UART_Receive()

HAL_StatusTypeDef HAL_UART_Receive	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	Timeout
	)

Receive an amount of data in blocking mode.

Note

When FIFO mode is enabled, the RXFNE flag is set as long as the RXFIFO is not empty. Read operations from the RDR register are performed when RXFNE flag is set. From hardware perspective, RXFNE flag and RXNE are mapped on the same bit-field.

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be received.
Timeout	Timeout duration.

Return values

HAL

status

HAL_UART_Receive_DMA()

HAL_StatusTypeDef HAL_UART_Receive_DMA	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size
	)

Receive an amount of data in DMA mode.

Note

When the UART parity is enabled (PCE = 1), the received data contain the parity bit (MSB position).

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be received.

Return values

HAL

status

HAL_UART_Receive_IT()

HAL_StatusTypeDef HAL_UART_Receive_IT	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size
	)

Receive an amount of data in interrupt mode.

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be received.

Return values

HAL

status

HAL_UART_Transmit()

HAL_StatusTypeDef HAL_UART_Transmit	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	Timeout
	)

Send an amount of data in blocking mode.

Note

When FIFO mode is enabled, writing a data in the TDR register adds one data to the TXFIFO. Write operations to the TDR register are performed when TXFNF flag is set. From hardware perspective, TXFNF flag and TXE are mapped on the same bit-field.

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be sent.
Timeout	Timeout duration.

Return values

HAL

status

HAL_UART_Transmit_DMA()

HAL_StatusTypeDef HAL_UART_Transmit_DMA	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size
	)

Send an amount of data in DMA mode.

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be sent.

Return values

HAL

status

HAL_UART_Transmit_IT()

HAL_StatusTypeDef HAL_UART_Transmit_IT	(	UART_HandleTypeDef *	huart,
		uint8_t *	pData,
		uint16_t	Size
	)

Send an amount of data in interrupt mode.

Parameters

huart	UART handle.
pData	Pointer to data buffer.
Size	Amount of data to be sent.

Return values

HAL

status