mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_L011K4/TOOLCHAIN_ARM_MICRO/stm32l0xx_hal_def.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_NUCLEO_L011K4/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_def.h@167:84c0a372a020 
mbed library. Release version 164

Who changed what in which revision?

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