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_STM32F3/device/stm32f3xx_hal_def.h@186:707f6e361f3e, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 16:45:37 2018 +0100
Revision:
186:707f6e361f3e
Parent:
180:96ed750bd169 
mbed-dev library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32f3xx_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 __STM32F3xx_HAL_DEF
<> 144:ef7eb2e8f9f7 39 #define __STM32F3xx_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 "stm32f3xx.h"
Anna Bridge 186:707f6e361f3e 47 #if defined USE_LEGACY
Anna Bridge 186:707f6e361f3e 48 #include "stm32_hal_legacy.h" // MBED patch
Anna Bridge 186:707f6e361f3e 49 #endif
<> 144:ef7eb2e8f9f7 50 #include <stdio.h>
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 /* Exported types ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 53
<> 144:ef7eb2e8f9f7 54 /**
<> 144:ef7eb2e8f9f7 55 * @brief HAL Status structures definition
<> 144:ef7eb2e8f9f7 56 */
<> 144:ef7eb2e8f9f7 57 typedef enum
<> 144:ef7eb2e8f9f7 58 {
<> 157:ff67d9f36b67 59 HAL_OK = 0x00U,
<> 157:ff67d9f36b67 60 HAL_ERROR = 0x01U,
<> 157:ff67d9f36b67 61 HAL_BUSY = 0x02U,
<> 144:ef7eb2e8f9f7 62 HAL_TIMEOUT = 0x03
<> 144:ef7eb2e8f9f7 63 } HAL_StatusTypeDef;
<> 144:ef7eb2e8f9f7 64
<> 144:ef7eb2e8f9f7 65 /**
<> 144:ef7eb2e8f9f7 66 * @brief HAL Lock structures definition
<> 144:ef7eb2e8f9f7 67 */
<> 144:ef7eb2e8f9f7 68 typedef enum
<> 144:ef7eb2e8f9f7 69 {
<> 157:ff67d9f36b67 70 HAL_UNLOCKED = 0x00U,
<> 144:ef7eb2e8f9f7 71 HAL_LOCKED = 0x01
<> 144:ef7eb2e8f9f7 72 } HAL_LockTypeDef;
<> 144:ef7eb2e8f9f7 73
<> 144:ef7eb2e8f9f7 74 /* Exported macro ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 75 #define HAL_MAX_DELAY 0xFFFFFFFFU
<> 144:ef7eb2e8f9f7 76
<> 144:ef7eb2e8f9f7 77 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) != RESET)
<> 144:ef7eb2e8f9f7 78 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == RESET)
<> 144:ef7eb2e8f9f7 79
<> 144:ef7eb2e8f9f7 80 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \
<> 144:ef7eb2e8f9f7 81 do{ \
<> 144:ef7eb2e8f9f7 82 (__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
<> 144:ef7eb2e8f9f7 83 (__DMA_HANDLE_).Parent = (__HANDLE__); \
<> 157:ff67d9f36b67 84 } while(0U)
<> 144:ef7eb2e8f9f7 85
<> 144:ef7eb2e8f9f7 86 #define UNUSED(x) ((void)(x))
<> 144:ef7eb2e8f9f7 87
<> 144:ef7eb2e8f9f7 88 /** @brief Reset the Handle's State field.
Anna Bridge 186:707f6e361f3e 89 * @param __HANDLE__ specifies the Peripheral Handle.
<> 144:ef7eb2e8f9f7 90 * @note This macro can be used for the following purpose:
<> 144:ef7eb2e8f9f7 91 * - When the Handle is declared as local variable; before passing it as parameter
<> 144:ef7eb2e8f9f7 92 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro
<> 144:ef7eb2e8f9f7 93 * to set to 0 the Handle's "State" field.
<> 144:ef7eb2e8f9f7 94 * Otherwise, "State" field may have any random value and the first time the function
<> 144:ef7eb2e8f9f7 95 * HAL_PPP_Init() is called, the low level hardware initialization will be missed
<> 144:ef7eb2e8f9f7 96 * (i.e. HAL_PPP_MspInit() will not be executed).
<> 144:ef7eb2e8f9f7 97 * - When there is a need to reconfigure the low level hardware: instead of calling
<> 144:ef7eb2e8f9f7 98 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
<> 144:ef7eb2e8f9f7 99 * In this later function, when the Handle's "State" field is set to 0, it will execute the function
<> 144:ef7eb2e8f9f7 100 * HAL_PPP_MspInit() which will reconfigure the low level hardware.
<> 144:ef7eb2e8f9f7 101 * @retval None
<> 144:ef7eb2e8f9f7 102 */
<> 157:ff67d9f36b67 103 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U)
<> 144:ef7eb2e8f9f7 104
<> 157:ff67d9f36b67 105 #if (USE_RTOS == 1U)
<> 144:ef7eb2e8f9f7 106 #error " USE_RTOS should be 0 in the current HAL release "
<> 144:ef7eb2e8f9f7 107 #else
<> 144:ef7eb2e8f9f7 108 #define __HAL_LOCK(__HANDLE__) \
<> 144:ef7eb2e8f9f7 109 do{ \
<> 144:ef7eb2e8f9f7 110 if((__HANDLE__)->Lock == HAL_LOCKED) \
<> 144:ef7eb2e8f9f7 111 { \
<> 144:ef7eb2e8f9f7 112 return HAL_BUSY; \
<> 144:ef7eb2e8f9f7 113 } \
<> 144:ef7eb2e8f9f7 114 else \
<> 144:ef7eb2e8f9f7 115 { \
<> 144:ef7eb2e8f9f7 116 (__HANDLE__)->Lock = HAL_LOCKED; \
<> 144:ef7eb2e8f9f7 117 } \
<> 157:ff67d9f36b67 118 }while (0U)
<> 144:ef7eb2e8f9f7 119
<> 144:ef7eb2e8f9f7 120 #define __HAL_UNLOCK(__HANDLE__) \
<> 144:ef7eb2e8f9f7 121 do{ \
<> 144:ef7eb2e8f9f7 122 (__HANDLE__)->Lock = HAL_UNLOCKED; \
<> 157:ff67d9f36b67 123 }while (0U)
<> 144:ef7eb2e8f9f7 124 #endif /* USE_RTOS */
Anna Bridge 186:707f6e361f3e 125
Anna Bridge 186:707f6e361f3e 126 // MBED patch
<> 153:fa9ff456f731 127 #if defined (__CC_ARM)
<> 153:fa9ff456f731 128 #pragma diag_suppress 3731
<> 153:fa9ff456f731 129 #endif
Anna Bridge 186:707f6e361f3e 130
Anna Bridge 186:707f6e361f3e 131 // MBED patch
<> 153:fa9ff456f731 132 static inline void atomic_set_u32(volatile uint32_t *ptr, uint32_t mask)
<> 153:fa9ff456f731 133 {
<> 153:fa9ff456f731 134 uint32_t newValue;
<> 153:fa9ff456f731 135 do {
Anna Bridge 180:96ed750bd169 136 newValue = (uint32_t)__LDREXW(ptr) | mask;
<> 153:fa9ff456f731 137
Anna Bridge 180:96ed750bd169 138 } while (__STREXW(newValue, ptr));
<> 153:fa9ff456f731 139 }
<> 153:fa9ff456f731 140
Anna Bridge 186:707f6e361f3e 141 // MBED patch
<> 153:fa9ff456f731 142 static inline void atomic_clr_u32(volatile uint32_t *ptr, uint32_t mask)
<> 153:fa9ff456f731 143 {
<> 153:fa9ff456f731 144 uint32_t newValue;
<> 153:fa9ff456f731 145 do {
Anna Bridge 180:96ed750bd169 146 newValue = (uint32_t)__LDREXW(ptr) &~mask;
<> 153:fa9ff456f731 147
Anna Bridge 180:96ed750bd169 148 } while (__STREXW(newValue, ptr));
<> 153:fa9ff456f731 149 }
<> 144:ef7eb2e8f9f7 150
Anna Bridge 186:707f6e361f3e 151 // MBED patch
Anna Bridge 164:289d4deac6e4 152 #if defined ( __GNUC__ ) && !defined ( __CC_ARM )
<> 144:ef7eb2e8f9f7 153 #ifndef __weak
<> 144:ef7eb2e8f9f7 154 #define __weak __attribute__((weak))
<> 144:ef7eb2e8f9f7 155 #endif /* __weak */
<> 144:ef7eb2e8f9f7 156 #ifndef __packed
<> 144:ef7eb2e8f9f7 157 #define __packed __attribute__((__packed__))
<> 144:ef7eb2e8f9f7 158 #endif /* __packed */
<> 144:ef7eb2e8f9f7 159 #endif /* __GNUC__ */
<> 144:ef7eb2e8f9f7 160
<> 144:ef7eb2e8f9f7 161
<> 144:ef7eb2e8f9f7 162 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
<> 144:ef7eb2e8f9f7 163 #if defined (__GNUC__) /* GNU Compiler */
<> 144:ef7eb2e8f9f7 164 #ifndef __ALIGN_END
<> 144:ef7eb2e8f9f7 165 #define __ALIGN_END __attribute__ ((aligned (4)))
<> 144:ef7eb2e8f9f7 166 #endif /* __ALIGN_END */
<> 144:ef7eb2e8f9f7 167 #ifndef __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 168 #define __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 169 #endif /* __ALIGN_BEGIN */
<> 144:ef7eb2e8f9f7 170 #else
<> 144:ef7eb2e8f9f7 171 #ifndef __ALIGN_END
<> 144:ef7eb2e8f9f7 172 #define __ALIGN_END
<> 144:ef7eb2e8f9f7 173 #endif /* __ALIGN_END */
<> 144:ef7eb2e8f9f7 174 #ifndef __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 175 #if defined (__CC_ARM) /* ARM Compiler */
<> 144:ef7eb2e8f9f7 176 #define __ALIGN_BEGIN __align(4)
<> 144:ef7eb2e8f9f7 177 #elif defined (__ICCARM__) /* IAR Compiler */
<> 144:ef7eb2e8f9f7 178 #define __ALIGN_BEGIN
<> 144:ef7eb2e8f9f7 179 #endif /* __CC_ARM */
<> 144:ef7eb2e8f9f7 180 #endif /* __ALIGN_BEGIN */
<> 144:ef7eb2e8f9f7 181 #endif /* __GNUC__ */
<> 144:ef7eb2e8f9f7 182
<> 144:ef7eb2e8f9f7 183 /**
<> 144:ef7eb2e8f9f7 184 * @brief __NOINLINE definition
<> 144:ef7eb2e8f9f7 185 */
<> 144:ef7eb2e8f9f7 186 #if defined ( __CC_ARM ) || defined ( __GNUC__ )
<> 144:ef7eb2e8f9f7 187 /* ARM & GNUCompiler
<> 144:ef7eb2e8f9f7 188 ----------------
<> 144:ef7eb2e8f9f7 189 */
<> 144:ef7eb2e8f9f7 190 #define __NOINLINE __attribute__ ( (noinline) )
<> 144:ef7eb2e8f9f7 191
<> 144:ef7eb2e8f9f7 192 #elif defined ( __ICCARM__ )
<> 144:ef7eb2e8f9f7 193 /* ICCARM Compiler
<> 144:ef7eb2e8f9f7 194 ---------------
<> 144:ef7eb2e8f9f7 195 */
<> 144:ef7eb2e8f9f7 196 #define __NOINLINE _Pragma("optimize = no_inline")
<> 144:ef7eb2e8f9f7 197
<> 144:ef7eb2e8f9f7 198 #endif
<> 144:ef7eb2e8f9f7 199
<> 144:ef7eb2e8f9f7 200 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 201 }
<> 144:ef7eb2e8f9f7 202 #endif
<> 144:ef7eb2e8f9f7 203
<> 144:ef7eb2e8f9f7 204 #endif /* ___STM32F3xx_HAL_DEF */
<> 144:ef7eb2e8f9f7 205
<> 144:ef7eb2e8f9f7 206 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/