Elijah Orr / mbed-renbed

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:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F446RE/stm32f4xx_hal_def.h@110:165afa46840b, 2015-11-25 (annotated)

Committer:
Kojto
Date:
Wed Nov 25 13:21:40 2015 +0000
Revision:
110:165afa46840b
Parent:
106:ba1f97679dad 
Release 110  of the mbed library



Changes:

- new platforms - STM32F410R, DISCO_F429ZI, DISCO_F469NI

- Nucleo L476 - gcc and uvision template

- k22,k64f targets - ADC channels A addition

- EFM32 - bugfixes in sleep, serial and spi

- Delta DFCM NNN40 - pinnames update

Who changed what in which revision?

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