stm32f3xx_hal_def.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. /**
  2. ******************************************************************************
  3. * @file stm32f3xx_hal_def.h
  4. * @author MCD Application Team
  5. * @version V1.4.0
  6. * @date 16-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 __STM32F3xx_HAL_DEF
  40. #define __STM32F3xx_HAL_DEF
  41. #ifdef __cplusplus
  42. extern "C" {
  43. #endif
  44. /* Includes ------------------------------------------------------------------*/
  45. #include "stm32f3xx.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 = 0x03
  58. } HAL_StatusTypeDef;
  59. /**
  60. * @brief HAL Lock structures definition
  61. */
  62. typedef enum
  63. {
  64. HAL_UNLOCKED = 0x00U,
  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(0U)
  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 == 1U)
  94. #error " USE_RTOS should be 0 in the current HAL release "
  95. #else
  96. #define __HAL_LOCK(__HANDLE__) \
  97. do{ \
  98. if((__HANDLE__)->Lock == HAL_LOCKED) \
  99. { \
  100. return HAL_BUSY; \
  101. } \
  102. else \
  103. { \
  104. (__HANDLE__)->Lock = HAL_LOCKED; \
  105. } \
  106. }while (0U)
  107. #define __HAL_UNLOCK(__HANDLE__) \
  108. do{ \
  109. (__HANDLE__)->Lock = HAL_UNLOCKED; \
  110. }while (0U)
  111. #endif /* USE_RTOS */
  112. #if defined ( __GNUC__ )
  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. /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
  121. #if defined (__GNUC__) /* GNU Compiler */
  122. #ifndef __ALIGN_END
  123. #define __ALIGN_END __attribute__ ((aligned (4)))
  124. #endif /* __ALIGN_END */
  125. #ifndef __ALIGN_BEGIN
  126. #define __ALIGN_BEGIN
  127. #endif /* __ALIGN_BEGIN */
  128. #else
  129. #ifndef __ALIGN_END
  130. #define __ALIGN_END
  131. #endif /* __ALIGN_END */
  132. #ifndef __ALIGN_BEGIN
  133. #if defined (__CC_ARM) /* ARM Compiler */
  134. #define __ALIGN_BEGIN __align(4)
  135. #elif defined (__ICCARM__) /* IAR Compiler */
  136. #define __ALIGN_BEGIN
  137. #endif /* __CC_ARM */
  138. #endif /* __ALIGN_BEGIN */
  139. #endif /* __GNUC__ */
  140. /**
  141. * @brief __NOINLINE definition
  142. */
  143. #if defined ( __CC_ARM ) || defined ( __GNUC__ )
  144. /* ARM & GNUCompiler
  145. ----------------
  146. */
  147. #define __NOINLINE __attribute__ ( (noinline) )
  148. #elif defined ( __ICCARM__ )
  149. /* ICCARM Compiler
  150. ---------------
  151. */
  152. #define __NOINLINE _Pragma("optimize = no_inline")
  153. #endif
  154. #ifdef __cplusplus
  155. }
  156. #endif
  157. #endif /* ___STM32F3xx_HAL_DEF */
  158. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/