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_DISCO_F746NG/TOOLCHAIN_ARM_MICRO/stm32f7xx_hal_def.h@172:65be27845400, 2019-02-20 (annotated)

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

Who changed what in which revision?

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