| /** |
| ****************************************************************************** |
| * @file stm32l0xx_hal_uart_ex.h |
| * @author MCD Application Team |
| * @brief Header file of UART HAL Extended module. |
| ****************************************************************************** |
| * @attention |
| * |
| * <h2><center>© Copyright (c) 2016 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 __STM32L0xx_HAL_UART_EX_H |
| #define __STM32L0xx_HAL_UART_EX_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32l0xx_hal_def.h" |
| |
| /** @addtogroup STM32L0xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup UARTEx |
| * @{ |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /** @defgroup UARTEx_Exported_Types UARTEx Exported Types |
| * @{ |
| */ |
| |
| /** |
| * @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; |
| |
| /** |
| * @} |
| */ |
| |
| /* 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 |
| * @{ |
| */ |
| |
| void HAL_UARTEx_WakeupCallback(UART_HandleTypeDef *huart); |
| |
| |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup UARTEx_Exported_Functions_Group3 |
| * @{ |
| */ |
| |
| /* Peripheral Control functions **********************************************/ |
| 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); |
| HAL_StatusTypeDef HAL_UARTEx_EnableClockStopMode(UART_HandleTypeDef *huart); |
| HAL_StatusTypeDef HAL_UARTEx_DisableClockStopMode(UART_HandleTypeDef *huart); |
| 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__. |
| */ |
| #if defined (STM32L031xx) || defined (STM32L041xx) || defined (STM32L011xx) || defined (STM32L021xx) || defined (STM32L010xB) || defined (STM32L010x8) || defined (STM32L010x6) || defined (STM32L010x4) |
| #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| 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 == LPUART1) \ |
| { \ |
| switch(__HAL_RCC_GET_LPUART1_SOURCE()) \ |
| { \ |
| case RCC_LPUART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| |
| #elif defined (STM32L051xx) || defined (STM32L052xx) || defined (STM32L053xx) || defined (STM32L061xx) || defined (STM32L062xx) || defined (STM32L063xx) |
| |
| #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 == LPUART1) \ |
| { \ |
| switch(__HAL_RCC_GET_LPUART1_SOURCE()) \ |
| { \ |
| case RCC_LPUART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| |
| #else |
| |
| #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 == USART4) \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART5) \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == LPUART1) \ |
| { \ |
| switch(__HAL_RCC_GET_LPUART1_SOURCE()) \ |
| { \ |
| case RCC_LPUART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_LPUART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| #endif /* (STM32L031xx) || (STM32L041xx) || (STM32L011xx) || (STM32L021xx) || (STM32L010xB) || (STM32L010x8) || (STM32L010x6) || (STM32L010x4)*/ |
| |
| |
| /** @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 /* __STM32L0xx_HAL_UART_EX_H */ |
| |
| /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |
