STM32L443xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32l4xx_hal_dma_ex.h 00004 * @author MCD Application Team 00005 * @brief Header file of DMA HAL extension module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * Copyright (c) 2017 STMicroelectronics. 00010 * All rights reserved. 00011 * 00012 * This software is licensed under terms that can be found in the LICENSE file 00013 * in the root directory of this software component. 00014 * If no LICENSE file comes with this software, it is provided AS-IS. 00015 * 00016 ****************************************************************************** 00017 */ 00018 00019 /* Define to prevent recursive inclusion -------------------------------------*/ 00020 #ifndef STM32L4xx_HAL_DMA_EX_H 00021 #define STM32L4xx_HAL_DMA_EX_H 00022 00023 #ifdef __cplusplus 00024 extern "C" { 00025 #endif 00026 00027 #if defined(DMAMUX1) 00028 00029 /* Includes ------------------------------------------------------------------*/ 00030 #include "stm32l4xx_hal_def.h" 00031 00032 /** @addtogroup STM32L4xx_HAL_Driver 00033 * @{ 00034 */ 00035 00036 /** @addtogroup DMAEx 00037 * @{ 00038 */ 00039 00040 /* Exported types ------------------------------------------------------------*/ 00041 /** @defgroup DMAEx_Exported_Types DMAEx Exported Types 00042 * @{ 00043 */ 00044 00045 /** 00046 * @brief HAL DMA Synchro definition 00047 */ 00048 00049 00050 /** 00051 * @brief HAL DMAMUX Synchronization configuration structure definition 00052 */ 00053 typedef struct 00054 { 00055 uint32_t SyncSignalID; /*!< Specifies the synchronization signal gating the DMA request in periodic mode. 00056 This parameter can be a value of @ref DMAEx_DMAMUX_SyncSignalID_selection */ 00057 00058 uint32_t SyncPolarity; /*!< Specifies the polarity of the signal on which the DMA request is synchronized. 00059 This parameter can be a value of @ref DMAEx_DMAMUX_SyncPolarity_selection */ 00060 00061 FunctionalState SyncEnable; /*!< Specifies if the synchronization shall be enabled or disabled 00062 This parameter can take the value ENABLE or DISABLE*/ 00063 00064 00065 FunctionalState EventEnable; /*!< Specifies if an event shall be generated once the RequestNumber is reached. 00066 This parameter can take the value ENABLE or DISABLE */ 00067 00068 uint32_t RequestNumber; /*!< Specifies the number of DMA request that will be authorized after a sync event 00069 This parameter must be a number between Min_Data = 1 and Max_Data = 32 */ 00070 00071 00072 }HAL_DMA_MuxSyncConfigTypeDef; 00073 00074 00075 /** 00076 * @brief HAL DMAMUX request generator parameters structure definition 00077 */ 00078 typedef struct 00079 { 00080 uint32_t SignalID; /*!< Specifies the ID of the signal used for DMAMUX request generator 00081 This parameter can be a value of @ref DMAEx_DMAMUX_SignalGeneratorID_selection */ 00082 00083 uint32_t Polarity; /*!< Specifies the polarity of the signal on which the request is generated. 00084 This parameter can be a value of @ref DMAEx_DMAMUX_RequestGeneneratorPolarity_selection */ 00085 00086 uint32_t RequestNumber; /*!< Specifies the number of DMA request that will be generated after a signal event 00087 This parameter must be a number between Min_Data = 1 and Max_Data = 32 */ 00088 00089 }HAL_DMA_MuxRequestGeneratorConfigTypeDef; 00090 00091 /** 00092 * @} 00093 */ 00094 00095 /* Exported constants --------------------------------------------------------*/ 00096 /** @defgroup DMAEx_Exported_Constants DMAEx Exported Constants 00097 * @{ 00098 */ 00099 00100 /** @defgroup DMAEx_DMAMUX_SyncSignalID_selection DMAMUX SyncSignalID selection 00101 * @{ 00102 */ 00103 #define HAL_DMAMUX1_SYNC_EXTI0 0U /*!< Synchronization Signal is EXTI0 IT */ 00104 #define HAL_DMAMUX1_SYNC_EXTI1 1U /*!< Synchronization Signal is EXTI1 IT */ 00105 #define HAL_DMAMUX1_SYNC_EXTI2 2U /*!< Synchronization Signal is EXTI2 IT */ 00106 #define HAL_DMAMUX1_SYNC_EXTI3 3U /*!< Synchronization Signal is EXTI3 IT */ 00107 #define HAL_DMAMUX1_SYNC_EXTI4 4U /*!< Synchronization Signal is EXTI4 IT */ 00108 #define HAL_DMAMUX1_SYNC_EXTI5 5U /*!< Synchronization Signal is EXTI5 IT */ 00109 #define HAL_DMAMUX1_SYNC_EXTI6 6U /*!< Synchronization Signal is EXTI6 IT */ 00110 #define HAL_DMAMUX1_SYNC_EXTI7 7U /*!< Synchronization Signal is EXTI7 IT */ 00111 #define HAL_DMAMUX1_SYNC_EXTI8 8U /*!< Synchronization Signal is EXTI8 IT */ 00112 #define HAL_DMAMUX1_SYNC_EXTI9 9U /*!< Synchronization Signal is EXTI9 IT */ 00113 #define HAL_DMAMUX1_SYNC_EXTI10 10U /*!< Synchronization Signal is EXTI10 IT */ 00114 #define HAL_DMAMUX1_SYNC_EXTI11 11U /*!< Synchronization Signal is EXTI11 IT */ 00115 #define HAL_DMAMUX1_SYNC_EXTI12 12U /*!< Synchronization Signal is EXTI12 IT */ 00116 #define HAL_DMAMUX1_SYNC_EXTI13 13U /*!< Synchronization Signal is EXTI13 IT */ 00117 #define HAL_DMAMUX1_SYNC_EXTI14 14U /*!< Synchronization Signal is EXTI14 IT */ 00118 #define HAL_DMAMUX1_SYNC_EXTI15 15U /*!< Synchronization Signal is EXTI15 IT */ 00119 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH0_EVT 16U /*!< Synchronization Signal is DMAMUX1 Channel0 Event */ 00120 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH1_EVT 17U /*!< Synchronization Signal is DMAMUX1 Channel1 Event */ 00121 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH2_EVT 18U /*!< Synchronization Signal is DMAMUX1 Channel2 Event */ 00122 #define HAL_DMAMUX1_SYNC_DMAMUX1_CH3_EVT 19U /*!< Synchronization Signal is DMAMUX1 Channel3 Event */ 00123 #define HAL_DMAMUX1_SYNC_LPTIM1_OUT 20U /*!< Synchronization Signal is LPTIM1 OUT */ 00124 #define HAL_DMAMUX1_SYNC_LPTIM2_OUT 21U /*!< Synchronization Signal is LPTIM2 OUT */ 00125 #if defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined (STM32L4S9xx) 00126 #define HAL_DMAMUX1_SYNC_DSI_TE 22U /*!< Synchronization Signal is DSI Tearing Effect */ 00127 #define HAL_DMAMUX1_SYNC_DSI_EOT 23U /*!< Synchronization Signal is DSI End of refresh */ 00128 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */ 00129 #define HAL_DMAMUX1_SYNC_DMA2D_EOT 24U /*!< Synchronization Signal is DMA2D End of Transfer */ 00130 #define HAL_DMAMUX1_SYNC_LDTC_IT 25U /*!< Synchronization Signal is LDTC IT */ 00131 00132 /** 00133 * @} 00134 */ 00135 00136 /** @defgroup DMAEx_DMAMUX_SyncPolarity_selection DMAMUX SyncPolarity selection 00137 * @{ 00138 */ 00139 #define HAL_DMAMUX_SYNC_NO_EVENT 0U /*!< block synchronization events */ 00140 #define HAL_DMAMUX_SYNC_RISING DMAMUX_CxCR_SPOL_0 /*!< synchronize with rising edge events */ 00141 #define HAL_DMAMUX_SYNC_FALLING DMAMUX_CxCR_SPOL_1 /*!< synchronize with falling edge events */ 00142 #define HAL_DMAMUX_SYNC_RISING_FALLING DMAMUX_CxCR_SPOL /*!< synchronize with rising and falling edge events */ 00143 00144 /** 00145 * @} 00146 */ 00147 00148 /** @defgroup DMAEx_DMAMUX_SignalGeneratorID_selection DMAMUX SignalGeneratorID selection 00149 * @{ 00150 */ 00151 00152 #define HAL_DMAMUX1_REQ_GEN_EXTI0 0U /*!< Request generator Signal is EXTI0 IT */ 00153 #define HAL_DMAMUX1_REQ_GEN_EXTI1 1U /*!< Request generator Signal is EXTI1 IT */ 00154 #define HAL_DMAMUX1_REQ_GEN_EXTI2 2U /*!< Request generator Signal is EXTI2 IT */ 00155 #define HAL_DMAMUX1_REQ_GEN_EXTI3 3U /*!< Request generator Signal is EXTI3 IT */ 00156 #define HAL_DMAMUX1_REQ_GEN_EXTI4 4U /*!< Request generator Signal is EXTI4 IT */ 00157 #define HAL_DMAMUX1_REQ_GEN_EXTI5 5U /*!< Request generator Signal is EXTI5 IT */ 00158 #define HAL_DMAMUX1_REQ_GEN_EXTI6 6U /*!< Request generator Signal is EXTI6 IT */ 00159 #define HAL_DMAMUX1_REQ_GEN_EXTI7 7U /*!< Request generator Signal is EXTI7 IT */ 00160 #define HAL_DMAMUX1_REQ_GEN_EXTI8 8U /*!< Request generator Signal is EXTI8 IT */ 00161 #define HAL_DMAMUX1_REQ_GEN_EXTI9 9U /*!< Request generator Signal is EXTI9 IT */ 00162 #define HAL_DMAMUX1_REQ_GEN_EXTI10 10U /*!< Request generator Signal is EXTI10 IT */ 00163 #define HAL_DMAMUX1_REQ_GEN_EXTI11 11U /*!< Request generator Signal is EXTI11 IT */ 00164 #define HAL_DMAMUX1_REQ_GEN_EXTI12 12U /*!< Request generator Signal is EXTI12 IT */ 00165 #define HAL_DMAMUX1_REQ_GEN_EXTI13 13U /*!< Request generator Signal is EXTI13 IT */ 00166 #define HAL_DMAMUX1_REQ_GEN_EXTI14 14U /*!< Request generator Signal is EXTI14 IT */ 00167 #define HAL_DMAMUX1_REQ_GEN_EXTI15 15U /*!< Request generator Signal is EXTI15 IT */ 00168 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH0_EVT 16U /*!< Request generator Signal is DMAMUX1 Channel0 Event */ 00169 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH1_EVT 17U /*!< Request generator Signal is DMAMUX1 Channel1 Event */ 00170 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH2_EVT 18U /*!< Request generator Signal is DMAMUX1 Channel2 Event */ 00171 #define HAL_DMAMUX1_REQ_GEN_DMAMUX1_CH3_EVT 19U /*!< Request generator Signal is DMAMUX1 Channel3 Event */ 00172 #define HAL_DMAMUX1_REQ_GEN_LPTIM1_OUT 20U /*!< Request generator Signal is LPTIM1 OUT */ 00173 #define HAL_DMAMUX1_REQ_GEN_LPTIM2_OUT 21U /*!< Request generator Signal is LPTIM2 OUT */ 00174 #if defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined (STM32L4S9xx) 00175 #define HAL_DMAMUX1_REQ_GEN_DSI_TE 22U /*!< Request generator Signal is DSI Tearing Effect */ 00176 #define HAL_DMAMUX1_REQ_GEN_DSI_EOT 23U /*!< Request generator Signal is DSI End of refresh */ 00177 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */ 00178 #define HAL_DMAMUX1_REQ_GEN_DMA2D_EOT 24U /*!< Request generator Signal is DMA2D End of Transfer */ 00179 #define HAL_DMAMUX1_REQ_GEN_LTDC_IT 25U /*!< Request generator Signal is LTDC IT */ 00180 00181 /** 00182 * @} 00183 */ 00184 00185 /** @defgroup DMAEx_DMAMUX_RequestGeneneratorPolarity_selection DMAMUX RequestGeneneratorPolarity selection 00186 * @{ 00187 */ 00188 #define HAL_DMAMUX_REQ_GEN_NO_EVENT 0U /*!< block request generator events */ 00189 #define HAL_DMAMUX_REQ_GEN_RISING DMAMUX_RGxCR_GPOL_0 /*!< generate request on rising edge events */ 00190 #define HAL_DMAMUX_REQ_GEN_FALLING DMAMUX_RGxCR_GPOL_1 /*!< generate request on falling edge events */ 00191 #define HAL_DMAMUX_REQ_GEN_RISING_FALLING DMAMUX_RGxCR_GPOL /*!< generate request on rising and falling edge events */ 00192 00193 /** 00194 * @} 00195 */ 00196 00197 /** 00198 * @} 00199 */ 00200 00201 /* Exported macro ------------------------------------------------------------*/ 00202 00203 /* Exported functions --------------------------------------------------------*/ 00204 /** @addtogroup DMAEx_Exported_Functions 00205 * @{ 00206 */ 00207 00208 /* IO operation functions *****************************************************/ 00209 /** @addtogroup DMAEx_Exported_Functions_Group1 00210 * @{ 00211 */ 00212 00213 /* ------------------------- REQUEST -----------------------------------------*/ 00214 HAL_StatusTypeDef HAL_DMAEx_ConfigMuxRequestGenerator (DMA_HandleTypeDef *hdma, 00215 HAL_DMA_MuxRequestGeneratorConfigTypeDef *pRequestGeneratorConfig); 00216 HAL_StatusTypeDef HAL_DMAEx_EnableMuxRequestGenerator (DMA_HandleTypeDef *hdma); 00217 HAL_StatusTypeDef HAL_DMAEx_DisableMuxRequestGenerator (DMA_HandleTypeDef *hdma); 00218 /* -------------------------------------------------------------------------- */ 00219 00220 /* ------------------------- SYNCHRO -----------------------------------------*/ 00221 HAL_StatusTypeDef HAL_DMAEx_ConfigMuxSync(DMA_HandleTypeDef *hdma, HAL_DMA_MuxSyncConfigTypeDef *pSyncConfig); 00222 /* -------------------------------------------------------------------------- */ 00223 00224 void HAL_DMAEx_MUX_IRQHandler(DMA_HandleTypeDef *hdma); 00225 00226 /** 00227 * @} 00228 */ 00229 00230 /** 00231 * @} 00232 */ 00233 00234 00235 /* Private defines -----------------------------------------------------------*/ 00236 /* Private macros ------------------------------------------------------------*/ 00237 /** @defgroup DMAEx_Private_Macros DMAEx Private Macros 00238 * @brief DMAEx private macros 00239 * @{ 00240 */ 00241 00242 #define IS_DMAMUX_SYNC_SIGNAL_ID(SIGNAL_ID) ((SIGNAL_ID) <= HAL_DMAMUX1_SYNC_LDTC_IT) 00243 00244 #define IS_DMAMUX_SYNC_REQUEST_NUMBER(REQUEST_NUMBER) (((REQUEST_NUMBER) > 0U) && ((REQUEST_NUMBER) <= 32U)) 00245 00246 #define IS_DMAMUX_SYNC_POLARITY(POLARITY) (((POLARITY) == HAL_DMAMUX_SYNC_NO_EVENT) || \ 00247 ((POLARITY) == HAL_DMAMUX_SYNC_RISING) || \ 00248 ((POLARITY) == HAL_DMAMUX_SYNC_FALLING) || \ 00249 ((POLARITY) == HAL_DMAMUX_SYNC_RISING_FALLING)) 00250 00251 #define IS_DMAMUX_SYNC_STATE(SYNC) (((SYNC) == DISABLE) || ((SYNC) == ENABLE)) 00252 00253 #define IS_DMAMUX_SYNC_EVENT(EVENT) (((EVENT) == DISABLE) || \ 00254 ((EVENT) == ENABLE)) 00255 00256 #define IS_DMAMUX_REQUEST_GEN_SIGNAL_ID(SIGNAL_ID) ((SIGNAL_ID) <= HAL_DMAMUX1_REQ_GEN_LTDC_IT) 00257 00258 #define IS_DMAMUX_REQUEST_GEN_REQUEST_NUMBER(REQUEST_NUMBER) (((REQUEST_NUMBER) > 0U) && ((REQUEST_NUMBER) <= 32U)) 00259 00260 #define IS_DMAMUX_REQUEST_GEN_POLARITY(POLARITY) (((POLARITY) == HAL_DMAMUX_REQ_GEN_NO_EVENT) || \ 00261 ((POLARITY) == HAL_DMAMUX_REQ_GEN_RISING) || \ 00262 ((POLARITY) == HAL_DMAMUX_REQ_GEN_FALLING) || \ 00263 ((POLARITY) == HAL_DMAMUX_REQ_GEN_RISING_FALLING)) 00264 00265 /** 00266 * @} 00267 */ 00268 00269 00270 /** 00271 * @} 00272 */ 00273 00274 /** 00275 * @} 00276 */ 00277 00278 #endif /* DMAMUX1 */ 00279 00280 #ifdef __cplusplus 00281 } 00282 #endif 00283 00284 #endif /* STM32L4xx_HAL_DMA_H */