You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
425 lines
20 KiB
425 lines
20 KiB
/** |
|
****************************************************************************** |
|
* @file stm32f7xx_hal_uart_ex.h |
|
* @author MCD Application Team |
|
* @brief Header file of UART HAL Extended module. |
|
****************************************************************************** |
|
* @attention |
|
* |
|
* <h2><center>© Copyright (c) 2017 STMicroelectronics. |
|
* All rights reserved.</center></h2> |
|
* |
|
* This software component is licensed by ST under BSD 3-Clause license, |
|
* the "License"; You may not use this file except in compliance with the |
|
* License. You may obtain a copy of the License at: |
|
* opensource.org/licenses/BSD-3-Clause |
|
* |
|
****************************************************************************** |
|
*/ |
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/ |
|
#ifndef STM32F7xx_HAL_UART_EX_H |
|
#define STM32F7xx_HAL_UART_EX_H |
|
|
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
/* Includes ------------------------------------------------------------------*/ |
|
#include "stm32f7xx_hal_def.h" |
|
|
|
/** @addtogroup STM32F7xx_HAL_Driver |
|
* @{ |
|
*/ |
|
|
|
/** @addtogroup UARTEx |
|
* @{ |
|
*/ |
|
|
|
/* Exported types ------------------------------------------------------------*/ |
|
/** @defgroup UARTEx_Exported_Types UARTEx Exported Types |
|
* @{ |
|
*/ |
|
|
|
#if defined(USART_CR1_UESM) |
|
/** |
|
* @brief UART wake up from stop mode parameters |
|
*/ |
|
typedef struct |
|
{ |
|
uint32_t WakeUpEvent; /*!< Specifies which event will activate the Wakeup from Stop mode flag (WUF). |
|
This parameter can be a value of @ref UART_WakeUp_from_Stop_Selection. |
|
If set to UART_WAKEUP_ON_ADDRESS, the two other fields below must |
|
be filled up. */ |
|
|
|
uint16_t AddressLength; /*!< Specifies whether the address is 4 or 7-bit long. |
|
This parameter can be a value of @ref UARTEx_WakeUp_Address_Length. */ |
|
|
|
uint8_t Address; /*!< UART/USART node address (7-bit long max). */ |
|
} UART_WakeUpTypeDef; |
|
|
|
#endif /* USART_CR1_UESM */ |
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Exported constants --------------------------------------------------------*/ |
|
/** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants |
|
* @{ |
|
*/ |
|
|
|
/** @defgroup UARTEx_Word_Length UARTEx Word Length |
|
* @{ |
|
*/ |
|
#define UART_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long UART frame */ |
|
#define UART_WORDLENGTH_8B 0x00000000U /*!< 8-bit long UART frame */ |
|
#define UART_WORDLENGTH_9B USART_CR1_M0 /*!< 9-bit long UART frame */ |
|
/** |
|
* @} |
|
*/ |
|
|
|
/** @defgroup UARTEx_WakeUp_Address_Length UARTEx WakeUp Address Length |
|
* @{ |
|
*/ |
|
#define UART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit long wake-up address */ |
|
#define UART_ADDRESS_DETECT_7B USART_CR2_ADDM7 /*!< 7-bit long wake-up address */ |
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Exported macros -----------------------------------------------------------*/ |
|
/* Exported functions --------------------------------------------------------*/ |
|
/** @addtogroup UARTEx_Exported_Functions |
|
* @{ |
|
*/ |
|
|
|
/** @addtogroup UARTEx_Exported_Functions_Group1 |
|
* @{ |
|
*/ |
|
|
|
/* Initialization and de-initialization functions ****************************/ |
|
HAL_StatusTypeDef HAL_RS485Ex_Init(UART_HandleTypeDef *huart, uint32_t Polarity, uint32_t AssertionTime, |
|
uint32_t DeassertionTime); |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** @addtogroup UARTEx_Exported_Functions_Group2 |
|
* @{ |
|
*/ |
|
|
|
#if defined(USART_CR1_UESM) |
|
void HAL_UARTEx_WakeupCallback(UART_HandleTypeDef *huart); |
|
|
|
#endif /* USART_CR1_UESM */ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** @addtogroup UARTEx_Exported_Functions_Group3 |
|
* @{ |
|
*/ |
|
|
|
/* Peripheral Control functions **********************************************/ |
|
#if defined(USART_CR1_UESM) |
|
HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection); |
|
HAL_StatusTypeDef HAL_UARTEx_EnableStopMode(UART_HandleTypeDef *huart); |
|
HAL_StatusTypeDef HAL_UARTEx_DisableStopMode(UART_HandleTypeDef *huart); |
|
|
|
#endif/* USART_CR1_UESM */ |
|
#if defined(USART_CR3_UCESM) |
|
HAL_StatusTypeDef HAL_UARTEx_EnableClockStopMode(UART_HandleTypeDef *huart); |
|
HAL_StatusTypeDef HAL_UARTEx_DisableClockStopMode(UART_HandleTypeDef *huart); |
|
|
|
#endif /* USART_CR3_UCESM */ |
|
HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set(UART_HandleTypeDef *huart, uint32_t AddressLength); |
|
|
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Private macros ------------------------------------------------------------*/ |
|
/** @defgroup UARTEx_Private_Macros UARTEx Private Macros |
|
* @{ |
|
*/ |
|
|
|
/** @brief Report the UART clock source. |
|
* @param __HANDLE__ specifies the UART Handle. |
|
* @param __CLOCKSOURCE__ output variable. |
|
* @retval UART clocking source, written in __CLOCKSOURCE__. |
|
*/ |
|
#define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
|
do { \ |
|
if((__HANDLE__)->Instance == USART1) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
|
{ \ |
|
case RCC_USART1CLKSOURCE_PCLK2: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK2; \ |
|
break; \ |
|
case RCC_USART1CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_USART1CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_USART1CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if((__HANDLE__)->Instance == USART2) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_USART2_SOURCE()) \ |
|
{ \ |
|
case RCC_USART2CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_USART2CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_USART2CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_USART2CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if((__HANDLE__)->Instance == USART3) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_USART3_SOURCE()) \ |
|
{ \ |
|
case RCC_USART3CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_USART3CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_USART3CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_USART3CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if((__HANDLE__)->Instance == UART4) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_UART4_SOURCE()) \ |
|
{ \ |
|
case RCC_UART4CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_UART4CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_UART4CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_UART4CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if ((__HANDLE__)->Instance == UART5) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_UART5_SOURCE()) \ |
|
{ \ |
|
case RCC_UART5CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_UART5CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_UART5CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_UART5CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if((__HANDLE__)->Instance == USART6) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_USART6_SOURCE()) \ |
|
{ \ |
|
case RCC_USART6CLKSOURCE_PCLK2: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK2; \ |
|
break; \ |
|
case RCC_USART6CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_USART6CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_USART6CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if ((__HANDLE__)->Instance == UART7) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_UART7_SOURCE()) \ |
|
{ \ |
|
case RCC_UART7CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_UART7CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_UART7CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_UART7CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else if ((__HANDLE__)->Instance == UART8) \ |
|
{ \ |
|
switch(__HAL_RCC_GET_UART8_SOURCE()) \ |
|
{ \ |
|
case RCC_UART8CLKSOURCE_PCLK1: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
|
break; \ |
|
case RCC_UART8CLKSOURCE_HSI: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
|
break; \ |
|
case RCC_UART8CLKSOURCE_SYSCLK: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
|
break; \ |
|
case RCC_UART8CLKSOURCE_LSE: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
|
break; \ |
|
default: \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
break; \ |
|
} \ |
|
} \ |
|
else \ |
|
{ \ |
|
(__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
|
} \ |
|
} while(0U) |
|
|
|
/** @brief Report the UART mask to apply to retrieve the received data |
|
* according to the word length and to the parity bits activation. |
|
* @note If PCE = 1, the parity bit is not included in the data extracted |
|
* by the reception API(). |
|
* This masking operation is not carried out in the case of |
|
* DMA transfers. |
|
* @param __HANDLE__ specifies the UART Handle. |
|
* @retval None, the mask to apply to UART RDR register is stored in (__HANDLE__)->Mask field. |
|
*/ |
|
#define UART_MASK_COMPUTATION(__HANDLE__) \ |
|
do { \ |
|
if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_9B) \ |
|
{ \ |
|
if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x01FFU ; \ |
|
} \ |
|
else \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x00FFU ; \ |
|
} \ |
|
} \ |
|
else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_8B) \ |
|
{ \ |
|
if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x00FFU ; \ |
|
} \ |
|
else \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x007FU ; \ |
|
} \ |
|
} \ |
|
else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_7B) \ |
|
{ \ |
|
if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x007FU ; \ |
|
} \ |
|
else \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x003FU ; \ |
|
} \ |
|
} \ |
|
else \ |
|
{ \ |
|
(__HANDLE__)->Mask = 0x0000U; \ |
|
} \ |
|
} while(0U) |
|
|
|
/** |
|
* @brief Ensure that UART frame length is valid. |
|
* @param __LENGTH__ UART frame length. |
|
* @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) |
|
*/ |
|
#define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_7B) || \ |
|
((__LENGTH__) == UART_WORDLENGTH_8B) || \ |
|
((__LENGTH__) == UART_WORDLENGTH_9B)) |
|
|
|
/** |
|
* @brief Ensure that UART wake-up address length is valid. |
|
* @param __ADDRESS__ UART wake-up address length. |
|
* @retval SET (__ADDRESS__ is valid) or RESET (__ADDRESS__ is invalid) |
|
*/ |
|
#define IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__) (((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \ |
|
((__ADDRESS__) == UART_ADDRESS_DETECT_7B)) |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Private functions ---------------------------------------------------------*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#endif /* STM32F7xx_HAL_UART_EX_H */ |
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
|
|