Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_def.h@92:4fc01daae5a5, 2014-11-27 (annotated)

Committer:
bogdanm
Date:
Thu Nov 27 13:33:22 2014 +0000
Revision:
92:4fc01daae5a5
Parent:
89:552587b429a1 
Release 92 of the mbed libray



Main changes:



- nRF51822: fixed pin assignment issues

- ST targets moving to the STM32Cube driver

- LPC1439: fixed serial interrupt issue

- first Cortex-A platform supported in mbed (RZ_A1H)

Who changed what in which revision?

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