405 lines
21 KiB
C
405 lines
21 KiB
C
/**
|
|
******************************************************************************
|
|
* @file stm32f3xx_hal_usart_ex.h
|
|
* @author MCD Application Team
|
|
* @brief Header file of USART HAL Extended module.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* Copyright (c) 2016 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.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef STM32F3xx_HAL_USART_EX_H
|
|
#define STM32F3xx_HAL_USART_EX_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "stm32f3xx_hal_def.h"
|
|
|
|
/** @addtogroup STM32F3xx_HAL_Driver
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup USARTEx
|
|
* @{
|
|
*/
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
/* Exported constants --------------------------------------------------------*/
|
|
/** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup USARTEx_Word_Length USARTEx Word Length
|
|
* @{
|
|
*/
|
|
#if defined(USART_CR1_M0)&& defined(USART_CR1_M1)
|
|
#define USART_WORDLENGTH_7B (USART_CR1_M1) /*!< 7-bit long USART frame */
|
|
#define USART_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long USART frame */
|
|
#define USART_WORDLENGTH_9B (USART_CR1_M0) /*!< 9-bit long USART frame */
|
|
#elif defined(USART_CR1_M)
|
|
#define USART_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long USART frame */
|
|
#define USART_WORDLENGTH_9B (USART_CR1_M) /*!< 9-bit long USART frame */
|
|
#endif /* USART_CR1_M0 && USART_CR1_M */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private macros ------------------------------------------------------------*/
|
|
/** @defgroup USARTEx_Private_Macros USARTEx Private Macros
|
|
* @{
|
|
*/
|
|
|
|
/** @brief Report the USART clock source.
|
|
* @param __HANDLE__ specifies the USART Handle.
|
|
* @param __CLOCKSOURCE__ output variable.
|
|
* @retval the USART clocking source, written in __CLOCKSOURCE__.
|
|
*/
|
|
/** @brief Report the USART clock source.
|
|
* @param __HANDLE__ specifies the USART Handle.
|
|
* @param __CLOCKSOURCE__ output variable.
|
|
* @retval USART clocking source, written in __CLOCKSOURCE__.
|
|
*/
|
|
#if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || defined(STM32F302xC) \
|
|
|| defined(STM32F303xC) || defined(STM32F358xx)
|
|
#define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
|
|
do { \
|
|
if((__HANDLE__)->Instance == USART1) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART1_SOURCE()) \
|
|
{ \
|
|
case RCC_USART1CLKSOURCE_PCLK2: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART2) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART2_SOURCE()) \
|
|
{ \
|
|
case RCC_USART2CLKSOURCE_PCLK1: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART3) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART3_SOURCE()) \
|
|
{ \
|
|
case RCC_USART3CLKSOURCE_PCLK1: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
} \
|
|
} while(0U)
|
|
#elif defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || defined(STM32F301x8) \
|
|
|| defined(STM32F302x8) || defined(STM32F318xx)
|
|
#define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
|
|
do { \
|
|
if((__HANDLE__)->Instance == USART1) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART1_SOURCE()) \
|
|
{ \
|
|
case RCC_USART1CLKSOURCE_PCLK1: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART2) \
|
|
{ \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART3) \
|
|
{ \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
} \
|
|
} while(0U)
|
|
#else
|
|
#define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
|
|
do { \
|
|
if((__HANDLE__)->Instance == USART1) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART1_SOURCE()) \
|
|
{ \
|
|
case RCC_USART1CLKSOURCE_PCLK2: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART1CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART2) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART2_SOURCE()) \
|
|
{ \
|
|
case RCC_USART2CLKSOURCE_PCLK1: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART2CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else if((__HANDLE__)->Instance == USART3) \
|
|
{ \
|
|
switch(__HAL_RCC_GET_USART3_SOURCE()) \
|
|
{ \
|
|
case RCC_USART3CLKSOURCE_PCLK1: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_HSI: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_SYSCLK: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
|
|
break; \
|
|
case RCC_USART3CLKSOURCE_LSE: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
|
|
break; \
|
|
default: \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
break; \
|
|
} \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
|
|
} \
|
|
} while(0U)
|
|
#endif /* STM32F302xE || STM32F303xE || STM32F398xx || STM32F302xC || STM32F303xC || STM32F358xx */
|
|
/** @brief Compute the USART 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 USART Handle.
|
|
* @retval None, the mask to apply to USART RDR register is stored in (__HANDLE__)->Mask field.
|
|
*/
|
|
#if defined(USART_CR1_M0)&& defined(USART_CR1_M1)
|
|
#define USART_MASK_COMPUTATION(__HANDLE__) \
|
|
do { \
|
|
if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
|
|
{ \
|
|
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x01FFU; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x00FFU; \
|
|
} \
|
|
} \
|
|
else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
|
|
{ \
|
|
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x00FFU; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x007FU; \
|
|
} \
|
|
} \
|
|
else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
|
|
{ \
|
|
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x007FU; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x003FU; \
|
|
} \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x0000U; \
|
|
} \
|
|
} while(0U)
|
|
#elif defined(USART_CR1_M)
|
|
#define USART_MASK_COMPUTATION(__HANDLE__) \
|
|
do { \
|
|
if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
|
|
{ \
|
|
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x01FFU; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x00FFU; \
|
|
} \
|
|
} \
|
|
else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
|
|
{ \
|
|
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x00FFU; \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x007FU; \
|
|
} \
|
|
} \
|
|
else \
|
|
{ \
|
|
(__HANDLE__)->Mask = 0x0000U; \
|
|
} \
|
|
} while(0U)
|
|
#endif /* USART_CR1_M0 && USART_CR1_M */
|
|
|
|
/**
|
|
* @brief Ensure that USART frame length is valid.
|
|
* @param __LENGTH__ USART frame length.
|
|
* @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
|
|
*/
|
|
#if defined(USART_CR1_M0)&& defined(USART_CR1_M1)
|
|
#define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \
|
|
((__LENGTH__) == USART_WORDLENGTH_8B) || \
|
|
((__LENGTH__) == USART_WORDLENGTH_9B))
|
|
#elif defined(USART_CR1_M)
|
|
#define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_8B) || \
|
|
((__LENGTH__) == USART_WORDLENGTH_9B))
|
|
#endif /* USART_CR1_M0 && USART_CR1_M */
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported functions --------------------------------------------------------*/
|
|
/** @addtogroup USARTEx_Exported_Functions
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup USARTEx_Exported_Functions_Group1
|
|
* @{
|
|
*/
|
|
|
|
/* IO operation functions *****************************************************/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @addtogroup USARTEx_Exported_Functions_Group2
|
|
* @{
|
|
*/
|
|
|
|
/* Peripheral Control functions ***********************************************/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* STM32F3xx_HAL_USART_EX_H */
|
|
|