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_L476VG/stm32l4xx_hal_usart_ex.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
107:4f6c30876dfa 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 107:4f6c30876dfa 1 /**
Kojto 107:4f6c30876dfa 2 ******************************************************************************
Kojto 107:4f6c30876dfa 3 * @file stm32l4xx_hal_usart_ex.h
Kojto 107:4f6c30876dfa 4 * @author MCD Application Team
Kojto 107:4f6c30876dfa 5 * @version V1.0.0
Kojto 107:4f6c30876dfa 6 * @date 26-June-2015
Kojto 107:4f6c30876dfa 7 * @brief Header file of USART HAL Extended module.
Kojto 107:4f6c30876dfa 8 ******************************************************************************
Kojto 107:4f6c30876dfa 9 * @attention
Kojto 107:4f6c30876dfa 10 *
Kojto 107:4f6c30876dfa 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 107:4f6c30876dfa 12 *
Kojto 107:4f6c30876dfa 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 107:4f6c30876dfa 14 * are permitted provided that the following conditions are met:
Kojto 107:4f6c30876dfa 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 107:4f6c30876dfa 16 * this list of conditions and the following disclaimer.
Kojto 107:4f6c30876dfa 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 107:4f6c30876dfa 18 * this list of conditions and the following disclaimer in the documentation
Kojto 107:4f6c30876dfa 19 * and/or other materials provided with the distribution.
Kojto 107:4f6c30876dfa 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 107:4f6c30876dfa 21 * may be used to endorse or promote products derived from this software
Kojto 107:4f6c30876dfa 22 * without specific prior written permission.
Kojto 107:4f6c30876dfa 23 *
Kojto 107:4f6c30876dfa 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 107:4f6c30876dfa 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 107:4f6c30876dfa 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 107:4f6c30876dfa 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 107:4f6c30876dfa 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 107:4f6c30876dfa 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 107:4f6c30876dfa 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 107:4f6c30876dfa 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 107:4f6c30876dfa 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 107:4f6c30876dfa 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 107:4f6c30876dfa 34 *
Kojto 107:4f6c30876dfa 35 ******************************************************************************
Kojto 107:4f6c30876dfa 36 */
Kojto 107:4f6c30876dfa 37
Kojto 107:4f6c30876dfa 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 107:4f6c30876dfa 39 #ifndef __STM32L4xx_HAL_USART_EX_H
Kojto 107:4f6c30876dfa 40 #define __STM32L4xx_HAL_USART_EX_H
Kojto 107:4f6c30876dfa 41
Kojto 107:4f6c30876dfa 42 #ifdef __cplusplus
Kojto 107:4f6c30876dfa 43 extern "C" {
Kojto 107:4f6c30876dfa 44 #endif
Kojto 107:4f6c30876dfa 45
Kojto 107:4f6c30876dfa 46 /* Includes ------------------------------------------------------------------*/
Kojto 107:4f6c30876dfa 47 #include "stm32l4xx_hal_def.h"
Kojto 107:4f6c30876dfa 48
Kojto 107:4f6c30876dfa 49 /** @addtogroup STM32L4xx_HAL_Driver
Kojto 107:4f6c30876dfa 50 * @{
Kojto 107:4f6c30876dfa 51 */
Kojto 107:4f6c30876dfa 52
Kojto 107:4f6c30876dfa 53 /** @addtogroup USARTEx
Kojto 107:4f6c30876dfa 54 * @{
Kojto 107:4f6c30876dfa 55 */
Kojto 107:4f6c30876dfa 56
Kojto 107:4f6c30876dfa 57 /* Exported types ------------------------------------------------------------*/
Kojto 107:4f6c30876dfa 58 /* Exported constants --------------------------------------------------------*/
Kojto 107:4f6c30876dfa 59 /** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
Kojto 107:4f6c30876dfa 60 * @{
Kojto 107:4f6c30876dfa 61 */
Kojto 107:4f6c30876dfa 62
Kojto 107:4f6c30876dfa 63 /** @defgroup USARTEx_Word_Length USARTEx Word Length
Kojto 107:4f6c30876dfa 64 * @{
Kojto 107:4f6c30876dfa 65 */
Kojto 107:4f6c30876dfa 66 #define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long USART frame */
Kojto 107:4f6c30876dfa 67 #define USART_WORDLENGTH_8B ((uint32_t)0x00000000) /*!< 8-bit long USART frame */
Kojto 107:4f6c30876dfa 68 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long USART frame */
Kojto 107:4f6c30876dfa 69 /**
Kojto 107:4f6c30876dfa 70 * @}
Kojto 107:4f6c30876dfa 71 */
Kojto 107:4f6c30876dfa 72
Kojto 107:4f6c30876dfa 73 /**
Kojto 107:4f6c30876dfa 74 * @}
Kojto 107:4f6c30876dfa 75 */
Kojto 107:4f6c30876dfa 76
Kojto 107:4f6c30876dfa 77 /* Exported functions --------------------------------------------------------*/
Kojto 107:4f6c30876dfa 78
Kojto 107:4f6c30876dfa 79 /* Private macros ------------------------------------------------------------*/
Kojto 107:4f6c30876dfa 80 /** @defgroup USARTEx_Private_Macros USARTEx Private Macros
Kojto 107:4f6c30876dfa 81 * @{
Kojto 107:4f6c30876dfa 82 */
Kojto 107:4f6c30876dfa 83
Kojto 107:4f6c30876dfa 84 /** @brief Compute the USART mask to apply to retrieve the received data
Kojto 107:4f6c30876dfa 85 * according to the word length and to the parity bits activation.
Kojto 107:4f6c30876dfa 86 * @note If PCE = 1, the parity bit is not included in the data extracted
Kojto 107:4f6c30876dfa 87 * by the reception API().
Kojto 107:4f6c30876dfa 88 * This masking operation is not carried out in the case of
Kojto 107:4f6c30876dfa 89 * DMA transfers.
Kojto 107:4f6c30876dfa 90 * @param __HANDLE__: specifies the USART Handle.
Kojto 107:4f6c30876dfa 91 * @retval None, the mask to apply to USART RDR register is stored in (__HANDLE__)->Mask field.
Kojto 107:4f6c30876dfa 92 */
Kojto 107:4f6c30876dfa 93 #define USART_MASK_COMPUTATION(__HANDLE__) \
Kojto 107:4f6c30876dfa 94 do { \
Kojto 107:4f6c30876dfa 95 if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
Kojto 107:4f6c30876dfa 96 { \
Kojto 107:4f6c30876dfa 97 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
Kojto 107:4f6c30876dfa 98 { \
Kojto 107:4f6c30876dfa 99 (__HANDLE__)->Mask = 0x01FF ; \
Kojto 107:4f6c30876dfa 100 } \
Kojto 107:4f6c30876dfa 101 else \
Kojto 107:4f6c30876dfa 102 { \
Kojto 107:4f6c30876dfa 103 (__HANDLE__)->Mask = 0x00FF ; \
Kojto 107:4f6c30876dfa 104 } \
Kojto 107:4f6c30876dfa 105 } \
Kojto 107:4f6c30876dfa 106 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
Kojto 107:4f6c30876dfa 107 { \
Kojto 107:4f6c30876dfa 108 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
Kojto 107:4f6c30876dfa 109 { \
Kojto 107:4f6c30876dfa 110 (__HANDLE__)->Mask = 0x00FF ; \
Kojto 107:4f6c30876dfa 111 } \
Kojto 107:4f6c30876dfa 112 else \
Kojto 107:4f6c30876dfa 113 { \
Kojto 107:4f6c30876dfa 114 (__HANDLE__)->Mask = 0x007F ; \
Kojto 107:4f6c30876dfa 115 } \
Kojto 107:4f6c30876dfa 116 } \
Kojto 107:4f6c30876dfa 117 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
Kojto 107:4f6c30876dfa 118 { \
Kojto 107:4f6c30876dfa 119 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
Kojto 107:4f6c30876dfa 120 { \
Kojto 107:4f6c30876dfa 121 (__HANDLE__)->Mask = 0x007F ; \
Kojto 107:4f6c30876dfa 122 } \
Kojto 107:4f6c30876dfa 123 else \
Kojto 107:4f6c30876dfa 124 { \
Kojto 107:4f6c30876dfa 125 (__HANDLE__)->Mask = 0x003F ; \
Kojto 107:4f6c30876dfa 126 } \
Kojto 107:4f6c30876dfa 127 } \
Kojto 107:4f6c30876dfa 128 } while(0)
Kojto 107:4f6c30876dfa 129
Kojto 107:4f6c30876dfa 130 /**
Kojto 107:4f6c30876dfa 131 * @brief Ensure that USART frame length is valid.
Kojto 107:4f6c30876dfa 132 * @param __LENGTH__: USART frame length.
Kojto 107:4f6c30876dfa 133 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
Kojto 107:4f6c30876dfa 134 */
Kojto 107:4f6c30876dfa 135 #define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \
Kojto 107:4f6c30876dfa 136 ((__LENGTH__) == USART_WORDLENGTH_8B) || \
Kojto 107:4f6c30876dfa 137 ((__LENGTH__) == USART_WORDLENGTH_9B))
Kojto 107:4f6c30876dfa 138
Kojto 107:4f6c30876dfa 139 /**
Kojto 107:4f6c30876dfa 140 * @}
Kojto 107:4f6c30876dfa 141 */
Kojto 107:4f6c30876dfa 142
Kojto 107:4f6c30876dfa 143 /* Exported functions --------------------------------------------------------*/
Kojto 107:4f6c30876dfa 144
Kojto 107:4f6c30876dfa 145 /**
Kojto 107:4f6c30876dfa 146 * @}
Kojto 107:4f6c30876dfa 147 */
Kojto 107:4f6c30876dfa 148
Kojto 107:4f6c30876dfa 149 /**
Kojto 107:4f6c30876dfa 150 * @}
Kojto 107:4f6c30876dfa 151 */
Kojto 107:4f6c30876dfa 152
Kojto 107:4f6c30876dfa 153 #ifdef __cplusplus
Kojto 107:4f6c30876dfa 154 }
Kojto 107:4f6c30876dfa 155 #endif
Kojto 107:4f6c30876dfa 156
Kojto 107:4f6c30876dfa 157 #endif /* __STM32L4xx_HAL_USART_EX_H */
Kojto 107:4f6c30876dfa 158
Kojto 107:4f6c30876dfa 159 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/