Subversion Repositories dashGPS

Rev

Blame | Last modification | View Log | Download | RSS feed

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