TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

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.

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

HAL_L476/stm32l4xx_hal_def.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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