mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_L432KC/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_def.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
161:aa5281ff4a02
mbed library. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /**
AnnaBridge 156:ff21514d8981 2 ******************************************************************************
AnnaBridge 156:ff21514d8981 3 * @file stm32l4xx_hal_def.h
AnnaBridge 156:ff21514d8981 4 * @author MCD Application Team
AnnaBridge 156:ff21514d8981 5 * @version V1.7.1
AnnaBridge 156:ff21514d8981 6 * @date 21-April-2017
AnnaBridge 156:ff21514d8981 7 * @brief This file contains HAL common defines, enumeration, macros and
AnnaBridge 156:ff21514d8981 8 * structures definitions.
AnnaBridge 156:ff21514d8981 9 ******************************************************************************
AnnaBridge 156:ff21514d8981 10 * @attention
AnnaBridge 156:ff21514d8981 11 *
AnnaBridge 156:ff21514d8981 12 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 156:ff21514d8981 13 *
AnnaBridge 156:ff21514d8981 14 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 156:ff21514d8981 15 * are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 16 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 156:ff21514d8981 17 * this list of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 156:ff21514d8981 19 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 156:ff21514d8981 20 * and/or other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 156:ff21514d8981 22 * may be used to endorse or promote products derived from this software
AnnaBridge 156:ff21514d8981 23 * without specific prior written permission.
AnnaBridge 156:ff21514d8981 24 *
AnnaBridge 156:ff21514d8981 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 156:ff21514d8981 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 156:ff21514d8981 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 156:ff21514d8981 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 156:ff21514d8981 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 156:ff21514d8981 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 156:ff21514d8981 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 156:ff21514d8981 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 156:ff21514d8981 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 35 *
AnnaBridge 156:ff21514d8981 36 ******************************************************************************
AnnaBridge 156:ff21514d8981 37 */
AnnaBridge 156:ff21514d8981 38
AnnaBridge 156:ff21514d8981 39 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 156:ff21514d8981 40 #ifndef __STM32L4xx_HAL_DEF
AnnaBridge 156:ff21514d8981 41 #define __STM32L4xx_HAL_DEF
AnnaBridge 156:ff21514d8981 42
AnnaBridge 156:ff21514d8981 43 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 44 extern "C" {
AnnaBridge 156:ff21514d8981 45 #endif
AnnaBridge 156:ff21514d8981 46
AnnaBridge 156:ff21514d8981 47 /* Includes ------------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 48 #include "stm32l4xx.h"
AnnaBridge 156:ff21514d8981 49 #include "stm32_hal_legacy.h" /* Aliases file for old names compatibility */
AnnaBridge 156:ff21514d8981 50 #include <stdio.h>
AnnaBridge 156:ff21514d8981 51
AnnaBridge 156:ff21514d8981 52 /* Exported types ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 53
AnnaBridge 156:ff21514d8981 54 /**
AnnaBridge 156:ff21514d8981 55 * @brief HAL Status structures definition
AnnaBridge 156:ff21514d8981 56 */
AnnaBridge 156:ff21514d8981 57 typedef enum
AnnaBridge 156:ff21514d8981 58 {
AnnaBridge 156:ff21514d8981 59 HAL_OK = 0x00,
AnnaBridge 156:ff21514d8981 60 HAL_ERROR = 0x01,
AnnaBridge 156:ff21514d8981 61 HAL_BUSY = 0x02,
AnnaBridge 156:ff21514d8981 62 HAL_TIMEOUT = 0x03
AnnaBridge 156:ff21514d8981 63 } HAL_StatusTypeDef;
AnnaBridge 156:ff21514d8981 64
AnnaBridge 156:ff21514d8981 65 /**
AnnaBridge 156:ff21514d8981 66 * @brief HAL Lock structures definition
AnnaBridge 156:ff21514d8981 67 */
AnnaBridge 156:ff21514d8981 68 typedef enum
AnnaBridge 156:ff21514d8981 69 {
AnnaBridge 156:ff21514d8981 70 HAL_UNLOCKED = 0x00,
AnnaBridge 156:ff21514d8981 71 HAL_LOCKED = 0x01
AnnaBridge 156:ff21514d8981 72 } HAL_LockTypeDef;
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 75
AnnaBridge 156:ff21514d8981 76 #define HAL_MAX_DELAY 0xFFFFFFFFU
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) == (BIT))
AnnaBridge 156:ff21514d8981 79 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == RESET)
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__) \
AnnaBridge 156:ff21514d8981 82 do{ \
AnnaBridge 156:ff21514d8981 83 (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \
AnnaBridge 156:ff21514d8981 84 (__DMA_HANDLE__).Parent = (__HANDLE__); \
AnnaBridge 156:ff21514d8981 85 } while(0)
AnnaBridge 156:ff21514d8981 86
AnnaBridge 156:ff21514d8981 87 #define UNUSED(x) ((void)(x))
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 /** @brief Reset the Handle's State field.
AnnaBridge 156:ff21514d8981 90 * @param __HANDLE__: specifies the Peripheral Handle.
AnnaBridge 156:ff21514d8981 91 * @note This macro can be used for the following purpose:
AnnaBridge 156:ff21514d8981 92 * - When the Handle is declared as local variable; before passing it as parameter
AnnaBridge 156:ff21514d8981 93 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro
AnnaBridge 156:ff21514d8981 94 * to set to 0 the Handle's "State" field.
AnnaBridge 156:ff21514d8981 95 * Otherwise, "State" field may have any random value and the first time the function
AnnaBridge 156:ff21514d8981 96 * HAL_PPP_Init() is called, the low level hardware initialization will be missed
AnnaBridge 156:ff21514d8981 97 * (i.e. HAL_PPP_MspInit() will not be executed).
AnnaBridge 156:ff21514d8981 98 * - When there is a need to reconfigure the low level hardware: instead of calling
AnnaBridge 156:ff21514d8981 99 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
AnnaBridge 156:ff21514d8981 100 * In this later function, when the Handle's "State" field is set to 0, it will execute the function
AnnaBridge 156:ff21514d8981 101 * HAL_PPP_MspInit() which will reconfigure the low level hardware.
AnnaBridge 156:ff21514d8981 102 * @retval None
AnnaBridge 156:ff21514d8981 103 */
AnnaBridge 156:ff21514d8981 104 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0)
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 #if (USE_RTOS == 1)
AnnaBridge 156:ff21514d8981 107 /* Reserved for future use */
AnnaBridge 156:ff21514d8981 108 #error " USE_RTOS should be 0 in the current HAL release "
AnnaBridge 156:ff21514d8981 109 #else
AnnaBridge 156:ff21514d8981 110 #define __HAL_LOCK(__HANDLE__) \
AnnaBridge 156:ff21514d8981 111 do{ \
AnnaBridge 156:ff21514d8981 112 if((__HANDLE__)->Lock == HAL_LOCKED) \
AnnaBridge 156:ff21514d8981 113 { \
AnnaBridge 156:ff21514d8981 114 return HAL_BUSY; \
AnnaBridge 156:ff21514d8981 115 } \
AnnaBridge 156:ff21514d8981 116 else \
AnnaBridge 156:ff21514d8981 117 { \
AnnaBridge 156:ff21514d8981 118 (__HANDLE__)->Lock = HAL_LOCKED; \
AnnaBridge 156:ff21514d8981 119 } \
AnnaBridge 156:ff21514d8981 120 }while (0)
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 #define __HAL_UNLOCK(__HANDLE__) \
AnnaBridge 156:ff21514d8981 123 do{ \
AnnaBridge 156:ff21514d8981 124 (__HANDLE__)->Lock = HAL_UNLOCKED; \
AnnaBridge 156:ff21514d8981 125 }while (0)
AnnaBridge 156:ff21514d8981 126 #endif /* USE_RTOS */
AnnaBridge 156:ff21514d8981 127 #if defined (__CC_ARM)
AnnaBridge 156:ff21514d8981 128 #pragma diag_suppress 3731
AnnaBridge 156:ff21514d8981 129 #endif
AnnaBridge 156:ff21514d8981 130
AnnaBridge 156:ff21514d8981 131 static inline void atomic_set_u32(volatile uint32_t *ptr, uint32_t mask)
AnnaBridge 156:ff21514d8981 132 {
AnnaBridge 156:ff21514d8981 133 uint32_t newValue;
AnnaBridge 156:ff21514d8981 134 do {
Anna Bridge 160:5571c4ff569f 135 newValue = (uint32_t)__LDREXW(ptr) | mask;
AnnaBridge 156:ff21514d8981 136
Anna Bridge 160:5571c4ff569f 137 } while (__STREXW(newValue, ptr));
AnnaBridge 156:ff21514d8981 138 }
AnnaBridge 156:ff21514d8981 139
AnnaBridge 156:ff21514d8981 140
AnnaBridge 156:ff21514d8981 141 static inline void atomic_clr_u32(volatile uint32_t *ptr, uint32_t mask)
AnnaBridge 156:ff21514d8981 142 {
AnnaBridge 156:ff21514d8981 143 uint32_t newValue;
AnnaBridge 156:ff21514d8981 144 do {
Anna Bridge 160:5571c4ff569f 145 newValue = (uint32_t)__LDREXW(ptr) &~mask;
AnnaBridge 156:ff21514d8981 146
Anna Bridge 160:5571c4ff569f 147 } while (__STREXW(newValue, ptr));
AnnaBridge 156:ff21514d8981 148 }
AnnaBridge 156:ff21514d8981 149
AnnaBridge 156:ff21514d8981 150 #if defined ( __GNUC__ ) && !defined ( __CC_ARM )
AnnaBridge 156:ff21514d8981 151 #ifndef __weak
AnnaBridge 156:ff21514d8981 152 #define __weak __attribute__((weak))
AnnaBridge 156:ff21514d8981 153 #endif /* __weak */
AnnaBridge 156:ff21514d8981 154 #ifndef __packed
AnnaBridge 156:ff21514d8981 155 #define __packed __attribute__((__packed__))
AnnaBridge 156:ff21514d8981 156 #endif /* __packed */
AnnaBridge 156:ff21514d8981 157 #endif /* __GNUC__ */
AnnaBridge 156:ff21514d8981 158
AnnaBridge 156:ff21514d8981 159
AnnaBridge 156:ff21514d8981 160 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
AnnaBridge 156:ff21514d8981 161 #if defined (__GNUC__) /* GNU Compiler */
AnnaBridge 156:ff21514d8981 162 #ifndef __ALIGN_END
AnnaBridge 156:ff21514d8981 163 #define __ALIGN_END __attribute__ ((aligned (4)))
AnnaBridge 156:ff21514d8981 164 #endif /* __ALIGN_END */
AnnaBridge 156:ff21514d8981 165 #ifndef __ALIGN_BEGIN
AnnaBridge 156:ff21514d8981 166 #define __ALIGN_BEGIN
AnnaBridge 156:ff21514d8981 167 #endif /* __ALIGN_BEGIN */
AnnaBridge 156:ff21514d8981 168 #else
AnnaBridge 156:ff21514d8981 169 #ifndef __ALIGN_END
AnnaBridge 156:ff21514d8981 170 #define __ALIGN_END
AnnaBridge 156:ff21514d8981 171 #endif /* __ALIGN_END */
AnnaBridge 156:ff21514d8981 172 #ifndef __ALIGN_BEGIN
AnnaBridge 156:ff21514d8981 173 #if defined (__CC_ARM) /* ARM Compiler */
AnnaBridge 156:ff21514d8981 174 #define __ALIGN_BEGIN __align(4)
AnnaBridge 156:ff21514d8981 175 #elif defined (__ICCARM__) /* IAR Compiler */
AnnaBridge 156:ff21514d8981 176 #define __ALIGN_BEGIN
AnnaBridge 156:ff21514d8981 177 #endif /* __CC_ARM */
AnnaBridge 156:ff21514d8981 178 #endif /* __ALIGN_BEGIN */
AnnaBridge 156:ff21514d8981 179 #endif /* __GNUC__ */
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 /**
AnnaBridge 156:ff21514d8981 182 * @brief __RAM_FUNC definition
AnnaBridge 156:ff21514d8981 183 */
AnnaBridge 156:ff21514d8981 184 #if defined ( __CC_ARM )
AnnaBridge 156:ff21514d8981 185 /* ARM Compiler
AnnaBridge 156:ff21514d8981 186 ------------
AnnaBridge 156:ff21514d8981 187 RAM functions are defined using the toolchain options.
AnnaBridge 156:ff21514d8981 188 Functions that are executed in RAM should reside in a separate source module.
AnnaBridge 156:ff21514d8981 189 Using the 'Options for File' dialog you can simply change the 'Code / Const'
AnnaBridge 156:ff21514d8981 190 area of a module to a memory space in physical RAM.
AnnaBridge 156:ff21514d8981 191 Available memory areas are declared in the 'Target' tab of the 'Options for Target'
AnnaBridge 156:ff21514d8981 192 dialog.
AnnaBridge 156:ff21514d8981 193 */
AnnaBridge 156:ff21514d8981 194 #define __RAM_FUNC HAL_StatusTypeDef
AnnaBridge 156:ff21514d8981 195
AnnaBridge 156:ff21514d8981 196 #elif defined ( __ICCARM__ )
AnnaBridge 156:ff21514d8981 197 /* ICCARM Compiler
AnnaBridge 156:ff21514d8981 198 ---------------
AnnaBridge 156:ff21514d8981 199 RAM functions are defined using a specific toolchain keyword "__ramfunc".
AnnaBridge 156:ff21514d8981 200 */
AnnaBridge 156:ff21514d8981 201 #define __RAM_FUNC __ramfunc HAL_StatusTypeDef
AnnaBridge 156:ff21514d8981 202
AnnaBridge 156:ff21514d8981 203 #elif defined ( __GNUC__ )
AnnaBridge 156:ff21514d8981 204 /* GNU Compiler
AnnaBridge 156:ff21514d8981 205 ------------
AnnaBridge 156:ff21514d8981 206 RAM functions are defined using a specific toolchain attribute
AnnaBridge 156:ff21514d8981 207 "__attribute__((section(".RamFunc")))".
AnnaBridge 156:ff21514d8981 208 */
AnnaBridge 156:ff21514d8981 209 #define __RAM_FUNC HAL_StatusTypeDef __attribute__((section(".RamFunc")))
AnnaBridge 156:ff21514d8981 210
AnnaBridge 156:ff21514d8981 211 #endif
AnnaBridge 156:ff21514d8981 212
AnnaBridge 156:ff21514d8981 213 /**
AnnaBridge 156:ff21514d8981 214 * @brief __NOINLINE definition
AnnaBridge 156:ff21514d8981 215 */
AnnaBridge 156:ff21514d8981 216 #if defined ( __CC_ARM ) || defined ( __GNUC__ )
AnnaBridge 156:ff21514d8981 217 /* ARM & GNUCompiler
AnnaBridge 156:ff21514d8981 218 ----------------
AnnaBridge 156:ff21514d8981 219 */
AnnaBridge 156:ff21514d8981 220 #define __NOINLINE __attribute__ ( (noinline) )
AnnaBridge 156:ff21514d8981 221
AnnaBridge 156:ff21514d8981 222 #elif defined ( __ICCARM__ )
AnnaBridge 156:ff21514d8981 223 /* ICCARM Compiler
AnnaBridge 156:ff21514d8981 224 ---------------
AnnaBridge 156:ff21514d8981 225 */
AnnaBridge 156:ff21514d8981 226 #define __NOINLINE _Pragma("optimize = no_inline")
AnnaBridge 156:ff21514d8981 227
AnnaBridge 156:ff21514d8981 228 #endif
AnnaBridge 156:ff21514d8981 229
AnnaBridge 156:ff21514d8981 230
AnnaBridge 156:ff21514d8981 231 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 232 }
AnnaBridge 156:ff21514d8981 233 #endif
AnnaBridge 156:ff21514d8981 234
AnnaBridge 156:ff21514d8981 235 #endif /* ___STM32L4xx_HAL_DEF */
AnnaBridge 156:ff21514d8981 236
AnnaBridge 156:ff21514d8981 237 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/