Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_DISCO_L053C8/stm32l0xx_hal_irda_ex.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
99:dbbf35b96557 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 99:dbbf35b96557 1 /**
Kojto 99:dbbf35b96557 2 ******************************************************************************
Kojto 99:dbbf35b96557 3 * @file stm32l0xx_hal_irda_ex.h
Kojto 99:dbbf35b96557 4 * @author MCD Application Team
Kojto 99:dbbf35b96557 5 * @version V1.2.0
Kojto 99:dbbf35b96557 6 * @date 06-February-2015
Kojto 99:dbbf35b96557 7 * @brief Header file of IRDA HAL Extension module.
Kojto 99:dbbf35b96557 8 ******************************************************************************
Kojto 99:dbbf35b96557 9 * @attention
Kojto 99:dbbf35b96557 10 *
Kojto 99:dbbf35b96557 11 * <h2><center>&copy; COPYRIGHT(c) 2013 STMicroelectronics</center></h2>
Kojto 99:dbbf35b96557 12 *
Kojto 99:dbbf35b96557 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 99:dbbf35b96557 14 * are permitted provided that the following conditions are met:
Kojto 99:dbbf35b96557 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 99:dbbf35b96557 16 * this list of conditions and the following disclaimer.
Kojto 99:dbbf35b96557 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 99:dbbf35b96557 18 * this list of conditions and the following disclaimer in the documentation
Kojto 99:dbbf35b96557 19 * and/or other materials provided with the distribution.
Kojto 99:dbbf35b96557 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 99:dbbf35b96557 21 * may be used to endorse or promote products derived from this software
Kojto 99:dbbf35b96557 22 * without specific prior written permission.
Kojto 99:dbbf35b96557 23 *
Kojto 99:dbbf35b96557 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 99:dbbf35b96557 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 99:dbbf35b96557 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 99:dbbf35b96557 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 99:dbbf35b96557 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 99:dbbf35b96557 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 99:dbbf35b96557 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 99:dbbf35b96557 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 99:dbbf35b96557 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 99:dbbf35b96557 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 99:dbbf35b96557 34 *
Kojto 99:dbbf35b96557 35 ******************************************************************************
Kojto 99:dbbf35b96557 36 */
Kojto 99:dbbf35b96557 37
Kojto 99:dbbf35b96557 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 99:dbbf35b96557 39 #ifndef __STM32L0xx_HAL_IRDA_EX_H
Kojto 99:dbbf35b96557 40 #define __STM32L0xx_HAL_IRDA_EX_H
Kojto 99:dbbf35b96557 41
Kojto 99:dbbf35b96557 42 #ifdef __cplusplus
Kojto 99:dbbf35b96557 43 extern "C" {
Kojto 99:dbbf35b96557 44 #endif
Kojto 99:dbbf35b96557 45
Kojto 99:dbbf35b96557 46 /* Includes ------------------------------------------------------------------*/
Kojto 99:dbbf35b96557 47 #include "stm32l0xx_hal_def.h"
Kojto 99:dbbf35b96557 48
Kojto 99:dbbf35b96557 49 /** @addtogroup STM32L0xx_HAL_Driver
Kojto 99:dbbf35b96557 50 * @{
Kojto 99:dbbf35b96557 51 */
Kojto 99:dbbf35b96557 52
Kojto 99:dbbf35b96557 53 /** @addtogroup IRDAEx
Kojto 99:dbbf35b96557 54 * @{
Kojto 99:dbbf35b96557 55 */
Kojto 99:dbbf35b96557 56
Kojto 99:dbbf35b96557 57 /* Exported types ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 58 /* Exported constants --------------------------------------------------------*/
Kojto 99:dbbf35b96557 59 /** @defgroup IRDAEx_Extended_Exported_Constants IRDA Extended Exported Constants
Kojto 99:dbbf35b96557 60 * @{
Kojto 99:dbbf35b96557 61 */
Kojto 99:dbbf35b96557 62
Kojto 99:dbbf35b96557 63 /** @defgroup IRDAEx_Word_Length IRDAEx Word length
Kojto 99:dbbf35b96557 64 * @{
Kojto 99:dbbf35b96557 65 */
Kojto 99:dbbf35b96557 66 #define IRDA_WORDLENGTH_7B ((uint32_t)USART_CR1_M_1)
Kojto 99:dbbf35b96557 67 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
Kojto 99:dbbf35b96557 68 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0)
Kojto 99:dbbf35b96557 69 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_7B) || \
Kojto 99:dbbf35b96557 70 ((LENGTH) == IRDA_WORDLENGTH_8B) || \
Kojto 99:dbbf35b96557 71 ((LENGTH) == IRDA_WORDLENGTH_9B))
Kojto 99:dbbf35b96557 72 /**
Kojto 99:dbbf35b96557 73 * @}
Kojto 99:dbbf35b96557 74 */
Kojto 99:dbbf35b96557 75
Kojto 99:dbbf35b96557 76
Kojto 99:dbbf35b96557 77 /**
Kojto 99:dbbf35b96557 78 * @}
Kojto 99:dbbf35b96557 79 */
Kojto 99:dbbf35b96557 80
Kojto 99:dbbf35b96557 81 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 82
Kojto 99:dbbf35b96557 83 /** @defgroup IRDAEx_Extended_Exported_Macros IRDA Extended Exported Macros
Kojto 99:dbbf35b96557 84 * @{
Kojto 99:dbbf35b96557 85 */
Kojto 99:dbbf35b96557 86 /** @brief Reports the IRDA clock source.
Kojto 99:dbbf35b96557 87 * @param __HANDLE__: specifies the UART Handle
Kojto 99:dbbf35b96557 88 * @param __CLOCKSOURCE__ : output variable
Kojto 99:dbbf35b96557 89 * @retval IRDA clocking source, written in __CLOCKSOURCE__.
Kojto 99:dbbf35b96557 90 */
Kojto 99:dbbf35b96557 91 #if defined (STM32L031xx) || defined (STM32L041xx)
Kojto 99:dbbf35b96557 92 #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
Kojto 99:dbbf35b96557 93 do { \
Kojto 99:dbbf35b96557 94 if((__HANDLE__)->Instance == USART2) \
Kojto 99:dbbf35b96557 95 { \
Kojto 99:dbbf35b96557 96 switch(__HAL_RCC_GET_USART2_SOURCE()) \
Kojto 99:dbbf35b96557 97 { \
Kojto 99:dbbf35b96557 98 case RCC_USART2CLKSOURCE_PCLK1: \
Kojto 99:dbbf35b96557 99 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
Kojto 99:dbbf35b96557 100 break; \
Kojto 99:dbbf35b96557 101 case RCC_USART2CLKSOURCE_HSI: \
Kojto 99:dbbf35b96557 102 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
Kojto 99:dbbf35b96557 103 break; \
Kojto 99:dbbf35b96557 104 case RCC_USART2CLKSOURCE_SYSCLK: \
Kojto 99:dbbf35b96557 105 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
Kojto 99:dbbf35b96557 106 break; \
Kojto 99:dbbf35b96557 107 case RCC_USART2CLKSOURCE_LSE: \
Kojto 99:dbbf35b96557 108 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
Kojto 99:dbbf35b96557 109 break; \
Kojto 99:dbbf35b96557 110 default: \
Kojto 99:dbbf35b96557 111 break; \
Kojto 99:dbbf35b96557 112 } \
Kojto 99:dbbf35b96557 113 } \
Kojto 99:dbbf35b96557 114 else if((__HANDLE__)->Instance == LPUART1) \
Kojto 99:dbbf35b96557 115 { \
Kojto 99:dbbf35b96557 116 switch(__HAL_RCC_GET_LPUART1_SOURCE()) \
Kojto 99:dbbf35b96557 117 { \
Kojto 99:dbbf35b96557 118 case RCC_LPUART1CLKSOURCE_PCLK1: \
Kojto 99:dbbf35b96557 119 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
Kojto 99:dbbf35b96557 120 break; \
Kojto 99:dbbf35b96557 121 case RCC_LPUART1CLKSOURCE_HSI: \
Kojto 99:dbbf35b96557 122 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
Kojto 99:dbbf35b96557 123 break; \
Kojto 99:dbbf35b96557 124 case RCC_LPUART1CLKSOURCE_SYSCLK: \
Kojto 99:dbbf35b96557 125 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
Kojto 99:dbbf35b96557 126 break; \
Kojto 99:dbbf35b96557 127 case RCC_LPUART1CLKSOURCE_LSE: \
Kojto 99:dbbf35b96557 128 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
Kojto 99:dbbf35b96557 129 break; \
Kojto 99:dbbf35b96557 130 default: \
Kojto 99:dbbf35b96557 131 break; \
Kojto 99:dbbf35b96557 132 } \
Kojto 99:dbbf35b96557 133 } \
Kojto 99:dbbf35b96557 134 } while(0)
Kojto 99:dbbf35b96557 135
Kojto 99:dbbf35b96557 136 #else /* (STM32L031xx) || defined (STM32L041xx) */
Kojto 99:dbbf35b96557 137
Kojto 99:dbbf35b96557 138 #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
Kojto 99:dbbf35b96557 139 do { \
Kojto 99:dbbf35b96557 140 if((__HANDLE__)->Instance == USART1) \
Kojto 99:dbbf35b96557 141 { \
Kojto 99:dbbf35b96557 142 switch(__HAL_RCC_GET_USART1_SOURCE()) \
Kojto 99:dbbf35b96557 143 { \
Kojto 99:dbbf35b96557 144 case RCC_USART1CLKSOURCE_PCLK2: \
Kojto 99:dbbf35b96557 145 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK2; \
Kojto 99:dbbf35b96557 146 break; \
Kojto 99:dbbf35b96557 147 case RCC_USART1CLKSOURCE_HSI: \
Kojto 99:dbbf35b96557 148 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
Kojto 99:dbbf35b96557 149 break; \
Kojto 99:dbbf35b96557 150 case RCC_USART1CLKSOURCE_SYSCLK: \
Kojto 99:dbbf35b96557 151 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
Kojto 99:dbbf35b96557 152 break; \
Kojto 99:dbbf35b96557 153 case RCC_USART1CLKSOURCE_LSE: \
Kojto 99:dbbf35b96557 154 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
Kojto 99:dbbf35b96557 155 break; \
Kojto 99:dbbf35b96557 156 default: \
Kojto 99:dbbf35b96557 157 break; \
Kojto 99:dbbf35b96557 158 } \
Kojto 99:dbbf35b96557 159 } \
Kojto 99:dbbf35b96557 160 else if((__HANDLE__)->Instance == USART2) \
Kojto 99:dbbf35b96557 161 { \
Kojto 99:dbbf35b96557 162 switch(__HAL_RCC_GET_USART2_SOURCE()) \
Kojto 99:dbbf35b96557 163 { \
Kojto 99:dbbf35b96557 164 case RCC_USART2CLKSOURCE_PCLK1: \
Kojto 99:dbbf35b96557 165 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
Kojto 99:dbbf35b96557 166 break; \
Kojto 99:dbbf35b96557 167 case RCC_USART2CLKSOURCE_HSI: \
Kojto 99:dbbf35b96557 168 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
Kojto 99:dbbf35b96557 169 break; \
Kojto 99:dbbf35b96557 170 case RCC_USART2CLKSOURCE_SYSCLK: \
Kojto 99:dbbf35b96557 171 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
Kojto 99:dbbf35b96557 172 break; \
Kojto 99:dbbf35b96557 173 case RCC_USART2CLKSOURCE_LSE: \
Kojto 99:dbbf35b96557 174 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
Kojto 99:dbbf35b96557 175 break; \
Kojto 99:dbbf35b96557 176 default: \
Kojto 99:dbbf35b96557 177 break; \
Kojto 99:dbbf35b96557 178 } \
Kojto 99:dbbf35b96557 179 } \
Kojto 99:dbbf35b96557 180 else if((__HANDLE__)->Instance == LPUART1) \
Kojto 99:dbbf35b96557 181 { \
Kojto 99:dbbf35b96557 182 switch(__HAL_RCC_GET_LPUART1_SOURCE()) \
Kojto 99:dbbf35b96557 183 { \
Kojto 99:dbbf35b96557 184 case RCC_LPUART1CLKSOURCE_PCLK1: \
Kojto 99:dbbf35b96557 185 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
Kojto 99:dbbf35b96557 186 break; \
Kojto 99:dbbf35b96557 187 case RCC_LPUART1CLKSOURCE_HSI: \
Kojto 99:dbbf35b96557 188 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
Kojto 99:dbbf35b96557 189 break; \
Kojto 99:dbbf35b96557 190 case RCC_LPUART1CLKSOURCE_SYSCLK: \
Kojto 99:dbbf35b96557 191 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
Kojto 99:dbbf35b96557 192 break; \
Kojto 99:dbbf35b96557 193 case RCC_LPUART1CLKSOURCE_LSE: \
Kojto 99:dbbf35b96557 194 (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
Kojto 99:dbbf35b96557 195 break; \
Kojto 99:dbbf35b96557 196 default: \
Kojto 99:dbbf35b96557 197 break; \
Kojto 99:dbbf35b96557 198 } \
Kojto 99:dbbf35b96557 199 } \
Kojto 99:dbbf35b96557 200 } while(0)
Kojto 99:dbbf35b96557 201 #endif /* (STM32L031xx) || (STM32L041xx) */
Kojto 99:dbbf35b96557 202
Kojto 99:dbbf35b96557 203 /** @brief Reports the mask to apply to retrieve the received data
Kojto 99:dbbf35b96557 204 * according to the word length and to the parity bits activation.
Kojto 99:dbbf35b96557 205 * @param __HANDLE__: specifies the IRDA Handle
Kojto 99:dbbf35b96557 206 * @retval mask to apply to USART RDR register value.
Kojto 99:dbbf35b96557 207 */
Kojto 99:dbbf35b96557 208 #define IRDA_MASK_COMPUTATION(__HANDLE__) \
Kojto 99:dbbf35b96557 209 do { \
Kojto 99:dbbf35b96557 210 if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \
Kojto 99:dbbf35b96557 211 { \
Kojto 99:dbbf35b96557 212 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
Kojto 99:dbbf35b96557 213 { \
Kojto 99:dbbf35b96557 214 (__HANDLE__)->Mask = 0x01FF ; \
Kojto 99:dbbf35b96557 215 } \
Kojto 99:dbbf35b96557 216 else \
Kojto 99:dbbf35b96557 217 { \
Kojto 99:dbbf35b96557 218 (__HANDLE__)->Mask = 0x00FF ; \
Kojto 99:dbbf35b96557 219 } \
Kojto 99:dbbf35b96557 220 } \
Kojto 99:dbbf35b96557 221 else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \
Kojto 99:dbbf35b96557 222 { \
Kojto 99:dbbf35b96557 223 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
Kojto 99:dbbf35b96557 224 { \
Kojto 99:dbbf35b96557 225 (__HANDLE__)->Mask = 0x00FF ; \
Kojto 99:dbbf35b96557 226 } \
Kojto 99:dbbf35b96557 227 else \
Kojto 99:dbbf35b96557 228 { \
Kojto 99:dbbf35b96557 229 (__HANDLE__)->Mask = 0x007F ; \
Kojto 99:dbbf35b96557 230 } \
Kojto 99:dbbf35b96557 231 } \
Kojto 99:dbbf35b96557 232 else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_7B) \
Kojto 99:dbbf35b96557 233 { \
Kojto 99:dbbf35b96557 234 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
Kojto 99:dbbf35b96557 235 { \
Kojto 99:dbbf35b96557 236 (__HANDLE__)->Mask = 0x007F ; \
Kojto 99:dbbf35b96557 237 } \
Kojto 99:dbbf35b96557 238 else \
Kojto 99:dbbf35b96557 239 { \
Kojto 99:dbbf35b96557 240 (__HANDLE__)->Mask = 0x003F ; \
Kojto 99:dbbf35b96557 241 } \
Kojto 99:dbbf35b96557 242 } \
Kojto 99:dbbf35b96557 243 } while(0)
Kojto 99:dbbf35b96557 244 /**
Kojto 99:dbbf35b96557 245 * @}
Kojto 99:dbbf35b96557 246 */
Kojto 99:dbbf35b96557 247
Kojto 99:dbbf35b96557 248 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 249 /* Initialization/de-initialization methods **********************************/
Kojto 99:dbbf35b96557 250 /* IO operation methods *******************************************************/
Kojto 99:dbbf35b96557 251 /* Peripheral Control methods ************************************************/
Kojto 99:dbbf35b96557 252 /* Peripheral State methods **************************************************/
Kojto 99:dbbf35b96557 253
Kojto 99:dbbf35b96557 254
Kojto 99:dbbf35b96557 255 /**
Kojto 99:dbbf35b96557 256 * @}
Kojto 99:dbbf35b96557 257 */
Kojto 99:dbbf35b96557 258
Kojto 99:dbbf35b96557 259 /**
Kojto 99:dbbf35b96557 260 * @}
Kojto 99:dbbf35b96557 261 */
Kojto 99:dbbf35b96557 262
Kojto 99:dbbf35b96557 263 #ifdef __cplusplus
Kojto 99:dbbf35b96557 264 }
Kojto 99:dbbf35b96557 265 #endif
Kojto 99:dbbf35b96557 266
Kojto 99:dbbf35b96557 267 #endif /* __STM32L0xx_HAL_IRDA_EX_H */
Kojto 99:dbbf35b96557 268
Kojto 99:dbbf35b96557 269 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Kojto 99:dbbf35b96557 270