Ricardo Benitez / mbed

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.

Fork of mbed by mbed official

TARGET_MTS_MDOT_F411RE/stm32f4xx_hal_def.h@106:ba1f97679dad, 2015-09-02 (annotated)

Committer:
Kojto
Date:
Wed Sep 02 14:17:43 2015 +0100
Revision:
106:ba1f97679dad
Parent:
99:dbbf35b96557
Child:
110:165afa46840b
Release 106  of the mbed library



Changes:

- new platform - Nucleo F446RE

- STM32F4 Cube driver update v2.3.2

- ST cmsis driver v2.3.2

- nordic bugfix gcc linker start address

- lpc11u68 - bugfix for serial ports

Who changed what in which revision?

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