/** | |
****************************************************************************** | |
* @file stm32l4xx_hal_usart_ex.h | |
* @author MCD Application Team | |
* @version V1.7.1 | |
* @date 21-April-2017 | |
* @brief Header file of USART HAL Extended module. | |
****************************************************************************** | |
* @attention | |
* | |
* <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> | |
* | |
* Redistribution and use in source and binary forms, with or without modification, | |
* are permitted provided that the following conditions are met: | |
* 1. Redistributions of source code must retain the above copyright notice, | |
* this list of conditions and the following disclaimer. | |
* 2. Redistributions in binary form must reproduce the above copyright notice, | |
* this list of conditions and the following disclaimer in the documentation | |
* and/or other materials provided with the distribution. | |
* 3. Neither the name of STMicroelectronics nor the names of its contributors | |
* may be used to endorse or promote products derived from this software | |
* without specific prior written permission. | |
* | |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
* | |
****************************************************************************** | |
*/ | |
/* Define to prevent recursive inclusion -------------------------------------*/ | |
#ifndef __STM32L4xx_HAL_USART_EX_H | |
#define __STM32L4xx_HAL_USART_EX_H | |
#ifdef __cplusplus | |
extern "C" { | |
#endif | |
/* Includes ------------------------------------------------------------------*/ | |
#include "stm32l4xx_hal_def.h" | |
/** @addtogroup STM32L4xx_HAL_Driver | |
* @{ | |
*/ | |
/** @addtogroup USARTEx | |
* @{ | |
*/ | |
/* Exported types ------------------------------------------------------------*/ | |
/* Exported constants --------------------------------------------------------*/ | |
/** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants | |
* @{ | |
*/ | |
/** @defgroup USARTEx_Word_Length USARTEx Word Length | |
* @{ | |
*/ | |
#define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long USART frame */ | |
#define USART_WORDLENGTH_8B ((uint32_t)0x00000000) /*!< 8-bit long USART frame */ | |
#define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long USART frame */ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/* Exported functions --------------------------------------------------------*/ | |
/* 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__. | |
*/ | |
#if defined (STM32L432xx) || defined (STM32L442xx) | |
#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; \ | |
} \ | |
} \ | |
} while(0) | |
#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; \ | |
} \ | |
} \ | |
} while(0) | |
#endif /* STM32L432xx || STM32L442xx */ | |
/** @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. | |
*/ | |
#define USART_MASK_COMPUTATION(__HANDLE__) \ | |
do { \ | |
if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \ | |
{ \ | |
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \ | |
{ \ | |
(__HANDLE__)->Mask = 0x01FF ; \ | |
} \ | |
else \ | |
{ \ | |
(__HANDLE__)->Mask = 0x00FF ; \ | |
} \ | |
} \ | |
else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \ | |
{ \ | |
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \ | |
{ \ | |
(__HANDLE__)->Mask = 0x00FF ; \ | |
} \ | |
else \ | |
{ \ | |
(__HANDLE__)->Mask = 0x007F ; \ | |
} \ | |
} \ | |
else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \ | |
{ \ | |
if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \ | |
{ \ | |
(__HANDLE__)->Mask = 0x007F ; \ | |
} \ | |
else \ | |
{ \ | |
(__HANDLE__)->Mask = 0x003F ; \ | |
} \ | |
} \ | |
} while(0) | |
/** | |
* @brief Ensure that USART frame length is valid. | |
* @param __LENGTH__: USART frame length. | |
* @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) | |
*/ | |
#define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \ | |
((__LENGTH__) == USART_WORDLENGTH_8B) || \ | |
((__LENGTH__) == USART_WORDLENGTH_9B)) | |
/** | |
* @} | |
*/ | |
/* Exported functions --------------------------------------------------------*/ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
#ifdef __cplusplus | |
} | |
#endif | |
#endif /* __STM32L4xx_HAL_USART_EX_H */ | |
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |