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_F303RE/TOOLCHAIN_ARM_MICRO/stm32f3xx_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_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_def.h@168:b9e159c1930a 
mbed library. Release version 164

Who changed what in which revision?

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