Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F070RB/stm32f0xx_hal_def.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
93:e188a91d3eaa 
12

Who changed what in which revision?

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