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