/* ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ /** * @file DMAv1/stm32_dma.c * @brief DMA helper driver code. * * @addtogroup STM32_DMA * @details DMA sharing helper driver. In the STM32 the DMA streams are a * shared resource, this driver allows to allocate and free DMA * streams at runtime in order to allow all the other device * drivers to coordinate the access to the resource. * @note The DMA ISR handlers are all declared into this module because * sharing, the various device drivers can associate a callback to * ISRs when allocating streams. * @{ */ #include "hal.h" /* The following macro is only defined if some driver requiring DMA services has been enabled.*/ #if defined(STM32_DMA_REQUIRED) || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver local definitions. */ /*===========================================================================*/ /** * @brief Mask of the DMA1 streams in @p dma_streams_mask. */ #define STM32_DMA1_STREAMS_MASK ((1U << STM32_DMA1_NUM_CHANNELS) - 1U) /** * @brief Mask of the DMA2 streams in @p dma_streams_mask. */ #define STM32_DMA2_STREAMS_MASK (((1U << STM32_DMA2_NUM_CHANNELS) - \ 1U) << STM32_DMA1_NUM_CHANNELS) #if STM32_DMA_SUPPORTS_CSELR == TRUE #if defined(DMA1_CSELR) #define DMA1_VARIANT &DMA1_CSELR->CSELR #else #define DMA1_VARIANT &DMA1->CSELR #endif #if defined(DMA2_CSELR) #define DMA2_VARIANT &DMA2_CSELR->CSELR #else #define DMA2_VARIANT &DMA2->CSELR #endif #define DMA1_CH1_VARIANT DMA1_VARIANT #define DMA1_CH2_VARIANT DMA1_VARIANT #define DMA1_CH3_VARIANT DMA1_VARIANT #define DMA1_CH4_VARIANT DMA1_VARIANT #define DMA1_CH5_VARIANT DMA1_VARIANT #define DMA1_CH6_VARIANT DMA1_VARIANT #define DMA1_CH7_VARIANT DMA1_VARIANT #define DMA2_CH1_VARIANT DMA2_VARIANT #define DMA2_CH2_VARIANT DMA2_VARIANT #define DMA2_CH3_VARIANT DMA2_VARIANT #define DMA2_CH4_VARIANT DMA2_VARIANT #define DMA2_CH5_VARIANT DMA2_VARIANT #define DMA2_CH6_VARIANT DMA2_VARIANT #define DMA2_CH7_VARIANT DMA2_VARIANT #elif STM32_DMA_SUPPORTS_DMAMUX == TRUE #define DMA1_CH1_VARIANT DMAMUX1_Channel0 #define DMA1_CH2_VARIANT DMAMUX1_Channel1 #define DMA1_CH3_VARIANT DMAMUX1_Channel2 #define DMA1_CH4_VARIANT DMAMUX1_Channel3 #define DMA1_CH5_VARIANT DMAMUX1_Channel4 #define DMA1_CH6_VARIANT DMAMUX1_Channel5 #define DMA1_CH7_VARIANT DMAMUX1_Channel6 #define DMA2_CH1_VARIANT DMAMUX1_Channel7 #define DMA2_CH2_VARIANT DMAMUX1_Channel8 #define DMA2_CH3_VARIANT DMAMUX1_Channel9 #define DMA2_CH4_VARIANT DMAMUX1_Channel10 #define DMA2_CH5_VARIANT DMAMUX1_Channel11 #define DMA2_CH6_VARIANT DMAMUX1_Channel12 #define DMA2_CH7_VARIANT DMAMUX1_Channel13 #else /* !(STM32_DMA_SUPPORTS_DMAMUX == TRUE) */ #define DMA1_CH1_VARIANT 0 #define DMA1_CH2_VARIANT 0 #define DMA1_CH3_VARIANT 0 #define DMA1_CH4_VARIANT 0 #define DMA1_CH5_VARIANT 0 #define DMA1_CH6_VARIANT 0 #define DMA1_CH7_VARIANT 0 #define DMA2_CH1_VARIANT 0 #define DMA2_CH2_VARIANT 0 #define DMA2_CH3_VARIANT 0 #define DMA2_CH4_VARIANT 0 #define DMA2_CH5_VARIANT 0 #define DMA2_CH6_VARIANT 0 #define DMA2_CH7_VARIANT 0 #endif /* !(STM32_DMA_SUPPORTS_DMAMUX == TRUE) */ /* * Default ISR collision masks. */ #if !defined(DMA1_CH1_CMASK) #define DMA1_CH1_CMASK 0x00000001U #endif #if !defined(DMA1_CH2_CMASK) #define DMA1_CH2_CMASK 0x00000002U #endif #if !defined(DMA1_CH3_CMASK) #define DMA1_CH3_CMASK 0x00000004U #endif #if !defined(DMA1_CH4_CMASK) #define DMA1_CH4_CMASK 0x00000008U #endif #if !defined(DMA1_CH5_CMASK) #define DMA1_CH5_CMASK 0x00000010U #endif #if !defined(DMA1_CH6_CMASK) #define DMA1_CH6_CMASK 0x00000020U #endif #if !defined(DMA1_CH7_CMASK) #define DMA1_CH7_CMASK 0x00000040U #endif #if !defined(DMA2_CH1_CMASK) #define DMA2_CH1_CMASK 0x00000080U #endif #if !defined(DMA2_CH2_CMASK) #define DMA2_CH2_CMASK 0x00000100U #endif #if !defined(DMA2_CH3_CMASK) #define DMA2_CH3_CMASK 0x00000200U #endif #if !defined(DMA2_CH4_CMASK) #define DMA2_CH4_CMASK 0x00000400U #endif #if !defined(DMA2_CH5_CMASK) #define DMA2_CH5_CMASK 0x00000800U #endif #if !defined(DMA2_CH6_CMASK) #define DMA2_CH6_CMASK 0x00001000U #endif #if !defined(DMA2_CH7_CMASK) #define DMA2_CH7_CMASK 0x00002000U #endif /*===========================================================================*/ /* Driver exported variables. */ /*===========================================================================*/ /** * @brief DMA streams descriptors. * @details This table keeps the association between an unique stream * identifier and the involved physical registers. * @note Don't use this array directly, use the appropriate wrapper macros * instead: @p STM32_DMA1_STREAM1, @p STM32_DMA1_STREAM2 etc. */ const stm32_dma_stream_t _stm32_dma_streams[STM32_DMA_STREAMS] = { {DMA1, DMA1_Channel1, DMA1_CH1_CMASK, DMA1_CH1_VARIANT, 0, 0, STM32_DMA1_CH1_NUMBER}, {DMA1, DMA1_Channel2, DMA1_CH2_CMASK, DMA1_CH2_VARIANT, 4, 1, STM32_DMA1_CH2_NUMBER}, {DMA1, DMA1_Channel3, DMA1_CH3_CMASK, DMA1_CH3_VARIANT, 8, 2, STM32_DMA1_CH3_NUMBER}, {DMA1, DMA1_Channel4, DMA1_CH4_CMASK, DMA1_CH4_VARIANT, 12, 3, STM32_DMA1_CH4_NUMBER}, {DMA1, DMA1_Channel5, DMA1_CH5_CMASK, DMA1_CH5_VARIANT, 16, 4, STM32_DMA1_CH5_NUMBER}, #if STM32_DMA1_NUM_CHANNELS > 5 {DMA1, DMA1_Channel6, DMA1_CH6_CMASK, DMA1_CH6_VARIANT, 20, 5, STM32_DMA1_CH6_NUMBER}, #if STM32_DMA1_NUM_CHANNELS > 6 {DMA1, DMA1_Channel7, DMA1_CH7_CMASK, DMA1_CH7_VARIANT, 24, 6, STM32_DMA1_CH7_NUMBER}, #if STM32_DMA2_NUM_CHANNELS > 0 {DMA2, DMA2_Channel1, DMA2_CH1_CMASK, DMA2_CH1_VARIANT, 0, 7, STM32_DMA2_CH1_NUMBER}, {DMA2, DMA2_Channel2, DMA2_CH2_CMASK, DMA2_CH2_VARIANT, 4, 8, STM32_DMA2_CH2_NUMBER}, {DMA2, DMA2_Channel3, DMA2_CH3_CMASK, DMA2_CH3_VARIANT, 8, 9, STM32_DMA2_CH3_NUMBER}, {DMA2, DMA2_Channel4, DMA2_CH4_CMASK, DMA2_CH4_VARIANT, 12, 10, STM32_DMA2_CH4_NUMBER}, {DMA2, DMA2_Channel5, DMA2_CH5_CMASK, DMA2_CH5_VARIANT, 16, 11, STM32_DMA2_CH5_NUMBER}, #if STM32_DMA2_NUM_CHANNELS > 5 {DMA2, DMA2_Channel6, DMA2_CH6_CMASK, DMA2_CH6_VARIANT, 20, 12, STM32_DMA2_CH6_NUMBER}, #if STM32_DMA2_NUM_CHANNELS > 6 {DMA2, DMA2_Channel7, DMA2_CH7_CMASK, DMA2_CH7_VARIANT, 24, 13, STM32_DMA2_CH7_NUMBER}, #endif #endif #endif #endif #endif }; /*===========================================================================*/ /* Driver local variables and types. */ /*===========================================================================*/ /** * @brief Global DMA-related data structures. */ static struct { /** * @brief Mask of the allocated streams. */ uint32_t allocated_mask; /** * @brief Mask of the enabled streams ISRs. */ uint32_t isr_mask; /** * @brief DMA IRQ redirectors. */ struct { /** * @brief DMA callback function. */ stm32_dmaisr_t func; /** * @brief DMA callback parameter. */ void *param; } streams[STM32_DMA_STREAMS]; } dma; /*===========================================================================*/ /* Driver local functions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver interrupt handlers. */ /*===========================================================================*/ #if defined(STM32_DMA1_CH1_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 1 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH1_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM1); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH2_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 2 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH2_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM2); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH3_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 3 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH3_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM3); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH4_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 4 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH4_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM4); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH5_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 5 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH5_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM5); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH6_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 6 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH6_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM6); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA1_CH7_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA1 stream 7 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA1_CH7_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA1_STREAM7); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH1_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 1 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH1_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM1); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH2_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 2 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH2_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM2); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH3_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 3 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH3_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM3); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH4_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 4 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH4_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM4); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH5_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 5 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH5_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM5); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH6_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 6 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH6_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM6); OSAL_IRQ_EPILOGUE(); } #endif #if defined(STM32_DMA2_CH7_HANDLER) || defined(__DOXYGEN__) /** * @brief DMA2 stream 7 shared ISR. * * @isr */ OSAL_IRQ_HANDLER(STM32_DMA2_CH7_HANDLER) { OSAL_IRQ_PROLOGUE(); dmaServeInterrupt(STM32_DMA2_STREAM7); OSAL_IRQ_EPILOGUE(); } #endif /*===========================================================================*/ /* Driver exported functions. */ /*===========================================================================*/ /** * @brief STM32 DMA helper initialization. * * @init */ void dmaInit(void) { int i; dma.allocated_mask = 0U; dma.isr_mask = 0U; for (i = 0; i < STM32_DMA_STREAMS; i++) { _stm32_dma_streams[i].channel->CCR = STM32_DMA_CCR_RESET_VALUE; dma.streams[i].func = NULL; } DMA1->IFCR = 0xFFFFFFFFU; #if STM32_DMA2_NUM_CHANNELS > 0 DMA2->IFCR = 0xFFFFFFFFU; #endif } /** * @brief Allocates a DMA stream. * @details The stream is allocated and, if required, the DMA clock enabled. * The function also enables the IRQ vector associated to the stream * and initializes its priority. * * @param[in] id numeric identifiers of a specific stream or: * - @p STM32_DMA_STREAM_ID_ANY for any stream. * - @p STM32_DMA_STREAM_ID_ANY_DMA1 for any stream * on DMA1. * - @p STM32_DMA_STREAM_ID_ANY_DMA2 for any stream * on DMA2. * . * @param[in] priority IRQ priority for the DMA stream * @param[in] func handling function pointer, can be @p NULL * @param[in] param a parameter to be passed to the handling function * @return Pointer to the allocated @p stm32_dma_stream_t * structure. * @retval NULL if a/the stream is not available. * * @iclass */ const stm32_dma_stream_t *dmaStreamAllocI(uint32_t id, uint32_t priority, stm32_dmaisr_t func, void *param) { uint32_t i, startid, endid; osalDbgCheckClassI(); if (id < STM32_DMA_STREAMS) { startid = id; endid = id; } #if STM32_DMA_SUPPORTS_DMAMUX == TRUE else if (id == STM32_DMA_STREAM_ID_ANY) { startid = 0U; endid = STM32_DMA_STREAMS - 1U; } else if (id == STM32_DMA_STREAM_ID_ANY_DMA1) { startid = 0U; endid = STM32_DMA1_NUM_CHANNELS - 1U; } #if STM32_DMA2_NUM_CHANNELS > 0 else if (id == STM32_DMA_STREAM_ID_ANY_DMA2) { startid = 7U; endid = STM32_DMA_STREAMS - 1U; } #endif #endif else { osalDbgCheck(false); } for (i = startid; i <= endid; i++) { uint32_t mask = (1U << i); if ((dma.allocated_mask & mask) == 0U) { const stm32_dma_stream_t *dmastp = STM32_DMA_STREAM(i); /* Installs the DMA handler.*/ dma.streams[i].func = func; dma.streams[i].param = param; dma.allocated_mask |= mask; /* Enabling DMA clocks required by the current streams set.*/ if ((STM32_DMA1_STREAMS_MASK & mask) != 0U) { rccEnableDMA1(true); } #if STM32_DMA2_NUM_CHANNELS > 0 if ((STM32_DMA2_STREAMS_MASK & mask) != 0U) { rccEnableDMA2(true); } #endif #if (STM32_DMA_SUPPORTS_DMAMUX == TRUE) && defined(rccEnableDMAMUX) /* Enabling DMAMUX if present.*/ if (dma.allocated_mask != 0U) { rccEnableDMAMUX(true); } #endif /* Enables the associated IRQ vector if not already enabled and if a callback is defined.*/ if (func != NULL) { if ((dma.isr_mask & dmastp->cmask) == 0U) { nvicEnableVector(dmastp->vector, priority); } dma.isr_mask |= mask; } /* Putting the stream in a known state.*/ dmaStreamDisable(dmastp); dmastp->channel->CCR = STM32_DMA_CCR_RESET_VALUE; return dmastp; } } return NULL; } /** * @brief Allocates a DMA stream. * @details The stream is allocated and, if required, the DMA clock enabled. * The function also enables the IRQ vector associated to the stream * and initializes its priority. * * @param[in] id numeric identifiers of a specific stream or: * - @p STM32_DMA_STREAM_ID_ANY for any stream. * - @p STM32_DMA_STREAM_ID_ANY_DMA1 for any stream * on DMA1. * - @p STM32_DMA_STREAM_ID_ANY_DMA2 for any stream * on DMA2. * . * @param[in] priority IRQ priority for the DMA stream * @param[in] func handling function pointer, can be @p NULL * @param[in] param a parameter to be passed to the handling function * @return Pointer to the allocated @p stm32_dma_stream_t * structure. * @retval NULL if a/the stream is not available. * * @api */ const stm32_dma_stream_t *dmaStreamAlloc(uint32_t id, uint32_t priority, stm32_dmaisr_t func, void *param) { const stm32_dma_stream_t *dmastp; osalSysLock(); dmastp = dmaStreamAllocI(id, priority, func, param); osalSysUnlock(); return dmastp; } /** * @brief Releases a DMA stream. * @details The stream is freed and, if required, the DMA clock disabled. * Trying to release a unallocated stream is an illegal operation * and is trapped if assertions are enabled. * * @param[in] dmastp pointer to a stm32_dma_stream_t structure * * @iclass */ void dmaStreamFreeI(const stm32_dma_stream_t *dmastp) { osalDbgCheck(dmastp != NULL); /* Check if the streams is not taken.*/ osalDbgAssert((dma.allocated_mask & (1 << dmastp->selfindex)) != 0U, "not allocated"); /* Marks the stream as not allocated.*/ dma.allocated_mask &= ~(1U << dmastp->selfindex); dma.isr_mask &= ~(1U << dmastp->selfindex); /* Disables the associated IRQ vector if it is no more in use.*/ if ((dma.allocated_mask & dmastp->cmask) == 0U) { nvicDisableVector(dmastp->vector); } /* Removes the DMA handler.*/ dma.streams[dmastp->selfindex].func = NULL; dma.streams[dmastp->selfindex].param = NULL; /* Shutting down clocks that are no more required, if any.*/ if ((dma.allocated_mask & STM32_DMA1_STREAMS_MASK) == 0U) { rccDisableDMA1(); } #if STM32_DMA2_NUM_CHANNELS > 0 if ((dma.allocated_mask & STM32_DMA2_STREAMS_MASK) == 0U) { rccDisableDMA2(); } #endif #if (STM32_DMA_SUPPORTS_DMAMUX == TRUE) && defined(rccDisableDMAMUX) /* Shutting down DMAMUX if present.*/ if (dma.allocated_mask == 0U) { rccDisableDMAMUX(); } #endif } /** * @brief Releases a DMA stream. * @details The stream is freed and, if required, the DMA clock disabled. * Trying to release a unallocated stream is an illegal operation * and is trapped if assertions are enabled. * * @param[in] dmastp pointer to a stm32_dma_stream_t structure * * @api */ void dmaStreamFree(const stm32_dma_stream_t *dmastp) { osalSysLock(); dmaStreamFreeI(dmastp); osalSysUnlock(); } /** * @brief Serves a DMA IRQ. * * @param[in] dmastp pointer to a stm32_dma_stream_t structure * * @special */ void dmaServeInterrupt(const stm32_dma_stream_t *dmastp) { uint32_t flags; uint32_t idx = (dmastp)->selfindex; flags = (dmastp->dma->ISR >> dmastp->shift) & STM32_DMA_ISR_MASK; if (flags & dmastp->channel->CCR) { dmastp->dma->IFCR = flags << dmastp->shift; if (dma.streams[idx].func) { dma.streams[idx].func(dma.streams[idx].param, flags); } } } #if (STM32_DMA_SUPPORTS_DMAMUX == TRUE) || defined(__DOXYGEN__) /** * @brief Associates a peripheral request to a DMA stream. * @note This function can be invoked in both ISR or thread context. * * @param[in] dmastp pointer to a @p stm32_dma_stream_t structure * @param[in] per peripheral identifier * * @special */ void dmaSetRequestSource(const stm32_dma_stream_t *dmastp, uint32_t per) { osalDbgCheck(per < 256U); dmastp->mux->CCR = per; } #endif #endif /* STM32_DMA_REQUIRED */ /** @} */