lzbp li / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_def.h@385:be64abf45658, 2014-11-04 (annotated)

Committer:
mbed_official
Date:
Tue Nov 04 09:45:07 2014 +0000
Revision:
385:be64abf45658
Parent:
targets/cmsis/TARGET_STM/TARGET_NUCLEO_F334R8/stm32f3xx_hal_def.h@375:3d36234a1087
Child:
632:7687fb9c4f91
Synchronized with git revision 5a868b18bc02bd5bb19d24424d0a2464cd1930bb



Full URL: https://github.com/mbedmicro/mbed/commit/5a868b18bc02bd5bb19d24424d0a2464cd1930bb/



Targets: Factorisation of NUCLEO_F302R8 and F334R8 cmsis folders

Who changed what in which revision?

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