481 lines
19 KiB
C
481 lines
19 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2015 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.h
|
|
* @brief DMA helper driver header.
|
|
* @note This driver uses the new naming convention used for the STM32F2xx
|
|
* so the "DMA channels" are referred as "DMA streams".
|
|
*
|
|
* @addtogroup STM32_DMA
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _STM32_DMA_H_
|
|
#define _STM32_DMA_H_
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief DMA capability.
|
|
* @details if @p TRUE then the DMA is able of burst transfers, FIFOs,
|
|
* scatter gather and other advanced features.
|
|
*/
|
|
#define STM32_DMA_ADVANCED FALSE
|
|
|
|
/**
|
|
* @brief Total number of DMA streams.
|
|
* @details This is the total number of streams among all the DMA units.
|
|
*/
|
|
#define STM32_DMA_STREAMS (STM32_DMA1_NUM_CHANNELS + \
|
|
STM32_DMA2_NUM_CHANNELS)
|
|
|
|
/**
|
|
* @brief Mask of the ISR bits passed to the DMA callback functions.
|
|
*/
|
|
#define STM32_DMA_ISR_MASK 0x0F
|
|
|
|
/**
|
|
* @brief From stream number to shift factor in @p ISR and @p IFCR registers.
|
|
*/
|
|
#define STM32_DMA_ISR_SHIFT(stream) (((stream) - 1U) * 4U)
|
|
|
|
/**
|
|
* @brief Returns the request line associated to the specified stream.
|
|
* @note In some STM32 manuals the request line is named confusingly
|
|
* channel.
|
|
*
|
|
* @param[in] id the unique numeric stream identifier
|
|
* @param[in] c a stream/request association word, one request per
|
|
* nibble
|
|
* @return Returns the request associated to the stream.
|
|
*/
|
|
#define STM32_DMA_GETCHANNEL(id, c) (((c) >> (((id) % 7U) * 4U)) & 15U)
|
|
|
|
/**
|
|
* @brief Checks if a DMA priority is within the valid range.
|
|
* @param[in] prio DMA priority
|
|
*
|
|
* @retval The check result.
|
|
* @retval false invalid DMA priority.
|
|
* @retval true correct DMA priority.
|
|
*/
|
|
#define STM32_DMA_IS_VALID_PRIORITY(prio) (((prio) >= 0U) && ((prio) <= 3U))
|
|
|
|
/**
|
|
* @brief Returns an unique numeric identifier for a DMA stream.
|
|
*
|
|
* @param[in] dma the DMA unit number
|
|
* @param[in] stream the stream number
|
|
* @return An unique numeric stream identifier.
|
|
*/
|
|
#define STM32_DMA_STREAM_ID(dma, stream) ((((dma) - 1U) * 7U) + ((stream) - 1U))
|
|
|
|
/**
|
|
* @brief Returns a DMA stream identifier mask.
|
|
*
|
|
*
|
|
* @param[in] dma the DMA unit number
|
|
* @param[in] stream the stream number
|
|
* @return A DMA stream identifier mask.
|
|
*/
|
|
#define STM32_DMA_STREAM_ID_MSK(dma, stream) \
|
|
(1U << STM32_DMA_STREAM_ID(dma, stream))
|
|
|
|
/**
|
|
* @brief Checks if a DMA stream unique identifier belongs to a mask.
|
|
*
|
|
* @param[in] id the stream numeric identifier
|
|
* @param[in] mask the stream numeric identifiers mask
|
|
*
|
|
* @retval The check result.
|
|
* @retval false id does not belong to the mask.
|
|
* @retval true id belongs to the mask.
|
|
*/
|
|
#define STM32_DMA_IS_VALID_ID(id, mask) (((1U << (id)) & (mask)))
|
|
|
|
/**
|
|
* @name DMA streams identifiers
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Returns a pointer to a stm32_dma_stream_t structure.
|
|
*
|
|
* @param[in] id the stream numeric identifier
|
|
* @return A pointer to the stm32_dma_stream_t constant structure
|
|
* associated to the DMA stream.
|
|
*/
|
|
#define STM32_DMA_STREAM(id) (&_stm32_dma_streams[id])
|
|
|
|
#define STM32_DMA1_STREAM1 STM32_DMA_STREAM(0)
|
|
#define STM32_DMA1_STREAM2 STM32_DMA_STREAM(1)
|
|
#define STM32_DMA1_STREAM3 STM32_DMA_STREAM(2)
|
|
#define STM32_DMA1_STREAM4 STM32_DMA_STREAM(3)
|
|
#define STM32_DMA1_STREAM5 STM32_DMA_STREAM(4)
|
|
#define STM32_DMA1_STREAM6 STM32_DMA_STREAM(5)
|
|
#define STM32_DMA1_STREAM7 STM32_DMA_STREAM(6)
|
|
#define STM32_DMA2_STREAM1 STM32_DMA_STREAM(7)
|
|
#define STM32_DMA2_STREAM2 STM32_DMA_STREAM(8)
|
|
#define STM32_DMA2_STREAM3 STM32_DMA_STREAM(9)
|
|
#define STM32_DMA2_STREAM4 STM32_DMA_STREAM(10)
|
|
#define STM32_DMA2_STREAM5 STM32_DMA_STREAM(11)
|
|
#define STM32_DMA2_STREAM6 STM32_DMA_STREAM(12)
|
|
#define STM32_DMA2_STREAM7 STM32_DMA_STREAM(13)
|
|
/** @} */
|
|
|
|
/**
|
|
* @name CR register constants common to all DMA types
|
|
* @{
|
|
*/
|
|
#define STM32_DMA_CR_EN DMA_CCR_EN
|
|
#define STM32_DMA_CR_TEIE DMA_CCR_TEIE
|
|
#define STM32_DMA_CR_HTIE DMA_CCR_HTIE
|
|
#define STM32_DMA_CR_TCIE DMA_CCR_TCIE
|
|
#define STM32_DMA_CR_DIR_MASK (DMA_CCR_DIR | DMA_CCR_MEM2MEM)
|
|
#define STM32_DMA_CR_DIR_P2M 0U
|
|
#define STM32_DMA_CR_DIR_M2P DMA_CCR_DIR
|
|
#define STM32_DMA_CR_DIR_M2M DMA_CCR_MEM2MEM
|
|
#define STM32_DMA_CR_CIRC DMA_CCR_CIRC
|
|
#define STM32_DMA_CR_PINC DMA_CCR_PINC
|
|
#define STM32_DMA_CR_MINC DMA_CCR_MINC
|
|
#define STM32_DMA_CR_PSIZE_MASK DMA_CCR_PSIZE
|
|
#define STM32_DMA_CR_PSIZE_BYTE 0U
|
|
#define STM32_DMA_CR_PSIZE_HWORD DMA_CCR_PSIZE_0
|
|
#define STM32_DMA_CR_PSIZE_WORD DMA_CCR_PSIZE_1
|
|
#define STM32_DMA_CR_MSIZE_MASK DMA_CCR_MSIZE
|
|
#define STM32_DMA_CR_MSIZE_BYTE 0U
|
|
#define STM32_DMA_CR_MSIZE_HWORD DMA_CCR_MSIZE_0
|
|
#define STM32_DMA_CR_MSIZE_WORD DMA_CCR_MSIZE_1
|
|
#define STM32_DMA_CR_SIZE_MASK (STM32_DMA_CR_PSIZE_MASK | \
|
|
STM32_DMA_CR_MSIZE_MASK)
|
|
#define STM32_DMA_CR_PL_MASK DMA_CCR_PL
|
|
#define STM32_DMA_CR_PL(n) ((n) << 12U)
|
|
/** @} */
|
|
|
|
/**
|
|
* @name Request line selector macro
|
|
* @{
|
|
*/
|
|
#if STM32_DMA_SUPPORTS_CSELR || defined(__DOXYGEN__)
|
|
#define STM32_DMA_CR_CHSEL_MASK (15U << 16U)
|
|
#define STM32_DMA_CR_CHSEL(n) ((n) << 16U)
|
|
#else
|
|
#define STM32_DMA_CR_CHSEL_MASK 0U
|
|
#define STM32_DMA_CR_CHSEL(n) 0U
|
|
#endif
|
|
/** @} */
|
|
|
|
/**
|
|
* @name CR register constants only found in enhanced DMA
|
|
* @{
|
|
*/
|
|
#define STM32_DMA_CR_DMEIE 0U /**< @brief Ignored by normal DMA. */
|
|
/** @} */
|
|
|
|
/**
|
|
* @name Status flags passed to the ISR callbacks
|
|
* @{
|
|
*/
|
|
#define STM32_DMA_ISR_FEIF 0U
|
|
#define STM32_DMA_ISR_DMEIF 0U
|
|
#define STM32_DMA_ISR_TEIF DMA_ISR_TEIF1
|
|
#define STM32_DMA_ISR_HTIF DMA_ISR_HTIF1
|
|
#define STM32_DMA_ISR_TCIF DMA_ISR_TCIF1
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if !defined(STM32_DMA_SUPPORTS_CSELR)
|
|
#error "STM32_DMA_SUPPORTS_CSELR not defined in registry"
|
|
#endif
|
|
|
|
#if !defined(STM32_DMA1_NUM_CHANNELS)
|
|
#error "STM32_DMA1_NUM_CHANNELS not defined in registry"
|
|
#endif
|
|
|
|
#if !defined(STM32_DMA2_NUM_CHANNELS)
|
|
#error "STM32_DMA2_NUM_CHANNELS not defined in registry"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief STM32 DMA stream descriptor structure.
|
|
*/
|
|
typedef struct {
|
|
DMA_TypeDef *dma ; /**< @brief Associated DMA. */
|
|
DMA_Channel_TypeDef *channel; /**< @brief Associated DMA channel. */
|
|
uint32_t cmask; /**< @brief Mask of streams sharing
|
|
the same ISR. */
|
|
volatile uint32_t *cselr; /**< @brief Associated CSELR reg. */
|
|
uint8_t shift; /**< @brief Bit offset in ISR, IFCR
|
|
and CSELR registers. */
|
|
uint8_t selfindex; /**< @brief Index to self in array. */
|
|
uint8_t vector; /**< @brief Associated IRQ vector. */
|
|
} stm32_dma_stream_t;
|
|
|
|
/**
|
|
* @brief STM32 DMA ISR function type.
|
|
*
|
|
* @param[in] p parameter for the registered function
|
|
* @param[in] flags pre-shifted content of the ISR register, the bits
|
|
* are aligned to bit zero
|
|
*/
|
|
typedef void (*stm32_dmaisr_t)(void *p, uint32_t flags);
|
|
|
|
/**
|
|
* @brief DMA ISR redirector type.
|
|
*/
|
|
typedef struct {
|
|
stm32_dmaisr_t dma_func; /**< @brief DMA callback function. */
|
|
void *dma_param; /**< @brief DMA callback parameter. */
|
|
} dma_isr_redir_t;
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Macro Functions
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Associates a peripheral data register to a DMA stream.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @param[in] addr value to be written in the CPAR register
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamSetPeripheral(dmastp, addr) { \
|
|
(dmastp)->channel->CPAR = (uint32_t)(addr); \
|
|
}
|
|
|
|
/**
|
|
* @brief Associates a memory destination to a DMA stream.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @param[in] addr value to be written in the CMAR register
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamSetMemory0(dmastp, addr) { \
|
|
(dmastp)->channel->CMAR = (uint32_t)(addr); \
|
|
}
|
|
|
|
/**
|
|
* @brief Sets the number of transfers to be performed.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @param[in] size value to be written in the CNDTR register
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamSetTransactionSize(dmastp, size) { \
|
|
(dmastp)->channel->CNDTR = (uint32_t)(size); \
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the number of transfers to be performed.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @return The number of transfers to be performed.
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamGetTransactionSize(dmastp) ((size_t)((dmastp)->channel->CNDTR))
|
|
|
|
/**
|
|
* @brief Programs the stream mode settings.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @param[in] mode value to be written in the CCR register
|
|
*
|
|
* @special
|
|
*/
|
|
#if STM32_DMA_SUPPORTS_CSELR || defined(__DOXYGEN__)
|
|
#define dmaStreamSetMode(dmastp, mode) { \
|
|
uint32_t cselr = *(dmastp)->cselr; \
|
|
cselr &= ~(0x0000000FU << (dmastp)->shift); \
|
|
cselr |= (((uint32_t)(mode) >> 16U) << (dmastp)->shift); \
|
|
*(dmastp)->cselr = cselr; \
|
|
(dmastp)->channel->CCR = (uint32_t)(mode); \
|
|
}
|
|
#else
|
|
#define dmaStreamSetMode(dmastp, mode) { \
|
|
(dmastp)->channel->CCR = (uint32_t)(mode); \
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @brief DMA stream enable.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamEnable(dmastp) { \
|
|
(dmastp)->channel->CCR |= STM32_DMA_CR_EN; \
|
|
}
|
|
|
|
/**
|
|
* @brief DMA stream disable.
|
|
* @details The function disables the specified stream and then clears any
|
|
* pending interrupt.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @note Interrupts enabling flags are set to zero after this call, see
|
|
* bug 3607518.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamDisable(dmastp) { \
|
|
(dmastp)->channel->CCR &= ~(STM32_DMA_CR_TCIE | STM32_DMA_CR_HTIE | \
|
|
STM32_DMA_CR_TEIE | STM32_DMA_CR_EN); \
|
|
dmaStreamClearInterrupt(dmastp); \
|
|
}
|
|
|
|
/**
|
|
* @brief DMA stream interrupt sources clear.
|
|
* @note This function can be invoked in both ISR or thread context.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
*
|
|
* @special
|
|
*/
|
|
#define dmaStreamClearInterrupt(dmastp) { \
|
|
(dmastp)->dma->IFCR = STM32_DMA_ISR_MASK << (dmastp)->shift; \
|
|
}
|
|
|
|
/**
|
|
* @brief Starts a memory to memory operation using the specified stream.
|
|
* @note The default transfer data mode is "byte to byte" but it can be
|
|
* changed by specifying extra options in the @p mode parameter.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
* @param[in] mode value to be written in the CCR register, this value
|
|
* is implicitly ORed with:
|
|
* - @p STM32_DMA_CR_MINC
|
|
* - @p STM32_DMA_CR_PINC
|
|
* - @p STM32_DMA_CR_DIR_M2M
|
|
* - @p STM32_DMA_CR_EN
|
|
* .
|
|
* @param[in] src source address
|
|
* @param[in] dst destination address
|
|
* @param[in] n number of data units to copy
|
|
*/
|
|
#define dmaStartMemCopy(dmastp, mode, src, dst, n) { \
|
|
dmaStreamSetPeripheral(dmastp, src); \
|
|
dmaStreamSetMemory0(dmastp, dst); \
|
|
dmaStreamSetTransactionSize(dmastp, n); \
|
|
dmaStreamSetMode(dmastp, (mode) | \
|
|
STM32_DMA_CR_MINC | STM32_DMA_CR_PINC | \
|
|
STM32_DMA_CR_DIR_M2M | STM32_DMA_CR_EN); \
|
|
}
|
|
|
|
/**
|
|
* @brief Polled wait for DMA transfer end.
|
|
* @pre The stream must have been allocated using @p dmaStreamAllocate().
|
|
* @post After use the stream can be released using @p dmaStreamRelease().
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
*/
|
|
#define dmaWaitCompletion(dmastp) { \
|
|
while ((dmastp)->channel->CNDTR > 0U) \
|
|
; \
|
|
dmaStreamDisable(dmastp); \
|
|
}
|
|
|
|
/**
|
|
* @brief Serves a DMA IRQ.
|
|
*
|
|
* @param[in] dmastp pointer to a stm32_dma_stream_t structure
|
|
*/
|
|
#define dmaServeInterrupt(dmastp) { \
|
|
uint32_t flags; \
|
|
uint32_t idx = (dmastp)->selfindex; \
|
|
\
|
|
flags = ((dmastp)->dma->ISR >> (dmastp)->shift) & STM32_DMA_ISR_MASK; \
|
|
if (flags & STM32_DMA_ISR_MASK) { \
|
|
(dmastp)->dma->IFCR = flags << (dmastp)->shift; \
|
|
if (_stm32_dma_isr_redir[idx].dma_func) { \
|
|
_stm32_dma_isr_redir[idx].dma_func(_stm32_dma_isr_redir[idx].dma_param, flags); \
|
|
} \
|
|
} \
|
|
}
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if !defined(__DOXYGEN__)
|
|
extern const stm32_dma_stream_t _stm32_dma_streams[STM32_DMA_STREAMS];
|
|
extern dma_isr_redir_t _stm32_dma_isr_redir[STM32_DMA_STREAMS];
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void dmaInit(void);
|
|
bool dmaStreamAllocate(const stm32_dma_stream_t *dmastp,
|
|
uint32_t priority,
|
|
stm32_dmaisr_t func,
|
|
void *param);
|
|
void dmaStreamRelease(const stm32_dma_stream_t *dmastp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _STM32_DMA_H_ */
|
|
|
|
/** @} */
|