mbed official / mbed-src

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_def.h@369:2e96f1b71984, 2014-10-27 (annotated)

Committer:
mbed_official
Date:
Mon Oct 27 09:45:07 2014 +0000
Revision:
369:2e96f1b71984
Parent:
226:b062af740e40 
Synchronized with git revision 2d1f64de28cfb25c0e602532e3ce5ad1d9accbed



Full URL: https://github.com/mbedmicro/mbed/commit/2d1f64de28cfb25c0e602532e3ce5ad1d9accbed/



CMSIS: NUCLEO_F401RE - Update STM32Cube driver

Who changed what in which revision?

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