mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_def.h@164:289d4deac6e4, 2017-05-10 (annotated)

Committer:
Anna Bridge
Date:
Wed May 10 12:06:41 2017 +0100
Revision:
164:289d4deac6e4
Parent:
153:fa9ff456f731
Child:
167:e84263d55307
This updates the lib to the mbed lib v142

Who changed what in which revision?

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