mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

cmsis/BUILD/mbed/TARGET_DISCO_L496AG/TOOLCHAIN_ARM_STD/stm32l4xx_hal_def.h@189:f392fc9709a3, 2019-02-20 (annotated)

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

Who changed what in which revision?

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