| /** |
| ****************************************************************************** |
| * @file stm32f3xx_hal_uart_ex.h |
| * @author MCD Application Team |
| * @version V1.4.0 |
| * @date 16-December-2016 |
| * @brief Header file of UART HAL Extended module. |
| ****************************************************************************** |
| * @attention |
| * |
| * <h2><center>© COPYRIGHT(c) 2016 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 __STM32F3xx_HAL_UART_EX_H |
| #define __STM32F3xx_HAL_UART_EX_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32f3xx_hal_def.h" |
| |
| /** @addtogroup STM32F3xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup UARTEx |
| * @{ |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /* Exported constants --------------------------------------------------------*/ |
| /** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants |
| * @{ |
| */ |
| |
| /** @defgroup UARTEx_Word_Length UARTEx Word Length |
| * @{ |
| */ |
| #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \ |
| defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || \ |
| defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) |
| #define UART_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long UART frame */ |
| #define UART_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long UART frame */ |
| #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long UART frame */ |
| #else |
| #define UART_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long UART frame */ |
| #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M) /*!< 9-bit long UART frame */ |
| #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */ |
| /* STM32F303x8 || STM32F334x8 || STM32F328xx || */ |
| /* STM32F301x8 || STM32F302x8 || STM32F318xx */ |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* 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); |
| |
| /** |
| * @} |
| */ |
| |
| /* IO operation functions *****************************************************/ |
| |
| /** @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_MultiProcessorEx_AddressLength_Set(UART_HandleTypeDef *huart, uint32_t AddressLength); |
| void HAL_UARTEx_WakeupCallback(UART_HandleTypeDef *huart); |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* 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(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \ |
| defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) |
| #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 \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0U) |
| #elif defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || \ |
| defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) |
| #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| if((__HANDLE__)->Instance == USART1) \ |
| { \ |
| switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
| { \ |
| case RCC_USART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| 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) \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART3) \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0U) |
| #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 == 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 \ |
| { \ |
| (__CLOCKSOURCE__) = UART_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0U) |
| #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */ |
| /* STM32F302xC || STM32F303xC || STM32F358xx */ |
| |
| |
| /** @brief Compute 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. |
| */ |
| #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \ |
| defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || \ |
| defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) |
| #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 ; \ |
| } \ |
| } \ |
| } while(0U) |
| #else |
| #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 ; \ |
| } \ |
| } \ |
| } while(0U) |
| #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */ |
| /* STM32F303x8 || STM32F334x8 || STM32F328xx || */ |
| /* STM32F301x8 || STM32F302x8 || STM32F318xx */ |
| |
| /** |
| * @brief Ensure that UART frame length is valid. |
| * @param __LENGTH__: UART frame length. |
| * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) |
| */ |
| #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \ |
| defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || \ |
| defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) |
| #define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_7B) || \ |
| ((__LENGTH__) == UART_WORDLENGTH_8B) || \ |
| ((__LENGTH__) == UART_WORDLENGTH_9B)) |
| #else |
| #define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_8B) || \ |
| ((__LENGTH__) == UART_WORDLENGTH_9B)) |
| #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */ |
| /* STM32F303x8 || STM32F334x8 || STM32F328xx || */ |
| /* STM32F301x8 || STM32F302x8 || STM32F318xx */ |
| /** |
| * @} |
| */ |
| |
| /* Private functions ---------------------------------------------------------*/ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* __STM32F3xx_HAL_UART_EX_H */ |
| |
| /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |