1 /** 2 ****************************************************************************** 3 * @file stm32l5xx_hal_dma_ex.h 4 * @author MCD Application Team 5 * @brief Header file of DMA HAL extension module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© Copyright (c) 2019 STMicroelectronics. 10 * All rights reserved.</center></h2> 11 * 12 * This software component is licensed by ST under BSD 3-Clause license, 13 * the "License"; You may not use this file except in compliance with the 14 * License. You may obtain a copy of the License at: 15 * opensource.org/licenses/BSD-3-Clause 16 * 17 ****************************************************************************** 18 */ 19 20 /* Define to prevent recursive inclusion -------------------------------------*/ 21 #ifndef STM32L5xx_HAL_DMA_EX_H 22 #define STM32L5xx_HAL_DMA_EX_H 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #include "stm32l5xx_hal_def.h" 30 31 /** @addtogroup STM32L5xx_HAL_Driver 32 * @{ 33 */ 34 35 /** @addtogroup DMAEx 36 * @{ 37 */ 38 39 /* Exported types ------------------------------------------------------------*/ 40 /** @defgroup DMAEx_Exported_Types DMAEx Exported Types 41 * @{ 42 */ 43 44 /** 45 * @brief HAL DMA Memory definition 46 */ 47 typedef enum 48 { 49 MEMORY0 = 0x00U, /*!< Memory 0 */ 50 MEMORY1 = 0x01U, /*!< Memory 1 */ 51 52 }HAL_DMA_MemoryTypeDef; 53 54 /** 55 * @brief HAL DMA Synchro definition 56 */ 57 58 59 /** 60 * @brief HAL DMAMUX Synchronization configuration structure definition 61 */ 62 typedef struct 63 { 64 uint32_t SyncSignalID; /*!< Specifies the synchronization signal gating the DMA request in periodic mode. 65 This parameter can be a value of @ref DMAEx_DMAMUX_SyncSignalID_selection */ 66 67 uint32_t SyncPolarity; /*!< Specifies the polarity of the signal on which the DMA request is synchronized. 68 This parameter can be a value of @ref DMAEx_DMAMUX_SyncPolarity_selection */ 69 70 FunctionalState SyncEnable; /*!< Specifies if the synchronization shall be enabled or disabled 71 This parameter can take the value ENABLE or DISABLE*/ 72 73 74 FunctionalState EventEnable; /*!< Specifies if an event shall be generated once the RequestNumber is reached. 75 This parameter can take the value ENABLE or DISABLE */ 76 77 uint32_t RequestNumber; /*!< Specifies the number of DMA request that will be authorized after a sync event 78 This parameter must be a number between Min_Data = 1 and Max_Data = 32 */ 79 80 81 }HAL_DMA_MuxSyncConfigTypeDef; 82 83 84 /** 85 * @brief HAL DMAMUX request generator parameters structure definition 86 */ 87 typedef struct 88 { 89 uint32_t SignalID; /*!< Specifies the ID of the signal used for DMAMUX request generator 90 This parameter can be a value of @ref DMAEx_DMAMUX_SignalGeneratorID_selection */ 91 92 uint32_t Polarity; /*!< Specifies the polarity of the signal on which the request is generated. 93 This parameter can be a value of @ref DMAEx_DMAMUX_RequestGeneneratorPolarity_selection */ 94 95 uint32_t RequestNumber; /*!< Specifies the number of DMA request that will be generated after a signal event 96 This parameter must be a number between Min_Data = 1 and Max_Data = 32 */ 97 98 }HAL_DMA_MuxRequestGeneratorConfigTypeDef; 99 100 /** 101 * @} 102 */ 103 104 /* Exported constants --------------------------------------------------------*/ 105 /** @defgroup DMAEx_Exported_Constants DMAEx Exported Constants 106 * @{ 107 */ 108 109 /** @defgroup DMAEx_DMAMUX_SyncSignalID_selection DMAMUX SyncSignalID selection 110 * @{ 111 */ 112 #define HAL_DMAMUX1_SYNC_EXTI0 0U /*!< Synchronization Signal is EXTI0 IT */ 113 #define HAL_DMAMUX1_SYNC_EXTI1 1U /*!< Synchronization Signal is EXTI1 IT */ 114 #define HAL_DMAMUX1_SYNC_EXTI2 2U /*!< Synchronization Signal is EXTI2 IT */ 115 #define HAL_DMAMUX1_SYNC_EXTI3 3U /*!< Synchronization Signal is EXTI3 IT */ 116 #define HAL_DMAMUX1_SYNC_EXTI4 4U /*!< Synchronization Signal is EXTI4 IT */ 117 #define HAL_DMAMUX1_SYNC_EXTI5 5U /*!< Synchronization Signal is EXTI5 IT */ 118 #define HAL_DMAMUX1_SYNC_EXTI6 6U /*!< Synchronization Signal is EXTI6 IT */ 119 #define HAL_DMAMUX1_SYNC_EXTI7 7U /*!< Synchronization Signal is EXTI7 IT */ 120 #define HAL_DMAMUX1_SYNC_EXTI8 8U /*!< Synchronization Signal is EXTI8 IT */ 121 #define HAL_DMAMUX1_SYNC_EXTI9 9U /*!< Synchronization Signal is EXTI9 IT */ 122 #define HAL_DMAMUX1_SYNC_EXTI10 10U /*!< Synchronization Signal is EXTI10 IT */ 123 #define HAL_DMAMUX1_SYNC_EXTI11 11U /*!< Synchronization Signal is EXTI11 IT */ 124 #define HAL_DMAMUX1_SYNC_EXTI12 12U /*!< Synchronization Signal is EXTI12 IT */ 125 #define HAL_DMAMUX1_SYNC_EXTI13 13U /*!< Synchronization Signal is EXTI13 IT */ 126 #define HAL_DMAMUX1_SYNC_EXTI14 14U /*!< Synchronization Signal is EXTI14 IT */ 127 #define HAL_DMAMUX1_SYNC_EXTI15 15U /*!< Synchronization Signal is EXTI15 IT */ 128 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH0_EVT 16U /*!< Synchronization Signal is DMAMUX1 Channel0 Event */ 129 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH1_EVT 17U /*!< Synchronization Signal is DMAMUX1 Channel1 Event */ 130 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH2_EVT 18U /*!< Synchronization Signal is DMAMUX1 Channel2 Event */ 131 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH3_EVT 19U /*!< Synchronization Signal is DMAMUX1 Channel3 Event */ 132 #define HAL_DMAMUX1_SYNC_LPTIM1_OUT 20U /*!< Synchronization Signal is LPTIM1 OUT */ 133 #define HAL_DMAMUX1_SYNC_LPTIM2_OUT 21U /*!< Synchronization Signal is LPTIM2 OUT */ 134 #define HAL_DMAMUX1_SYNC_LPTIM3_OUT 22U /*!< Synchronization Signal is LPTIM3 OUT */ 135 136 /** 137 * @} 138 */ 139 140 /** @defgroup DMAEx_DMAMUX_SyncPolarity_selection DMAMUX SyncPolarity selection 141 * @{ 142 */ 143 #define HAL_DMAMUX_SYNC_NO_EVENT 0U /*!< block synchronization events */ 144 #define HAL_DMAMUX_SYNC_RISING DMAMUX_CxCR_SPOL_0 /*!< synchronize with rising edge events */ 145 #define HAL_DMAMUX_SYNC_FALLING DMAMUX_CxCR_SPOL_1 /*!< synchronize with falling edge events */ 146 #define HAL_DMAMUX_SYNC_RISING_FALLING DMAMUX_CxCR_SPOL /*!< synchronize with rising and falling edge events */ 147 148 /** 149 * @} 150 */ 151 152 /** @defgroup DMAEx_DMAMUX_SignalGeneratorID_selection DMAMUX SignalGeneratorID selection 153 * @{ 154 */ 155 156 #define HAL_DMAMUX1_REQ_GEN_EXTI0 0U /*!< Request generator Signal is EXTI0 IT */ 157 #define HAL_DMAMUX1_REQ_GEN_EXTI1 1U /*!< Request generator Signal is EXTI1 IT */ 158 #define HAL_DMAMUX1_REQ_GEN_EXTI2 2U /*!< Request generator Signal is EXTI2 IT */ 159 #define HAL_DMAMUX1_REQ_GEN_EXTI3 3U /*!< Request generator Signal is EXTI3 IT */ 160 #define HAL_DMAMUX1_REQ_GEN_EXTI4 4U /*!< Request generator Signal is EXTI4 IT */ 161 #define HAL_DMAMUX1_REQ_GEN_EXTI5 5U /*!< Request generator Signal is EXTI5 IT */ 162 #define HAL_DMAMUX1_REQ_GEN_EXTI6 6U /*!< Request generator Signal is EXTI6 IT */ 163 #define HAL_DMAMUX1_REQ_GEN_EXTI7 7U /*!< Request generator Signal is EXTI7 IT */ 164 #define HAL_DMAMUX1_REQ_GEN_EXTI8 8U /*!< Request generator Signal is EXTI8 IT */ 165 #define HAL_DMAMUX1_REQ_GEN_EXTI9 9U /*!< Request generator Signal is EXTI9 IT */ 166 #define HAL_DMAMUX1_REQ_GEN_EXTI10 10U /*!< Request generator Signal is EXTI10 IT */ 167 #define HAL_DMAMUX1_REQ_GEN_EXTI11 11U /*!< Request generator Signal is EXTI11 IT */ 168 #define HAL_DMAMUX1_REQ_GEN_EXTI12 12U /*!< Request generator Signal is EXTI12 IT */ 169 #define HAL_DMAMUX1_REQ_GEN_EXTI13 13U /*!< Request generator Signal is EXTI13 IT */ 170 #define HAL_DMAMUX1_REQ_GEN_EXTI14 14U /*!< Request generator Signal is EXTI14 IT */ 171 #define HAL_DMAMUX1_REQ_GEN_EXTI15 15U /*!< Request generator Signal is EXTI15 IT */ 172 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH0_EVT 16U /*!< Request generator Signal is DMAMUX1 Channel0 Event */ 173 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH1_EVT 17U /*!< Request generator Signal is DMAMUX1 Channel1 Event */ 174 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH2_EVT 18U /*!< Request generator Signal is DMAMUX1 Channel2 Event */ 175 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH3_EVT 19U /*!< Request generator Signal is DMAMUX1 Channel3 Event */ 176 #define HAL_DMAMUX1_REQ_GEN_LPTIM1_OUT 20U /*!< Request generator Signal is LPTIM1 OUT */ 177 #define HAL_DMAMUX1_REQ_GEN_LPTIM2_OUT 21U /*!< Request generator Signal is LPTIM2 OUT */ 178 #define HAL_DMAMUX1_REQ_GEN_LPTIM3_OUT 22U /*!< Request generator Signal is LPTIM3 OUT */ 179 180 /** 181 * @} 182 */ 183 184 /** @defgroup DMAEx_DMAMUX_RequestGeneneratorPolarity_selection DMAMUX RequestGeneneratorPolarity selection 185 * @{ 186 */ 187 #define HAL_DMAMUX_REQ_GEN_NO_EVENT 0U /*!< block request generator events */ 188 #define HAL_DMAMUX_REQ_GEN_RISING DMAMUX_RGxCR_GPOL_0 /*!< generate request on rising edge events */ 189 #define HAL_DMAMUX_REQ_GEN_FALLING DMAMUX_RGxCR_GPOL_1 /*!< generate request on falling edge events */ 190 #define HAL_DMAMUX_REQ_GEN_RISING_FALLING DMAMUX_RGxCR_GPOL /*!< generate request on rising and falling edge events */ 191 192 /** 193 * @} 194 */ 195 196 /** 197 * @} 198 */ 199 200 /* Exported macro ------------------------------------------------------------*/ 201 202 /* Exported functions --------------------------------------------------------*/ 203 /** @addtogroup DMAEx_Exported_Functions 204 * @{ 205 */ 206 207 /* IO operation functions *****************************************************/ 208 /** @addtogroup DMAEx_Exported_Functions_Group1 209 * @{ 210 */ 211 /* ------------------------- Double Buffering --------------------------------*/ 212 HAL_StatusTypeDef HAL_DMAEx_MultiBufferStart(DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t SecondMemAddress, uint32_t DataLength); 213 HAL_StatusTypeDef HAL_DMAEx_MultiBufferStart_IT(DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t SecondMemAddress, uint32_t DataLength); 214 HAL_StatusTypeDef HAL_DMAEx_ChangeMemory(DMA_HandleTypeDef *hdma, uint32_t Address, HAL_DMA_MemoryTypeDef memory); 215 216 /* ------------------------- REQUEST -----------------------------------------*/ 217 HAL_StatusTypeDef HAL_DMAEx_ConfigMuxRequestGenerator (DMA_HandleTypeDef *hdma, 218 HAL_DMA_MuxRequestGeneratorConfigTypeDef *pRequestGeneratorConfig); 219 HAL_StatusTypeDef HAL_DMAEx_EnableMuxRequestGenerator (DMA_HandleTypeDef *hdma); 220 HAL_StatusTypeDef HAL_DMAEx_DisableMuxRequestGenerator (DMA_HandleTypeDef *hdma); 221 /* -------------------------------------------------------------------------- */ 222 223 /* ------------------------- SYNCHRO -----------------------------------------*/ 224 HAL_StatusTypeDef HAL_DMAEx_ConfigMuxSync(DMA_HandleTypeDef *hdma, HAL_DMA_MuxSyncConfigTypeDef *pSyncConfig); 225 /* -------------------------------------------------------------------------- */ 226 227 void HAL_DMAEx_MUX_IRQHandler(DMA_HandleTypeDef *hdma); 228 229 /** 230 * @} 231 */ 232 233 /** 234 * @} 235 */ 236 237 238 /* Private macros ------------------------------------------------------------*/ 239 /** @defgroup DMAEx_Private_Macros DMAEx Private Macros 240 * @brief DMAEx private macros 241 * @{ 242 */ 243 244 #define IS_DMAMUX_SYNC_SIGNAL_ID(SIGNAL_ID) ((SIGNAL_ID) <= HAL_DMAMUX1_SYNC_LPTIM3_OUT) 245 246 #define IS_DMAMUX_SYNC_REQUEST_NUMBER(REQUEST_NUMBER) (((REQUEST_NUMBER) > 0U) && ((REQUEST_NUMBER) <= 32U)) 247 248 #define IS_DMAMUX_SYNC_POLARITY(POLARITY) (((POLARITY) == HAL_DMAMUX_SYNC_NO_EVENT) || \ 249 ((POLARITY) == HAL_DMAMUX_SYNC_RISING) || \ 250 ((POLARITY) == HAL_DMAMUX_SYNC_FALLING) || \ 251 ((POLARITY) == HAL_DMAMUX_SYNC_RISING_FALLING)) 252 253 #define IS_DMAMUX_SYNC_STATE(SYNC) (((SYNC) == DISABLE) || ((SYNC) == ENABLE)) 254 255 #define IS_DMAMUX_SYNC_EVENT(EVENT) (((EVENT) == DISABLE) || \ 256 ((EVENT) == ENABLE)) 257 258 #define IS_DMAMUX_REQUEST_GEN_SIGNAL_ID(SIGNAL_ID) ((SIGNAL_ID) <= HAL_DMAMUX1_REQ_GEN_LPTIM3_OUT) 259 260 #define IS_DMAMUX_REQUEST_GEN_REQUEST_NUMBER(REQUEST_NUMBER) (((REQUEST_NUMBER) > 0U) && ((REQUEST_NUMBER) <= 32U)) 261 262 #define IS_DMAMUX_REQUEST_GEN_POLARITY(POLARITY) (((POLARITY) == HAL_DMAMUX_REQ_GEN_NO_EVENT) || \ 263 ((POLARITY) == HAL_DMAMUX_REQ_GEN_RISING) || \ 264 ((POLARITY) == HAL_DMAMUX_REQ_GEN_FALLING) || \ 265 ((POLARITY) == HAL_DMAMUX_REQ_GEN_RISING_FALLING)) 266 267 /** 268 * @} 269 */ 270 271 272 /** 273 * @} 274 */ 275 276 /** 277 * @} 278 */ 279 280 #ifdef __cplusplus 281 } 282 #endif 283 284 #endif /* STM32L5xx_HAL_DMA_EX_H */ 285 286 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 287
