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_L4R5ZI_P/TOOLCHAIN_ARM_STD/stm32l4xx_hal_def.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

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