| /** |
| ****************************************************************************** |
| * @file stm32f0xx_hal_irda_ex.h |
| * @author MCD Application Team |
| * @brief Header file of IRDA 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 __STM32F0xx_HAL_IRDA_EX_H |
| #define __STM32F0xx_HAL_IRDA_EX_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #if !defined(STM32F030x6) && !defined(STM32F030x8) && !defined(STM32F070x6) && !defined(STM32F070xB) && !defined(STM32F030xC) |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32f0xx_hal_def.h" |
| |
| /** @addtogroup STM32F0xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup IRDAEx |
| * @{ |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /* Exported constants --------------------------------------------------------*/ |
| /** @defgroup IRDAEx_Exported_Constants IRDAEx Exported Constants |
| * @{ |
| */ |
| |
| /** @defgroup IRDAEx_Word_Length IRDA Word Length |
| * @{ |
| */ |
| #if defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined (STM32F098xx) |
| #define IRDA_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long frame */ |
| #define IRDA_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long frame */ |
| #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long frame */ |
| #else |
| #define IRDA_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long frame */ |
| #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M) /*!< 9-bit long frame */ |
| #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined (STM32F098xx)*/ |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported macros -----------------------------------------------------------*/ |
| /* Exported functions --------------------------------------------------------*/ |
| |
| /* Private macros ------------------------------------------------------------*/ |
| |
| /** @defgroup IRDAEx_Private_Macros IRDAEx Private Macros |
| * @{ |
| */ |
| |
| /** @brief Report the IRDA clock source. |
| * @param __HANDLE__ specifies the IRDA Handle. |
| * @param __CLOCKSOURCE__ output variable. |
| * @retval IRDA clocking source, written in __CLOCKSOURCE__. |
| */ |
| |
| #if defined(STM32F031x6) || defined(STM32F038xx) |
| #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
| { \ |
| case RCC_USART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } while(0) |
| #elif defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F051x8) || defined (STM32F058xx) |
| #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| if((__HANDLE__)->Instance == USART1) \ |
| { \ |
| switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
| { \ |
| case RCC_USART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART2) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| #elif defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) |
| #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| if((__HANDLE__)->Instance == USART1) \ |
| { \ |
| switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
| { \ |
| case RCC_USART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART2) \ |
| { \ |
| switch(__HAL_RCC_GET_USART2_SOURCE()) \ |
| { \ |
| case RCC_USART2CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART3) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART4) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| #elif defined(STM32F091xC) || defined(STM32F098xx) |
| #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ |
| do { \ |
| if((__HANDLE__)->Instance == USART1) \ |
| { \ |
| switch(__HAL_RCC_GET_USART1_SOURCE()) \ |
| { \ |
| case RCC_USART1CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART1CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART2) \ |
| { \ |
| switch(__HAL_RCC_GET_USART2_SOURCE()) \ |
| { \ |
| case RCC_USART2CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART2CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART3) \ |
| { \ |
| switch(__HAL_RCC_GET_USART3_SOURCE()) \ |
| { \ |
| case RCC_USART3CLKSOURCE_PCLK1: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| break; \ |
| case RCC_USART3CLKSOURCE_HSI: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \ |
| break; \ |
| case RCC_USART3CLKSOURCE_SYSCLK: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \ |
| break; \ |
| case RCC_USART3CLKSOURCE_LSE: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \ |
| break; \ |
| default: \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| break; \ |
| } \ |
| } \ |
| else if((__HANDLE__)->Instance == USART4) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART5) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART6) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART7) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else if((__HANDLE__)->Instance == USART8) \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \ |
| } \ |
| else \ |
| { \ |
| (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \ |
| } \ |
| } while(0) |
| |
| #endif /* defined(STM32F031x6) || defined(STM32F038xx) */ |
| |
| |
| /** @brief Compute the 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 IRDA Handle. |
| * @retval None, the mask to apply to the associated UART RDR register is stored in (__HANDLE__)->Mask field. |
| */ |
| #if defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined (STM32F098xx) |
| #define IRDA_MASK_COMPUTATION(__HANDLE__) \ |
| do { \ |
| if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \ |
| { \ |
| if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ |
| { \ |
| (__HANDLE__)->Mask = 0x01FFU ; \ |
| } \ |
| else \ |
| { \ |
| (__HANDLE__)->Mask = 0x00FFU ; \ |
| } \ |
| } \ |
| else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \ |
| { \ |
| if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ |
| { \ |
| (__HANDLE__)->Mask = 0x00FFU ; \ |
| } \ |
| else \ |
| { \ |
| (__HANDLE__)->Mask = 0x007FU ; \ |
| } \ |
| } \ |
| else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_7B) \ |
| { \ |
| if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ |
| { \ |
| (__HANDLE__)->Mask = 0x007FU ; \ |
| } \ |
| else \ |
| { \ |
| (__HANDLE__)->Mask = 0x003FU ; \ |
| } \ |
| } \ |
| } while(0) |
| #else |
| #define IRDA_MASK_COMPUTATION(__HANDLE__) \ |
| do { \ |
| if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \ |
| { \ |
| if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ |
| { \ |
| (__HANDLE__)->Mask = 0x01FFU ; \ |
| } \ |
| else \ |
| { \ |
| (__HANDLE__)->Mask = 0x00FFU ; \ |
| } \ |
| } \ |
| else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \ |
| { \ |
| if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ |
| { \ |
| (__HANDLE__)->Mask = 0x00FFU ; \ |
| } \ |
| else \ |
| { \ |
| (__HANDLE__)->Mask = 0x007FU ; \ |
| } \ |
| } \ |
| } while(0) |
| #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined(STM32F098xx) */ |
| |
| /** |
| * @brief Ensure that IRDA frame length is valid. |
| * @param __LENGTH__ IRDA frame length. |
| * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) |
| */ |
| #if defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined (STM32F098xx) |
| #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_7B) || \ |
| ((__LENGTH__) == IRDA_WORDLENGTH_8B) || \ |
| ((__LENGTH__) == IRDA_WORDLENGTH_9B)) |
| #else |
| #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_8B) || \ |
| ((__LENGTH__) == IRDA_WORDLENGTH_9B)) |
| #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \ |
| defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \ |
| defined (STM32F091xC) || defined (STM32F098xx)*/ |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported functions --------------------------------------------------------*/ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| #endif /* !defined(STM32F030x6) && !defined(STM32F030x8) && !defined(STM32F070x6) && !defined(STM32F070xB) && !defined(STM32F030xC) */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* __STM32F0xx_HAL_IRDA_EX_H */ |
| |
| /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |
| |
