HAL_UART_Receive_DMA() function

Receives an amount of data in DMA mode.

Syntax

from stm32f4xx_hal_uart.h:750

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

Implemented in stm32f4xx_hal_uart.c:1441

Arguments

huart

Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.

pData

Pointer to data buffer (u8 or u16 data elements).

Size

Amount of data elements (u8 or u16) to be received.

Return value

HAL status

Notes

When UART parity is not enabled (PCE = 0), and Word Length is configured to 9 bits (M1-M0 = 01), the received data is handled as a set of u16. In this case, Size must indicate the number of u16 available through pData. When the UART parity is enabled (PCE = 1) the received data contains the parity bit.

Examples

HAL_UART_Receive_DMA() is referenced by 13 libraries and example projects.

References

Location	Text
stm32f4xx_hal_uart.c:1441	HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef huart, uint8_t pData, uint16_t Size)
stm32f4xx_hal_uart.h:750	HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef huart, uint8_t pData, uint16_t Size);