Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_ELMO_F411RE/stm32f4xx_hal_def.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

Who changed what in which revision?

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