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@161:aa5281ff4a02, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:16:41 2018 +0000
Revision:
161:aa5281ff4a02
Parent:
160:5571c4ff569f 
mbed library. Release version 159.

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