lib/main/STM32F3/Drivers/STM32F3xx_HAL_Driver/Inc/stm32f3xx_hal_def.h

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