Greg Steiert / maxim-dev

Dependents:   MAX34417_demo MAXREFDES1265 MAXREFDES1265

Fork of mbed-dev by mbed official

Committer:
switches
Date:
Fri Mar 24 15:15:13 2017 +0000
Revision:
164:2e7515f8c45d
Parent:
149:156823d33999
Added low level init to clear IO registers

Who changed what in which revision?

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