HAL_dma.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. /**
  2. ******************************************************************************
  3. * @file HAL_dma.h
  4. * @author AE Team
  5. * @version V2.0.0
  6. * @date 22/08/2017
  7. * @brief This file contains all the functions prototypes for the DMA firmware
  8. * library.
  9. ******************************************************************************
  10. * @copy
  11. *
  12. * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  13. * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  14. * TIME. AS A RESULT, MindMotion SHALL NOT BE HELD LIABLE FOR ANY
  15. * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  16. * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  17. * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  18. *
  19. * <h2><center>&copy; COPYRIGHT 2017 MindMotion</center></h2>
  20. */
  21. /* Define to prevent recursive inclusion -------------------------------------*/
  22. #ifndef __HAL_DMA_H
  23. #define __HAL_DMA_H
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "HAL_device.h"
  26. /** @addtogroup StdPeriph_Driver
  27. * @{
  28. */
  29. /** @addtogroup DMA
  30. * @{
  31. */
  32. /** @defgroup DMA_Exported_Types
  33. * @{
  34. */
  35. /**
  36. * @brief DMA Init structure definition
  37. */
  38. typedef struct
  39. {
  40. uint32_t DMA_PeripheralBaseAddr;
  41. uint32_t DMA_MemoryBaseAddr;
  42. uint32_t DMA_DIR;
  43. uint32_t DMA_BufferSize;
  44. uint32_t DMA_PeripheralInc;
  45. uint32_t DMA_MemoryInc;
  46. uint32_t DMA_PeripheralDataSize;
  47. uint32_t DMA_MemoryDataSize;
  48. uint32_t DMA_Mode;
  49. uint32_t DMA_Priority;
  50. uint32_t DMA_M2M;
  51. }DMA_InitTypeDef;
  52. /**
  53. * @}
  54. */
  55. /** @defgroup DMA_Exported_Constants
  56. * @{
  57. */
  58. #define IS_DMA_ALL_PERIPH(PERIPH) (((*(uint32_t*)&(PERIPH)) == DMA1_Channel1_BASE) || \
  59. ((*(uint32_t*)&(PERIPH)) == DMA1_Channel2_BASE) || \
  60. ((*(uint32_t*)&(PERIPH)) == DMA1_Channel3_BASE) || \
  61. ((*(uint32_t*)&(PERIPH)) == DMA1_Channel4_BASE) || \
  62. ((*(uint32_t*)&(PERIPH)) == DMA1_Channel5_BASE))
  63. /** @defgroup DMA_data_transfer_direction
  64. * @{
  65. */
  66. #define DMA_DIR_PeripheralDST ((uint32_t)0x00000010) //mtop
  67. #define DMA_DIR_PeripheralSRC ((uint32_t)0x00000000) //ptom
  68. #define IS_DMA_DIR(DIR) (((DIR) == DMA_DIR_PeripheralDST) || \
  69. ((DIR) == DMA_DIR_PeripheralSRC))
  70. /**
  71. * @}
  72. */
  73. /** @defgroup DMA_peripheral_incremented_mode
  74. * @{
  75. */
  76. #define DMA_PeripheralInc_Enable ((uint32_t)0x00000040)
  77. #define DMA_PeripheralInc_Disable ((uint32_t)0x00000000)
  78. #define IS_DMA_PERIPHERAL_INC_STATE(STATE) (((STATE) == DMA_PeripheralInc_Enable) || \
  79. ((STATE) == DMA_PeripheralInc_Disable))
  80. /**
  81. * @}
  82. */
  83. /** @defgroup DMA_memory_incremented_mode
  84. * @{
  85. */
  86. #define DMA_MemoryInc_Enable ((uint32_t)0x00000080)
  87. #define DMA_MemoryInc_Disable ((uint32_t)0x00000000)
  88. #define IS_DMA_MEMORY_INC_STATE(STATE) (((STATE) == DMA_MemoryInc_Enable) || \
  89. ((STATE) == DMA_MemoryInc_Disable))
  90. /**
  91. * @}
  92. */
  93. /** @defgroup DMA_peripheral_data_size
  94. * @{
  95. */
  96. #define DMA_PeripheralDataSize_Byte ((uint32_t)0x00000000)
  97. #define DMA_PeripheralDataSize_HalfWord ((uint32_t)0x00000100)
  98. #define DMA_PeripheralDataSize_Word ((uint32_t)0x00000200)
  99. #define IS_DMA_PERIPHERAL_DATA_SIZE(SIZE) (((SIZE) == DMA_PeripheralDataSize_Byte) || \
  100. ((SIZE) == DMA_PeripheralDataSize_HalfWord) || \
  101. ((SIZE) == DMA_PeripheralDataSize_Word))
  102. /**
  103. * @}
  104. */
  105. /** @defgroup DMA_memory_data_size
  106. * @{
  107. */
  108. #define DMA_MemoryDataSize_Byte ((uint32_t)0x00000000)
  109. #define DMA_MemoryDataSize_HalfWord ((uint32_t)0x00000400)
  110. #define DMA_MemoryDataSize_Word ((uint32_t)0x00000800)
  111. #define IS_DMA_MEMORY_DATA_SIZE(SIZE) (((SIZE) == DMA_MemoryDataSize_Byte) || \
  112. ((SIZE) == DMA_MemoryDataSize_HalfWord) || \
  113. ((SIZE) == DMA_MemoryDataSize_Word))
  114. /**
  115. * @}
  116. */
  117. /** @defgroup DMA_circular_normal_mode
  118. * @{
  119. */
  120. #define DMA_Mode_Circular ((uint32_t)0x00000020)
  121. #define DMA_Mode_Normal ((uint32_t)0x00000000)
  122. #define IS_DMA_MODE(MODE) (((MODE) == DMA_Mode_Circular) || ((MODE) == DMA_Mode_Normal))
  123. /**
  124. * @}
  125. */
  126. /** @defgroup DMA_priority_level
  127. * @{
  128. */
  129. #define DMA_Priority_VeryHigh ((uint32_t)0x00003000)
  130. #define DMA_Priority_High ((uint32_t)0x00002000)
  131. #define DMA_Priority_Medium ((uint32_t)0x00001000)
  132. #define DMA_Priority_Low ((uint32_t)0x00000000)
  133. #define IS_DMA_PRIORITY(PRIORITY) (((PRIORITY) == DMA_Priority_VeryHigh) || \
  134. ((PRIORITY) == DMA_Priority_High) || \
  135. ((PRIORITY) == DMA_Priority_Medium) || \
  136. ((PRIORITY) == DMA_Priority_Low))
  137. /**
  138. * @}
  139. */
  140. /** @defgroup DMA_memory_to_memory
  141. * @{
  142. */
  143. #define DMA_M2M_Enable ((uint32_t)0x00004000)
  144. #define DMA_M2M_Disable ((uint32_t)0x00000000)
  145. #define IS_DMA_M2M_STATE(STATE) (((STATE) == DMA_M2M_Enable) || ((STATE) == DMA_M2M_Disable))
  146. /**
  147. * @}
  148. */
  149. /** @defgroup DMA_interrupts_definition
  150. * @{
  151. */
  152. #define DMA_IT_TC ((uint32_t)0x00000002)
  153. #define DMA_IT_HT ((uint32_t)0x00000004)
  154. #define DMA_IT_TE ((uint32_t)0x00000008)
  155. #define IS_DMA_CONFIG_IT(IT) ((((IT) & 0xFFFFFFF1) == 0x00) && ((IT) != 0x00))
  156. /**
  157. * @brief For DMA1
  158. */
  159. #define DMA1_IT_GL1 ((uint32_t)0x00000001)
  160. #define DMA1_IT_TC1 ((uint32_t)0x00000002)
  161. #define DMA1_IT_HT1 ((uint32_t)0x00000004)
  162. #define DMA1_IT_TE1 ((uint32_t)0x00000008)
  163. #define DMA1_IT_GL2 ((uint32_t)0x00000010)
  164. #define DMA1_IT_TC2 ((uint32_t)0x00000020)
  165. #define DMA1_IT_HT2 ((uint32_t)0x00000040)
  166. #define DMA1_IT_TE2 ((uint32_t)0x00000080)
  167. #define DMA1_IT_GL3 ((uint32_t)0x00000100)
  168. #define DMA1_IT_TC3 ((uint32_t)0x00000200)
  169. #define DMA1_IT_HT3 ((uint32_t)0x00000400)
  170. #define DMA1_IT_TE3 ((uint32_t)0x00000800)
  171. #define DMA1_IT_GL4 ((uint32_t)0x00001000)
  172. #define DMA1_IT_TC4 ((uint32_t)0x00002000)
  173. #define DMA1_IT_HT4 ((uint32_t)0x00004000)
  174. #define DMA1_IT_TE4 ((uint32_t)0x00008000)
  175. #define DMA1_IT_GL5 ((uint32_t)0x00010000)
  176. #define DMA1_IT_TC5 ((uint32_t)0x00020000)
  177. #define DMA1_IT_HT5 ((uint32_t)0x00040000)
  178. #define DMA1_IT_TE5 ((uint32_t)0x00080000)
  179. #define IS_DMA_CLEAR_IT(IT) (((((IT) & 0xF0000000) == 0x00) || (((IT) & 0xEFF00000) == 0x00)) && ((IT) != 0x00))
  180. #define IS_DMA_GET_IT(IT) (((IT) == DMA1_IT_GL1) || ((IT) == DMA1_IT_TC1) || \
  181. ((IT) == DMA1_IT_HT1) || ((IT) == DMA1_IT_TE1) || \
  182. ((IT) == DMA1_IT_GL2) || ((IT) == DMA1_IT_TC2) || \
  183. ((IT) == DMA1_IT_HT2) || ((IT) == DMA1_IT_TE2) || \
  184. ((IT) == DMA1_IT_GL3) || ((IT) == DMA1_IT_TC3) || \
  185. ((IT) == DMA1_IT_HT3) || ((IT) == DMA1_IT_TE3) || \
  186. ((IT) == DMA1_IT_GL4) || ((IT) == DMA1_IT_TC4) || \
  187. ((IT) == DMA1_IT_HT4) || ((IT) == DMA1_IT_TE4) || \
  188. ((IT) == DMA1_IT_GL5) || ((IT) == DMA1_IT_TC5) || \
  189. ((IT) == DMA1_IT_HT5) || ((IT) == DMA1_IT_TE5))
  190. /**
  191. * @}
  192. */
  193. /** @defgroup DMA_flags_definition
  194. * @{
  195. */
  196. /**
  197. * @brief For DMA1
  198. */
  199. #define DMA1_FLAG_GL1 ((uint32_t)0x00000001)
  200. #define DMA1_FLAG_TC1 ((uint32_t)0x00000002)
  201. #define DMA1_FLAG_HT1 ((uint32_t)0x00000004)
  202. #define DMA1_FLAG_TE1 ((uint32_t)0x00000008)
  203. #define DMA1_FLAG_GL2 ((uint32_t)0x00000010)
  204. #define DMA1_FLAG_TC2 ((uint32_t)0x00000020)
  205. #define DMA1_FLAG_HT2 ((uint32_t)0x00000040)
  206. #define DMA1_FLAG_TE2 ((uint32_t)0x00000080)
  207. #define DMA1_FLAG_GL3 ((uint32_t)0x00000100)
  208. #define DMA1_FLAG_TC3 ((uint32_t)0x00000200)
  209. #define DMA1_FLAG_HT3 ((uint32_t)0x00000400)
  210. #define DMA1_FLAG_TE3 ((uint32_t)0x00000800)
  211. #define DMA1_FLAG_GL4 ((uint32_t)0x00001000)
  212. #define DMA1_FLAG_TC4 ((uint32_t)0x00002000)
  213. #define DMA1_FLAG_HT4 ((uint32_t)0x00004000)
  214. #define DMA1_FLAG_TE4 ((uint32_t)0x00008000)
  215. #define DMA1_FLAG_GL5 ((uint32_t)0x00010000)
  216. #define DMA1_FLAG_TC5 ((uint32_t)0x00020000)
  217. #define DMA1_FLAG_HT5 ((uint32_t)0x00040000)
  218. #define DMA1_FLAG_TE5 ((uint32_t)0x00080000)
  219. #define IS_DMA_CLEAR_FLAG(FLAG) (((((FLAG) & 0xF0000000) == 0x00) || (((FLAG) & 0xEFF00000) == 0x00)) && ((FLAG) != 0x00))
  220. #define IS_DMA_GET_FLAG(FLAG) (((FLAG) == DMA1_FLAG_GL1) || ((FLAG) == DMA1_FLAG_TC1) || \
  221. ((FLAG) == DMA1_FLAG_HT1) || ((FLAG) == DMA1_FLAG_TE1) || \
  222. ((FLAG) == DMA1_FLAG_GL2) || ((FLAG) == DMA1_FLAG_TC2) || \
  223. ((FLAG) == DMA1_FLAG_HT2) || ((FLAG) == DMA1_FLAG_TE2) || \
  224. ((FLAG) == DMA1_FLAG_GL3) || ((FLAG) == DMA1_FLAG_TC3) || \
  225. ((FLAG) == DMA1_FLAG_HT3) || ((FLAG) == DMA1_FLAG_TE3) || \
  226. ((FLAG) == DMA1_FLAG_GL4) || ((FLAG) == DMA1_FLAG_TC4) || \
  227. ((FLAG) == DMA1_FLAG_HT4) || ((FLAG) == DMA1_FLAG_TE4) || \
  228. ((FLAG) == DMA1_FLAG_GL5) || ((FLAG) == DMA1_FLAG_TC5) || \
  229. ((FLAG) == DMA1_FLAG_HT5) || ((FLAG) == DMA1_FLAG_TE5))
  230. /**
  231. * @}
  232. */
  233. /** @defgroup DMA_Buffer_Size
  234. * @{
  235. */
  236. #define IS_DMA_BUFFER_SIZE(SIZE) (((SIZE) >= 0x1) && ((SIZE) < 0x10000))
  237. /**
  238. * @}
  239. */
  240. /**
  241. * @}
  242. */
  243. /** @defgroup DMA_Exported_Macros
  244. * @{
  245. */
  246. /**
  247. * @}
  248. */
  249. /** @defgroup DMA_Exported_Functions
  250. * @{
  251. */
  252. void DMA_DeInit(DMA_Channel_TypeDef* DMAy_Channelx);
  253. void DMA_Init(DMA_Channel_TypeDef* DMAy_Channelx, DMA_InitTypeDef* DMA_InitStruct);
  254. void DMA_StructInit(DMA_InitTypeDef* DMA_InitStruct);
  255. void DMA_Cmd(DMA_Channel_TypeDef* DMAy_Channelx, FunctionalState NewState);
  256. void DMA_ITConfig(DMA_Channel_TypeDef* DMAy_Channelx, uint32_t DMA_IT, FunctionalState NewState);
  257. uint16_t DMA_GetCurrDataCounter(DMA_Channel_TypeDef* DMAy_Channelx);
  258. FlagStatus DMA_GetFlagStatus(uint32_t DMA_FLAG);
  259. void DMA_ClearFlag(uint32_t DMA_FLAG);
  260. ITStatus DMA_GetITStatus(uint32_t DMA_IT);
  261. void DMA_ClearITPendingBit(uint32_t DMA_IT);
  262. #endif /*__HAL_DMA_H */
  263. /**
  264. * @}
  265. */
  266. /**
  267. * @}
  268. */
  269. /**
  270. * @}
  271. */
  272. /*------------------ (C) COPYRIGHT 2017 MindMotion ------------------*/