erez i / mbed

version_2.0

Dependents:   cc3000_ping_demo_try_2

Fork of mbed by mbed official

TARGET_NUCLEO_L053R8/stm32l0xx_hal_usart_ex.h@86:4f9a848d74c7, 2014-06-25 (annotated)

Committer:
erezi
Date:
Wed Jun 25 06:08:49 2014 +0000
Revision:
86:4f9a848d74c7
Parent:
84:0b3ab51c8877 
version_2.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 84:0b3ab51c8877 1 /**
bogdanm 84:0b3ab51c8877 2 ******************************************************************************
bogdanm 84:0b3ab51c8877 3 * @file stm32l0xx_hal_usart_ex.h
bogdanm 84:0b3ab51c8877 4 * @author MCD Application Team
bogdanm 84:0b3ab51c8877 5 * @version V1.0.0
bogdanm 84:0b3ab51c8877 6 * @date 22-April-2014
bogdanm 84:0b3ab51c8877 7 * @brief Header file of USART HAL Extension module.
bogdanm 84:0b3ab51c8877 8 ******************************************************************************
bogdanm 84:0b3ab51c8877 9 * @attention
bogdanm 84:0b3ab51c8877 10 *
bogdanm 84:0b3ab51c8877 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 84:0b3ab51c8877 12 *
bogdanm 84:0b3ab51c8877 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 84:0b3ab51c8877 14 * are permitted provided that the following conditions are met:
bogdanm 84:0b3ab51c8877 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 84:0b3ab51c8877 16 * this list of conditions and the following disclaimer.
bogdanm 84:0b3ab51c8877 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 84:0b3ab51c8877 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 84:0b3ab51c8877 19 * and/or other materials provided with the distribution.
bogdanm 84:0b3ab51c8877 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 84:0b3ab51c8877 21 * may be used to endorse or promote products derived from this software
bogdanm 84:0b3ab51c8877 22 * without specific prior written permission.
bogdanm 84:0b3ab51c8877 23 *
bogdanm 84:0b3ab51c8877 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 84:0b3ab51c8877 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 84:0b3ab51c8877 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 84:0b3ab51c8877 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 84:0b3ab51c8877 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 84:0b3ab51c8877 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 84:0b3ab51c8877 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 84:0b3ab51c8877 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 84:0b3ab51c8877 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 84:0b3ab51c8877 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 84:0b3ab51c8877 34 *
bogdanm 84:0b3ab51c8877 35 ******************************************************************************
bogdanm 84:0b3ab51c8877 36 */
bogdanm 84:0b3ab51c8877 37
bogdanm 84:0b3ab51c8877 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 84:0b3ab51c8877 39 #ifndef __STM32L0xx_HAL_USART_EX_H
bogdanm 84:0b3ab51c8877 40 #define __STM32L0xx_HAL_USART_EX_H
bogdanm 84:0b3ab51c8877 41
bogdanm 84:0b3ab51c8877 42 #ifdef __cplusplus
bogdanm 84:0b3ab51c8877 43 extern "C" {
bogdanm 84:0b3ab51c8877 44 #endif
bogdanm 84:0b3ab51c8877 45
bogdanm 84:0b3ab51c8877 46 /* Includes ------------------------------------------------------------------*/
bogdanm 84:0b3ab51c8877 47 #include "stm32l0xx_hal_def.h"
bogdanm 84:0b3ab51c8877 48
bogdanm 84:0b3ab51c8877 49 /** @addtogroup STM32L0xx_HAL_Driver
bogdanm 84:0b3ab51c8877 50 * @{
bogdanm 84:0b3ab51c8877 51 */
bogdanm 84:0b3ab51c8877 52
bogdanm 84:0b3ab51c8877 53 /** @addtogroup USARTEx
bogdanm 84:0b3ab51c8877 54 * @{
bogdanm 84:0b3ab51c8877 55 */
bogdanm 84:0b3ab51c8877 56
bogdanm 84:0b3ab51c8877 57 /* Exported types ------------------------------------------------------------*/
bogdanm 84:0b3ab51c8877 58 /* Exported constants --------------------------------------------------------*/
bogdanm 84:0b3ab51c8877 59 /** @defgroup USARTEx_Extended_Exported_Constants
bogdanm 84:0b3ab51c8877 60 * @{
bogdanm 84:0b3ab51c8877 61 */
bogdanm 84:0b3ab51c8877 62
bogdanm 84:0b3ab51c8877 63 /** @defgroup USARTEx_Word_Length USART Word Length
bogdanm 84:0b3ab51c8877 64 * @{
bogdanm 84:0b3ab51c8877 65 */
bogdanm 84:0b3ab51c8877 66 #define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M_1)
bogdanm 84:0b3ab51c8877 67 #define USART_WORDLENGTH_8B ((uint32_t)0x00000000)
bogdanm 84:0b3ab51c8877 68 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0)
bogdanm 84:0b3ab51c8877 69 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_7B) || \
bogdanm 84:0b3ab51c8877 70 ((LENGTH) == USART_WORDLENGTH_8B) || \
bogdanm 84:0b3ab51c8877 71 ((LENGTH) == USART_WORDLENGTH_9B))
bogdanm 84:0b3ab51c8877 72 /**
bogdanm 84:0b3ab51c8877 73 * @}
bogdanm 84:0b3ab51c8877 74 */
bogdanm 84:0b3ab51c8877 75
bogdanm 84:0b3ab51c8877 76 /**
bogdanm 84:0b3ab51c8877 77 * @}
bogdanm 84:0b3ab51c8877 78 */
bogdanm 84:0b3ab51c8877 79
bogdanm 84:0b3ab51c8877 80 /* Exported macro ------------------------------------------------------------*/
bogdanm 84:0b3ab51c8877 81
bogdanm 84:0b3ab51c8877 82 /** @defgroup USARTEx_Extended_Exported_Macros
bogdanm 84:0b3ab51c8877 83 * @{
bogdanm 84:0b3ab51c8877 84 */
bogdanm 84:0b3ab51c8877 85
bogdanm 84:0b3ab51c8877 86 /** @brief Reports the USART clock source.
bogdanm 84:0b3ab51c8877 87 * @param __HANDLE__: specifies the USART Handle
bogdanm 84:0b3ab51c8877 88 * @param __CLOCKSOURCE__ : output variable
bogdanm 84:0b3ab51c8877 89 * @retval the USART clocking source, written in __CLOCKSOURCE__.
bogdanm 84:0b3ab51c8877 90 */
bogdanm 84:0b3ab51c8877 91 #define __HAL_USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
bogdanm 84:0b3ab51c8877 92 do { \
bogdanm 84:0b3ab51c8877 93 if((__HANDLE__)->Instance == USART1) \
bogdanm 84:0b3ab51c8877 94 { \
bogdanm 84:0b3ab51c8877 95 switch(__HAL_RCC_GET_USART1_SOURCE()) \
bogdanm 84:0b3ab51c8877 96 { \
bogdanm 84:0b3ab51c8877 97 case RCC_USART1CLKSOURCE_PCLK2: \
bogdanm 84:0b3ab51c8877 98 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
bogdanm 84:0b3ab51c8877 99 break; \
bogdanm 84:0b3ab51c8877 100 case RCC_USART1CLKSOURCE_HSI: \
bogdanm 84:0b3ab51c8877 101 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
bogdanm 84:0b3ab51c8877 102 break; \
bogdanm 84:0b3ab51c8877 103 case RCC_USART1CLKSOURCE_SYSCLK: \
bogdanm 84:0b3ab51c8877 104 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
bogdanm 84:0b3ab51c8877 105 break; \
bogdanm 84:0b3ab51c8877 106 case RCC_USART1CLKSOURCE_LSE: \
bogdanm 84:0b3ab51c8877 107 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
bogdanm 84:0b3ab51c8877 108 break; \
bogdanm 84:0b3ab51c8877 109 default: \
bogdanm 84:0b3ab51c8877 110 break; \
bogdanm 84:0b3ab51c8877 111 } \
bogdanm 84:0b3ab51c8877 112 } \
bogdanm 84:0b3ab51c8877 113 else if((__HANDLE__)->Instance == USART2) \
bogdanm 84:0b3ab51c8877 114 { \
bogdanm 84:0b3ab51c8877 115 switch(__HAL_RCC_GET_USART2_SOURCE()) \
bogdanm 84:0b3ab51c8877 116 { \
bogdanm 84:0b3ab51c8877 117 case RCC_USART2CLKSOURCE_PCLK1: \
bogdanm 84:0b3ab51c8877 118 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
bogdanm 84:0b3ab51c8877 119 break; \
bogdanm 84:0b3ab51c8877 120 case RCC_USART2CLKSOURCE_HSI: \
bogdanm 84:0b3ab51c8877 121 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
bogdanm 84:0b3ab51c8877 122 break; \
bogdanm 84:0b3ab51c8877 123 case RCC_USART2CLKSOURCE_SYSCLK: \
bogdanm 84:0b3ab51c8877 124 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
bogdanm 84:0b3ab51c8877 125 break; \
bogdanm 84:0b3ab51c8877 126 case RCC_USART2CLKSOURCE_LSE: \
bogdanm 84:0b3ab51c8877 127 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
bogdanm 84:0b3ab51c8877 128 break; \
bogdanm 84:0b3ab51c8877 129 default: \
bogdanm 84:0b3ab51c8877 130 break; \
bogdanm 84:0b3ab51c8877 131 } \
bogdanm 84:0b3ab51c8877 132 } \
bogdanm 84:0b3ab51c8877 133 } while(0)
bogdanm 84:0b3ab51c8877 134
bogdanm 84:0b3ab51c8877 135 /** @brief Reports the USART mask to apply to retrieve the received data
bogdanm 84:0b3ab51c8877 136 * according to the word length and to the parity bits activation.
bogdanm 84:0b3ab51c8877 137 * If PCE = 1, the parity bit is not included in the data extracted
bogdanm 84:0b3ab51c8877 138 * by the reception API().
bogdanm 84:0b3ab51c8877 139 * This masking operation is not carried out in the case of
bogdanm 84:0b3ab51c8877 140 * DMA transfers.
bogdanm 84:0b3ab51c8877 141 * @param __HANDLE__: specifies the USART Handle
bogdanm 84:0b3ab51c8877 142 * @param __MASK__ : output variable
bogdanm 84:0b3ab51c8877 143 * @retval mask to apply to USART RDR register value.
bogdanm 84:0b3ab51c8877 144 */
bogdanm 84:0b3ab51c8877 145 #define __HAL_USART_MASK_COMPUTATION(__HANDLE__) \
bogdanm 84:0b3ab51c8877 146 do { \
bogdanm 84:0b3ab51c8877 147 if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
bogdanm 84:0b3ab51c8877 148 { \
bogdanm 84:0b3ab51c8877 149 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
bogdanm 84:0b3ab51c8877 150 { \
bogdanm 84:0b3ab51c8877 151 (__HANDLE__)->Mask = 0x01FF ; \
bogdanm 84:0b3ab51c8877 152 } \
bogdanm 84:0b3ab51c8877 153 else \
bogdanm 84:0b3ab51c8877 154 { \
bogdanm 84:0b3ab51c8877 155 (__HANDLE__)->Mask = 0x00FF ; \
bogdanm 84:0b3ab51c8877 156 } \
bogdanm 84:0b3ab51c8877 157 } \
bogdanm 84:0b3ab51c8877 158 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
bogdanm 84:0b3ab51c8877 159 { \
bogdanm 84:0b3ab51c8877 160 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
bogdanm 84:0b3ab51c8877 161 { \
bogdanm 84:0b3ab51c8877 162 (__HANDLE__)->Mask = 0x00FF ; \
bogdanm 84:0b3ab51c8877 163 } \
bogdanm 84:0b3ab51c8877 164 else \
bogdanm 84:0b3ab51c8877 165 { \
bogdanm 84:0b3ab51c8877 166 (__HANDLE__)->Mask = 0x007F ; \
bogdanm 84:0b3ab51c8877 167 } \
bogdanm 84:0b3ab51c8877 168 } \
bogdanm 84:0b3ab51c8877 169 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
bogdanm 84:0b3ab51c8877 170 { \
bogdanm 84:0b3ab51c8877 171 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
bogdanm 84:0b3ab51c8877 172 { \
bogdanm 84:0b3ab51c8877 173 (__HANDLE__)->Mask = 0x007F ; \
bogdanm 84:0b3ab51c8877 174 } \
bogdanm 84:0b3ab51c8877 175 else \
bogdanm 84:0b3ab51c8877 176 { \
bogdanm 84:0b3ab51c8877 177 (__HANDLE__)->Mask = 0x003F ; \
bogdanm 84:0b3ab51c8877 178 } \
bogdanm 84:0b3ab51c8877 179 } \
bogdanm 84:0b3ab51c8877 180 } while(0)
bogdanm 84:0b3ab51c8877 181
bogdanm 84:0b3ab51c8877 182 /**
bogdanm 84:0b3ab51c8877 183 * @}
bogdanm 84:0b3ab51c8877 184 */
bogdanm 84:0b3ab51c8877 185
bogdanm 84:0b3ab51c8877 186 /* Exported functions --------------------------------------------------------*/
bogdanm 84:0b3ab51c8877 187 /* Initialization/de-initialization methods **********************************/
bogdanm 84:0b3ab51c8877 188 /* IO operation methods *******************************************************/
bogdanm 84:0b3ab51c8877 189 /* Peripheral Control methods ************************************************/
bogdanm 84:0b3ab51c8877 190 /* Peripheral State methods **************************************************/
bogdanm 84:0b3ab51c8877 191
bogdanm 84:0b3ab51c8877 192
bogdanm 84:0b3ab51c8877 193 /**
bogdanm 84:0b3ab51c8877 194 * @}
bogdanm 84:0b3ab51c8877 195 */
bogdanm 84:0b3ab51c8877 196
bogdanm 84:0b3ab51c8877 197 /**
bogdanm 84:0b3ab51c8877 198 * @}
bogdanm 84:0b3ab51c8877 199 */
bogdanm 84:0b3ab51c8877 200
bogdanm 84:0b3ab51c8877 201 #ifdef __cplusplus
bogdanm 84:0b3ab51c8877 202 }
bogdanm 84:0b3ab51c8877 203 #endif
bogdanm 84:0b3ab51c8877 204
bogdanm 84:0b3ab51c8877 205 #endif /* __STM32L0xx_HAL_USART_EX_H */
bogdanm 84:0b3ab51c8877 206
bogdanm 84:0b3ab51c8877 207 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/