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_F412ZG/TOOLCHAIN_ARM_STD/stm32f4xx_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_F407VG/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_def.h@163:e59c8e839560 
mbed library. Release version 164

Who changed what in which revision?

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