lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_def.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f7xx_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) 2017 STMicroelectronics.
  11   * All rights reserved.</center></h2>
  12   *
  13   * This software component is licensed by ST under BSD 3-Clause license,
  14   * the "License"; You may not use this file except in compliance with the
  15   * License. You may obtain a copy of the License at:
  16   *                        opensource.org/licenses/BSD-3-Clause
  17   *
  18   ******************************************************************************
  19   */
  20
  21 /* Define to prevent recursive inclusion -------------------------------------*/
  22 #ifndef __STM32F7xx_HAL_DEF
  23 #define __STM32F7xx_HAL_DEF
  24
  25 #ifdef __cplusplus
  26  extern "C" {
  27 #endif
  28
  29 /* Includes ------------------------------------------------------------------*/
  30 #include "stm32f7xx.h"
  31 #include "Legacy/stm32_hal_legacy.h"
  32 #include <stddef.h>
  33
  34 /* Exported types ------------------------------------------------------------*/
  35
  36 /**
  37   * @brief  HAL Status structures definition
  38   */
  39 typedef enum
  40 {
  41   HAL_OK       = 0x00U,
  42   HAL_ERROR    = 0x01U,
  43   HAL_BUSY     = 0x02U,
  44   HAL_TIMEOUT  = 0x03U
  45 } HAL_StatusTypeDef;
  46
  47 /**
  48   * @brief  HAL Lock structures definition
  49   */
  50 typedef enum
  51 {
  52   HAL_UNLOCKED = 0x00U,
  53   HAL_LOCKED   = 0x01U
  54 } HAL_LockTypeDef;
  55
  56 /* Exported macro ------------------------------------------------------------*/
  57
  58 #if !defined(UNUSED)
  59 #define UNUSED(X) ((void)(X))      /* To avoid gcc/g++ warnings */
  60 #endif
  61
  62 #define HAL_MAX_DELAY      0xFFFFFFFFU
  63
  64 #define HAL_IS_BIT_SET(REG, BIT)         (((REG) & (BIT)) == (BIT))
  65 #define HAL_IS_BIT_CLR(REG, BIT)         (((REG) & (BIT)) == 0U)
  66
  67 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__)               \
  68                         do{                                                      \
  69                               (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \
  70                               (__DMA_HANDLE__).Parent = (__HANDLE__);             \
  71                           } while(0)
  72
  73 /** @brief Reset the Handle's State field.
  74   * @param __HANDLE__ specifies the Peripheral Handle.
  75   * @note  This macro can be used for the following purpose:
  76   *          - When the Handle is declared as local variable; before passing it as parameter
  77   *            to HAL_PPP_Init() for the first time, it is mandatory to use this macro
  78   *            to set to 0 the Handle's "State" field.
  79   *            Otherwise, "State" field may have any random value and the first time the function
  80   *            HAL_PPP_Init() is called, the low level hardware initialization will be missed
  81   *            (i.e. HAL_PPP_MspInit() will not be executed).
  82   *          - When there is a need to reconfigure the low level hardware: instead of calling
  83   *            HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
  84   *            In this later function, when the Handle's "State" field is set to 0, it will execute the function
  85   *            HAL_PPP_MspInit() which will reconfigure the low level hardware.
  86   * @retval None
  87   */
  88 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U)
  89
  90 #if (USE_RTOS == 1U)
  91   /* Reserved for future use */
  92   #error "USE_RTOS should be 0 in the current HAL release"
  93 #else
  94   #define __HAL_LOCK(__HANDLE__)                                           \
  95                                 do{                                        \
  96                                     if((__HANDLE__)->Lock == HAL_LOCKED)   \
  97                                     {                                      \
  98                                        return HAL_BUSY;                    \
  99                                     }                                      \
 100                                     else                                   \
 101                                     {                                      \
 102                                        (__HANDLE__)->Lock = HAL_LOCKED;    \
 103                                     }                                      \
 104                                   }while (0U)
 105
 106   #define __HAL_UNLOCK(__HANDLE__)                                          \
 107                                   do{                                       \
 108                                       (__HANDLE__)->Lock = HAL_UNLOCKED;    \
 109                                     }while (0U)
 110 #endif /* USE_RTOS */
 111
 112 #if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
 113   #ifndef __weak
 114     #define __weak   __attribute__((weak))
 115   #endif /* __weak */
 116   #ifndef __packed
 117     #define __packed __attribute__((__packed__))
 118   #endif /* __packed */
 119 #endif /* __GNUC__ */
 120
 121
 122 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
 123 #if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
 124   #ifndef __ALIGN_END
 125     #define __ALIGN_END    __attribute__ ((aligned (4)))
 126   #endif /* __ALIGN_END */
 127   #ifndef __ALIGN_BEGIN
 128     #define __ALIGN_BEGIN
 129   #endif /* __ALIGN_BEGIN */
 130 #else
 131   #ifndef __ALIGN_END
 132     #define __ALIGN_END
 133   #endif /* __ALIGN_END */
 134   #ifndef __ALIGN_BEGIN
 135     #if defined   (__CC_ARM)      /* ARM Compiler */
 136       #define __ALIGN_BEGIN    __align(4)
 137     #elif defined (__ICCARM__)    /* IAR Compiler */
 138       #define __ALIGN_BEGIN
 139     #endif /* __CC_ARM */
 140   #endif /* __ALIGN_BEGIN */
 141 #endif /* __GNUC__ */
 142
 143 /* Macro to get variable aligned on 32-bytes,needed for cache maintenance purpose */
 144 #if defined   (__GNUC__)      /* GNU Compiler */
 145   #define ALIGN_32BYTES(buf)  buf __attribute__ ((aligned (32)))
 146 #elif defined (__ICCARM__)    /* IAR Compiler */
 147   #define ALIGN_32BYTES(buf) _Pragma("data_alignment=32") buf
 148 #elif defined (__CC_ARM)      /* ARM Compiler */
 149   #define ALIGN_32BYTES(buf) __align(32) buf
 150 #endif
 151
 152 /**
 153   * @brief  __RAM_FUNC definition
 154   */
 155 #if defined ( __CC_ARM   )
 156 /* ARM Compiler
 157    ------------
 158    RAM functions are defined using the toolchain options.
 159    Functions that are executed in RAM should reside in a separate source module.
 160    Using the 'Options for File' dialog you can simply change the 'Code / Const'
 161    area of a module to a memory space in physical RAM.
 162    Available memory areas are declared in the 'Target' tab of the 'Options for Target'
 163    dialog.
 164 */
 165 #define __RAM_FUNC
 166
 167 #elif defined ( __ICCARM__ )
 168 /* ICCARM Compiler
 169    ---------------
 170    RAM functions are defined using a specific toolchain keyword "__ramfunc".
 171 */
 172 #define __RAM_FUNC __ramfunc
 173
 174 #elif defined   (  __GNUC__  )
 175 /* GNU Compiler
 176    ------------
 177   RAM functions are defined using a specific toolchain attribute
 178    "__attribute__((section(".RamFunc")))".
 179 */
 180 #define __RAM_FUNC __attribute__((section(".RamFunc")))
 181
 182 #endif
 183
 184 /**
 185   * @brief  __NOINLINE definition
 186   */
 187 #if defined ( __CC_ARM   ) || defined   (  __GNUC__  )
 188 /* ARM & GNUCompiler
 189    ----------------
 190 */
 191 #define __NOINLINE __attribute__ ( (noinline) )
 192
 193 #elif defined ( __ICCARM__ )
 194 /* ICCARM Compiler
 195    ---------------
 196 */
 197 #define __NOINLINE _Pragma("optimize = no_inline")
 198
 199 #endif
 200
 201 #ifdef __cplusplus
 202 }
 203 #endif
 204
 205 #endif /* ___STM32F7xx_HAL_DEF */
 206
 207 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/