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_STM32L0/device/stm32l0xx_hal_def.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
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 stm32l0xx_hal_def.h
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
<> 144:ef7eb2e8f9f7 5 * @brief This file contains HAL common defines, enumeration, macros and
<> 144:ef7eb2e8f9f7 6 * structures definitions.
<> 144:ef7eb2e8f9f7 7 ******************************************************************************
<> 144:ef7eb2e8f9f7 8 * @attention
<> 144:ef7eb2e8f9f7 9 *
<> 144:ef7eb2e8f9f7 10 * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32L0xx_HAL_DEF
<> 144:ef7eb2e8f9f7 39 #define __STM32L0xx_HAL_DEF
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 42 extern "C" {
<> 144:ef7eb2e8f9f7 43 #endif
<> 144:ef7eb2e8f9f7 44
<> 144:ef7eb2e8f9f7 45 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 46 #include "stm32l0xx.h"
<> 144:ef7eb2e8f9f7 47 #include "stm32_hal_legacy.h"
<> 144:ef7eb2e8f9f7 48 #include <stdio.h>
<> 144:ef7eb2e8f9f7 49
<> 144:ef7eb2e8f9f7 50 /* Exported types ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 /**
<> 144:ef7eb2e8f9f7 53 * @brief HAL Status structures definition
<> 144:ef7eb2e8f9f7 54 */
<> 144:ef7eb2e8f9f7 55 typedef enum
<> 144:ef7eb2e8f9f7 56 {
<> 151:5eaa88a5bcc7 57 HAL_OK = 0x00U,
<> 151:5eaa88a5bcc7 58 HAL_ERROR = 0x01U,
<> 151:5eaa88a5bcc7 59 HAL_BUSY = 0x02U,
<> 151:5eaa88a5bcc7 60 HAL_TIMEOUT = 0x03U
<> 144:ef7eb2e8f9f7 61 } HAL_StatusTypeDef;
<> 144:ef7eb2e8f9f7 62
<> 144:ef7eb2e8f9f7 63 /**
<> 144:ef7eb2e8f9f7 64 * @brief HAL Lock structures definition
<> 144:ef7eb2e8f9f7 65 */
<> 144:ef7eb2e8f9f7 66 typedef enum
<> 144:ef7eb2e8f9f7 67 {
<> 151:5eaa88a5bcc7 68 HAL_UNLOCKED = 0x00U,
<> 151:5eaa88a5bcc7 69 HAL_LOCKED = 0x01U
<> 144:ef7eb2e8f9f7 70 } HAL_LockTypeDef;
<> 144:ef7eb2e8f9f7 71
<> 144:ef7eb2e8f9f7 72 /* Exported macro ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 73
<> 144:ef7eb2e8f9f7 74 #define UNUSED(x) ((void)(x))
<> 144:ef7eb2e8f9f7 75
<> 151:5eaa88a5bcc7 76 #define HAL_MAX_DELAY 0xFFFFFFFFU
<> 144:ef7eb2e8f9f7 77
<> 144:ef7eb2e8f9f7 78 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) != RESET)
<> 144:ef7eb2e8f9f7 79 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == RESET)
<> 144:ef7eb2e8f9f7 80
<> 144:ef7eb2e8f9f7 81 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__) \
<> 144:ef7eb2e8f9f7 82 do{ \
<> 144:ef7eb2e8f9f7 83 (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \
<> 144:ef7eb2e8f9f7 84 (__DMA_HANDLE__).Parent = (__HANDLE__); \
<> 144:ef7eb2e8f9f7 85 } while(0)
<> 144:ef7eb2e8f9f7 86
<> 144:ef7eb2e8f9f7 87 /** @brief Reset the Handle's State field.
<> 144:ef7eb2e8f9f7 88 * @param __HANDLE__: specifies the Peripheral Handle.
<> 144:ef7eb2e8f9f7 89 * @note This macro can be used for the following purpose:
<> 144:ef7eb2e8f9f7 90 * - When the Handle is declared as local variable; before passing it as parameter
<> 144:ef7eb2e8f9f7 91 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro
<> 144:ef7eb2e8f9f7 92 * to set to 0 the Handle's "State" field.
<> 144:ef7eb2e8f9f7 93 * Otherwise, "State" field may have any random value and the first time the function
<> 144:ef7eb2e8f9f7 94 * HAL_PPP_Init() is called, the low level hardware initialization will be missed
<> 144:ef7eb2e8f9f7 95 * (i.e. HAL_PPP_MspInit() will not be executed).
<> 144:ef7eb2e8f9f7 96 * - When there is a need to reconfigure the low level hardware: instead of calling
<> 144:ef7eb2e8f9f7 97 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
<> 144:ef7eb2e8f9f7 98 * In this later function, when the Handle's "State" field is set to 0, it will execute the function
<> 144:ef7eb2e8f9f7 99 * HAL_PPP_MspInit() which will reconfigure the low level hardware.
<> 144:ef7eb2e8f9f7 100 * @retval None
<> 144:ef7eb2e8f9f7 101 */
<> 151:5eaa88a5bcc7 102 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U)
<> 144:ef7eb2e8f9f7 103
<> 144:ef7eb2e8f9f7 104 #if (USE_RTOS == 1)
<> 144:ef7eb2e8f9f7 105
<> 144:ef7eb2e8f9f7 106 /* Reserved for future use */
<> 144:ef7eb2e8f9f7 107 #error "USE_RTOS should be 0 in the current HAL release"
<> 144:ef7eb2e8f9f7 108
<> 144:ef7eb2e8f9f7 109 #else
<> 144:ef7eb2e8f9f7 110 #define __HAL_LOCK(__HANDLE__) \
<> 144:ef7eb2e8f9f7 111 do{ \
<> 144:ef7eb2e8f9f7 112 if((__HANDLE__)->Lock == HAL_LOCKED) \
<> 144:ef7eb2e8f9f7 113 { \
<> 144:ef7eb2e8f9f7 114 return HAL_BUSY; \
<> 144:ef7eb2e8f9f7 115 } \
<> 144:ef7eb2e8f9f7 116 else \
<> 144:ef7eb2e8f9f7 117 { \
<> 144:ef7eb2e8f9f7 118 (__HANDLE__)->Lock = HAL_LOCKED; \
<> 144:ef7eb2e8f9f7 119 } \
<> 144:ef7eb2e8f9f7 120 }while (0)
<> 144:ef7eb2e8f9f7 121
<> 144:ef7eb2e8f9f7 122 #define __HAL_UNLOCK(__HANDLE__) \
<> 144:ef7eb2e8f9f7 123 do{ \
<> 144:ef7eb2e8f9f7 124 (__HANDLE__)->Lock = HAL_UNLOCKED; \
<> 144:ef7eb2e8f9f7 125 }while (0)
<> 144:ef7eb2e8f9f7 126 #endif /* USE_RTOS */
<> 144:ef7eb2e8f9f7 127
Anna Bridge 164:289d4deac6e4 128 #if defined ( __GNUC__ ) && !defined ( __CC_ARM )
<> 144:ef7eb2e8f9f7 129 #ifndef __weak
<> 144:ef7eb2e8f9f7 130 #define __weak __attribute__((weak))
<> 144:ef7eb2e8f9f7 131 #endif /* __weak */
<> 144:ef7eb2e8f9f7 132 #ifndef __packed
<> 144:ef7eb2e8f9f7 133 #define __packed __attribute__((__packed__))
<> 144:ef7eb2e8f9f7 134 #endif /* __packed */
<> 144:ef7eb2e8f9f7 135
<> 144:ef7eb2e8f9f7 136 #define __NOINLINE __attribute__ ( (noinline) )
<> 144:ef7eb2e8f9f7 137
<> 144:ef7eb2e8f9f7 138 #endif /* __GNUC__ */
<> 144:ef7eb2e8f9f7 139
<> 144:ef7eb2e8f9f7 140
<> 144:ef7eb2e8f9f7 141 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
<> 144:ef7eb2e8f9f7 142 #if defined (__GNUC__) /* GNU Compiler */
<> 144:ef7eb2e8f9f7 143 #ifndef __ALIGN_END
<> 144:ef7eb2e8f9f7 144 #define __ALIGN_END __attribute__ ((aligned (4)))
<> 144:ef7eb2e8f9f7 145 #endif /* __ALIGN_END */
<> 144:ef7eb2e8f9f7 146 #ifndef __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 147 #define __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 148 #endif /* __ALIGN_BEGIN */
<> 144:ef7eb2e8f9f7 149 #else
<> 144:ef7eb2e8f9f7 150 #ifndef __ALIGN_END
<> 144:ef7eb2e8f9f7 151 #define __ALIGN_END
<> 144:ef7eb2e8f9f7 152 #endif /* __ALIGN_END */
<> 144:ef7eb2e8f9f7 153 #ifndef __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 154 #if defined (__CC_ARM) /* ARM Compiler */
<> 144:ef7eb2e8f9f7 155 #define __ALIGN_BEGIN __align(4)
<> 144:ef7eb2e8f9f7 156 #elif defined (__ICCARM__) /* IAR Compiler */
<> 144:ef7eb2e8f9f7 157 #define __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 158 #endif /* __CC_ARM */
<> 144:ef7eb2e8f9f7 159 #endif /* __ALIGN_BEGIN */
<> 144:ef7eb2e8f9f7 160 #endif /* __GNUC__ */
<> 144:ef7eb2e8f9f7 161
<> 144:ef7eb2e8f9f7 162 /**
<> 144:ef7eb2e8f9f7 163 * @brief __RAM_FUNC definition
<> 144:ef7eb2e8f9f7 164 */
<> 144:ef7eb2e8f9f7 165 #if defined ( __CC_ARM )
<> 144:ef7eb2e8f9f7 166 /* ARM Compiler
<> 144:ef7eb2e8f9f7 167 ------------
<> 144:ef7eb2e8f9f7 168 RAM functions are defined using the toolchain options.
<> 144:ef7eb2e8f9f7 169 Functions that are executed in RAM should reside in a separate source module.
<> 144:ef7eb2e8f9f7 170 Using the 'Options for File' dialog you can simply change the 'Code / Const'
<> 144:ef7eb2e8f9f7 171 area of a module to a memory space in physical RAM.
<> 144:ef7eb2e8f9f7 172 Available memory areas are declared in the 'Target' tab of the 'Options for Target'
<> 144:ef7eb2e8f9f7 173 dialog.
<> 144:ef7eb2e8f9f7 174 */
<> 144:ef7eb2e8f9f7 175 #define __RAM_FUNC HAL_StatusTypeDef
<> 144:ef7eb2e8f9f7 176
<> 144:ef7eb2e8f9f7 177 #define __NOINLINE __attribute__ ( (noinline) )
<> 144:ef7eb2e8f9f7 178
<> 144:ef7eb2e8f9f7 179
<> 144:ef7eb2e8f9f7 180 #elif defined ( __ICCARM__ )
<> 144:ef7eb2e8f9f7 181 /* ICCARM Compiler
<> 144:ef7eb2e8f9f7 182 ---------------
<> 144:ef7eb2e8f9f7 183 RAM functions are defined using a specific toolchain keyword "__ramfunc".
<> 144:ef7eb2e8f9f7 184 */
<> 144:ef7eb2e8f9f7 185 #define __RAM_FUNC __ramfunc HAL_StatusTypeDef
<> 144:ef7eb2e8f9f7 186
<> 144:ef7eb2e8f9f7 187 #define __NOINLINE _Pragma("optimize = no_inline")
<> 144:ef7eb2e8f9f7 188
<> 144:ef7eb2e8f9f7 189 #elif defined ( __GNUC__ )
<> 144:ef7eb2e8f9f7 190 /* GNU Compiler
<> 144:ef7eb2e8f9f7 191 ------------
<> 144:ef7eb2e8f9f7 192 RAM functions are defined using a specific toolchain attribute
<> 144:ef7eb2e8f9f7 193 "__attribute__((section(".RamFunc")))".
<> 144:ef7eb2e8f9f7 194 */
<> 144:ef7eb2e8f9f7 195 #define __RAM_FUNC HAL_StatusTypeDef __attribute__((section(".RamFunc")))
<> 144:ef7eb2e8f9f7 196
<> 144:ef7eb2e8f9f7 197 #endif
<> 144:ef7eb2e8f9f7 198
<> 144:ef7eb2e8f9f7 199 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 200 }
<> 144:ef7eb2e8f9f7 201 #endif
<> 144:ef7eb2e8f9f7 202
<> 144:ef7eb2e8f9f7 203 #endif /* ___STM32L0xx_HAL_DEF */
<> 144:ef7eb2e8f9f7 204
<> 144:ef7eb2e8f9f7 205 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Anna Bridge 186:707f6e361f3e 206