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_L496ZG_P/TOOLCHAIN_IAR/stm32l4xx_hal_def.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_def.h@161:aa5281ff4a02 
mbed library. Release version 164

Who changed what in which revision?

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