mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32F1/device/stm32f1xx_hal_def.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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