stm32h7xx_hal_uart_ex.h File Reference

Header file of UART HAL Extended module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	UART_WakeUpTypeDef
	UART wake up from stop mode parameters. More...
Defines
#define	UART_WORDLENGTH_7B   USART_CR1_M1
#define	UART_WORDLENGTH_8B   0x00000000U
#define	UART_WORDLENGTH_9B   USART_CR1_M0
#define	UART_ADDRESS_DETECT_4B   0x00000000U
#define	UART_ADDRESS_DETECT_7B   USART_CR2_ADDM7
#define	UART_FIFOMODE_DISABLE   0x00000000U
#define	UART_FIFOMODE_ENABLE   USART_CR1_FIFOEN
#define	UART_TXFIFO_THRESHOLD_1_8   0x00000000U
#define	UART_TXFIFO_THRESHOLD_1_4   USART_CR3_TXFTCFG_0
#define	UART_TXFIFO_THRESHOLD_1_2   USART_CR3_TXFTCFG_1
#define	UART_TXFIFO_THRESHOLD_3_4   (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1)
#define	UART_TXFIFO_THRESHOLD_7_8   USART_CR3_TXFTCFG_2
#define	UART_TXFIFO_THRESHOLD_8_8   (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0)
#define	UART_RXFIFO_THRESHOLD_1_8   0x00000000U
#define	UART_RXFIFO_THRESHOLD_1_4   USART_CR3_RXFTCFG_0
#define	UART_RXFIFO_THRESHOLD_1_2   USART_CR3_RXFTCFG_1
#define	UART_RXFIFO_THRESHOLD_3_4   (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1)
#define	UART_RXFIFO_THRESHOLD_7_8   USART_CR3_RXFTCFG_2
#define	UART_RXFIFO_THRESHOLD_8_8   (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0)
#define	UART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the UART clock source.
#define	UART_MASK_COMPUTATION(__HANDLE__)
	Report the UART mask to apply to retrieve the received data according to the word length and to the parity bits activation.
#define	IS_UART_WORD_LENGTH(__LENGTH__)
	Ensure that UART frame length is valid.
#define	IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__)
	Ensure that UART wake-up address length is valid.
#define	IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART TXFIFO threshold level is valid.
#define	IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART RXFIFO threshold level is valid.
Functions
HAL_StatusTypeDef	HAL_RS485Ex_Init (UART_HandleTypeDef *huart, uint32_t Polarity, uint32_t AssertionTime, uint32_t DeassertionTime)
	Initialize the RS485 Driver enable feature according to the specified parameters in the UART_InitTypeDef and creates the associated handle.
__weak void	HAL_UARTEx_WakeupCallback (UART_HandleTypeDef *huart)
	UART wakeup from Stop mode callback.
__weak void	HAL_UARTEx_RxFifoFullCallback (UART_HandleTypeDef *huart)
	UART RX Fifo full callback.
__weak void	HAL_UARTEx_TxFifoEmptyCallback (UART_HandleTypeDef *huart)
	UART TX Fifo empty callback.
HAL_StatusTypeDef	HAL_UARTEx_StopModeWakeUpSourceConfig (UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection)
	Set Wakeup from Stop mode interrupt flag selection.
HAL_StatusTypeDef	HAL_UARTEx_EnableStopMode (UART_HandleTypeDef *huart)
	Enable UART Stop Mode.
HAL_StatusTypeDef	HAL_UARTEx_DisableStopMode (UART_HandleTypeDef *huart)
	Disable UART Stop Mode.
HAL_StatusTypeDef	HAL_MultiProcessorEx_AddressLength_Set (UART_HandleTypeDef *huart, uint32_t AddressLength)
	By default in multiprocessor mode, when the wake up method is set to address mark, the UART handles only 4-bit long addresses detection; this API allows to enable longer addresses detection (6-, 7- or 8-bit long).
HAL_StatusTypeDef	HAL_UARTEx_EnableFifoMode (UART_HandleTypeDef *huart)
	Enable the FIFO mode.
HAL_StatusTypeDef	HAL_UARTEx_DisableFifoMode (UART_HandleTypeDef *huart)
	Disable the FIFO mode.
HAL_StatusTypeDef	HAL_UARTEx_SetTxFifoThreshold (UART_HandleTypeDef *huart, uint32_t Threshold)
	Set the TXFIFO threshold.
HAL_StatusTypeDef	HAL_UARTEx_SetRxFifoThreshold (UART_HandleTypeDef *huart, uint32_t Threshold)
	Set the RXFIFO threshold.
HAL_StatusTypeDef	HAL_UARTEx_ReceiveToIdle (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint16_t *RxLen, uint32_t Timeout)
	Receive an amount of data in blocking mode till either the expected number of data is received or an IDLE event occurs.
HAL_StatusTypeDef	HAL_UARTEx_ReceiveToIdle_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Receive an amount of data in interrupt mode till either the expected number of data is received or an IDLE event occurs.
HAL_StatusTypeDef	HAL_UARTEx_ReceiveToIdle_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
	Receive an amount of data in DMA mode till either the expected number of data is received or an IDLE event occurs.

---

Detailed Description

Header file of UART HAL Extended module.

Author:

MCD Application Team

Attention:

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32h7xx_hal_uart_ex.h.