stm32f7xx_hal_def.h 8.1 KB

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