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_L152RE/stm32l1xx_hal_def.h@99:7f6c6de930c0, 2015-05-03 (annotated)

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

Who changed what in which revision?

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